MQTT协议数据包结构
1. 结构组成
官方文档中对于MQTT协议包的结构有着具体的说明:https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html
在MQTT协议中,一个MQTT数据包由:固定头(Fixed header)、可变头(Variable header)、消息体 (payload)三部分构成。MQTT数据包结构如下:
- (1)固定头(Fixed header)。存在于所有MQTT数据包中,表示数据包类型及数据包的分组类标识,如连接,发布,订阅,心跳等。其中固定头是必须的,所有类型的MQTT协议中,都必须包含固定头。
- (2)可变头(Variable header)。存在于部分MQTT数据包中,数据包类型决定了可变头是否存在及其具体内容。可变头部不是可选的意思,而是指这部分在有些协议类型中存在,在有些协议中不存在。
- (3)消息体(Payload)。存在于部分MQTT数据包中,表示客户端收到的具体内容。 与可变头一样,在有些协议类型中有消息内容,有些协议类型中没有消息内容。
2. 固定头(Fixed header)
固定头存在于所有MQTT数据包中, 固定头包含两部分内容,首字节(字节1)和剩余消息报文长度(从第二个字 节开始,长度为1-4字节),剩余长度是当前包中剩余内容长度的字节数,包括变量头和有效负载中的数据)。剩余 长度不包含用来编码剩余长度的字节。
剩余长度使用了一种可变长度的结构来编码,这种结构使用单一字节表示0-127的值。大于127的值如下处 理。每个字节的低7位用来编码数据,最高位用来表示是否还有后续字节。因此每个字节可以编码128个值,再加 上一个标识位。剩余长度最多可以用四个字节来表示。
1. 数据包类型
位置:第一个字节(Byte 1) 中的7-4个bit位(Bit[7-4]),表示4位无符号值
通过第一个字节的高4位确定消息报文的类型,4个bit位能确定16种类型,其中0000和1111是保留字段。 MQTT消息报文类型如下:
2.标志位
位置:第一个字节中的0-3个bit位(Bit[3-0])。意思是字节位Bit[3-0]用作报文的标识。
首字节的低4位(bit3~bit0)用来表示某些报文类型的控制字段,实际上只有少数报文类型有控制位,如下图:
(1):其中Bit[3]为DUP字段,如果该值为1,表明这个数据包是一条重复的消息;否则该数据包就是第一次发布的消息。
(2):Bit[2-1]为Qos字段:
如果Bit 1和Bit 2都为0,表示QoS 0:至多一次;
如果Bit 1为1,表示QoS 1:至少一次;
如果Bit 2为1,表示QoS 2:只有一次;
如果同时将Bit 1和Bit 2都设置成1,那么客户端或服务器认为这是一条非法的消息,会关闭当前连接。
目前Bit[3-0]只在PUBLISH协议中使用有效,并且表中指明了是MQTT 3.1.1版本。对于其它MQTT协议版 本,内容可能不同。所有固定头标记为”保留”的协议类型,Bit[3-0]必须保持与表中保持一致,如SUBSCRIBE 协议,其Bit 1必须为1。如果接收方接收到非法的消息,会强行关闭当前连接。
3. MQTT消息QoS
MQTT发布消息服务质量保证(QoS)不是端到端的,是客户端与服务器之间的。订阅者收到MQTT消息的 QoS级别,最终取决于发布消息的QoS和主题订阅的QoS。
Bit[0]为RETAIN字段,发布保留标识,表示服务器要保留这次推送的信息,如果有新的订阅者出现, 就把这消息推送给它,如果设有那么推送至当前订阅者后释放。
3. 可变头(Variable Header)
可变头的意思是可变化的消息头部。有些报文类型包含可变头部有些报文则不包含。可变头部在固定头部和消 息内容之间,其内容根据报文类型不同而不同。
1. 协议名
协议名是表示协议名MQTT的UTF-8编码的字符串。MQTT规范的后续版本不会改变这个字符串的偏移和 长度。
支持多种协议的服务端使用协议名字段判断数据是否为MQTT报文。协议名必须是UTF-8字符串“MQTT”。如果服务端不愿意接受CONNECT但希望表明其MQTT服务端身份,可以发送包含原因码为0x84(不支持的协议版本)的CONNACK报文,然后必须关闭网络连接
2. 协议版本
位无符号值表示客户端的版本等级。3.1.1版本的协议等级是4,MQTT v5.0的协议版本字段为5(0x05)
3. MQTT会话(Clean Session)
MQTT客户端向服务器发起CONNECT请求时,可以通过’Clean Session’标志设置会话。
Clean Session
设置为0,表示创建一个持久会话,在客户端断开连接时,会话仍然保持并保存离线消息,直到会话超时注销。Clean Session
设置为1,表示创建一个新的临时会话,在客户端断开时,会话自动销毁。
1.Will Flag/Will Qos/Will Retain
如果Will Flag被设置为1,这意味着,如果连接请求被接受,服务端必须存储一个Will Message,并和网 络连接关联起来。之后在网络连接断开的时候必须发布Will Message,除非服务端收到DISCONNECT包删掉 了Will Message
Will Message会在某些情况下发布,包括但不限于:
- 服务端发现I/O错误或网络失败。
- 客户端在Keep Alive时间内通信失败。
- 客户端没有发送DISCONNECT包就关闭了网络连接。
- 服务端因协议错误关闭了网络连接。 如果Will Flag被设置为1,连接标识中的Will QoS和Will Retain字段将会被服务端用到
Will QoS这两个bit表示发布Will Message时使用QoS的等级
Will Retain这个bit表示Will Message在发布之后是否需要保留。
如果Will Flag设置为0,那么Will Retain必须是0
如果Will Flag设置为1:
- 如果Will Retain设置为0,那么服务端必须发布Will Message,不必保存
- 如果Will Retain设置为1,那么服务端必须发布Will Message,并保存
2. User Name Flag
- 如果User Name Flag设置为0,那么用户名不必出现在载荷中
- 如果User Name Flag设置为1,那么用户名必须出现在载荷中
3. Password Flag
- 如果Password Flag设置为0,那么密码不必出现在载荷中
- 如果Password Flag设置为1,那么密码必须出现在载荷中
- 如果User Name Flag设置为0,那么Password Flag必须设置为0
4. MQTT连接保活心跳
心跳的作用:
PINGREQ包从客户端发往服务端,可以用来:
- 1:在没有其他控制包从客户端发送给服务端的时候,告知服务端客户端的存活状态。
- 2:请求服务端响应,来确认服务端是否存活。
- 3:确认网络连接的有效性。
PINGRESP包从服务端发送给客户端来响应PINGREQ包。它代表服务端是存活的。
MQTT客户端向服务器发起CONNECT请求时,通过KeepAlive参数设置保活周期。
Keep Alive是以秒为单位的时间间隔。用2字节表示,它指的是客户端从发送完成一个控制包到开始发送 下一个的最大时间间隔。客户端有责任确保两个控制包发送的间隔不能超过Keep Alive的值。如果没有其他 控制包可发,客户端必须发送PINGREQ包
客户端可以在任何时间发送PINGREQ包,不用关心Keep Alive的值,用PINGRESP来判断与服务端的网络连接是否正常。
如果Keep Alive的值非0,而且服务端在一个半Keep Alive的周期内没有收到客户端的控制包,服务端必须作为网络故障断开网络连接
如果客户端在发送了PINGREQ后,在一个合理的时间都没有收到PINGRESP包,客户端应该关闭和服务端的网络连接。
Keep Alive的值为0,就关闭了维持的机制。这意味着,在这种情况下,服务端不会断开静默的客户端。
5. MQTT遗愿消息(Last Will)
MQTT客户端向服务器端CONNECT请求时,可以设置是否发送遗愿消息(Will Message)标志,和遗愿消息主题(Topic)与内容(Payload)。
MQTT客户端异常下线时(客户端断开前未向服务器发送DISCONNECT消息),MQTT消息服务器会发布遗愿消息。
常见的一种可变头比如:Packet Identifier(消息ID)
一个消息ID包含2字节,高字节在前,低字节在后。包含Packet Identifier的协议类型包括:
PUBLISH( QoS > 0 )、 PUBACK 、 PUBREC 、 PUBREL 、 PUBCOMP 、 SUBSCRIBE 、 SUBACK 、 UNSUBSCRIBE 、 UNSUBACK
消息ID默认是从1开始并自增,如果一个消息ID被用完后,这个消息ID可以被重用。对于PUBLISH (QoS 1)来 说,如果发送端接收到PUBACK,那么这个消息ID就用完了。对于PUBLISH(QoS 2),如果接收方收到PUBCOMP,那么这个消息ID就用完了。对于SUBSCRIBE和UNSUBSCRIBE,消息ID使用完成的标记是发送方收到了对应的SUBACK和UNSUBACK。
另外客户端和服务端的消息ID是独立分配的,客户端和服务端可以同时使用同一个消息ID。
4. 消息体(Payload)
有些报文类型是包含Payload的,Payload意思是消息载体的意思
如PUBLISH的Payload就是指消息内容(应用程序发布的消息内容)。而CONNECT的Payload则包含Client Identifier,Will Topic,Will Message,Username,Password等信息。
包含payload的报文类型如下:
5. 总结
我们介绍了MQTT协议的消息格式,MQTT消息格式包含Fixed Header, Variable Header和Payload。 因为MQTT消息格式非常精简,所以可以高效的传输数据。
Fixed Header中包含首字节,高4位用来表示报文类型,低4位用于类型控制。目前只有PUBLISH使用了类型 控制字段。其它控制字段被保留并且必须与协议定义保持一致。
Fixed Header同时包含Remaining Length,这是剩余消息长度,最大长度为4字节,理论上一条MQTT最大可 以传输256MB数据。Remaining Length=Variable Header+Payload长度。
Variable Header是可变头部,有些报文类型中需要包含可变头部,可变头部根据报文类型不同而不同。比如 Packet Identifier在发布,订阅/取消订阅等报文中都使用到。
Payload是消息内容,也只在某些报文类型中出现,其内容和格式也根据报文类型不同而不同。