SpringBoot集成MQTT

MQTT介绍

MQTT 是基于 Publish/Subscribe（发布/订阅） 模式的物联网通信协议，凭借简单易实现、支持 QoS、报文小等特点。



其具有协议简洁、⼩巧、可扩展性强、省流量、省电等优点，⽽且已经有PHP，JAVA，Python，C，C#，Go等多个语⾔版本，基本可以使⽤在任何平台上，⼏乎可以把所有联⽹物品和外部连接起来，所以特别适合⽤来当做物联⽹的通信协议。

MQTT特点

MQTT协议是为⼤量计算能⼒有限，且⼯作在低带宽、不可靠的⽹络的远程传感器和控制设备通讯⽽设计的协议，它具有以下主要的⼏项特性：

• 使⽤发布/订阅消息模式，提供⼀对多的消息发布，解除应⽤程序耦合；
• 对负载内容屏蔽的消息传输；
• 使⽤ TCP/IP 提供⽹络连接；
• 有三种消息发布服务质量：

  “⾄多⼀次”，消息发布完全依赖底层 TCP/IP ⽹络。会发⽣消息丢失或重复。这⼀级别可⽤于如下情况，环境传感器数据，丢失⼀次读，记录⽆所谓，因为不久后还会有第⼆次发送。
  “⾄少⼀次”，确保消息到达，但消息重复可能会发⽣。
  “只有⼀次”，确保消息到达⼀次。这⼀级别可⽤于如下情况，在计费系统中，消息重复或丢失会导致不正确的结果。
  

• ⼩型传输，开销很⼩（固定长度的头部是 2 字节），协议交换最⼩化，以降低⽹络流量；(用极少的代码和有限的带宽，为连接远程设备提供实时可靠的消息服务。)
• 使⽤ Last Will 和 Testament 特性通知有关各⽅客户端异常中断的机制；

MQTT应用场景

作为一种低开销、低带宽占用的即时通讯协议，使其在物联网、小型设备、移动应用等方面有较广泛的应用。

java通过代码连接MQTT服务器，进行采集数据接收、解析、业务处理、存储入库、数据展示。

消息推送： ⽐如PC端的推送⼴告，⽐如安卓的推送服务，还有⼀些即时通信软件如微信、易信等也是采⽤的推送技术。

智能点餐： 通过MQTT消息队列产品，消费者可在餐桌上扫码点餐，并与商家后端系统连接实现自助下单、支付。

信息更新： 实现商场超市等场所的电子标签、公共场所的多媒体屏幕的显示更新管理。

扫码出站： 最常见的停车场扫码缴费，自动起竿；地铁闸口扫码进出站。

MQTT角色组成

1、服务端（Broker）

EMQX就是一个MQTT的Broker，emqx只是基于erlang语言开发的软件而已，其它的MQ还有ActiveMQ、RabbitMQ、HiveMQ等等。

EMQX服务端：https://www.emqx.io/zh/downloads?os=Windows

2、客户端(发布/订阅)

EMQX客户端：https://mqttx.app/zh

通过java代码来实现我们消息的生产者和消费者。

引入mqtt依赖

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-mqtt</artifactId>
</dependency>

生产者（发布）

修改配置文件

server:
  port: 8081
spring:
  application:
    name: provider
  # MQTT配置信息
  mqtt:
    # MQTT服务地址，端口号默认11883，如果有多个，用逗号隔开
    url: tcp://127.0.0.1:11883
    # 用户名
    username: admin
    # 密码
    password: 123456
    # 客户端id(不能重复)
    client:
      id: provider-id
    # MQTT默认的消息推送主题，实际可在调用接口是指定
    default:
      topic: topic

消息发布者客户端配置

@Configuration
@Slf4j
public class MqttProviderConfig {
    @Value("${spring.mqtt.username}")
    private String username;

    @Value("${spring.mqtt.password}")
    private String password;

    @Value("${spring.mqtt.url}")
    private String hostUrl;

    @Value("${spring.mqtt.client.id}")
    private String clientId;

    @Value("${spring.mqtt.default.topic}")
    private String defaultTopic;

    /**
     * 客户端对象
     */
    private MqttClient client;

    /**
     * 在bean初始化后连接到服务器
     */
    @PostConstruct
    public void init(){
        connect();
    }

    /**
     * 客户端连接服务端
     */
    public void connect(){
        try{
        //创建MQTT客户端对象
        client = new MqttClient(hostUrl,clientId,new MemoryPersistence());
        //连接设置
        MqttConnectOptions options = new MqttConnectOptions();
        //是否清空session，设置false表示服务器会保留客户端的连接记录（订阅主题，qos）,客户端重连之后能获取到服务器在客户端断开连接期间推送的消息
        //设置为true表示每次连接服务器都是以新的身份
        options.setCleanSession(true);
        //设置连接用户名
        options.setUserName(username);
        //设置连接密码
        options.setPassword(password.toCharArray());
        //设置超时时间，单位为秒
        options.setConnectionTimeout(100);
        //设置心跳时间 单位为秒，表示服务器每隔 1.5*20秒的时间向客户端发送心跳判断客户端是否在线
        options.setKeepAliveInterval(20);
        //设置遗嘱消息的话题，若客户端和服务器之间的连接意外断开，服务器将发布客户端的遗嘱信息
        options.setWill("willTopic",(clientId + "与服务器断开连接").getBytes(),0,false);
        //设置回调
        client.setCallback(new MqttProviderCallBack());
        client.connect(options);
        } catch(MqttException e){
            e.printStackTrace();
        }
    }
    public void publish(int qos,boolean retained,String topic,String message){
        MqttMessage mqttMessage = new MqttMessage();
        mqttMessage.setQos(qos);
        mqttMessage.setRetained(retained);
        mqttMessage.setPayload(message.getBytes());
        //主题的目的地，用于发布/订阅信息
        MqttTopic mqttTopic = client.getTopic(topic);
        //提供一种机制来跟踪消息的传递进度
        //用于在以非阻塞方式（在后台运行）执行发布是跟踪消息的传递进度
        MqttDeliveryToken token;
        try {
            //将指定消息发布到主题，但不等待消息传递完成，返回的token可用于跟踪消息的传递状态
            //一旦此方法干净地返回，消息就已被客户端接受发布，当连接可用，将在后台完成消息传递。
            token = mqttTopic.publish(mqttMessage);
            token.waitForCompletion();
        } catch (MqttException e) {
            e.printStackTrace();
        }
    }
}

消息发布客户端回调

@Configuration
public class MqttProviderCallBack implements MqttCallback{

    @Value("${spring.mqtt.client.id}")
    private String clientId;
    /**
     * 与服务器断开的回调
     */
    @Override
    public void connectionLost(Throwable cause) {
        System.out.println(clientId+"与服务器断开连接");
    }

    /**
     * 消息到达的回调
     */
    @Override
    public void messageArrived(String topic, MqttMessage message) throws Exception {

    }

    /**
     * 消息发布成功的回调
     */
    @Override
    public void deliveryComplete(IMqttDeliveryToken token) {
        IMqttAsyncClient client = token.getClient();
        System.out.println(client.getClientId()+"发布消息成功！");
    }
}

创建控制器测试发布信息

@Controller
public class SendController {
    @Autowired
    private MqttProviderConfig providerClient;

    @RequestMapping("/sendMessage")
    @ResponseBody
    public String sendMessage(int qos,boolean retained,String topic,String message){
        try {
            providerClient.publish(qos, retained, topic, message);
            return "发送成功";
        } catch (Exception e) {
            e.printStackTrace();
            return "发送失败";
        }
    }
}

消费者（订阅）

修改配置文件

server:
  port: 8082
spring:
  application:
    name: consumer
  # MQTT配置信息
  mqtt:
    # MQTT服务端地址，端口默认为11883，如果有多个，用逗号隔开
    url: tcp://127.0.0.1:11883
    # 用户名
    username: admin
    # 密码
    password: 123456
    # 客户端id（不能重复）
    client:
      id: consumer-id
    # MQTT默认的消息推送主题，实际可在调用接口时指定
    default:
      topic: topic

接收者客户端配置

@Configuration
public class MqttConsumerConfig {
    @Value("${spring.mqtt.username}")
    private String username;

    @Value("${spring.mqtt.password}")
    private String password;

    @Value("${spring.mqtt.url}")
    private String hostUrl;

    @Value("${spring.mqtt.client.id}")
    private String clientId;

    @Value("${spring.mqtt.default.topic}")
    private String defaultTopic;

    /**
     * 客户端对象
     */
    private MqttClient client;

    /**
     * 在bean初始化后连接到服务器
     */
    @PostConstruct
    public void init(){
        connect();
    }

    /**
     * 客户端连接服务端
     */
    public void connect(){
        try {
            //创建MQTT客户端对象
            client = new MqttClient(hostUrl,clientId,new MemoryPersistence());
            //连接设置
            MqttConnectOptions options = new MqttConnectOptions();
            //是否清空session，设置为false表示服务器会保留客户端的连接记录，客户端重连之后能获取到服务器在客户端断开连接期间推送的消息
            //设置为true表示每次连接到服务端都是以新的身份
            options.setCleanSession(true);
            //设置连接用户名
            options.setUserName(username);
            //设置连接密码
            options.setPassword(password.toCharArray());
            //设置超时时间，单位为秒
            options.setConnectionTimeout(100);
            //设置心跳时间 单位为秒，表示服务器每隔1.5*20秒的时间向客户端发送心跳判断客户端是否在线
            options.setKeepAliveInterval(20);
            //设置遗嘱消息的话题，若客户端和服务器之间的连接意外断开，服务器将发布客户端的遗嘱信息
            options.setWill("willTopic",(clientId + "与服务器断开连接").getBytes(),0,false);
            //设置回调
            client.setCallback(new MqttConsumerCallBack());
            client.connect(options);
            //订阅主题
            //消息等级，和主题数组一一对应，服务端将按照指定等级给订阅了主题的客户端推送消息
            int[] qos = {1,1};
            //主题
            String[] topics = {"topic1","topic2"};
            //订阅主题
            client.subscribe(topics,qos);
        } catch (MqttException e) {
            e.printStackTrace();
        }
    }

    /**
     * 断开连接
     */
    public void disConnect(){
        try {
            client.disconnect();
        } catch (MqttException e) {
            e.printStackTrace();
        }
    }

    /**
     * 订阅主题
     */
    public void subscribe(String topic,int qos){
        try {
            client.subscribe(topic,qos);
        } catch (MqttException e) {
            e.printStackTrace();
        }
    }
}

消息接收者客户端回调

package com.lyp.mqttconsumer.mqtt;

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
import org.eclipse.paho.client.mqttv3.MqttMessage;

public class MqttConsumerCallBack implements MqttCallback{

   /**
     * 客户端断开连接的回调
     */
    @Override
    public void connectionLost(Throwable throwable) {
        System.out.println("与服务器断开连接，可重连");
    }

    /**
     * 消息到达的回调
     */
    @Override
    public void messageArrived(String topic, MqttMessage message) throws Exception {
        System.out.println(String.format("接收消息主题 : %s",topic));
        System.out.println(String.format("接收消息Qos : %d",message.getQos()));
        System.out.println(String.format("接收消息内容 : %s",new String(message.getPayload())));
        System.out.println(String.format("接收消息retained : %b",message.isRetained()));
    }

    /**
     * 消息发布成功的回调
     */
    @Override
    public void deliveryComplete(IMqttDeliveryToken iMqttDeliveryToken) {

    }
}

控制器控制手动建立和断开连接方法

@Controller
public class TestController {
    @Autowired
    private MqttConsumerConfig client;

    @Value("${spring.mqtt.client.id}")
    private String clientId;

    @RequestMapping("/connect")
    @ResponseBody
    public String connect(){
        client.connect();
        return clientId + "连接到服务器";
    }

    @RequestMapping("/disConnect")
    @ResponseBody
    public String disConnect(){
        client.disConnect();
        return clientId + "与服务器断开连接";
    }
}