MQTT 遗嘱消息（Will Message）的使用

简介

当客户端断开链接时，发送给相关的订阅者的遗嘱消息。如下状况下会发送 Will Message：

• 服务端发生了I/O 错误或者网络失败；
• 客户端在定义的心跳时期失联；
• 客户端在发送下线包以前关闭网络链接；
• 服务端在收到下线包以前关闭网络链接。

遗嘱消息通常经过在客户端 CONNECT 的时候指定。以下所示，在链接的时候经过调用 MqttConnectOptions 实例的 setWill 方法来设定。任何订阅了下面的主题的客户端均可以收到该遗嘱消息。

//方法1MqttConnectOptions.setWill(MqttTopic topic, byte[] payload, int qos, boolean retained)//方法2MqttConnectOptions.setWill(java.lang.String topic, byte[] payload, int qos, boolean retained)

使用场景

在客户端 A 进行链接时候，遗嘱消息设定为”offline“，客户端 B 订阅这个遗嘱主题。当 A 异常断开时，客户端 B 会收到这个”offline“的遗嘱消息，从而知道客户端 A 离线了。

Connect Flag 报文字段

Bit	7	6	5	4	2	1	0
	User Name Flag	Password Flag	Will Retain	Will QoS	Will Flag	Clean Start	Reserved
byte 8	X	X	X	X	X	X	X

遗嘱消息在客户端正常调用 disconnect 方法以后并不会被发送。

Will Flag 做用

简而言之，就是客户端预先定义好，在本身异常断开的状况下，所留下的最后遗愿（Last Will），也称之为遗嘱（Testament）。这个遗嘱就是一个由客户端预先定义好的主题和对应消息，附加在CONNECT的可变报文头部中，在客户端链接出现异常的状况下，由服务器主动发布此消息。

当Will Flag位为1时，Will QoS和Will Retain才会被读取，此时消息体中要出现Will Topic和Will Message具体内容，不然Will QoS和Will Retain值会被忽略掉。

当Will Flag位为0时，则Will Qos和Will Retain无效。

命令行示例

下面是一个Will Message的示例：

1. Sub端clientid=sub预约义遗嘱消息:

   mosquitto_sub --will-topic test --will-payload die --will-qos 2 -t topic -i sub -h 192.168.1.1

2. 客户端 clientid=alive 在 192.168.1.1（EMQ服务器) 订阅遗嘱主题

   mosquitto_sub -t test -i alive -q 2 -h 192.168.1.1

3. 异常断开Sub端与Server端（EMQ服务器）链接，Pub端收到Will Message 。

高级使用场景

这里介绍一下如何将 Retained 消息与Will 消息结合起来进行使用。

1. 客户端 A 遗嘱消息设定为”offline“，该遗嘱主题与一个普通发送状态的主题设定成同一个 A/status；
2. 当客户端 A 链接时，向主题 A/status 发送 “online” 的 Retained 消息，其它客户端订阅主题 A/status的时候，获取 Retained 消息为 “online” ；
3. 当客户端 A 异常断开时，系统自动向主题 A/status 发送”offline“的消息，其它订阅了此主题的客户端会立刻收到”offline“消息；若是遗嘱消息被设定了 Retained 的话，这时有新的订阅A/status主题的客户端上线的时候，获取到的消息为“offline”。

---

更多信息请访问咱们的官网 emqx.io，或关注咱们的开源项目 github.com/emqx/emqx ，详细文档请访问 官方文档。