使用eclipse paho在java端实现MQTT消息的收发（客户端与服务端实例）

一、MQTT（消息队列）简介

MQTT(MQ Telemetry Transport)是IBM开发的一种网络应用层的协议，提供轻量级的，支持可发布/可订阅的的消息推送模式，使设备对设备之间的短消息通信变得简单，比如现在应用广泛的低功耗传感器，手机、嵌入式计算机、微型控制器等移动设备。

常用的有eclipse paho、activeMQ、阿里MQTT和其他的实现，本实例使用paho

1、使用场景：

1、不可靠、网络带宽小的网络

2、运行的设备CPU、内存非常有限

（我个人主要是用在服务端与嵌入式客户端进行消息和广告的通信）

2、特点：

1、基于发布/订阅模型的协议

2、他是二进制协议，二进制的特点就是紧凑、占用空间小。他的协议头只有2个字节

3、提供了三种消息可能性保障（Qos）：0：最多一次 、1：最少一次 、2：只有一次

3、关键字

1、HOST：搭载MQTT的服务器地址

2、TOPIC：消息主题，可以被客户端订阅，实现对应消息的收发

3、clientId：客户端ID，用于服务器对不同客户端的识别

4、subscribe/unsubscribe：客户端对消息主题的订阅和取消订阅

5、Qos：消息的服务质量，当网络过载或拥塞时，QoS 能确保重要业务量不受延迟或丢弃

6、Callback：当客户端收到消息后对消息的处理（回调）

7、KeepAliveInterval：客户端与服务器之间的连接是通过发送心跳包来保持存活

二、JAVA端实例

首先导入所依赖jar包

1、服务端代码（负责消息的发送）

package com.sc.util.paho;

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;
/**
* Title:Server 这是发送消息的服务端
* Description: 服务器向多个客户端推送主题，即不同客户端可向服务器订阅相同主题
* @author rao
*/
public class ServerMQTT {

//tcp://MQTT安装的服务器地址:MQTT定义的端口号
public static final String HOST = "tcp://dev.****.com.cn:1883";
//定义一个主题
public static final String TOPIC = "pos_message_all";
//定义MQTT的ID，可以在MQTT服务配置中指定
private static final String clientid = "server11";

private MqttClient client;
private MqttTopic topic11;
private String userName = "paho";  //非必须
private String passWord = "";  //非必须

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("这是推送消息的内容".getBytes());
server.publish(server.topic11 , server.message);
System.out.println(server.message.isRetained() + "------rataine
109d0
d状态");
}
}

2、对消息进行处理的回调函数代码（必须）

package com.sc.util.paho;

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
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()));
}
}

3、客户端代码（接收消息）

package com.sc.util.paho;

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;

/**
* 模拟一个客户端接收消息
* @author rao
*
*/
public class ClientMQTT {

public static final String HOST = "tcp://dev.****.com.cn:1883";
public static final String TOPIC1 = "pos_message_all";
private static final String clientid = "client11";
private MqttClient client;
private MqttConnectOptions options;
private String userName = "admin";    //非必须
private String passWord = "password";  //非必须
@SuppressWarnings("unused")
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(false);
// 设置连接的用户名
options.setUserName(userName);
// 设置连接的密码
options.setPassword(passWord.toCharArray());
// 设置超时时间 单位为秒
options.setConnectionTimeout(10);
// 设置会话心跳时间 单位为秒 服务器会每隔1.5*20秒的时间向客户端发送个消息判断客户端是否在线，但这个方法并没有重连的机制
options.setKeepAliveInterval(20);
// 设置回调
client.setCallback(new PushCallback());
MqttTopic topic = client.getTopic(TOPIC1);
//setWill方法，如果项目中需要知道客户端是否掉线可以调用该方法。设置最终端口的通知消息
//遗嘱        options.setWill(topic, "close".getBytes(), 2, true);
client.connect(options);
//订阅消息
int[] Qos  = {1};
String[] topic1 = {TOPIC1};
client.subscribe(topic1, Qos);

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

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

4、运行以上代码需要配置服务器

常用的搭建MQTT服务器的软件是mosquitto，是一款实现了消息推送协议 MQTT v3.1 的开源消息代理软件，可以很方便的搭载在linux、windows服务器上，我是搭载在linux服务器上使用。

mosquitto自带有许多TOPIC（主题）供我们订阅使用，可以实时的对服务器状态进行监测和状态响应以及统计，包括可以监测到当前连接的客户端数，某时间段内消息收发的总量等。

关于服务器的配置可参考：http://www.cnblogs.com/Free-Thinker/p/5559816.html

mosquito内置主题具体可参考：http://blog.csdn.net/qhdcsj/article/details/44630201

三、将以上代码调整为工具类供其他项目调用

1、服务端代码及调用实例

1）服务端代码（需要引入之前的回调函数）

package com.scpos.util;

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;
/**
* Title:Server 这是发送消息的服务端
* Description: 服务器向多个客户端推送主题，即不同客户端可向服务器订阅相同主题
* @author rao
*/
public class ServerMQTTUtil {

//tcp://MQTT安装的服务器地址:MQTT定义的端口号
public static final String HOST = "tcp://dev.****.com.cn:1883";
//定义MQTT的ID，可以在MQTT服务配置中指定
private static final String clientid = "server11";

private MqttClient client;
private MqttTopic mqttTopic;
private String userName = "paho";
private String passWord = "";

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

/**
*  用来连接服务器
*/
private void connect(String topic) {
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);
mqttTopic = client.getTopic(topic);
} catch (Exception e) {
e.printStackTrace();
}
}

//发送消息并获取回执
public void publish(MqttMessage message) throws MqttPersistenceException,
MqttException, InterruptedException {
MqttDeliveryToken token = mqttTopic.publish(message);
token.waitForCompletion();
System.out.println("message is published completely! "
+ token.isComplete());
System.out.println("messageId:" + token.getMessageId());
token.getResponse();
if (client.isConnected())
client.disconnect(10000);
System.out.println("Disconnected: delivery token \"" + token.hashCode()
+ "\" received: " + token.isComplete());
}

public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getPassWord() {
return passWord;
}
public void setPassWord(String passWord) {
this.passWord = passWord;
}

public MqttTopic getMqttTopic() {
return mqttTopic;
}

public void setMqttTopic(MqttTopic mqttTopic) {
this.mqttTopic = mqttTopic;
}

}

2）调用处代码

//设置推送消息体
String sendTime = TimeUtils.getTime();
String msgType = "html";
String title = message.getTitle();
String content = message.getContent();
String createTime = message.getCreateTime();
Map<String, Object> data = new HashMap<String, Object>();
data.put("messageId", messageId);
data.put("msgType", msgType);
data.put("title", title);
data.put("content", content);
data.put("createTime", createTime);
data.put("sendTime", sendTime);
msgType = "posMessage";
Map<String, Object> messageMap = new HashMap<String, Object>();
messageMap.put("msgType", msgType);
messageMap.put("data", data);
String MQTTObject = JSON.toJSONString(messageMap);
System.out.println(MQTTObject);
//将信息写入消息体
MqttMessage mqttMessage = new MqttMessage();
mqttMessage.setQos(1);
mqttMessage.setRetained(true);
mqttMessage.setPayload(MQTTObject.getBytes("UTF-8"));
//根据deviceIdList内容进行topic设置和发送推送
if (!deviceIdList.equals("all")) {
List deviceList = Arrays.asList(deviceIdList.split(","));
for (int i =0; i < deviceList.size(); i++) {

String topic = "pos_message_" + deviceList.get(i);
ServerMQTTUtil serverMQTTUtil = new ServerMQTTUtil(topic);
serverMQTTUtil.publish(mqttMessage);
System.out.println(mqttMessage.isRetained() + "------ratained状态");
}
} else {
String topic = "pos_message_all";
ServerMQTTUtil serverMQTTUtil = new ServerMQTTUtil(topic);
serverMQTTUtil.publish(mqttMessage);
System.out.println(mqttMessage.isRetained() + "------ratained状态");
}

2、客户端代码及调用实例

1）客户端代码

package com.sichang.util;

import java.util.concurrent.ScheduledExecutorService;

import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
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.MqttMessage;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;

/**
* 模拟一个客户端接收消息
* @author rao
*
*/

public class ClientSearch {
public static String str="";
public static final String HOST = "tcp://dev.****.com.cn:1883";
//服务器内置主题，用来监测当前服务器上连接的客户端数量（$SYS/broker/clients/connected）
public static final String TOPIC1 = "$SYS/broker/clients/connected";
private static final String clientid = "client13";
private MqttClient client;
private MqttConnectOptions options;
private String userName = "admin";
private String passWord = "password";
@SuppressWarnings("unused")
private ScheduledExecutorService scheduler;

public void start() throws MqttException {
// host为主机名，clientid即连接MQTT的客户端ID，一般以唯一标识符表示，MemoryPersistence设置clientid的保存形式，默认为以内存保存
client = new MqttClient(HOST, clientid, new MemoryPersistence());
// MQTT的连接设置
options = new MqttConnectOptions();
// 设置是否清空session,这里如果设置为false表示服务器会保留客户端的连接记录，设置为true表示每次连接到服务器都以新的身份连接
options.setCleanSession(false);
// 设置连接的用户名
options.setUserName(userName);
// 设置连接的密码
options.setPassword(passWord.toCharArray());
// 设置超时时间 单位为秒
options.setConnectionTimeout(10);
// 设置会话心跳时间 单位为秒 服务器会每隔1.5*20秒的时间向客户端发送个消息判断客户端是否在线，但这个方法并没有重连的机制
options.setKeepAliveInterval(20);
// 设置回调
client.setCallback(new 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 {
try {
str = message.toString();
//                  System.out.println(" 从服务器收到的消息为:"+message.toString());
} catch (Exception e) {
e.printStackTrace();
}
}
});
//      MqttTopic topic = client.getTopic(TOPIC1);
//      setWill方法，如果项目中需要知道客户端是否掉线可以调用该方法。设置最终端口的通知消息
//      options.setWill(topic, "close".getBytes(), 2, true);  //遗嘱
client.connect(options);
//订阅消息
int[] Qos  = {1};
String[] topic1 = {TOPIC1};
client.subscribe(topic1, Qos);
}
@SuppressWarnings("static-access")
//用来给调用处返回消息内容
public String resc() {
return this.str;
}
}

2）调用处代码

下面线程的作用是每三秒钟返回服务器上的客户端连接数

public void runTask() {
final long timeInterval = 2000;// 两秒运行一次
Runnable runnable = new Runnable() {
public void run() {
while (true) {
// ------- code for task to run
try {       //你要运行的程序
ClientSearch clientSearch = new ClientSearch();
try {
clientSearch.start();
} catch (MqttException e) {
e.printStackTrace();
}
Thread.sleep(1000); //给一秒时间接收服务器消息
Integer num = Integer.valueOf(clientSearch.resc());
System.out.println("当前客户端连接数："+num);
} catch (InterruptedException e) {
e.printStackTrace();
}
// ------- ends here
try {
Thread.sleep(timeInterval);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
};
Thread thread = new Thread(runnable);
thread.start();
}

到这里所要用的基本都阐述完了

项目需要的jar包下载地址将在之后更新