全部产品
云市场

API网关双向通信SDK实现指南

更新时间:2018-11-06 17:15:14

阿里云API网关对外提供双向通信能力,官方提供的SDK的语言有限,有些语言需要用户自己去开发SDK,本文档把SDK的实现细节描述出来,供用户在其他语言上实现SDK时参考。API网关官方提供的Android和Objective-C的SDK,是完整支持双向通信的,开发同学也可以参考Android和iOS的Objective-C结合本文档来实现目标语言的SDK。

关于API网关提供的双向通信的使用流程请参考下面文档:https://help.aliyun.com/document_detail/66031.html

1. 通信协议及相关命令字

客户端和API网关之间通过WebSocket通道进行通信,通信类型分两种:调用API和发送命令。在通道上制定了一些简单的通信规则:

1.1 API调用格式转换

客户端调用API,请求和应答是纯Json格式的字符串,也就是把HTTP请求对象按照Json的语法格式化后传输,就是将下面这个对象转化成Json格式:

  1. public class WebSocketApiRequest {
  2. String method;
  3. String host;
  4. String path;
  5. Map<String , String> querys;
  6. Map<String, List<String>> headers;
  7. int isBase64 = 0;
  8. String body;
  9. }

下面是一个示例,首先展示一个标准的HTTP请求报文:

  1. POST /http2test/test?param1=test HTTP/1.1
  2. host: apihangzhou444.foundai.com
  3. x-ca-seq:0
  4. x-ca-key:12344133
  5. ca_version:1
  6. content-type:application/x-www-form-urlencoded; charset=utf-8
  7. x-ca-timestamp:1525872629832
  8. date:Wed, 09 May 2018 13:30:29 GMT+00:00
  9. x-ca-signature:kYjdIuCnCrxx+EyLMTTx5NiXxqvfTTHBQAe68tv33Tw=
  10. user-agent:ALIYUN-ANDROID-DEMO
  11. x-ca-nonce:c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44
  12. x-ca-signature-headers:x-ca-seq,x-ca-key,x-ca-timestamp,x-ca-nonce
  13. content-length:33
  14. username=xiaoming&password=123456789

WebSocket在通信的时候会将这个HTTP请求报文格式化为下面的字符串格式进行传输:

  1. {
  2. "headers": {
  3. "accept": ["application/json; charset=utf-8"],
  4. "host": ["apihangzhou444.foundai.com"],
  5. "x-ca-seq": ["0"],
  6. "x-ca-key": ["12344133"],
  7. "ca_version": ["1"],
  8. "content-type": ["application/x-www-form-urlencoded; charset=utf-8"],
  9. "x-ca-timestamp": ["1525872629832"],
  10. "date": ["Wed, 09 May 2018 13:30:29 GMT+00:00"],
  11. "x-ca-signature": ["kYjdIuCnCrxx+EyLMTTx5NiXxqvfTTHBQAe68tv33Tw="],
  12. "user-agent": ["ALIYUN-ANDROID-DEMO"],
  13. "x-ca-nonce": ["c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44"],
  14. "x-ca-signature-headers": ["x-ca-seq,x-ca-key,x-ca-timestamp,x-ca-nonce"]
  15. },
  16. "host": "apihangzhou444.foundai.com",
  17. "isBase64": 0,
  18. "method": "POST",
  19. "path": "/http2test/test",
  20. "querys": {"param1":"test"},
  21. "body":"username=xiaoming&password=123456789"
  22. }

1.2 双向通信命令

在双向通信过程中,除了正常的API调用,还有一系列定制的命令:

1.2.1 客户端注册

  1. 命令字:RG
  2. 含义:在API网关注册长连接,携带DeviceId
  3. 命令类型:请求
  4. 发送端:客户端
  5. 格式:RG#DeviceId
  6. 示例:RG#ffd3234343dae324342@12344133
  7. 命令字:RO
  8. 含义:DeviceId注册成功时,API网关返回成功,并将连接唯一标识和心跳间隔配置返回
  9. 命令类型:应答
  10. 发送端:API网关
  11. 格式:RO#ConnectionCredential#keepAliveInterval
  12. 示例:RO#1534692949977#25000
  13. 失败命令字:RF
  14. 含义:API网关返回注册失败应答
  15. 命令类型:应答
  16. 发送端:API网关
  17. 格式:RF#ErrorMessage
  18. 示例:RF#ServerError

1.2.2 客户端保持心跳

  1. 命令字:H1
  2. 含义:客户端心跳请求信令
  3. 命令类型:请求
  4. 发送端:客户端
  5. 没有其他参数,直接发送命令字
  6. 命令字:HO
  7. 含义:API网关返回心跳保持成功应答信令
  8. 命令类型:应答
  9. 发送端:API网关
  10. 格式:HO#ConnectionCredential
  11. 示例:HO#ffd3234343dae324342

1.2.3 下行通知

  1. 命令字:NF
  2. 含义:API网关发送下行通知请求
  3. 命令类型:请求
  4. 发送端:API网关
  5. 格式为NF#MESSAGE
  6. 示例:NF#HELLO WORLD!
  7. 命令字:NO
  8. 含义:客户端返回接收下行通知应答
  9. 命令类型:应答
  10. 发送端:客户端
  11. 没有其他参数,直接发送命令字

1.2.4 其他信令

  1. 命令字:OS
  2. 含义:客户端请求量达到API网关流控阈值,API网关会给客户端发送这个命令,需要客户端主动断掉连接,主动重连。主动重连将不会影响用户体验。否则API网关不久后会主动断链长连接。
  3. 命令类型:请求
  4. 发送端:API网关
  5. 没有其他参数,直接发送命令字
  6. 命令字:CR
  7. 含义:连接达到长连接生命周期,API网关会给客户端发送这个命令,需要客户端主动断掉连接,主动重连。主动重连将不会影响用户体验。否则API网关不久后会主动断链长连接。
  8. 命令类型:请求
  9. 发送端:API网关
  10. 没有其他参数,直接发送命令字

1.2.5 设备唯一标识

DeviceId唯一标记客户端的长连接,格式为UUID@AppKey,下面是建议的JAVA实现。所有DeviceId在APP维度必须是唯一的。也就是同一个APP,不允许出现重复的DeviceId,否则在注册的时候会报错。

  1. String deviceId = UUID.randomUUID().toString().replace("-" , "")+ “@” + appKey;

下面是一个示例:ffd3234343dae324342@12344133

2. 通信流程

下图是SDK和API网关之间交互流程图:

image.png

从上图中我们可以看到,SDK主要需要完成一下工作:

  • WebSocket连接建立(包括协议协商)
  • 发送DeviceId注册请求(RG)
  • 调用注册API
  • 启动保持心跳线程,定期保持心跳(H1)
  • 调用其他API
  • 接收API网关发送的通知
  • 调用注销API请求

除了正常流程,SDK还需要处理以下异常流程:

  • 断线重连
  • 触及流控

2.1 WebSocket连接建立(包括协议协商)

API网关的双向通信是基于WebSocket实现的,客户端和API网关之间的连接建立过程是标准的WebSocket连接建立流程。WebSocket连接建立过程请参考WebSocket协议定义(https://tools.ietf.org/html/rfc6455)。

一般的语言都会有WebSocket协议客户端开源实现,比如Android用的就是OkHttp的WebSocket开源实现。

2.2 发送DeviceId注册请求(RG)

客户端在WebSocket连接建立之后,需要马上向API网关发送一条注册请求,请求中需要携带本机DeviceId;

API网关在收到注册信令后,会在接入层注册一条通信长连接,并且使用DeviceId标识这条长连接。API网关会给客户端返回注册成功的应答。

具体信令请参见1.2.1中的信令描述。

2.3 调用注册API

客户端在发送完注册信令后,需要马上发送一个注册API的请求。注册API需要在API网关提前定义好,具体的定义方法请参见《双向通信使用指南》文档的第二章:https://help.aliyun.com/document_detail/66031.html

API请求的发送格式请参见本文的1.1节。在发送注册API请求的时候,需要注意以下两点:

  1. 在API网关对RG信令正确应答后再发送;
  2. 需要增加一个标识注册API的头:x-ca-websocket_api_type:REGISTER

2.4 启动保持心跳线程,定期保持心跳(H1)

客户端需要每25秒给API网关发送一个心跳请求,API网关在接收到心跳请求后会更新用户的在线时间并且给出一个心跳处理成功的应答。

具体信令请参见1.2.2中的信令描述。

2.5 调用其他API

客户端在Websocket长连接建立好之后,随时可以给API网关发送普通的API请求,发送格式请参见本文的1.1节。

2.6 接收API网关发送的通知

客户端在注册API发送成功,并且收到API网关的200应答后,就可以正式接收API网关发送过来的下行通知了,下行通知的格式非常简单,请参见本文的1.2.3。

2.7 调用注销API请求

客户端在用户退出登录之前,需要发送一个注销API的请求。注册API需要在API网关提前定义好,具体的定义方法请参见《双向通信使用指南》文档的第二章:https://help.aliyun.com/document_detail/66031.html

API请求的发送格式请参见本文的1.1节。在发送注册API请求的时候,需要注意一点:需要增加一个标识注册API的头:x-ca-websocket_api_type:UNREGISTER

2.8 处理API网关发送过来的断线重连信令

每条长连接都会存在一个生命周期,API网关的长连接生命周期在处理完2000个API请求后结束。API网关会在处理完1500个请求的时候,给客户端发送一条要求客户端主动断线重连的信令(CR),具体信令格式参见本文1.2.4。API网关会在长连接的请求数积累到2000个请求的时候,删除这条长连接。

客户端在收到断线重连这两种信令后,需要暂时停止接收上层API发送请求,并且在发送完已经接收到的API请求后,重新连接API网关,重新发送注册信令和注册API,完成断线重连的过程。建议在第一次发送注册API的时候,将注册API的请求对象缓存在本地,每次断线重连的时候直接使用即可。

2.9 处理API网关发送过来的流控限制信令

API网关有流控限制,客户端的请求QPS如果超过流控限制会触发API网关的流控,客户端会收到API网关发送的触发流控阈值的信令(OS),具体信令格式请参见本文1.2.4节。这个时候客户端应该控制报文的发送速度。如果客户端不理会此信令,并且让QPS持续增长,API网关会删除这条长连接。

三.总结

3.1 流程总结

画一张图总结一下支持API网关双向通信的SDK需要做哪些事情:

双向通信信令示例图

注:普通API的请求应答报文格式和注册API的请求应答报文格式是一样的,故没有示例。

3.2 代码参考

目前API网关的Android和Objective-C已经具备双向通信能力,并且严格按照前两节规范实现的。下面我们使用Android的代码来逐步过第二章中提到相关流程的实现。

3.2.1 WebSocket连接建立(包括协议协商)

  1. //使用绑定的域名加8080端口作为连接地址
  2. String websocketUrl = "ws:" + yourdomain + ":8080";
  3. //新建一个client对象
  4. OkHttpClient client = new OkHttpClient.Builder()
  5. .readTimeout(params.getReadTimeout(), TimeUnit.MILLISECONDS)
  6. .writeTimeout(params.getWriteTimeout(), TimeUnit.MILLISECONDS)
  7. .connectTimeout(params.getConnectionTimeout(), TimeUnit.MILLISECONDS)
  8. .build();
  9. //建立WebSocket连接需要的HttpRequest请求
  10. Request connectRequest = new Request.Builder().url(websocketUrl).build();
  11. //连接建立好后的事件监听类
  12. webSocketListener = new WebSocketListener() {
  13. ......
  14. }
  15. //建立长连接
  16. client.newWebSocket(connectRequest, webSocketListener);

3.2.2 发送DeviceId注册请求/心跳请求

  1. String deviceId = generateDeviceId();
  2. webSocketListener = new WebSocketListener() {
  3. @Override
  4. //连接连接好后,回调本方法
  5. public void onOpen(WebSocket webSocket, Response response) {
  6. //发送注册信令
  7. String registerCommand = SdkConstant.CLOUDAPI_COMMAND_REGISTER_REQUEST + "#" + deviceId;
  8. webSocketRef.getObj().send(registerCommand);
  9. }
  10. @Override
  11. //收到API网关的数据后,调用本方法
  12. public void onMessage(WebSocket webSocket, String text) {
  13. if(null == text || "".equalsIgnoreCase(text)) {
  14. return;
  15. }
  16. //注册成功
  17. else if(text.length() > 2 && text.startsWith(SdkConstant.CLOUDAPI_COMMAND_REGISTER_SUCCESS_RESPONSE)){
  18. //解析API网关注册成功应答
  19. String responseObject[] = text.split("#");
  20. connectionCredential = responseObject[1];
  21. //从API网关应答中获取心跳时间间隔
  22. heartBeatInterval = Integer.parseInt(responseObject[2]);
  23. }
  24. //启动心跳线程,发送心跳信令
  25. if (null != heartBeatManager) {
  26. heartBeatManager.stop();
  27. }
  28. heartBeatManager = new HeartBeatManager(instance, heartBeatInterval);
  29. heartbeatThread = new Thread(heartBeatManager);
  30. heartbeatThread.start();
  31. return;
  32. }
  33. //注册失败
  34. else if(text.length() > 2 && text.startsWith(SdkConstant.CLOUDAPI_COMMAND_REGISTER_FAIL_REQUEST)){
  35. String responseObject[] = text.split("#");
  36. errorMessage.setObj(responseObject[1]);
  37. //停止发送心跳
  38. if (null != heartBeatManager) {
  39. heartBeatManager.stop();
  40. }
  41. return;
  42. }
  43. };
  44. }
  45. private String generateDeviceId(){
  46. return UUID.randomUUID().toString().replace("-" , "").substring(0 , 8);
  47. }

3.2.3 发送API请求:注册API、普通API、注销API

  1. protected void sendAsyncRequest(final ApiRequest apiRequest , final ApiCallback apiCallback){
  2. checkIsInit();
  3. //判断连接是否建立
  4. synchronized (connectionLock) {
  5. if (null != connectLatch.getObj() && connectLatch.getObj().getCount() == 1) {
  6. try {
  7. connectLatch.getObj().await(10, TimeUnit.SECONDS);
  8. } catch (InterruptedException ex) {
  9. throw new SdkException("WebSocket connect server failed ", ex);
  10. } finally {
  11. connectLatch.setObj(null);
  12. }
  13. }
  14. if (status == WebSocketConnectStatus.LOST_CONNECTION) {
  15. apiCallback.onFailure(apiRequest, new SdkException("WebSocket conection lost , connecting"));
  16. return;
  17. }
  18. //针对注册、注销类API,做特殊处理
  19. if (WebSocketApiType.COMMON != apiRequest.getWebSocketApiType()) {
  20. if(!preSendWebsocketCommandApi(apiRequest , apiCallback)) {
  21. return;
  22. }
  23. }
  24. Integer seqNumber = seq.getAndIncrement();
  25. apiRequest.addHeader(SdkConstant.CLOUDAPI_X_CA_SEQ, seqNumber.toString());
  26. callbackManager.add(seqNumber, new ApiContext(apiCallback, apiRequest));
  27. //生成需要发送的字符串
  28. String request = buildRequest(apiRequest);
  29. webSocketRef.getObj().send(request);
  30. }
  31. }
  32. private boolean preSendWebsocketCommandApi(final ApiRequest apiRequest , final ApiCallback apiCallback){
  33. //注册类API,需要判断注册信令是否完成
  34. if(WebSocketApiType.REGISTER == apiRequest.getWebSocketApiType()) {
  35. try {
  36. if (null != registerLatch.getObj() && !registerLatch.getObj().await(10, TimeUnit.SECONDS)) {
  37. Thread.sleep(5000);
  38. close();
  39. apiCallback.onFailure(apiRequest, new SdkException("WebSocket conection lost , connecting"));
  40. return false;
  41. }
  42. } catch (InterruptedException ex) {
  43. throw new SdkException("WebSocket register failed ", ex);
  44. } finally {
  45. registerLatch.setObj(null);
  46. }
  47. if (!registerCommandSuccess.getObj()) {
  48. apiCallback.onFailure(null, new SdkException("Register Comand return error :" + errorMessage.getObj()));
  49. return false;
  50. }
  51. //记录注册API,用于断线重连
  52. lastRegisterReqeust = apiRequest.duplicate();
  53. lastRegisterCallback = apiCallback;
  54. }
  55. //增加注册、注销API的标识头
  56. apiRequest.addHeader(SdkConstant.CLOUDAPI_X_CA_WEBSOCKET_API_TYPE, apiRequest.getWebSocketApiType().toString());
  57. return true;
  58. }
  59. private String buildRequest(ApiRequest apiRequest){
  60. apiRequest.setHost(host);
  61. apiRequest.setScheme(scheme);
  62. ApiRequestMaker.make(apiRequest , appKey , appSecret);
  63. WebSocketApiRequest webSocketApiRequest = new WebSocketApiRequest();
  64. webSocketApiRequest.setHost(host);
  65. webSocketApiRequest.setPath(apiRequest.getPath());
  66. webSocketApiRequest.setMethod(apiRequest.getMethod().getValue());
  67. webSocketApiRequest.setQuerys(apiRequest.getQuerys());
  68. webSocketApiRequest.setHeaders(apiRequest.getHeaders());
  69. webSocketApiRequest.setIsBase64(apiRequest.isBase64BodyViaWebsocket() == true ? 1 : 0);
  70. MediaType bodyType = MediaType.parse(apiRequest.getFirstHeaderValue(HttpConstant.CLOUDAPI_HTTP_HEADER_CONTENT_TYPE));
  71. if(null != apiRequest.getFormParams() && apiRequest.getFormParams().size() > 0){
  72. webSocketApiRequest.setBody(HttpCommonUtil.buildParamString(apiRequest.getFormParams()));
  73. }else if(null != apiRequest.getBody()){
  74. webSocketApiRequest.setBody(new String(apiRequest.getBody() , bodyType.charset(SdkConstant.CLOUDAPI_ENCODING)));
  75. }
  76. if(apiRequest.isBase64BodyViaWebsocket()){
  77. webSocketApiRequest.setBody(new String(Base64.encode(apiRequest.getBody() , Base64.DEFAULT) , bodyType.charset(SdkConstant.CLOUDAPI_ENCODING)));
  78. }
  79. return JSON.toJSONString(webSocketApiRequest);
  80. }

3.2.4 接收API网关发送的通知

  1. ApiWebSocketListner apiWebSocketListner = params.getApiWebSocketListner();
  2. webSocketListener = new WebSocketListener() {
  3. ......
  4. @Override
  5. //收到API网关的数据后,调用本方法
  6. public void onMessage(WebSocket webSocket, String text) {
  7. String message = text.substring(3);
  8. apiWebSocketListner.onNotify(message);
  9. if(status == WebSocketConnectStatus.CONNECTED && webSocketRef.getObj() != null){
  10. webSocketRef.getObj().send(SdkConstant.CLOUDAPI_COMMAND_NOTIFY_RESPONSE);
  11. }
  12. return ;
  13. }
  14. ......
  15. }

具体代码请下载Android SDK后,在src文件夹中可以找到。