MQTT通配符

话题名称和话题过滤器（MQTT“5.0”协议版本和MQTT“3.1.1”协议版本）

4.7.1 主题通配符 Topic wildcards

主题层级（topic level）分隔符用于将结构化引入主题名。如果存在分隔符，它将主题名分割为多个主题层级 topic level 。

订阅的主题过滤器可以包含特殊的通配符，允许客户端一次订阅多个主题。

主题过滤器中可以使用通配符，但是主题名不能使用通配符 [MQTT-4.7.0-1]。

4.7.1.1 主题层级分隔符 Topic level separator

斜杠（“/” U+002F）用于分割主题的每个层级，为主题名提供一个分层结构。当客户端订阅指定的主题过滤器包含两种通配符时，主题层级分隔符就很有用了。主题层级分隔符可以出现在主题过滤器或主题名字的任何位置。相邻的主题层次分隔符表示一个零长度的主题层级。

4.7.1.2 多层通配符 Multi-level wildcard

数字符号（“#” U+0023）是用于匹配主题中任意层级的通配符。多层通配符表示它的父级和任意数量的子层级。多层通配符必须单独指定，或者跟在主题层级分隔符后面。不管哪种情况，它都必须是主题过滤器的最后一个字符 [MQTT-4.7.1-1]。

非规范评注

例如，如果客户端订阅主题 “sport/tennis/player1/#”，它会收到使用下列主题名发布的消息：

“sport/tennis/player1”

“sport/tennis/player1/ranking”

“sport/tennis/player1/score/wimbledon”

非规范评注

“sport/#”也匹配单独的 “sport” 主题名，因为#包括它的父级。

“#”是有效的，会收到所有的应用消息。

“sport/tennis/#”也是有效的。

“sport/tennis#”是无效的。

“sport/tennis/#/ranking”是无效的。

4.7.1.3 单层通配符 Single-level wildcard

加号(“+” U+002B) 是只能用于单个主题层级匹配的通配符。

在主题过滤器的任意层级都可以使用单层通配符，包括第一个和最后一个层级。在使用它时，它必须占据过滤器的整个层级 [MQTT-4.7.1-2]。可以在主题过滤器中的多个层级中使用它，也可以和多层通配符一起使用。

非规范评注

例如，“sport/tennis/+”匹配“sport/tennis/player1”和“sport/tennis/player2”，但是不匹配“sport/tennis/player1/ranking”。同时，由于单层通配符只能匹配一个层级，“sport/+”不匹配“sport”但是却匹配 “sport/”。

“+” 是有效的。

“+/tennis/#” 是有效的。

“sport+” 是无效的。

“sport/+/player1” 也是有效的。

“/finance” 匹配 “+/+” 和 “/+” ，但是不匹配 “+”。

4.7.2 以$开头的主题 Topics beginning with $

服务端不能将$字符开头的主题名匹配通配符（#或+）开头的主题过滤器 [MQTT-4.7.2-1]。服务端应该阻止客户端使用这种主题名与其它客户端交换消息。服务端实现可以将$开头的主题名用作其他目的。

非规范评注

$SYS/被广泛用作包含服务器特定信息或控制接口的主题的前缀。

应用不能使用$字符开头的主题。

非规范评注

订阅“#”的客户端不会收到任何发布到以“$”开头主题的消息。

订阅“+/monitor/Clients”的客户端不会收到任何发布到“$SYS/monitor/Clients”的消息。

订阅“$SYS/#”的客户端会收到发布到以“$SYS/”开头主题的消息。

订阅“$SYS/monitor/+” 的客户端会收到发布到“$SYS/monitor/Clients”主题的消息。

如果客户端想同时接受以“$SYS/”开头主题的消息和不以$开头主题的消息，它需要同时订阅“#”和“$SYS/#”。

4.7.3 主题语义和用法 Topic semantic and usage

下列规则应用于主题名和主题过滤器：

所有的主题名和主题过滤器必须至少包含一个字符 [MQTT-4.7.3-1]。

主题名和主题过滤器是大小写敏感的。

主题名和主题过滤器可以包含空格字符。

主题名或主题过滤器以前置或后置斜杠“/”区分。

只包含斜杠“/”的主题名或主题过滤器是合法的。

主题名和主题过滤器不能包含空字符(Unicode U+0000) [Unicode] [MQTT-4.7.3-2]。

主题名和主题过滤器是UTF-8编码字符串，它们不能超过65535字节 [MQTT-4.7.3-3]。见1.5.4节。

除了不能超过UTF-8编码字符串的长度限制之外，主题名或主题过滤器的层级数量没有其它限制。

匹配订阅时，服务端不能对主题名或主题过滤器执行任何规范化（normalization）处理，不能修改或替换任何未识别的字符 [MQTT-4.7.3-4]。主题过滤器中的每个非通配符层级需要逐字符匹配主题名中对应的层级才算匹配成功。

非规范评注

使用UTF-8编码规则意味着，主题过滤器和主题名的比较可以通过比较编码后的UTF-8字节或解码后的Unicode字符。

非规范评注

“ACCOUNTS”和“Accounts”是不同的主题名。

“Accounts payable”是合法的主题名

“/finance”和“finance”是不同的。

如果订阅的主题过滤器与消息的主题名匹配，应用消息会被发送给每一个匹配的客户端订阅。主题资源可以是管理员在服务端预先定义好的，也可以是服务端收到第一个订阅或使用那个主题名的应用消息时动态添加的。服务端也可以使用一个安全组件有选择地授权客户端使用某个主题资源。