更新记录

1.0.3（2025-03-03） 下载此版本

去掉多余的注释；修改markdown；

1.0.1（2025-03-03） 下载此版本

修改README.md

平台兼容性

欢迎使用 c-websocket

注意事项 微信小程序需要wss开头的socket域名，需要配置socket合法域名，具体操作方法：https://mp.weixin.qq.com打开并登录 --->管理 --->开发管理 --->服务器域名 --->修改

安装

// npm安装方式，插件市场导入无需执行此命令。插件市场导入地址：https://ext.dcloud.net.cn/plugin?id=22423
npm install c-websocket

使用方法

// 以下导入方式按照安装方式导入，二选一
import Socket from "@/uni_modules/c-websocket";     // 插件市场导入方法
import Socket from "c-websocket";       // npm导入方法

const testSocket = new Socket("testSocket");
testSocket.setHeartbeatParams({
    time: 10000,    // 多少毫秒发送一次心跳
    data: "心跳"      // 心跳发送内容
});
testSocket.setReconnectParams({
    count: 3,       // 重连次数
    time: 3000      // 多少毫秒重连
})
testSocket.connect({
    url: "wss://...",
    heartbeat: {
        open: true,
        time: 30000,
        data: "心跳"
    },
    onOpen: (res) => {
        // socket监听打开，需要处理的逻辑
        testSocket.send("发送一条消息给后端");
    },
    onMessage: (res) => {
        // socket接收服务端的消息，需要处理的逻辑
    },
    onClose: (res) => {
        // socket监听关闭，需要处理的逻辑
    },
    onError: (err) => {
        // socket监听错误，需要处理的逻辑
    }
})
setTimeout(() => {
    testSocket.close((res) => {
        console.log("socket关闭情况：", res);
    });
}, 10000)

API

new Socket(taskName, closeLog)的taskName和closeLog Props

创建对象

new Socket().setReconnectParams(params: object)的params Props

设置重连socket参数

new Socket().setHeartbeatParams(params: object)的params Props

设置心跳的参数

new Socket().connect(params: object)的params Props

创建socket

new Socket().send(data, closeLog)的data和closeLog Props

给服务端发送的函数

new Socket().close(callback)的callback Props

关闭当前socket的函数