背景

• 当作为一个架构师，选择分布式API框架，你需要注意哪些事项
• 当你作为一个服务提供者，提供分布式API,你需要注意哪些事项,至少有10点。
• 当你需要调用一个分布式API，你需要注意哪些事项，至少有10点。
• 当调用出现故障或者性能优化问题，有哪些思路解决

分布式API

• 分布式API的技术选型
• REST API 设计原则 （参考 远程调用API设计 下：REST，待定）

面向架构质量的设计

• 如果服务 B 不可用，服务 A 如何保证高可用。比如宕机，故障，虚机漂移，网络故障
• 如果服务 B 出现阻塞，性能下降，服务 A 如何保性能不受影响
• 服务 A 调用服务 B，是否一定需要等待服务 B 的响应，能否解耦 A 和 B 调用，避免前面 2 个问题
• 服务 A 如果是通过其寻址服务到 B，如果寻址服务不可用，如何调用服务 B
• 如果服务B更新了API，服务A未同步更新（兼容）

• 如何保证服务 B 支持大并发的操作，包括自身支持大并发，以及依赖的下游支持
• 如何保证服务 B 支持大流量操作，甚至是不正常突发高流量下仍然可用，比如断网恢复后的高流量
• 如果服务 B 的下游不可用，如何给服务 A 提供可用接口
• 服务 B 的更新重启，会对服务 A 产生什么样的影响
• 如何可观测服务 B 的调用
• 如果服务 B 是公网服务，如何保证安全，数据被授权用户获取
• 如果服务B更新了API，服务A未及时更新（兼容考虑）

• 服务 A 应该只调用服务 B 一次，但实际服务 A 调用了多次
• 服务 A 调用频率应该是 1 分钟一次，但实际 1 秒一次
• 服务 A 应该先后顺序调用 B 俩次不同接口，但调用顺序相反。这种可能是 A 的 Bug，或者是事件驱动架构里顺序问题。

分布式API的架构

• TCP协议，使用这类协议的分布式API有Dubbo，RMI（EJB），gRPC，Thrift等，这列分布式API具有良好的性能，延迟都在1毫秒级，适用于系统内部微服务之间调用。其缺点是不易被观察。
• 基于HTTP协议，比如REST，SOAP建立在HTTP协议基础上，HTTP协议高可用和高性能，内置安全，并且支持跨内外网调用。而且HTTP上的调用易于被观测，如，通过HTTP代理观测，或者HTTP日志进行业务统计。因此基于HTTP的REST等API技术框架逐渐成为现在流行的分布式调用方式，适用于系统之间，用户和系统之间的调用。 基于REST调用延迟通常相对TCP方式的协议较大，即使内网之间调用，延迟在10+毫秒。对于需要毫秒级延迟的场景，REST协议不合适

• Client API ，以Java接口形式体现
• Client Stub，扮演了客户端的Gateway，通常会将调用的目标类，参数等封装成指定协议的报文，调用底层transport。Client Stub有负责寻址，调用分布式服务端的节点，并等待返回结果返回调用者
• Client Transport: 负责传输部分，客户端报文到服务器端
• Server Transport ：负责接收客户端报文
• Server Skeleton：负责把报文反序列化成调用参数，并调用实际的实现类Service Impl
• Service Impl：接口实现类

分布式API设计通用考虑

• 基础协议： 通常区分TCP或者HTTP，构建在HTTP基础上的分布式API，适用于系统之间或者内外网之间调用，直接构建在TCP上的协议通常性能更好，适用于内网之间调用，构建在TCP协议上的分布式API通常有更好的性能。目前基于TCP的分布式API都开始支持基于HTTP，以方便互联网调用而不是企业内网的调用。如RMI，Dubbo,gRPC
• 报文格式:通常文本格式更方便阅读，二进制格式性能更好。JSON相比与XML文本格式，性能也更好。报文格式以影响兼容性，这点非常重要，XML和JSON方式天然能实现向前，向后兼容，二进制则依赖序列化协议是否支持兼容。比如Hession，gPRC支持兼容，fury依赖配置以是否支持兼容。兼容性是选择序列化协议的一个考虑点
• 编程语言支持： 由于HTTP协议是一种非常成熟协议，因此所有语言都支持。gRpc和Dubbo等API框架，流行语言都支持，RMI则只有Java支持。广泛的编程语言支持，能保证异构系统之间的互相调用。
• 性能：当考虑到性能的时候，推荐基于TCP实现的分布式API框架。随着HTTP/2和HTTP/3的推出，HTTP协议也有较高的性能
• 内网/外网：如果分布式API暴漏给外网，则需要考虑到能穿透防火墙，通常HTTP协议比较适合，这也是REST，SOAP比较适合对外提供API或者系统(云）之间的调用
• 可观测，基于HTTP协议的分布式API有较好的可观测，通过网关，或者HTTP日志。基于TCP的分布式API则需要框架支持或者二次开发支持。
• 通信方式，包括同步和异步调用，以及服务端推送。比如gPRC同时支持这三种方式
• API Schema: 通常分布式API都会提供Schema来说明API的调用地址endpoint，入参，出参，以及参数校验规则。这些Schema除了能当做API文档外，还能生成客户端或者服务端代码，或者生成客户端或者服务测试代码和数据。Open API提供了REST调用的Schema。WSDL提供了SOPA调用的Schema，gRPC则使用protobuf
• 网关支持: API网关可以提高架构的高可用和可观测，大部分布式API都支持网关，以HTTP协议为基础的API天然支持通过Apache，Nginx，HAProxy等作为网关，或者Spring Cloud Gateway 。 对于Dubbo，则可以使用Apache Shengyu网关， 或者二次开发Spring Cloud Gateway，将REST请求转化为Dubbo请求。

分布式API 设计其他考虑

参考

询问AI