SDK 设计
图片
在之前提到了 cim 在做集成测试的时候遇到的问题,需要提供一个 SDK 来解决,于是我花了一些时间编写了 SDK,同时也将 cim-client 重构了。
重构后的代码长这个样子:
配合 springboot 使用时只需要创建一个 Client 即可,这个 Client 里维护了核心的:
- 长链接创建、状态维护
- 心跳检测
- 超时、网络异常重连等
同时也提供了简易的 API 可以直接收发消息:
图片
这样在集成到业务代码中时会更方便。
以前的代码耦合度非常高,同时因为基础代码是 18 年写的,现在真的没有眼看了;
重构的过程中使用一些 Java8+ 的一些语法糖精简了许多代码,各个模块间的组织关系也重新梳理,现在会更易维护了。
比如由于创建客户端需要许多可选参数,于是就提供了 Builder 模式的创建选项:
以上部分 API 的设计借鉴了 Pulsar。
Proxy 优化
除此之外还优化了请求代理,这个 Proxy 主要是用于方便在各个服务中发起 rest 调用,我这里为了轻量也没有使用 Dubbo、SpringCloud 这类服务框架。
但如果都硬编码 http client 去请求时会有许多重复冗余的代码,比如创建连接、请求参数、响应解析、异常处理等。
于是在之前的版本中就提供了一个 ProxyManager 的基本实现:
虽然提供了一些连接管理和参数封装等基础功能,但只实现了一半。
从上面的代码也可以看出序列化都得自己实现,这些代码完全是冗余的。
经过重构后以上的代码可以精简到如下:
这个调整之后就非常类似于 Dubbo gRPC 这类 RPC 框架的使用,只需要把接口定义好,就和调用本地函数一样的简单。
为了方便后续可能调用一些外部系统,在此基础上还支持了指定多种请求 method、指定 URL 、返回结果嵌套泛型等。
支持动态 URL 调用
图片
还有一个 todo:希望可以将 ProxyManager 交给 Spring 去管理,之前是在每次调用的地方都会创建一个 Proxy 对象,完全没有必要,代码也很冗余。
但有网友在实现过程中发现,有个场景的请求地址是动态的,如果是交给 Spring 管理为单例后是没法修改 URL 地址的,因为这个地址是在创建对象的时候初始化的。
所以我就在这里新增了一个动态 URL 的特性:
在声明接口的时候使用 @DynamicUrl 的方法参数注解,告诉代理这个参数是 URL。这样就可以允许在创建 Proxy 对象的时候不指定 URL,而是在实际调用时候再传入具体的 URL,更方便创建单例了。
集成测试优化
同时还优化了集成测试,支持了 server 的集群版测试。
比如在这里编写了一个客户端重连的单测,代码有点长,但它的主要流程如下:
- 启动两个 Server:Server1,Server2
- 启动 Route
- 在启动两个 Client 发送消息
- 校验消息发送是否成功
- 停止 Client1 连接的 Server
- 等待 Client 自动重连到另一个 Server
- 再次发送消息
- 校验消息发送是否成功
这样就可以验证在服务端 Server 宕机后整个服务是否可用,消息收发是否正常。
这里的启动两个 Server 就是创建了两个 Server 应用,然后保存好端口和应用之间的映射关系。
这样就可以根据客户端连接的 Server 信息指定停止哪一个 Server,更方便做测试。
这次重启 cim 的维护后会尽量维护下去,即便更新时间慢一点。
后续还会加上消息 ack、离线消息等之前呼声很高的功能,感兴趣的完全可以一起参与。
源码地址:https://github.com/crossoverJie/cim