控制台配置完AMQP服务端订阅后,您需要参考本文将AMQP客户端接入物联网平台。成功接入后,在您的服务端运行AMQP客户端,即可接收设备消息。

协议版本说明

AMQP协议标准的详细介绍,请参见AMQP协议标准

阿里云物联网平台服务端订阅仅支持AMQP 1.0版的协议标准。

建连认证过程

  1. 首先,AMQP客户端与物联网平台经过三次握手建立TCP连接,然后进行TLS握手校验。
    说明 为了保障安全,接收方必须使用TLS加密,不支持非加密的TCP传输。
  2. 客户端请求建立Connection。

    连接认证方式为PLAIN-SASL ,可以理解为用户名(userName)和密码(password)认证。云端认证userName和password通过后,建立Connection。

    此外,根据AMQP协议,客户端建连时,还需在Open帧中携带心跳时间,即AMQP协议的idle-time-out参数。心跳时间单位为毫秒,取值范围为30,000~300,000。如果超过心跳时间,Connection上没有任何帧通信,物联网平台将关闭连接。SDK不同,idle-time-out参数设置方法不同。具体设置方法,请参见各语言SDK示例文档。

  3. 客户端向云端发起请求,建立Receiver Link(即云端向客户端推送数据的单向通道)。

    客户端建立Connection成功后,需在15秒内完成Receiver Link的建立,否则物联网平台会关闭连接。

    建立Receiver Link后,客户端成功接入物联网平台。

    说明
    • 一个Connection上只能创建一个Receiver Link,不支持创建Sender Link,即只能由云端向客户端推送消息,客户端不能向云端发送消息。
    • Receiver Link在有的SDK中名称不同,例如在有的SDK上称为MessageConsumer,请根据具体SDK设置。

连接配置说明

AMQP客户端接入物联网平台的连接地址和连接认证参数说明如下。

  • 接入域名:
    • 您购买的实例的接入域名请在物联网平台控制台实例管理 > 实例设置页面,单击查看终端节点查看。
    • 公共实例的接入域名:amqps://${uid}.iot-amqp.${regionId}.aliyuncs.com
    表 1. 域名中的变量说明
    字段 说明
    uid 您的阿里云账号ID。

    用主账号登录阿里云控制台,单击账号头像,跳转至账号管理控制台,即可获取账号UID。

    regionId 您的物联网平台服务所在地域代码。

    在物联网平台控制台页右上方可查看地域。地域代码(Region ID) 的表达方法,请参见文档地域和可用区

  • 端口:5671。
  • 客户端身份认证参数:
    userName = clientId|iotInstanceId=${iotInstanceId},authMode=aksign,signMethod=hmacsha1,consumerGroupId=${consumerGroupId},authId=${accessKey},timestamp=1573489088171|
    password = signMethod(stringToSign, accessSecret)
    表 2. userName参数说明
    参数 是否必需 说明
    clientId 表示客户端ID,建议使用客户端机器UUID、MAC地址、IP等唯一标识。长度不可超过64个字符。

    控制台服务端订阅中消费组状态页将显示该参数,方便您识别区分不同的客户端。

    iotInstanceId 实例ID。仅购买的实例需要传入。
    authMode 鉴权模式。目前仅支持aksign模式。
    signMethod 签名算法。可选:hmacmd5、hmacsha1和hmacsha256。
    consumerGroupId 消费组ID。请在控制台上查看您的服务端订阅消费组ID。
    authId 认证信息。在aksign鉴权模式下,authId取值为您的阿里云账号AccessKey ID。
    登录阿里云控制台,将光标移至账号头像上,然后单击accesskeys,跳转至用户信息管理页,即可获取。
    说明 如果使用子账号AccessKey ID,您需要给该子账号授予管理物联网平台的权限(AliyunIOTFullAccess),否则将会连接失败。授权方法请参见授权子账号访问物联网平台
    timestamp 当前时间。Long类型的毫秒值时间戳。
    cleanSession 是否清除堆积的离线消息。可选值:
    • true:清除。
    • false:不清除。

    不传入此参数,则取默认值false

    表 3. password参数说明
    参数 是否必需 说明
    signMethod 签名算法。请使用userName中指定的签名算法计算签名值,并转为base64字符串。
    stringToSign 待签名的字符串。

    将需要签名的参数的键值对按照首字母字典排序,并在键值间添加等号(=);参数间添加与号(&),拼接成待签名的字符串。

    需要签名的参数为:authIdtimestamp

    待签名的字符串为stringToSign = authId=${accessKey}&timestamp=1573489088171

    accessSecret 您的阿里云账号的AccessKey Secret。

    登录阿里云控制台,将光标移至账号头像上,然后单击accesskeys,跳转至用户信息管理页,即可获取。

接收云端推送的消息

客户端和云端之间的Receiver Link建连成功后,云端就可以在这条Link上向AMQP客户端推送消息。

云端推送的消息:

  • 消息体:消息的payload为二进制格式。
  • 消息的业务属性,如消息Topic和Message ID等,需要从AMQP协议的Application Properties中获取。格式为key:value
    Key 含义
    topic 消息Topic。
    messageId 消息ID。
    generateTime 消息生成时间。

消息回执:

按照AMQP协议的定义,客户端需要给云端回执(AMQP协议上一般称为settle),通知云端消息已经被成功接收。AMQP客户端通常会提供自动回执模式(推荐)和手动回执模式。具体请参考相应的客户端的使用说明。

消息策略:
  1. 实时消息直接推送。
  2. 推送限流或失败进入堆积,堆积消息会尝试重新发送。
  3. 堆积消息会尝试重新发送。如果AMQP客户端回复ACK,云端马上触发下一个拉取消息窗口。
  4. 云端根据客户端返回的ACK判断消息是否送达。云端未收到ACK,则消息将进入堆积,并重发。
说明
  • 消息不保序。您可以使用时间戳来实现业务的相对有序。
  • 消息可能重复发送。为了确保消息送达,在某些情况下,同一条消息可能重复发送,直到客户端返回ACK或消息过期。您可以根据消息ID做唯一性处理。
  • 堆积清理。可在客户端设置cleanSession,每次上线清空堆积消息。具体操作见使用AMQP服务端订阅的Demo。

相关文档