From c9c8332c3aca6238a2620789fb28ff4f11ce4e1e Mon Sep 17 00:00:00 2001 From: yuanlei <18627959669@163.com> Date: Mon, 14 Jul 2025 11:19:48 +0800 Subject: [PATCH] =?UTF-8?q?=E7=BB=84=E4=BB=B6=E4=BC=98=E5=8C=96readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.development | 4 +- uni_modules/vrapile-im/package.json | 99 +++++++++++++++----------- uni_modules/vrapile-im/readme.md | 32 ++++----- uni_modules/vrapile-im/store/modules/socket.js | 5 +- 4 files changed, 76 insertions(+), 64 deletions(-) diff --git a/.env.development b/.env.development index 470abb6..25b918a 100644 --- a/.env.development +++ b/.env.development @@ -5,8 +5,8 @@ VITE_APP_TITLE = IM示例工程 VITE_APP_ENV = 'development' # 基础地址 -VITE_APP_BASE_URL = 'http://localhost:18081' -# VITE_APP_BASE_URL = 'https://api.ninecloud.top/msm' +# VITE_APP_BASE_URL = 'http://localhost:18081' +VITE_APP_BASE_URL = 'https://api.ninecloud.top/msm' # socket地址 # VITE_APP_SOCKET_URL = 'ws://localhost:9326' diff --git a/uni_modules/vrapile-im/package.json b/uni_modules/vrapile-im/package.json index c913571..8c4ba04 100644 --- a/uni_modules/vrapile-im/package.json +++ b/uni_modules/vrapile-im/package.json @@ -6,9 +6,11 @@ "keywords": [ "IM页面组件，websocket应用" ], - "repository": "", + "repository": "https://git.ninecloud.top/yuanlei/udemo-im.git", "engines": { - "HBuilderX": "^3.94" + "HBuilderX": "^3.94", + "uni-app": "^4.06", + "uni-app-x": "^4.06" }, "dcloudext": { "type": "component-vue", @@ -21,14 +23,17 @@ } }, "contact": { - "qq": "" + "qq": "642678614" }, "declaration": { "ads": "无", "data": "插件不采集任何数据", "permissions": "无" }, - "npmurl": "" + "npmurl": "", + "darkmode": "x", + "i18n": "x", + "widescreen": "√" }, "uni_modules": { "dependencies": [ @@ -37,48 +42,56 @@ "encrypt": [], "platforms": { "cloud": { - "tcb": "y", - "aliyun": "y", - "alipay": "y" + "tcb": "√", + "aliyun": "√", + "alipay": "√" }, "client": { - "Vue": { - "vue2": "y", - "vue3": "y" + "uni-app": { + "vue": { + "vue2": "-", + "vue3": "√" + }, + "web": { + "safari": "√", + "chrome": "√" + }, + "app": { + "vue": "√", + "nvue": "-", + "android": "√", + "ios": "√", + "harmony": "-" + }, + "mp": { + "weixin": "√", + "alipay": "√", + "toutiao": "-", + "baidu": "-", + "kuaishou": "-", + "jd": "-", + "harmony": "-", + "qq": "-", + "lark": "-" + }, + "quickapp": { + "huawei": "-", + "union": "-" + } }, - "App": { - "app-vue": "y", - "app-nvue": "y", - "app-uvue": "u", - "app-harmony": "y" - }, - "H5-mobile": { - "Safari": "y", - "Android Browser": "y", - "微信浏览器(Android)": "y", - "QQ浏览器(Android)": "y" - }, - "H5-pc": { - "Chrome": "y", - "IE": "y", - "Edge": "y", - "Firefox": "y", - "Safari": "y" - }, - "小程序": { - "微信": "y", - "阿里": "y", - "百度": "y", - "字节跳动": "y", - "QQ": "y", - "钉钉": "y", - "快手": "y", - "飞书": "y", - "京东": "y" - }, - "快应用": { - "华为": "y", - "联盟": "y" + "uni-app-x": { + "web": { + "safari": "-", + "chrome": "-" + }, + "app": { + "android": "-", + "ios": "-", + "harmony": "-" + }, + "mp": { + "weixin": "-" + } } } } diff --git a/uni_modules/vrapile-im/readme.md b/uni_modules/vrapile-im/readme.md index 1e0ae76..909b4a0 100644 --- a/uni_modules/vrapile-im/readme.md +++ b/uni_modules/vrapile-im/readme.md @@ -1,23 +1,22 @@ ## 组件说明 -1. 此组件为页面组件，实现了Socket连接/好友/群组/新消息/历史消息，且都是全局配置全局本地化存储，兼容H5/微信小程序/安卓App（其他平台未做调试） -2. 此组件中已提供示例工程，其中的接口和websocket服务，仅供各位开发者调试使用，正式发布需自行实现接口和websocket服务。 +1. 此组件为页面组件，实现了 WebSocket连接/好友/群组/新消息/历史消息，且都是 全局配置/全局本地化存储，兼容 H5/微信小程序/安卓App *（ 其它平台未测试 ）* ## 自行准备内容 -1. WebSocket服务，替换.env.development下VITE_APP_SOCKET_URL地址 +1. 此组件提供示例工程，其中的 接口服务 和 WebSocket服务 ，仅供各位开发者调试使用，正式发布需自行实现 - websocket需要实现连接，实现心跳检测/离线消息/在线消息/已读回执4种消息类型 +2. 接口服务，实现 /api/chat.js 和 /api/login.js 里面的方法 -2. 接口服务，实现聊天/api/chat.js和/api/login.js里面的方法 +3. WebSocket服务，实现 连接和心跳检测/离线消息/在线消息/已读回执4种消息类型 ## 引用说明 ### 1. 路由说明 -导入组件后，在pages.json中会自动注册组件，若未注册可手动添加 +导入组件后，在 pages.json 中会自动注册组件，若未注册可手动添加 ``` javascript { "path": "uni_modules/vrapile-im/pages/home/chatHome", @@ -58,17 +57,18 @@ ``` ### 2. 页面样式修改 - 页面样式在/uni_modules/vrapile-im/static/style/下的nine-chat-home-001.scss和nine-chat-friend-001.scss中， + 页面样式在 /uni_modules/vrapile-im/static/style/ 下的 nine-chat-home-001.scss 和 nine-chat-friend-001.scss 中， - 可通过重写/static/style/下的nine-chat-home-001.scss和nine-chat-friend-001.scss，将原样式替换 + 可重写 /static/style/ 下的 nine-chat-home-001.scss 和 nine-chat-friend-001.scss，将原样式替换 ## 演示说明 -以下共用一个后端，全部互通 +以下所有工程共用一个后端，账号互通 +（ *皆可用访客账号/密码：visitor/visitor* ）
-示例工程[源码]运行效果： +示例工程 [ 源码 ] 运行效果： https://www.ninecloud.top/udemo/im/index.html @@ -78,18 +78,16 @@
-演示商城H5效果： +演示商城效果：（ *H5中可下载安卓App* ） https://www.ninecloud.top/unine/index.html -H5中可下载安卓App -

-演示PC前端（与此组件无关，可用于多端消息互相发送测试）： +演示PC前端：（ *与此组件无关，可用于多端消息互相发送测试* ） https://www.ninecloud.top/msw/index @@ -97,8 +95,6 @@

-注：新注册账号，默认添加【visitor】为好友，默认加入【客服专用群】群 - -因此，可用访客/注册账号登录以上任意系统，可任意发送消息，皆能同步显示 +*注：通过以上系统新注册账号，默认添加 visitor 为好友，默认加入 客服专用群 群* -（*以上系统皆可用访客账号/密码：visitor/visitor*） \ No newline at end of file +*以上任意系统之间，IM消息皆能同步显示* diff --git a/uni_modules/vrapile-im/store/modules/socket.js b/uni_modules/vrapile-im/store/modules/socket.js index f2c6ea0..aa276ea 100644 --- a/uni_modules/vrapile-im/store/modules/socket.js +++ b/uni_modules/vrapile-im/store/modules/socket.js @@ -84,7 +84,10 @@ const socket = { }) }else{ uni.removeTabBarBadge({ - index: getApp().globalData.msgTabBarIndex + index: getApp().globalData.msgTabBarIndex, + fail: (e) => { + // console.log(e) + } }) } }catch(e){