微信小程序--P2P消息收发模式（MQTT）

前端_贾公子
160 阅读8分钟

微信小程序--P2P消息收发模式（MQTT）

目录

[TOC]

前言

P2P，顾名思义，是一对一的消息收发模式，即只有一个消息发送者和一个消息接收者。而Pub/Sub模式通常用于一对多或多对多的消息群发场景，即拥有一个或多个消息发送者和多个消息接收者的场景。

在P2P模式中，发送者发送消息时已经明确该消息预期的接收者信息，并明确该消息只需要被特定的单个客户端消费。发送者发送消息时通过Topic信息直接指定接收者，接收者无需提前订阅即可获取该消息。

P2P模式不仅可以为接收者节省注册订阅关系的成本，此外，由于收发消息的链路有单独的优化，还可以降低推送延迟。

参考文档 ：P2P消息收发模式（MQTT）

help.aliyun.com/document_de… 参考文档 ：P2P消息收发模式 .Client.

www.eclipse.org/paho/files/… 参考文档  paho-mqtt基础库

github.com/AwakenCN/In…

参考文档  阿里云安全库

cdnjs.cloudflare.com/ajax/libs/c…

js demo

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Aliyun Mqtt Websockets</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <script src="https://cdnjs.cloudflare.com/ajax/libs/paho-mqtt/1.0.1/mqttws31.js" type="text/javascript"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.9-1/crypto-js.js" type="text/javascript"></script>
    <script type="text/javascript">
        instanceId = 'XXXX';//实例 ID，购买后从控制台获取
        host = 'XXXX.mqtt.aliyuncs.com';// 设置当前用户的接入点域名，接入点获取方法请参考接入准备章节文档，先在控制台创建实例
        port = 80;//WebSocket 协议服务端口，如果是走 HTTPS，设置443端口
        topic = 'XXXX';//需要操作的 Topic,第一级父级 topic 需要在控制台申请
        useTLS = false;//是否走加密 HTTPS，如果走 HTTPS，设置为 true
        accessKey = 'XXXXX';//账号的 AccessKey，在阿里云控制台查看
        secretKey = 'XXXXX';//账号的的 SecretKey，在阿里云控制台查看
        cleansession = true;
        groupId = 'GID_XXXX';//MQTT GroupID,创建实例后从 MQTT 控制台创建
        clientId = groupId + '@@@00001';//GroupId@@@DeviceId，由控制台创建的 Group ID 和自己指定的 Device ID 组合构成
        var mqtt;
        var reconnectTimeout = 2000;
        var username = 'Signature|' + accessKey + '|' + instanceId;//username和 Password 签名模式下的设置方法，参考文档 https://help.aliyun.com/document_detail/48271.html?spm=a2c4g.11186623.6.553.217831c3BSFry7
        var password = CryptoJS.HmacSHA1(clientId, secretKey).toString(CryptoJS.enc.Base64);
 
        function MQTTconnect() {
            mqtt = new Paho.MQTT.Client(
                host,//MQTT 域名
                port,//WebSocket 端口，如果使用 HTTPS 加密则配置为443,否则配置80
                clientId//客户端 ClientId
            );
            var options = {
                timeout: 3,
                onSuccess: onConnect,
                mqttVersion: 4,
                cleanSession: cleansession,
                onFailure: function (message) {
                    setTimeout(MQTTconnect, reconnectTimeout);
                }
            };
            mqtt.onConnectionLost = onConnectionLost;
            mqtt.onMessageArrived = onMessageArrived;
            if (username != null) {
                options.userName = username;
                options.password = password;
                options.useSSL = useTLS;//如果使用 HTTPS 加密则配置为 true
            }
            mqtt.connect(options);
        }
 
        function onConnect() {
            // Connection succeeded; subscribe to our topic
            //发送 P2P 消息，topic 设置方式参考https://help.aliyun.com/document_detail/96176.html?spm=a2c4g.11186623.6.586.694f7cb4oookL7
            message = new Paho.MQTT.Message("Hello mqtt P2P Msg!!");//set body
            message.destinationName = topic + "/p2p/" + clientId;// set topic
            mqtt.send(message);
        }
 
        function onConnectionLost(response) {
            setTimeout(MQTTconnect, reconnectTimeout);
        };
 
        function onMessageArrived(message) {
            var topic = message.destinationName;
            var payload = message.payloadString;
            console.log("recv msg : " + topic + "   " + payload);
        };
        MQTTconnect();
    </script>
</head>
</html>

参数

new Paho.Client 创建对象

JavaScript应用程序使用Paho.MQTT.Client对象与服务器通信。

大多数应用程序只创建一个Client对象，然后调用其connect（）方法，但是如果需要，应用程序可以创建多个Client对象。在这种情况下，每个客户端对象的主机、端口和clientId属性的组合必须不同。

发送、订阅和取消订阅方法被实现为异步JavaScript方法（即使底层协议交换本质上可能是同步的）。这意味着它们通过调用应用程序（通过应用程序提供的有关方法的成功或失败回调函数）来发出完成的信号。这种回调在每个方法调用中最多调用一次，并且不会持续到调用脚本的生命周期之外。

相比之下，Paho.MQTT.Client对象上定义了一些回调函数，尤其是onMessageArrived。这些方法可能会被多次调用，并且与客户端进行的特定方法调用没有直接关系。

  • host字符串消息服务器的地址，作为完全限定的WebSocket URI，作为DNS名称或虚线十进制IP地址。
  • port number要连接到的端口号-仅当主机不是URI时才需要
  • path字符串要连接到的主机上的路径-仅当主机不是URI时使用。默认值：'/mqt'。
  • clientId字符串消息传递客户端标识符，长度在1到23个字符之间。

onConnectionLost  连接丢失回调

当连接丢失时调用。connect（）方法成功后。建立连接丢失时使用的回调。连接可能会丢失，因为客户端启动了断开连接，或者因为服务器或网络导致客户端断开连接。例如，如果客户端无法连接，则可以在不调用connectionComplete回调的情况下调用disconnect回调。将单个响应对象参数传递给onConnectionLost回调，该回调包含以下字段：

  • errorCode 错误代码
  • errorMessage 错误消息

onMessageArrived  监听数据

当消息到达此Paho.MQTT.客户端时调用。传递给onMessageArrived回调的参数为

  • destinationName ： 强制消息要发送到的目的地的名称（对于即将发送的消息）或接收消息的目的地名称。（用于onMessage功能接收的消息）。
  • payloadString ：只读如果有效负载包含有效的UTF-8字符，则将有效负载作为字符串
  • payloadBytes ：只读作为ArrayBuffer的有效负载
  • qs：用于传递消息的服务质量。0最大努力（默认）。1至少一次。2正好一次。
  • retained：如果为true，则服务器将保留该消息，并将其传递给当前订阅和未来订阅。如果为false，则服务器仅将消息传递给当前订户，这是新消息的默认值。如果消息发布时保留的布尔值设置为true，并且在消息发布后进行了订阅，则收到的消息将保留的布尔设置为true。
  • duplicate ：只读如果为true，则此消息可能与已接收的消息重复。这仅在从服务器接收的消息上设置。

disconnect（） :关闭链接

isConnected：（检查链接状态）

获取或设置当前的服务器连接是否成功，定时获取本属性可用于实时更新连接状态信息。

connect (connectOptions)将此消息客户端连接到其服务器。

connectOptions用于连接的属性

  1. timeout : 如果在该秒数内连接未成功，则视为连接失败。默认值为30秒
  2. userName 此连接的身份验证用户名
  3. password:此连接的身份验证密码。
  4. onSuccess:当从服务器接收到连接确认时调用。单个响应对象参数传递给onSuccess回调，该回调包含以下字段： invocationContext传递给connectOptions中的onSuccess方法。
  5. cleanSession:清除会话  cleanif true（默认值）成功连接时删除客户端和服务器的持久状态。
  6. mqttVersion 用于连接到MQTT代理的MQTT版本。 3or4
  7. useSSL 如果存在且为真，请使用SSL Websocket连接。{如果使用 HTTPS 加密则配置为 true}
  8. onFailure:当连接请求失败或超时时调用。单个响应对象参数传递给onFailure回调，该回调包含以下字段：
  • 传入connectOptions中onFailure方法的invocationContext。
  • errorCode表示错误性质的数字。
  • error描述错误的消息文本。

mqtt 频繁断开和重连问题

mqtt.js底层没有对你调用它方法传入的callback函数做异常捕获（你传入callback函数里面不做异常捕获，会导致mqtt底层代码逻辑异常，导致频繁断连&重连问题发生）， 所以你所有的callback函数都需要增加try..catch..方法捕获异常（比如发布，订阅，监听等方法调用的时候的第二个callback函数）

小程序实践

 const Paho = require('../../utils/mqtt');
 const CryptoJS = require('../../utils/crypto-js.js');
 let instanceId = 'XXXX';//实例 ID，购买后从控制台获取
 let host = 'XXXX.mqtt.aliyuncs.com';// 设置当前用户的接入点域名，接入点获取方法请参考接入准备章节文档，先在控制台创建实例
 let port = 80;//WebSocket 协议服务端口，如果是走 HTTPS，设置443端口
 let topic = 'XXXX';//需要操作的 Topic,第一级父级 topic 需要在控制台申请
 let useTLS = false;//是否走加密 HTTPS，如果走 HTTPS，设置为 true
 let accessKey = 'XXXXX';//账号的 AccessKey，在阿里云控制台查看
 let secretKey = 'XXXXX';//账号的的 SecretKey，在阿里云控制台查看
 let cleansession = true;
 let groupId = 'GID_XXXX';//MQTT GroupID,创建实例后从 MQTT 控制台创建
 let clientId = groupId + '@@@00001';//GroupId@@@DeviceId，由控制台创建的 Group ID 和自己指定的 Device ID 组合构成
 var mqtt;
 var reconnectTimeout = 2000;
 var username = 'Signature|' + accessKey + '|' + instanceId;//username和 Password 签名模式下的设置方法，参考文档 https://help.aliyun.com/document_detail/48271.html?spm=a2c4g.11186623.6.553.217831c3BSFry7
 var password = CryptoJS.HmacSHA1(clientId, secretKey).toString(CryptoJS.enc.Base64);
 
onLoad(options) {
 this.MQTTconnect()
},
// MQTT连接
  MQTTconnect() {
    try {
      let that = this
      //创建mqtt对象
      mqtt = new Paho.Client(
        host,//MQTT 域名
        port,//WebSocket 端口，如果使用 HTTPS 加密则配置为443,否则配置80
        clientId//客户端 ClientId
      );
      // 准备链接属性
      var options = {
        timeout: 3, //超时时间
        onSuccess: that.onConnect, //当从服务器接收到连接确认时调用
        mqttVersion: 4,//用于连接到MQTT代理的MQTT版本。
        cleanSession: cleansession,//清除会话  cleanif true（默认值）成功连接时删除客户端和服务器的持久状态。
        onFailure: function (message) {//当连接请求失败或超时时调用。
          console.log(message, "连接请求失败或超时。");
          setTimeout(that.MQTTconnect, reconnectTimeout);
        }
      };
 
      mqtt.onConnectionLost = that.onConnectionLost;  //连接丢失回调
      mqtt.onMessageArrived = that.onMessageArrived;  //监听数据回调
 
      if (username != null) {
        options.userName = username;//此连接的身份验证密码。
        options.password = password;//此连接的身份验证用户名s
        options.useSSL = useTLS;//如果使用 HTTPS 加密则配置为 true
      }
      //链接
      mqtt.connect(options);
    } catch (error) {
 
    }
  },
  //当从服务器接收到连接确认时调用
  onConnect() {
    try {
      // Connection succeeded; subscribe to our topic
      //发送 P2P 消息，topic 设置方式参考https://help.aliyun.com/document_detail/96176.html?spm=a2c4g.11186623.6.586.694f7cb4oookL7
      message = new Paho.Message("Hello mqtt P2P Msg!!");//set body
      message.destinationName = topic + "/p2p/" + clientId;// set topic
      mqtt.send(message);
    } catch (error) {
 
    }
  },
  //连接丢失回调
  onConnectionLost(response) {
    try {
      let that = this
      console.log("连接丢失了:" + response.errorCode + response.errorMessage)
      setTimeout(that.MQTTconnect, reconnectTimeout);
    } catch (error) {
 
    }
  },
  //监听数据
  onMessageArrived(message) {
    try {
      var topic = message.destinationName;
      var payload = message.payloadString;
      console.log("recv msg : " + topic + "   " + payload);
    } catch (error) {
 
    }
  },

单例模式 mqtt 封装

保证只有一个链接对象，便于复用，页使用面重写 onConnectionLost & onMessageArrived

  • getInstance 创建链接
  • onConnect  服务器确认链接回调
  • disconnect 关闭链接
  • onConnectionLost 连接丢失回调
  • onMessageArrived 监听数据
  • onFailure 创建链接失败回调 页面传入callback
  • info 链接信息

initMqtt文件

const single = (() => {
    let mqtt, instanceId, host, port, accessKey, secretKey, clientId, username, password, topic, message, infodata;
    let i = 0;
    const cleanSession = true;
    const useTLS = true;
    // 创建mqtt链接对象
    const createMqttObject = () => {
        mqtt = new Paho.Client(host, port, clientId);
    };
    // 建立mqtt链接
    const linkMqttObjectWithProperties = (options) => {
        // 链接对象存在&&已连接不在执行
        if (mqtt && mqtt.isConnected()) {
            console.log('已经连接---error');
            return;
        }
        try {
            mqtt.onConnectionLost = onConnectionLost;
            mqtt.onMessageArrived = onMessageArrived;
            if (username != null) {
                options.userName = username;
                options.password = password;
                options.useSSL = useTLS;
            }
            mqtt.connect(options);
            console.log('建立链接啦-----OK');
        } catch (error) {
            console.log(error);
        }
    };
    // 创建单例对象，保证只要一个mqtt对象
    function getInstance(info) {
        // console.log(`getInstance执行创建mqtt，mqtt: ${mqtt}, i: ${i}`);
        if (!mqtt) {
            //如果没有创建对象
            infodata = info;
            instanceId = info.instanceId;
            host = info.host;
            port = 443;
            accessKey = info.accessKey;
            secretKey = info.secretKey;
            clientId = `${info.client_id}${info.shopId}${info.xmid}`;
            username = `Signature|${accessKey}|${instanceId}`;
            password = CryptoJS.HmacSHA1(clientId, secretKey).toString(CryptoJS.enc.Base64);
            topic = info.topic;
            createMqttObject();
        }
        // 准备链接信息
        const options = {
            timeout: 3,
            onSuccess: onConnect,
            mqttVersion: 4,
            cleanSession: cleanSession,
            onFailure: (response) => {
                // console.log(response, '当连接请求失败或超时时调用----------');
                setTimeout(() => {
                    if (response.errorCode != 8) {
                        getInstance(infodata);
                    }
                }, 2000);
            }
        };
        // 建立连接
        linkMqttObjectWithProperties(options);
 
 
        // console.log(mqtt, 'mqttttttttt');
        return mqtt;
    }
 
    function onConnect() {
        try {
            // message = new Paho.Message("Hello mqtt P2P Msg!!");
            // message.destinationName = `${topic}/p2p/${clientId}`;
            // mqtt.send(message);·
            console.log('链接成功');
        } catch (err) {
            console.log(err);
        }
    }
 
    // 如果是已连接在关闭连接 制空连接对象
    function Disconnect() {
        if (mqtt && mqtt.isConnected()) {
            console.log('通道关闭成功 js');
            mqtt.disconnect();
            mqtt = undefined;
        }
    }
    // 连接丢失的回调
    function onConnectionLost(response) {
        // console.log("连接丢失回调 js文件");
        // console.log(response);
        setTimeout(() => {
            if (response.errorCode != 0) {
                getInstance(infodata);
            }
        }, 2000);
    }
    // 监听数据回调
    function onMessageArrived(message) {
        // console.log("监听数据js 文件");
        PubSub.publish('mqttMessageReceived', message);
    }
 
    return {
        getInstance,
        Disconnect,
    };
})();

页面创建链接

  onShow() {
    PubSub.unsubscribe('mqttMessageReceived',/*你要解绑的事件名*/);
    PubSub.subscribe('mqttMessageReceived', (msg, data) => {
      this.onMessageArrived(data)
    });
  },
  onMessageArrived(data){
      console.log(data)
  }
avatar
文章
阅读
粉丝