更新记录

1.0.2(2024-04-15)

监听服务端消息中,返回新增字节流数据,避免十六进制数据解析遇到编码问题,详情可参考最新使用说明。

1.0.0(2024-02-28)

  • 初版发布;
  • 支持创建TCP客户端,支持收发消息、断连等事件监听
  • 支持发送字符串、HEX字符串;

平台兼容性

Android Android CPU类型 iOS
适用版本区间:5.0 - 14.0 armeabi-v7a:支持,arm64-v8a:支持,x86:支持 ×

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


MoeTcpClient TCP客户端

引入方式

const moeTcpClient = uni.requireNativePlugin("moe-tcp-client");

方法

建立连接

MoeTcpClient.connect({
  ip: 'xxx.xxx.xxx.xxx',
  port: 6900
}, result => {
  // 连接结果 
  // {"code":1,"msg":"连接成功","data":""}
  // {"code":0,"msg":"连接失败","data":""}
})

主动断开连接

MoeTcpClient.disconnect();

发送字符串消息、Hex字符串消息

/**
 * 发送字符串消息
 * @return boolean 发送是否成功
 */
MoeTcpClient.sendStr({
  message: '发送的内容'
});

/**
 * 发送Hex字符串消息
 * @return boolean 发送是否成功
 */
MoeTcpClient.sendHexStr({
  message: '发送的内容'
});

判断是否处于连接

MoeTcpClient.isConnected(res => {
    // true or false
});

该值只能判断连接失败、或者连接成功后主动断连等场景下的状态。 对于被动断开的场景,比如服务端突然离线、空闲时间过久等场景导致的断连。可通过“发送消息”方法,判断返回的发送结果。一般发送失败基本都是已经断连导致的。

注册消息监听

监听服务端消息

MoeTcpClient.onReceive(res => {

});

注:服务端消息单次最大支持8192字节的数据

监听通讯断连

MoeTcpClient.onDisconnect(res => {

});

注:主动断连会触发该事件,被动断连可参照上面“判断是否处于连接”下的处理办法

服务端消息res返回值示例说明

{
    "code": 1,
    "data": "FF001122CCDD",
    "dataBinary": "RkYwMDExMjJDQ0REDQo=",
    "msg": "收到消息"
}
字段 字段类型 解析备注
code int 错误码:1正常、0失败
msg String 消息反馈
data String 消息数据(字节流UTF8编码后的字符串)
dataBinary String 消息数据原始字节流(uniapp会自动编码成base64字符串)

如果服务端消息是文本消息,使用data即可 如果服务端消息是十六进制数据,为防止编码问题,可直接使用 dataBinary 转换

下面给出一个常用的base64字符串转Hex字符串方法

/**
 * base64字符串转Hex字符串
 * @params base64Str
 */
let base64ToHexStr = function(base64Str){
  let binaryStr = atob(base64Str);
  let hexStr = '';
  for (let i = 0; i < binaryStr.length; i++) {
    let hex = binaryStr.charCodeAt(i).toString(16);
    hexStr += ('0' + hex).slice(-2);
  }
  return hexStr;
}

隐私、权限声明

1. 本插件需要申请的系统权限列表:

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

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

作者未提供license.md

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问