Android 消息推送之MQTT及采坑

最新推荐文章于 2023-12-30 20:54:06 发布

置顶我不是咸鱼

最新推荐文章于 2023-12-30 20:54:06 发布

阅读量7.4k

点赞数 3

分类专栏：消息推送文章标签： mqtt协议物联网消息推送 Android 移动开发

本文链接：https://blog.csdn.net/qq_26629729/article/details/83987974

版权

消息推送专栏收录该内容

1 篇文章 0 订阅

订阅专栏

Android 消息推送MQTT及采坑

大家好，我是一个心中有小宇宙，有很多很多事想去实现的程序员，之前想过去写博客，冥冥之中不知道如何下手，这几天公司开发的项目用到了MQTT这个东西，一想赶紧网上了解，查阅了大量的资料，文档，还是碰到了很多坑，第一，网上的文章单篇写的不全面，还是需要整合很多文章在一起才能解决。第二，时间不是很新的，有些2016、2017年，甚至2018的文章还是用的2017年的技术。于是我便迫不及待的写了本文。

1.MQTT简介

MQTT是一个轻量级的消息发布/订阅协议，它是实现基于手机客户端的消息推送服务器的理想解决方案。

MQTT官网：http://mqtt.org/
MQTT介绍：http://www.ibm.com
MQTT Android github：https://github.com/eclipse/paho.mqtt.android
MQTT API：http://www.eclipse.org/paho/files/javadoc/index.html
MQTT Android API： http://www.eclipse.org/paho/files/android-javadoc/index.html

2.MQTT协议

MQTT协议是为大量计算能力有限，且工作在低带宽、不可靠的网络的远程传感器和控制设备通讯而设计的协议，协议具有许多不同的功能：

它是一种发布/预订协议。
除提供一对多消息分发外，发布/预订也脱离了应用程序。对于具有多个客户机的应用程序来说，这些功能非常有用。
它与消息内容没有任何关系。
它通过 TCP/IP 运行，TCP/IP 可以提供基本网络连接。
它是一种管理网络中消息流的经济方式。例如，固定长度的标题仅 2 个字节长度，并且协议交换可最大程度地减少网络流量。
它具有一种“遗嘱”功能，该功能通知订户客户机从 MQTT 服务器异常断开连接。请参阅“最后的消息”发布。
它针对消息传送提供三种服务质量：
“至多一次”
         消息根据底层因特网协议网络尽最大努力进行传递。可能会丢失消息。例如，将此服务质量与通信环境传感器数据一起使用。对于是否丢失个别读取或是否稍后立即发布新的读取并不重要。
“至少一次”
         保证消息抵达，但可能会出现重复。
“刚好一次”
         确保只收到一次消息。
例如，将此服务质量与记帐系统一起使用。重复或丢失消息可能会导致不便或收取错误费用。

3.Android 客户端实现

概念

topic：中文意思是“话题”。在MQTT中订阅了(subscribe)同一话题（topic）的客户端会同时收到消息推送。直接实现了“群聊”功能。
clientId：客户身份唯一标识。
qos：服务质量。
retained：要保留最后的断开连接信息。
MqttAndroidClient#subscribe()：订阅某个话题。
MqttAndroidClient#publish()：向某个话题发送消息，之后服务器会推送给所有订阅了此话题的客户。
userName：连接到MQTT服务器的用户名。
passWord ：连接到MQTT服务器的密码。

添加依赖

注意：一定要添加最新的依赖包，不知道的可以去官网查。

repositories {
     maven {
          url “https://repo.eclipse.org/content/repositories/paho-releases/”
     }
}
dependencies {
          implementation ‘org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.0’
          implementation ‘org.eclipse.paho:org.eclipse.paho.android.service:1.1.1’
}

添加权限

 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 <uses-permission android:name="android.permission.WAKE_LOCK" />

注册Service和广播

<service android:name="org.eclipse.paho.android.service.MqttService" />
<service android:name="com.smarthome.com.app.MQTTService"/>

   <receiver
        android:name="com.smarthome.com.app.MyReceiver"
        android:enabled="true"
        android:exported="false"
        >
        <intent-filter>
            <category android:name="com.smarthome.com" />
            <action android:name="android.intent.action.BOOT_COMPLETED" />
            <action android:name="android.intent.action.USER_PRESENT" />
            <action android:name="com.example.androidtest.receiver" />
        </intent-filter>
    </receiver>

代码实现

/**
 * Created by 朱大大
 * QQ:941556675
 */
public class MQTTService extends Service {
    public static final String TAG = "MQTTService";
    private static MqttAndroidClient client;
    private MqttConnectOptions conOpt;
    private String host = "xxxxxxxxxxx";
    private String userName = "你的用户名";
    private String passWord ="你的密码";
    private String clientId ="唯一clientId";
    private MyReceiver myReceiver;
    private static boolean isCloseService=false;
    @Override
    public void onCreate() {
        super.onCreate();

    }

    @Override
    public int onStartCommand(Intent intent, int flags, int startId) {
        init();
        return super.onStartCommand(intent, flags, startId);
    }

    public static void publish(String msg,String topic){

     //   String topic = myTopic;
        Integer qos = 0;
        Boolean retained = false;
        try {
            client.publish(topic, msg.getBytes(), qos.intValue(), retained.booleanValue());
        } catch (MqttException e) {
            e.printStackTrace();
        }
    }
    public static boolean subscribe(String[] topicName, int qos[]){
        boolean flag = false;
        if (client != null && client.isConnected()) {
            try {
                
                client.subscribe(topicName, qos, null, new IMqttActionListener() {
                    @Override
                    public void onSuccess(IMqttToken asyncActionToken) {
                        Log.e("Subscribed","Subscribed");
                    }

                    @Override
                    public void onFailure(IMqttToken asyncActionToken, Throwable exception) {
                        Log.e("Failed to subscribe","Failed to subscribe");

                    }
                });
                flag = true;
            } catch (MqttException e) {
                e.printStackTrace();
            }
        }
        else {

        }
        return flag;
    }
    private void init() {
        // 服务器地址（协议+地址+端口号）
        String uri = host;

        client = new MqttAndroidClient(getApplicationContext(), uri, clientId);

        // 设置MQTT监听并且接受消息
        client.setCallback(new MqttCallbackExtended() {
            @Override
            public void connectComplete(boolean reconnect, String serverURI) {
                //断开连接必须重新订阅才能收到消息
                if(reconnect){
                //这里是发送消息去重新订阅
                    MQTTConMessage msg = new MQTTConMessage();
                    msg.setMessage("connect");
                    EventBus.getDefault().postSticky(msg);
                }

            }

            @Override
            public void connectionLost(Throwable cause) {
            	Log.e(TAG,"连接失败，重连");
                //重连处理
                doClientConnection();

            }

            @Override
            public void messageArrived(String topic, MqttMessage message) throws Exception {
                String str2 = topic + ";qos:" + message.getQos() + ";retained:" + message.isRetained();
                Log.e(TAG, str2);
                String str1 = new String(message.getPayload());
                Log.e(TAG, "收到消息:" + str1);
                MQTTMessage msg = new MQTTMessage();
                msg.setMessage(str1);
                msg.setTopic(topic);
                Log.e("主题", topic);
                EventBus.getDefault().postSticky(msg);
            }

            @Override
            public void deliveryComplete(IMqttDeliveryToken token) {

            }
        });

        conOpt = new MqttConnectOptions();
        conOpt.setAutomaticReconnect(true);
        // 清除缓存
        conOpt.setCleanSession(true);
        // 设置超时时间，单位：秒
        conOpt.setConnectionTimeout(60);
        // 心跳包发送间隔，单位：秒
        conOpt.setKeepAliveInterval(5);
        // 用户名
        conOpt.setUserName(userName);
        // 密码
        conOpt.setPassword(passWord.toCharArray());


        myReceiver = new MyReceiver();
        IntentFilter filter = new IntentFilter();
        filter.addAction(ConnectivityManager.CONNECTIVITY_ACTION);
        registerReceiver(myReceiver, filter);

    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        unregisterReceiver(myReceiver);
        try {
            if(client!=null){
                client.disconnect();
                client.unregisterResources();
            }

        } catch (MqttException e) {
            e.printStackTrace();
        }
        if(isCloseService){
            isCloseService=false;
        }
        else{
            //服务停止，重新开启服务。
            stopForeground(true);
            Intent intent = new Intent("com.example.androidtest.receiver");
            sendBroadcast(intent);
        }

    }
    public static void closeConnect(){
        isCloseService=true;
    }
    /** 连接MQTT服务器 */
    private void doClientConnection() {

        if (!client.isConnected() && isConnectIsNomarl()) {
            try {
                client.connect(conOpt, null, new IMqttActionListener() {
                    @Override
                    public void onSuccess(IMqttToken asyncActionToken) {
                        MQTTConMessage msg = new MQTTConMessage();
                        msg.setMessage("connect");
                        Log.e(TAG, "连接成功 ");
                        EventBus.getDefault().postSticky(msg);
                    }

                    @Override
                    public void onFailure(IMqttToken asyncActionToken, Throwable arg1) {
                        Log.e("arg1",arg1+"");
                        arg1.printStackTrace();
                        MQTTConMessage msg = new MQTTConMessage();
                        msg.setMessage("disconnect");
                        EventBus.getDefault().postSticky(msg);
                        Log.e(TAG, "连接失败，重连");
                    }
                });
            } catch (MqttException e) {

                e.printStackTrace();
            }
        }

    }

    /** 判断网络是否连接 */
    private boolean isConnectIsNomarl() {
        ConnectivityManager connectivityManager = (ConnectivityManager) this.getApplicationContext().getSystemService(Context.CONNECTIVITY_SERVICE);
        NetworkInfo info = connectivityManager.getActiveNetworkInfo();

        if (info != null && info.isConnected()) {
            String name = info.getTypeName();
            Log.e(TAG, "MQTT当前网络名称：" + name);
            return true;
        } else {
            Log.e(TAG, "MQTT 没有可用网络");
            return false;
        }
    }

    @Nullable
    @Override
    public IBinder onBind(Intent intent) {
        return null;
    }

    private class MyReceiver extends BroadcastReceiver{
        @Override
        public void onReceive(Context context, Intent intent) {
            if (!isConnectIsNomarl()) {
                Log.e("网络错误","网络错误");
            } else {
               doClientConnection();
            }
        }
    }

}

BroadcastReceiver代码

/**
 * Created by 朱大大
 * QQ:941556675
 */
public class MyReceiver extends BroadcastReceiver {
  
    @Override
    public void onReceive(Context context, Intent intent) {
        if(intent.getAction().equals("com.example.androidtest.receiver")){
            Log.e("MyReceiver","start");
            Intent sevice = new Intent(context, MQTTService.class);
            context.startService(sevice);
        }
    }
}

Activity代码

/**
 * Created by 朱大大
 * QQ:941556675
 */
public class MainActivity extends Activity {
 private String arr []={"#test"};
 private int qos []={0};
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        EventBus.getDefault().register(this);
        startService(new Intent(this, MQTTService.class));
        //一般订阅的内容都是从服务器获取
        //这里写获取服务器订阅主题的代码
}
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void getMqttMessage(MQTTMessage mqttMessage){
        Log.i(MQTTService.TAG,"get message:"+mqttMessage.getMessage());
        Toast.makeText(this,mqttMessage.getMessage(),Toast.LENGTH_SHORT).show();
    }
  @Subscribe(threadMode = ThreadMode.MAIN)
    public void getMqttConMessage(MQTTConMessage isConnection){
    	//连接成功发送过来的通知，连接成功才能去订阅消息。
        if(isConnection.getMessage().equals("connect")){
				//订阅消息
				//注意：订阅单个主题我不多说，但是如果需要一次订阅多个主题，需要用for循环去订阅多个，这可能是MQTT的bug。
                MQTTService.subscribe(arr,qos);
        }
       else{
        }

    }
    @Override
    protected void onDestroy() {
        EventBus.getDefault().unregister(this);
        super.onDestroy();
    }

}

public class MQTTConMessage {
    private String message;
    private String topic;

    public String getTopic() {
        return topic;
    }

    public void setTopic(String topic) {
        this.topic = topic;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

注意：
如果需要完全退出APP且不收到消息用

MQTTService.closeConnect()
Intent intent = new Intent(getApplicationContext(),MQTTService.class);
stopService(intent);

采坑记录

1.代码中用到了Service,所以服务就有可能会自动停止，所以在 onDestroy()销毁时又开启服务。保证了服务不再被停止运行从而保证MQTT能正常接收到消息。
2.考虑到用户使用过程中可能会突然断开网络，这时候要对监听网络的断开和重连，重连过程中发现，会不断的重连，导致崩溃，实际上已经连上服务器了，出现这样的原因是，重连了要重新订阅才能收到消息，在connectComplete方法中重新订阅。
3.注意new MqttAndroidClient(getApplicationContext(), uri, clientId); 这里上下文对象要是getApplicationContext()，如果写成this的话也会经常出现断连，这个就更生命周期有关了。

重点

第一次写博客好人做到底，赠上我的demo地址另外看完之后如有不懂的地方请在下方评论，我看到会及时回复。

我不是咸鱼

关注

3
点赞
踩
25

收藏

觉得还不错? 一键收藏
14
评论
Android 消息推送之MQTT及采坑

Android 消息推送MQTT及采坑大家好，我是一个心中有小宇宙，有很多很多事想去实现的程序员，之前想过去写博客，冥冥之中不知道如何下手，这几天公司开发的项目用到了MQTT这个东西，一想赶紧网上了解，查阅了大量的资料，文档，还是碰到了很多坑，第一，网上的文章单篇写的不全面，还是需要整合很多文章在一起才能解决。第二，时间不是很新的，有些2016、2017年，甚至2018的文章还是用的2017年的...
复制链接

扫一扫