MQTT基础知识及范例：client、server

本文主要介绍一下几点内容：

1.MQTT常用的特点和场景

2.java中常用到的MQTT配置项（即基础知识）

3.范例

 

1.MQTT是一种tcp消息协议，由于其传输开销很小（固定长度的头部是 2 字节），所以适用于网络环境差、客户端多、数据传输频繁的场景，如大量的硬件设备管理。

尤其要注意的是：MQTT是要安装服务端软件，这个和我们常用的tcp协议的不同；传统的我们直接自己写一个server一个client就测起来，而在MQTT中对应的是发布端和订阅端。也就是说我们在做MQTT测试的时候由三块组成：MQTT服务软件(服务器）+订阅端(client)+发布端（server）

 

2.常用到的属性：

服务端（发布端）：地址host、主题topic、用户名username、密码password、标识clientid。

客户端（订阅端）中除了上述服务端中的几种，还有：质量等级Qos，保留消息retained，遗嘱消息will

其中需要说明一下的有以下几个：

主题topic：可以将其理解为url的一种表现方式，即取哪里的数据；关于里面的通配符可以参考：https://blog.csdn.net/qq_28877125/article/details/78360376

消息质量Qos：有0、1、2三个级别，默认用0，后面两个涉及到存储消息以保证接收的正确性，性能开销都会增加，不常用，详见https://blog.csdn.net/yangguosb/article/details/78653228

保留消息retained：作用是保证客户端在连接后直接收到最近的一条消息；

遗嘱will：顾名思义，就是在连接还没有断的时候，设置好如果断线，将要发送什么消息。

 

3.java范例

范例的参考来源是：https://www.cnblogs.com/sxkgeek/p/9140180.html#_label5

由于在开发过程中遇到了一些特殊情况，我个人做了一些说明。

pom.xml

 
			org.eclipse.paho
			org.eclipse.paho.client.mqttv3
			1.1.1
		

服务端

import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.eclipse.paho.client.mqttv3.MqttPersistenceException;
import org.eclipse.paho.client.mqttv3.MqttTopic;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;

public class ServerMQTT {
    //tcp://MQTT安装的服务器地址:MQTT定义的端口号
    public static final String HOST = "tcp://localhost:1883";
    //定义一个主题
    public static final String TOPIC = "/app/lora/up";
    //定义MQTT的ID，可以在MQTT服务配置中指定
    private static final String clientid = "0000000000000005";

    private MqttClient client;
    private MqttTopic topic11;
    private String userName = "swiot";
    private String passWord = "swiot";

    private MqttMessage message;

    /**
     * 构造函数
     * @throws MqttException
     */
    public ServerMQTT() throws MqttException {
        // MemoryPersistence设置clientid的保存形式，默认为以内存保存
        client = new MqttClient(HOST, clientid, new MemoryPersistence());
        connect();
    }

    /**
     *  用来连接服务器
     */
    private void connect() {
        MqttConnectOptions options = new MqttConnectOptions();
        options.setCleanSession(false);
        options.setUserName(userName);
        options.setPassword(passWord.toCharArray());
        // 设置超时时间
        options.setConnectionTimeout(10);
        // 设置会话心跳时间
        options.setKeepAliveInterval(20);
        try {
            client.setCallback(new PushCallback());
            client.connect(options);

            topic11 = client.getTopic(TOPIC);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     *
     * @param topic
     * @param message
     * @throws MqttPersistenceException
     * @throws MqttException
     */
    public void publish(MqttTopic topic , MqttMessage message) throws MqttPersistenceException,
            MqttException {
        MqttDeliveryToken token = topic.publish(message);
        token.waitForCompletion();
        System.out.println("message is published completely! "
                + token.isComplete());
    }

    /**
     *  启动入口
     * @param args
     * @throws MqttException
     */
    public static void main(String[] args) throws MqttException {
        ServerMQTT server = new ServerMQTT();

        server.message = new MqttMessage();
        server.message.setQos(1);
        server.message.setRetained(true);
        server.message.setPayload("hello,topic11".getBytes());
        server.publish(server.topic11 , server.message);
        
        System.out.println(server.message.isRetained() + "------retained状态");
    }
}

客户端

//import java.util.concurrent.ScheduledExecutorService;
import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
//import org.eclipse.paho.client.mqttv3.MqttTopic;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;

public class ClientMQTT {
    public static final String HOST = "tcp://localhost:1883";
    //定义一个主题
    public static final String TOPIC = "/app/lora/up";
    //定义MQTT的ID，可以在MQTT服务配置中指定
    private static final String clientid = "0000000000000005";
    
    private MqttClient client;
    private MqttConnectOptions options;
    private String userName = "swiot";
    private String passWord = "swiot";

//    private ScheduledExecutorService scheduler;

    private void start() {
        try {
            // host为主机名，clientid即连接MQTT的客户端ID，一般以唯一标识符表示，MemoryPersistence设置clientid的保存形式，默认为以内存保存
            client = new MqttClient(HOST, clientid, new MemoryPersistence());
            // MQTT的连接设置
            options = new MqttConnectOptions();
            // 设置是否清空session,这里如果设置为false表示服务器会保留客户端的连接记录，这里设置为true表示每次连接到服务器都以新的身份连接
            options.setCleanSession(true);
            // 设置连接的用户名
            options.setUserName(userName);
            // 设置连接的密码
            options.setPassword(passWord.toCharArray());
            // 设置超时时间 单位为秒
            options.setConnectionTimeout(10);
            // 设置会话心跳时间 单位为秒 服务器会每隔1.5*20秒的时间向客户端发送个消息判断客户端是否在线，但这个方法并没有重连的机制
            options.setKeepAliveInterval(20);
            // 设置回调
            client.setCallback(new PushCallback());
           
            //setWill方法，如果项目中需要知道客户端是否掉线可以调用该方法。设置最终端口的通知消息
            //注意最后遗嘱的topic不可以带通配符，如下就是错误的
//            MqttTopic topic = client.getTopic("/app/lora/+/up");
//            options.setWill(topic, "close".getBytes(), 2, true);

            client.connect(options);
            //订阅消息
            int[] Qos  = {0};
            String[] topic1 = {TOPIC};
            client.subscribe(topic1, Qos);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) throws MqttException {
        ClientMQTT client = new ClientMQTT();
        client.start();
    }
}

其中要注意的是topic中如果适用了通配符，那这个topic可以设置主题，但是无法设置遗嘱！同时会报如下错误：

The topic name MUST NOT contain any wildcard characters (#+)。

发布消息的回调类 

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

/**
 * 发布消息的回调类 
 *
 * 必须实现MqttCallback的接口并实现对应的相关接口方法CallBack 类将实现 MqttCallBack。 
 * 每个客户机标识都需要一个回调实例。在此示例中，构造函数传递客户机标识以另存为实例数据。 
 * 在回调中，将它用来标识已经启动了该回调的哪个实例。 
 * 必须在回调类中实现三个方法： 
 *
 *  public void messageArrived(MqttTopic topic, MqttMessage message)接收已经预订的发布。 
 *
 *  public void connectionLost(Throwable cause)在断开连接时调用。 
 *
 *  public void deliveryComplete(MqttDeliveryToken token)) 
 *  接收到已经发布的 QoS 1 或 QoS 2 消息的传递令牌时调用。 
 *  由 MqttClient.connect 激活此回调。 
 */
public class PushCallback implements MqttCallback{
    public void connectionLost(Throwable cause) {
        // 连接丢失后，一般在这里面进行重连
        System.out.println("连接断开，可以做重连");
    }

    public void deliveryComplete(IMqttDeliveryToken token) {
        System.out.println("deliveryComplete---------" + token.isComplete());
    }

    public void messageArrived(String topic, MqttMessage message) throws Exception {
        // subscribe后得到的消息会执行到这里面
        System.out.println("接收消息主题 : " + topic);
        System.out.println("接收消息Qos : " + message.getQos());
        System.out.println("接收消息内容 : " + new String(message.getPayload()));
    }
}