中国 帮助

即时通讯

官方 付费 应用

Wujies 无界平台(wujies.cn)的即时通讯应用,一个插件一个仓库:

v1.0.3 2 次安装 本季度 1 次

<p> <a href="https://wujies.cn" target="_blank" rel="nofollow"> <img width="100" src="https://wujies.cn/brand/logo-stacked.svg" alt="Wujies 无界 logo"> </a> </p>

<p><b>即时通讯</b>,工作台、会话、消息、联系人、好友申请与群聊(含入群申请)。</p> <p> <a rel="nofollow"><img alt="应用版本" src="https://img.shields.io/badge/app-1.0.2-111111?style=flat-square"></a> <a rel="nofollow"><img alt="应用编码" src="https://img.shields.io/badge/code-im-0057FE?style=flat-square"></a> <a rel="nofollow"><img alt="License" src="https://img.shields.io/badge/license-commercial-orange?style=flat-square"></a> <br> <a rel="nofollow">功能特性</a> <a rel="nofollow">预览</a> <a rel="nofollow">安装</a> <a rel="nofollow">设置</a> <a rel="nofollow">常见问题</a> <a href="https://docs.wujies.cn/docs/wujies/5.x/platform/plugin" rel="nofollow">插件开发</a> <a href="https://gitee.com/wujies" rel="nofollow">Gitee</a> </p>


Wujies 无界平台(wujies.cn)的即时通讯应用,一个插件一个仓库:

  • 后台:应用市场装上后多一个「即时通讯」菜单,九个页面(工作台、会话管理、消息记录、联系人管理、 好友申请、群聊管理、群成员管理、入群申请与通信配置),前端是远程应用(frontend/,46 个文件)。
  • 实时下发:新消息由 ImMessageServiceImpl 交给平台的 WebSocket 通道 (cn.wujies.common.websocket 的 WebSocketUtils.publishMessage),本插件不自建长连接端点。
  • 门户接口:/portal/im 这一族(PortalImController)只校验登录、不要求 im:* 权限点, 查询一律由服务端强制加上「当前登录用户」条件,所以一个登录用户拿不到别人的会话与消息。
  • 前台:没有直出的公开页,本仓库不放 site-templates/;唯一的匿名入口是文章作者块「私信」用的 POST /site/im/conversation。

应用编码 im | 应用版本 1.0.2 | 后端构件 wujies-im-plugin | 引擎 &gt;=5.6.2 &lt;6.0.0

✨ 功能特性

  • 💬 工作台 — 左侧会话列表 + 右侧聊天窗,收发单聊与群聊消息,带在线状态与未读数。
  • 🗂️ 会话管理 — 后台按用户/会话查全量会话行,可见隐藏、置顶与最后一条消息时间。
  • 🕘 消息记录 — 消息分页检索,含消息类型、发送人、时间与撤回状态。
  • 👥 联系人管理 — 好友关系列表;好友申请单独一页(是否强制验证由「通信配置」开关决定)。
  • 🏷️ 群聊管理 — 建群、改资料、解散;群成员管理按群查成员;入群申请审批入群。
  • 📣 全员频道 — 平台内建的固定群号 IMCHANNEL,新用户首次打开聊天自动入会(见「全员频道」)。
  • 🔔 实时下发 — 复用平台 WebSocket,本插件只 publish,不做端点;在线与否由 WebSocketSessionHolder.existSession 判断。
  • ⚙️ 通信配置 — 好友验证、建群开关、附件大小上限、撤回时限集中在一页(菜单「通信配置」)。
  • 🔐 多租户 — 会话、消息、群都带 tenant_id,与平台其它应用同一套租户口径。

📸 预览

即时通讯工作台

![即时通讯工作台](docs/screenshots/im.png)

🚀 安装

环境要求

| 项 | 要求 | |---|---| | 平台版本 | &gt;=5.6.2 &lt;6.0.0(app.json 的 engine) | | 后端构建 | JDK 17+(父 POM 的 java.version 为 17) | | 前端构建 | Node.js 18+(建议 20 LTS 及以上),npm | | 安装方式 | 管理端「应用市场 → 本地安装」上传 zip,或由上架中心(wujies-market)发布后拉取 |

从应用市场安装

  1. 打开管理端「应用市场 → 本地安装」,上传打包好的 zip;或经上架中心发布后由平台拉取。
  2. 安装时自动执行 migrations/ 下的脚本:01-create-im-tables.sql(7 张 im_* 表)与 02-create-im-website-config.sql(sys_config 里 config_category = im 的 12 个键)。
  3. 装完刷新菜单,出现「即时通讯」即成功。

包里两个产物的路径由 app.json 的 assets 决定: frontend → frontend/index.js | backend → backend/wujies-im-plugin-1.0.2.jar。

从源码构建

在本仓库根打包(三条命令各管一段,都在本仓库根执行):

powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -CheckOnly   # ① 打包前检查:清单/产物/迁移/菜单/密钥,几秒返回
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -Dev         # ② 开发包:不签名,落 ..\.plugin-dist\im\dev
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1              # ③ 正式包:构建 + 用 keys\private.pem 签名

关于上面三条命令的取值口径:

  • 判据是「脚本所在仓库根有没有 app.json」,所以在本仓库里不要传 -Plugin(它按子目录找清单, 会报「找不到插件目录」);-FrontendProject / -FrontendDist 也不用传 —— 独立布局的前端工程固定就是 本仓库 frontend/、产物 frontend/dist,脚本自己跑 npm run build(首次先 cd frontend &amp;&amp; npm install, 缺依赖时脚本会把这条命令直接报给你)。只想复用现成产物就加 -SkipBuild。
  • -SkipFrontend 只用于没有前端的纯后端应用:带前端时它会连「复制前端产物」一起跳过, 出的包只有 app.json,装上去没有界面。
  • -CheckOnly 打出的 CHECK|级别|项|说明 行就是管理端「开发工具 → 插件开发 → 打包」抽屉里那份体检清单, 两边跑的是同一套检查;有 ERROR 时正式打包会被直接拦下。签名密钥在本仓库 keys/ (private.pem + public.pem,已在 .gitignore 里),生成或更换用 -Keygen (覆盖已有密钥要显式加 -KeygenForce,旧钥先整份备份进 keys\backup\&lt;时间戳&gt;\)。 参数全表与产物结构见文档站「打包应用」与「密钥与签名」两页。

手工构建(不用打包脚本时):

mvn -B -o package -DskipTests                # 后端(前提见「常见问题」里的父 pom 一条)
cd frontend &amp;&amp; npm install &amp;&amp; npm run build  # 前端,产物 dist/index.js + assets/im-app.css

最快的开发路子不用打包、不用重启宿主:启动平台宿主,打开管理端「开发工具 → 插件开发」, 找到 im 这一行点「启动后端」(自动编译并加载 target/classes,同时开启监听)与「启动前端」 (常驻 vite build --watch,保存源码即重建,刷新页面生效,没有 HMR)。全流程见 文档站「插件开发」。

升级与卸载

  • 升级:换 app.json 的 version 后重新打包上传;已执行的迁移脚本不可改内容, 新增表结构一律加新编号脚本。
  • 卸载:管理端「应用市场」里卸载,平台按 migrations/ 记录的建表脚本清理 im_* 数据表。

⚙️ 设置

运行时配置集中在后台「即时通讯 → 通信配置」页(菜单 imSettings),落在 sys_config (config_category = im)里,保存后即时生效:

| 键 | 作用 | |---|---| | im.friendRequestNeedVerify | 加好友是否需要对方同意 | | im.groupCreateEnabled | 是否允许用户自建群 | | im.maxFileSizeMb | 聊天附件大小上限(MB) | | im.messageRecallMinutes | 消息可撤回的分钟数 | | im.name / im.nameEn / im.logo / im.favicon / im.description / im.icp / im.copyright / im.backgroundImage | 站点展示文案与图(种子数据里图三项故意留空) |

会话、消息、联系人、好友申请、群聊、群成员、入群申请各自有独立菜单页,页面里没有第二套配置。

菜单入口

| 菜单 | 路径 | 组件键 | 权限前缀 | |---|---|---|---| | 通信配置 | imSettings | remote:im/im/settings | im:settings:list | | 工作台 | workbench | remote:im/im/workbench | im:conversation:list | | 会话管理 | conversation | remote:im/im/manage/conversation | im:conversation:list | | 消息记录 | message | remote:im/im/manage/message | im:message:list | | 联系人管理 | contact | remote:im/im/manage/contact | im:contact:list | | 好友申请 | friendRequest | remote:im/im/manage/friendRequest | im:friendRequest:list | | 群聊管理 | group | remote:im/im/manage/group | im:group:list | | 群成员管理 | groupMember | remote:im/im/manage/groupMember | im:groupMember:list | | 入群申请 | groupJoinRequest | remote:im/im/manage/groupJoinRequest | im:group:joinRequest:list |

&gt; 权限点全部是 im: 前缀(与 app.json 里每个 C/F 节点的 perms 逐字对应); &gt; 改前缀会让已授权角色失效,所以保留。菜单由 AppMenuPlanner 幂等 upsert,菜单键是小写 kebab。

门户与公开入口:

| 接口 | 鉴权 | 说明 | |---|---|---| | /portal/im/** | 只要求登录,不要求 im:* | 查询强制 owner_user_id = 当前用户,拿不到别人的会话与消息 | | POST /site/im/conversation | 匿名路径 + 控制器内自查登录态 | 建/复用与作者的陌生人单聊,不自动加好友;成为好友前发送方最多 2 条 | | /websocket | 登录 token + clientid | 平台通道,不是本插件的端点(见「实时消息与 WebSocket」) |

🧩 依赖与插件支持

| 项 | 说明 | |---|---| | 依赖插件 | 无(app.json 的 dependencies 为空) | | 被谁依赖 | 商城插件(mall)的「联系客服」与内容中心的作者「私信」都落到 POST /site/im/conversation | | CMS 主题 | 本应用无公开页,不需要 cms 才能跑;只有作者块「私信」按钮由 CMS 主题拼路径 | | 平台存储 | 聊天附件走平台「存储配置」,本插件不另存密钥;大小上限由 im.maxFileSizeMb 控 | | 公共 API | 前端走打进包内的 @wujies/api-client,运行时由宿主 import map 提供 vue / element-plus / @wujies/ui-shared 单例 |

实时消息与 WebSocket

本插件不监听端口:WebSocket 端点属于平台公共模块 cn.wujies.common.websocket, 默认路径 /websocket(配置项 websocket.path,允许跨域 allowedOrigins = *), 并且只在 websocket.enabled=true 时装配。握手拦截器 PlusWebSocketInterceptor 要求:

  • 请求已是登录态(LoginHelper.getLoginUser() 不为空);
  • 请求头或参数带的 clientid 与登录 token 里的一致,否则握手直接被拒(日志「WebSocket 认证失败」)。

所以「聊天不实时」先查平台这两项,不是查插件端口。落库与推送是分开的:WebSocketUtils.publishMessage 把 WebSocketMessageDto 推给在线会话,不在线就只留在库里,下次进工作台拉历史。

全员频道

工作台聊天里那条「全员频道」不是一个新模型,它就是一条固定群号为 IMCHANNEL 的普通群聊 (常量见 src/main/java/cn/wujies/im/constant/ImChannelConstants.java),复用 im_group + im_group_member + 每人一条 im_conversation 视图行 + sendGroupMessage 的扇出, 因此没有新表、没有新迁移。要点:

  • 入会是惰性的:ImConversationServiceImpl#queryPageList/queryList 在「查询对象 == 登录人」时先调 IImGroupService#ensureChannelMember,所以新建用户、注册用户、历史存量用户第一次打开聊天就自动在群里, 宿主建用户时不需要通知插件。频道行由第一个打开 IM 的人创建(并发靠 im_group 的 (tenant_id, group_no) 唯一键 + DuplicateKeyException 回落)。
  • im_group.owner_user_id = 0(系统持有):不能填真实用户,否则 leaveGroup 的「群主退出即解散」 会把解散权交给第一个打开聊天的人。leaveGroup / deleteGroups 另外对 IMCHANNEL 直接抛错。
  • 成员一律 member_role = member,所以禁言/移出/设为管理员被 getManageableMember 天然拦住。
  • 新人入会时把频道最近 50 条复制进他自己的会话并按已读落库(扇出存储对他之前的消息是空白的)。
  • 前端只认 VO 上现算的 channel 布尔:频道把角标显示成「频/频道」,右键菜单去掉退出/解散与从列表移除 (移除后没有恢复入口,且 sendGroupMessage 只发给 status=0 的会话行,会造成静默失联)。
  • 已知上限:一条频道消息 = N 次 im_message 插入 + N 次会话更新 + N 次推送,几十到几百人可接受; 成员面板由 ensureGroupData 的 pageSize: 200 封顶。人数量级再上去要改成单行读模型。

门户与公开接口口径

  • /portal/im 的每个查询都由服务端盖当前用户,前端传什么 ownerUserId 都会被覆盖; 分页上限写在控制器常量里:列表 500、会话 200、好友申请 100、群搜索 30、群成员 200、 用户搜索 30、用户批量查询 100、批量邀请 200,消息正文 5000 字符、扩展内容 2000 字符。
  • 陌生人单聊:STRANGER_MESSAGE_LIMIT = 2,未成为好友前发送方最多 2 条;加好友走 /portal/im 的好友申请, 不在这条公开入口里做。
  • POST /site/im/conversation 建的是两条镜像会话(我这边标题是对方、对方那边标题是我), 已存在则复用并把隐藏的会话翻出来,重复点击不会长出第二条。

开发环境

git clone git@gitee.com:wujies/wujies-im-plugin.git
cd wujies-im-plugin

打包脚本:本仓库自带完整的 package.ps1(母本在 wujies-plugins 仓库根,各仓用 node scripts/sync-package-script.mjs 同步过来),clone 下来就能在本仓库根直接体检、构建、签名、出包、 生成密钥,不需要回到单体仓库,也不需要手工传产物路径。

前端 SDK:已迁到已发布的 @wujies/* SDK(ui-shared / components / api-client / ui-plugin-bundler-kit)。frontend/vite.config.ts 只声明 defineRemoteApp({ appCode, root }), 共享依赖一律 external、运行期由宿主 import map 兜到同一份实例;宿主独有工具与业务模块 (@/utils/wujies、@/api/system/*、UserSelect/MemberSelect 等)按原样复制进了 frontend/src/, proxy?.$modal / useDict / download 与 ImageUpload/UserDetail/Module*Settings 由宿主运行时提供。 本仓库前端可独立构建;要直接落位到宿主,构建前设 WUJIES_FRONTEND_DIST=/app-market-dist/remote-apps。

仓库布局

| 位置 | 内容 | |---|---| | pom.xml | Maven 模块(父 pom = cn.wujies.plugins:wujies-plugins-parent,`` 已置空) | | app.json | 应用清单,打包器读的唯一事实来源(code / version / menus / assets) | | src/ | Java 源码(47 个文件),含 portal/(PortalImController)、site/(ImSiteConversationController)与 constant/ImChannelConstants | | migrations/ | 2 个脚本:01 建 7 张 im_* 表,02 写 sys_config 的 12 个 im.* 键 | | frontend/ | 远程应用源码(src/ 46 个文件),入口 frontend/src/index.ts |

❓ 常见问题

Q:陌生人 clone 后 mvn package 报找不到 wujies-plugins-parent? 父 pom 与 wujies-common-* 目前只有本地 mvn install 出来的版本,还没发布到 Maven 仓库 (后端构件发布那一阶段才补)。本机装过就能通,本机实测 mvn -B -o package -DskipTests 通过。

Q:打包时提示「找不到插件目录」? 在本仓库根不要传 -Plugin —— 脚本按「仓库根有没有 app.json」判定布局,传了它就去找子目录清单。

Q:消息不在线也能收到吗?装好后聊天没有实时推送? 推送走平台 /websocket,先确认宿主 websocket.enabled=true;握手除了登录态还要求 clientid 与 token 里记录的一致(头或参数),不一致会握手失败(见「实时消息与 WebSocket」)。 推送失败不影响落库,重新进工作台仍能看到历史。

Q:为什么陌生人只能发两条? 设计如此(STRANGER_MESSAGE_LIMIT = 2),加好友后不再受限;限额在 PortalImController#sendMessage 里判。

Q:前端构建产物里有裸 vue 之类的 import,会不会找不到? 正常。vue / element-plus / @wujies/ui-shared 由宿主 import map 提供单例,属于刻意 external。

🔒 隐私与外部资源

  • 不收集、不上报任何遥测;会话、消息、群与好友关系只存本平台数据库(按 tenant_id 隔离)。
  • 聊天附件存放位置由平台「存储配置」决定(本地磁盘或对象存储),本插件代码里不写任何密钥。
  • README 与仓库中不包含任何真实口令、token、登录凭证或私钥;签名密钥只在本机 keys/(已 gitignore), 握手用的 token / clientid 都是运行时值,不落文档。

📄 许可证与致谢

商业授权:需要一枚覆盖本应用的有效授权凭证才允许安装与加载(条文见仓库根目录 LICENSE)。 清单 app.json 里 license 为 UNLICENSED、licenseRequired 为 true;三档口径见官网文档「授权与版本」。

💬 反馈与建议

参考

wujies-hello-plugin(已按新布局跑通前端独立构建的样板)、 wujies-ui(npm 上 @wujies/* 四件套的源码仓)、 文档站「插件开发」章节。

v1.0.3 2026-11-14 平台 >=5.6.2 <6.0.0 267 KB

新增

  • 公开页私信入口
  • 陌生人私信限额 2 条

其他

  • README 改为 Halo/NexT 版式并更新品牌 logo 地址
v1.0.2 2026-11-08 平台 >=5.6.2 <6.0.0 259 KB

修复

  • 同步公钥检查——开源仓 yml 只有环境变量占位符时改比部署仓 keys/package-public.pem

其他

  • im 1.0.2 —— 版本号与包内 jar 名同步
  • 注释瘦身(保留 ≤3 行 why 与文档指针)
v1.0.0 2026-10-01 平台 >=5.6.2 <6.0.0 230 KB

这个版本没有写更新日志。

评论区需要浏览器启用 JavaScript 才能加载。