Android 项目必备（三十八）--＞APP 消息推送

Posted 2022-11-24 Kevin-Dev

文章目录

• • 前言
  • 推送的实现方式
  • • 1. C2DM
    • 2. 轮询
    • 3. SMS信令推送
    • 4. MQTT协议
    • 5. XMPP协议
    • 6. 使用第三方平台
  • Android 中 MQTT 的使用
  • • 1. 集成
    • 2. 具体代码
    • 3. 项目地址

前言

今天来讲讲推送这件小事，事虽小，要做好却不容易。

推送难，难于上青天。

我们在讨论 android 手机上的推送时，大多数情况是在说集成第三方推送，因为即使是像微信这样的大厂，也需要厂商加到启动白名单里才能保持在线。

ios 手机使用 APNs（Apple Push Notification service）进行推送，而 Android 手机，也是有 GCM（Google Cloud Messaging）作为 Google 官方的推送支持的，但是在国内需要翻墙才能使用，并且需要手机安装了 Google Service ，条件比较苛刻。

GCM 最新版本叫 FCM（Firebase Cloud Messaging）

推送的实现方式

1. C2DM

Cloud to Device Messaging，云端推送，是Android系统级别的消息推送服务（Google出品）

• 原理
  基于Push方式
• 具体描述
  C2DM服务负责处理诸如消息排队等事务，并向运行于目标设备上的应用程序分发这些消息。如下图：
  
• C2DM原理

  • 优点
    C2DM提供了一个简单的、轻量级的机制，允许服务器可以通知移动应用程序直接与服务器进行通信，以便于从服务器获取应用程序更新和用户数据。

  • 缺点
    1.依赖于Google官方提供的C2DM服务器，但在国内使用Google服务需要翻墙，成本较大；
    2.需要用户手机安装Google服务。但由于Android机型、系统的碎片化 & 国内环境，国内的Android系统都自动去除Google服务，假如要使用C2DM服务，这意味着用户还得去安装Google服务，成本较大。

2. 轮询

• 原理
  基于Pull方式

• 具体描述
  应用程序隔固定时间主动与服务器进行连接并查询是否有新的消息

• 优点
  实时性好

• 缺点
  成本大，需要自己实现与服务器之间的通信，例如消息排队等；
  到达率不确定，考虑轮询的频率：太低可能导致消息的延迟；太高，更费客户端的资源（CPU资源、网络流量、系统电量）和服务器资源（网络带宽）

3. SMS信令推送

• 原理
  基于Push方式
• 具体描述
  服务器有新消息时，发送1条类似短信的信令给客户端，客户端通过拦截信令，解析消息内容 / 向服务器获取信息
• 优点
  可实现完全的实时操作
• 缺点
  成本高（主要是短信资费的支出）

4. MQTT协议

• 定义
  轻量级的消息发布/订阅协议
• 原理
  基于Push方式，wmqtt.jar 是IBM提供的MQTT协议的实现，原理如下图：
  
• 项目实例
  AndroidPushNotificationsDemo

5. XMPP协议

• 定义
  Extensible Messageing and Presence Protocol，可扩展消息与存在协议，是基于可扩展标记语言（XML）的协议，是目前主流的四种IM协议之一

• 原理流程
  

• 优点
  1.开源：可通过修改其源代码来适应我们的应用程序。
  2.简单：XML易于解析和阅读；将复杂性从客户端转移到了服务器端
  3.可拓展性强：继承了在XML环境中灵活的发展性，可进一步对协议进行扩展，实现更为完善的功能。

• 缺点
  如果将消息从服务器上推送出去，则不管消息是否成功到达客户端手机上。

6. 使用第三方平台

现今主流的推送平台分为：

• 手机厂商类：小米推送、华为推送。
• 第三方平台类：友盟推送、极光推送、云巴（基于MQTT）
• BAT大厂的平台推送：阿里云移动推送、腾讯信鸽推送、百度云推送

推荐阅读：Android消息推送：第三方消息推送平台详细解析

Android 中 MQTT 的使用

Android中使用MQTT需要使用到Paho Android Service库，Paho Android Service是一个用Java编写的MQTT客户端库。
GitHub地址：https://github.com/eclipse/paho.mqtt.android

1. 集成

• 在 module 的 build.gradle 文件中添加依赖：

repositories 
    maven 
        url "https://repo.eclipse.org/content/repositories/paho-snapshots/"
    

dependencies 
    compile 'org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.1.0'
    compile 'org.eclipse.paho:org.eclipse.paho.android.service:1.1.1'

• 在 AndroidManifest.xml 添加限权

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

• 在 AndroidManifest.xml 注册 Service

        <service android:name="org.eclipse.paho.android.service.MqttService" /> <!--MqttService-->
        <service android:name="com.dongyk.service.MyMqttService"/> <!--MyMqttService-->

2. 具体代码

2.1 Android中使用MQTT最主要的就是以下几个方法：

• connect：连接MQTT服务器，这里主要讲3个参数的方法，如下：

 @Override
 public IMqttToken connect(MqttConnectOptions options, Object userContext,
   IMqttActionListener callback) throws MqttException 
    //...

参数options：用来携带连接服务器的一系列参数，例如用户名、密码等。
参数userContext：可选对象，用于向回调传递上下文。一般传null即可。
参数callback：用来监听MQTT是否连接成功的回调

• publish：发布消息，这里使用四个参数的方法，如下：

 @Override
 public IMqttDeliveryToken publish(String topic, byte[] payload, int qos,
   boolean retained) throws MqttException, MqttPersistenceException 
    //...
 

参数topic：发布消息的主题
参数payload：消息的字节数组
参数qos：提供消息的服务质量，可传0、1或2
参数retained：是否在服务器保留断开连接后的最后一条消息

• subscribe：订阅消息，这里主要讲2个参数的方法，如下：

 @Override
 public IMqttToken subscribe(String topic, int qos) throws MqttException,
   MqttSecurityException 
    //...
 

参数topic：订阅消息的主题
参数qos：订阅消息的服务质量，可传0、1或2

2.2 MQTT服务——MyMqttService

public class MyMqttService extends Service 

    public final String TAG = MyMqttService.class.getSimpleName();
    private static MqttAndroidClient  mqttAndroidClient;
    private        MqttConnectOptions mMqttConnectOptions;
    public        String HOST           = "tcp://192.168.0.102:61613";//服务器地址（协议+地址+端口号）
    public        String USERNAME       = "admin";//用户名
    public        String PASSWORD       = "password";//密码
    public static String PUBLISH_TOPIC  = "tourist_enter";//发布主题
    public static String RESPONSE_TOPIC = "message_arrived";//响应主题
    @RequiresApi(api = 26)
    public        String CLIENTID       = Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
            ? Build.getSerial() : Build.SERIAL;//客户端ID，一般以客户端唯一标识符表示，这里用设备序列号表示

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

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

    /**
     * 开启服务
     */
    public static void startService(Context mContext) 
        mContext.startService(new Intent(mContext, MyMqttService.class));
    

    /**
     * 发布 （模拟其他客户端发布消息）
     *
     * @param message 消息
     */
    public static void publish(String message) 
        String topic = PUBLISH_TOPIC;
        Integer qos = 2;
        Boolean retained = false;
        try 
            //参数分别为：主题、消息的字节数组、服务质量、是否在服务器保留断开连接后的最后一条消息
            mqttAndroidClient.publish(topic, message.getBytes(), qos.intValue(), retained.booleanValue());
         catch (MqttException e) 
            e.printStackTrace();
        
    

    /**
     * 响应 （收到其他客户端的消息后，响应给对方告知消息已到达或者消息有问题等）
     *
     * @param message 消息
     */
    public void response(String message) 
        String topic = RESPONSE_TOPIC;
        Integer qos = 2;
        Boolean retained = false;
        try 
            //参数分别为：主题、消息的字节数组、服务质量、是否在服务器保留断开连接后的最后一条消息
            mqttAndroidClient.publish(topic, message.getBytes(), qos.intValue(), retained.booleanValue());
         catch (MqttException e) 
            e.printStackTrace();
        
    

    /**
     * 初始化
     */
    private void init() 
        String serverURI = HOST; //服务器地址（协议+地址+端口号）
        mqttAndroidClient = new MqttAndroidClient(this, serverURI, CLIENTID);
        mqttAndroidClient.setCallback(mqttCallback); //设置监听订阅消息的回调
        mMqttConnectOptions = new MqttConnectOptions();
        mMqttConnectOptions.setCleanSession(true); //设置是否清除缓存
        mMqttConnectOptions.setConnectionTimeout(10); //设置超时时间，单位：秒
        mMqttConnectOptions.setKeepAliveInterval(20); //设置心跳包发送间隔，单位：秒
        mMqttConnectOptions.setUserName(USERNAME); //设置用户名
        mMqttConnectOptions.setPassword(PASSWORD.toCharArray()); //设置密码

        // last will message
        boolean doConnect = true;
        String message = "\\"terminal_uid\\":\\"" + CLIENTID + "\\"";
        String topic = PUBLISH_TOPIC;
        Integer qos = 2;
        Boolean retained = false;
        if ((!message.equals("")) || (!topic.equals(""))) 
            // 最后的遗嘱
            try 
                mMqttConnectOptions.setWill(topic, message.getBytes(), qos.intValue(), retained.booleanValue());
             catch (Exception e) 
                Log.i(TAG, "Exception Occured", e);
                doConnect = false;
                iMqttActionListener.onFailure(null, e);
            
        
        if (doConnect) 
            doClientConnection();
        
    

    /**
     * 连接MQTT服务器
     */
    private void doClientConnection() 
        if (!mqttAndroidClient.isConnected() && isConnectIsNomarl()) 
            try 
                mqttAndroidClient.connect(mMqttConnectOptions, null, iMqttActionListener);
             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.isAvailable()) 
            String name = info.getTypeName();
            Log.i(TAG, "当前网络名称：" + name);
            return true;
         else 
            Log.i(TAG, "没有可用网络");
            /*没有可用网络的时候，延迟3秒再尝试重连*/
            new Handler().postDelayed(new Runnable() 
                @Override
                public void run() 
                    doClientConnection();
                
            , 3000);
            return false;
        
    

    //MQTT是否连接成功的监听
    private IMqttActionListener iMqttActionListener = new IMqttActionListener() 

        @Override
        public void onSuccess(IMqttToken arg0) 
            Log.i(TAG, "连接成功 ");
            try 
                mqttAndroidClient.subscribe(PUBLISH_TOPIC, 2);//订阅主题，参数：主题、服务质量
             catch (MqttException e) 
                e.printStackTrace();
            
        

        @Override
        public void onFailure(IMqttToken arg0, Throwable arg1) 
            arg1.printStackTrace();
            Log.i(TAG, "连接失败 ");
            doClientConnection();//连接失败，重连（可关闭服务器进行模拟）
        
    ;

    //订阅主题的回调
    private MqttCallback mqttCallback = new MqttCallback() 

        @Override
        public void messageArrived(String topic, MqttMessage message) throws Exception 
            Log.i(TAG, "收到消息： " + new String(message.getPayload()));
            //收到消息，这里弹出Toast表示。如果需要更新UI，可以使用广播或者EventBus进行发送
            Toast.makeText(getApplicationContext(), "messageArrived: " + new String(message.getPayload()), Toast.LENGTH_LONG).show();
            //收到其他客户端的消息后，响应给对方告知消息已到达或者消息有问题等
            response("message arrived");
        

        @Override
        public void deliveryComplete(IMqttDeliveryToken arg0) 

        

        @Override
        public void connectionLost(Throwable arg0) 
            Log.i(TAG, "连接断开 ");
            doClientConnection();//连接断开，重连
        
    ;

    @Override
    public void onDestroy() 
        try 
            mqttAndroidClient.disconnect(); //断开连接
         catch (MqttException e) 
            e.printStackTrace();
        
        super.onDestroy();
    

该 MyMqttService 类的大概逻辑就是开启服务后，调用init()方法初始化各个参数，包括服务器地址、用户名、密码等等，然后调用doClientConnection()方法连接MQTT服务器，iMqttActionListener用来监听MQTT是否连接成功，连接成功则订阅主题。mqttCallback为订阅主题的回调，收到消息后会执行该回调中的messageArrived()方法，拿到消息后进行UI更新，并调用response()方法响应给对方告知消息已到达或者消息有问题等。

2.3 开启服务
在MainActivity中开启服务，这里为了方便不做UI更新，所以就一行开启服务的代码，如下：

public class MainActivity extends AppCompatActivity 

   @Override
   protected void onCreate(Bundle savedInstanceState) 
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);
       MyMqttService.startService(this); //开启服务
   

3. 项目地址

MqttAndroidClient