网易实战分享｜云信IM SDK接口设计实践

引语

IM (Instant Messaging)是网络上最流行的通信方式，与日常生活息息相关。IM软件也层出不穷，例如：微信、QQ、易信等。通过多年深耕和技术沉淀，云信产出了一套成熟稳定的IM SDK架构。它提供了IM的主要功能，大大降低了第三方实现IM功能的难度。本文主要对IM接口设计实践展开论述。

 

 1 对外接口的设计准则

SDK对外提供接口设计的基本原则是易用，易懂，易扩展，易监控。展开来可归纳为以下几个特性：

1. API按照业务功能分类，但所有业务具有统一的调用风格。
2. API不包含方法实现，接口的实现对调用者隐藏。
3. API调用可跟踪。

在功能形式上，SDK需要提供以下类型的API：

1. 功能接口：主动调用使用其提供的功能
   1. 同步接口：在调用线程完成函数调用，并立即返回结果。
   2. 普通异步接口：在后台线程完成函数调用，可以添加回调函数。
   3. 可中断异步接口：在后台线程完成函数调用，可以添加回调函数，可以中断调用。
2. 回调接口：监听数据和状态改变。

 

2 业务的分类

SDK包含多种业务，一部分是基础业务，另一部分是可选业务。比如用户认证服务、群服务等是基础业务；超大群服务、第三方推送服务等是可选业务。另外，不同的业务之间难免有相似的功能，如群服务和超大群服务中，都有添加群成员，拉取群消息等功能。因此，需要将不同的业务进行隔离，一方面方便业务功能的扩展与调整，另一方面方便函数的命名与用户的理解。

同一个业务下有多个API，按照调用的主动性，分为回调接口和功能接口，分别放在与业务一一对应的接口类Observer和Service中。例如：用户认证服务下的所有回调接口和功能接口都位于AuthServiceObserver和AuthService中。其中由用户主动调用来实现功能的功能接口在AuthService中，如登录、登出等；而用于注册回调的回调接口都在AuthServiceObserver中，如监听在线状态、监听数据同步等。

每个Service中的功能接口根据执行的性质又分为三种，同步接口、普通异步接口和可中断异步接口。其中同步接口在调用线程立即执行；异步接口在后台线程执行，在调用线程返回可设置回调的InvocationFuture类型，最终结果在主线程回调；可中断异步接口和普通异步接口相似，但是返回的是继承自InvocationFuture的AbortableFuture类型，支持中断操作，用户可以通过主动调用来中断功能接口的执行。接口调用的线程切换流程如图2.1所示，业务功能和接口的分类如图2.2所示。