# bzGhost-ws-SDK **Repository Path**: jinligen/bzGhost-websocket-sdk ## Basic Information - **Project Name**: bzGhost-ws-SDK - **Description**: 可私有化部署的全开源即时通讯js-sdk，仅需植入 sdk 即可轻松集成聊天 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2025-08-06 - **Last Updated**: 2025-08-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # websocket #### 介绍 websocket ## webPacketCode ### 数据包解码文件 --- 报文格式：magic4字节 + 版本1字节 + 序列化算法1字节 + 指令1字节 + 数据长度4字节 + 数据内容总字节长度 = 11 + 数据内容长度 * **编码encode** ```js let dataView = new DataView(buffer) dataView.setInt32(0, 0x12345678) dataView.setInt8(4, packet.version) dataView.setInt8(5, 1) // 写死1表示json序列化 dataView.setInt8(6, packet.command) dataView.setInt32(7, bytes.length) for (let i = 11; i < bytes.length + 11; i++) { dataView.setUint8(i, bytes[i - 11]) } ``` * **解码decode** ```js let dataView = new DataView(buffer) let lenght = dataView.getInt32(7) let bytes = [] for (let i = 11; i < lenght + 11; i++) { bytes[i - 11] = dataView.getUint8(i) } ``` ## ## webIm ### 通讯文件 --- * 分离了API 与webSocket 。 * 群通道，用户通道。 * 重试次数，心跳检测，断网重连。 * 字节传输，支持自定义加密解密等功能。 ### 用户绑定 --- * **方法名** login * **参数说明** | 属性名 | 备注 | 类型 | 可选值 | | :------- | :----------- | :----- | :-------- | | userId | 用户唯一标识 | String | 5f6d9d98 | | groupIds | 群组ids | Array | \["",""\] | | command | 指令集 | Number | 1 | | version | 版本号 | Number | 1 | * **示例代码** ```js import webim from '@/util/socket/webim.js'; // 全局初始化 webim.initSocket(); webim.login(userId, groupIds ,command, version, res=>{ //输出res }); ``` * **请求入参** ```js let packet = { version:1, command: 1, userId:"5f6d9d98", groupIds:["dasdasdsa"] } ``` * **响应参数** ```js let packet = { version : 1, command: 2, errorMsg:"", success: true } ``` ### 发送消息 --- * **方法名** sendMessage * **参数说明** | 属性名 | 备注 | 类型 | 可选值 | | :-------------- | :----------------------------------- | :----- | :------------------------------- | | isItMe | 发送人 | Boolen | false/true | | contentType | 消息类型\(文字/图片/语音/视频/红包\) | Number | 0/1/2/3/4/5 | | content | 消息内容 | String | 测试 | | createTime | 创建时间 | Date | 2021-11-2 | | hasBeenSentId | 消息id | String | 1447565 | | fromUserId | 发送人id | String | 220e805b8521444e9f27d78e45633b44 | | fromUserName | 发送人账户 | String | test | | fromUserHeadImg | 发送人图像 | String | defalut.jpg | | userId | 当前用户id | String | 5f6d9d98 | | toUserId | 接收人id | String | 5f6d9d98 | | toUserName | 接收人账户 | String | admin | | toUserHeadImg | 接收人图像 | String | defalut.jpg | | chatType | 聊天类型\(群/私\) | Number | 1/0 | | version | 版本 | Number | 1 | | command | 指令集 | Number | 3 | * **请求入参** ```js let packet = { isItMe: true, contentType: 0, content: "测试", createTime: Date.now(), hasBeenSentId: Date.now(), fromUserId: "5f6d9d98", fromUserName: "admin", fromUserHeadImg: '/static/image/huge.jpg', userId: "5f6d9d98", toUserId: "220e805b8521444e9f27d78e45633b44", toUserName: "test", toUserHeadImg:'/static/image/huge.jpg', chatType: 0, version : 1, command: 3, }; ``` * **响应参数** ```js let packet = { isItMe: true, contentType: 0, content: "测试", createTime: Date.now(), hasBeenSentId: Date.now(), fromUserId: "5f6d9d98", fromUserName: "admin", fromUserHeadImg: '/static/image/huge.jpg', userId: "5f6d9d98", toUserId: "220e805b8521444e9f27d78e45633b44", toUserName: "test", toUserHeadImg:'/static/image/huge.jpg', chatType: 0, version : 1, command: 4, }; ``` ### 指令集参照表 | 指令集 | 备注 | | :----- | :----------- | | 1 | 用户绑定请求 | | 2 | 用户绑定响应 | | 3 | 发送消息请求 | | 4 | 发送消息响应 | ## webSocket ### 长连接封装 --- 封装uni方法 * 心跳包 * 断线重连 * 断线重试 * 网络检测 * 自定义报文 ### initWebSocket\(options\) --- 初始化创建一个[websocket](https://developer.mozilla.org/zh-CN/docs/Web/API/WebSocket)连接 **options参数说明** | 参数名 | 类型 | 说明 | | :------ | :------- | :------------------- | | url | String | 服务器地址ws://协议 | | success | Function | 接口调用成功回调函数 | | fail | Function | 接口调用失败回调函数 | **示例代码** ```js WEBIM.options = { url: 'ws://127.0.0.1', success(res) { resolve(res); }, fail(e) { reject(e); } } WEBIM.server.initWebSocket(WEBIM.options); ``` ### sendWebSocketMsg\(options\) --- 通过 WebSocket 连接发送数据，需要先 initWebSocket，并在 \_onSocketOpened回调之后才能发送 **options参数说明** | 属性 | 类型 | 说明 | | :------ | :---------- | :----------------------------------------------------------- | | data | ArrayBuffer | 服务器发送消息 [encode编码](http://bzghost.com/packetcodecjs.html) | | success | Function | 成功回调函数 | | fail | Function | 失败回调函数 | **示例代码** ```js WEBIM.server.sendWebSocketMsg({ data: arrayBuffer, success(res) {}, fail(err) { // 进行重连 WEBIM.server._isLogin = false; if (WEBIM.server._isReconnection) { console.log('网络中断，尝试重连') WEBIM.options = { url: WEBIM.serverUrl, success(res) {}, fail(err) {} } WEBIM.server._reConnect(WEBIM.options) } console.log('【websocket】发送失败,尝试手动重连') } }); ``` ### onReceivedMsg\(callBack\) --- 监听WebSocket接受到服务器的消息事件。 **CALLBACK 返回参数** | 属性 | 类型 | 说明 | | :------- | :---------- | :----------------------------------------------------------- | | callBack | ArrayBuffer | 服务器返回消息数据 [decode解码](http://bzghost.com/packetcodecjs.html) | **示例代码** ```js WEBIM.server.onReceivedMsg(event => { let packet = packetCode.decode(event.data); let command = packet.command; // 转发事件 eventDispatcher.dispatchEvent(command, toJSON(packet)) eventDispatcher.removeListener(command, toJSON(packet)) if(command === -10){ store.commit('setNewsPush', packet); } }); ``` #