# V-IM

**Repository Path**: alyouge/V-IM

## Basic Information

- **Project Name**: V-IM
- **Description**: V-IM（中文名：乐聊）基于JS的超轻量级聊天软件。前端：vue3.0、element plus、electron、TypeScrip，支持windows、linux、mac、安卓、IOS、小程序、H5。支持语音消息，视频通话等。
服务端： springboot、tio、mybatis 等技术。
- **Primary Language**: JavaScript
- **License**: AGPL-3.0
- **Default Branch**: 2025
- **Homepage**: https://gitee.com/alyouge/V-IM
- **GVP Project**: No

## Statistics

- **Stars**: 5278
- **Forks**: 1593
- **Created**: 2018-12-09
- **Last Updated**: 2026-05-20

## Categories & Tags

**Categories**: im

**Tags**: 聊天, H5, WebSocket, vue3, TypeScript

## README

<div align="center">

# V-IM

开源即时通讯系统，包含 PC/Web 客户端与 Java 服务端，适合学习 IM 架构、二次开发、私有化原型验证和中小型内部沟通场景。

![License](https://img.shields.io/badge/license-AGPL--3.0-blue)
![Vue3](https://img.shields.io/badge/Vue-3.4-42b883)
![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178c6)
![Electron](https://img.shields.io/badge/Electron-34-47848f)
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.3-6db33f)
![Java](https://img.shields.io/badge/Java-21-f89820)

[快速启动](#快速启动) | [功能概览](#功能概览) | [技术栈](#技术栈) | [企业版](#v-im-pro-企业版) | [商务授权](#商务咨询与授权)

</div>

---

## 项目定位

V-IM 优先面向开发者开放基础 IM 能力。你可以本地启动、阅读源码、理解客户端和服务端的协作方式，也可以基于现有代码继续扩展自己的业务系统。

如果你的目标是学习 IM 架构、验证私有化通信方案、做内部原型或二次开发，开源版是更合适的起点。

你可以先从开源版开始评估。如果项目后续需要多端一致体验、视频会议、云盘、插件、SSO、集群部署和商业支持，可以升级到后文的 V-IM PRO 企业版。

---

## 项目亮点

| 能力 | 说明 |
| :--- | :--- |
| 开源可运行 | 提供 PC/Web 客户端、服务端、数据库脚本和基础启动说明 |
| 基础 IM 能力 | 支持单聊、群聊、文本、表情、图片、文件、离线消息、聊天记录等常见能力 |
| 前后端分离 | 客户端基于 Electron + Vue3 + TypeScript，服务端基于 Spring Boot |
| 便于二次开发 | 可通过 Bridge 思路对接用户、组织、登录等外部系统 |
| 适合学习架构 | 可以了解 WebSocket、消息会话、好友群组、组织通讯录等模块的实现 |

---

## 仓库结构

| 路径 | 说明 |
| :--- | :--- |
| `v-im-pc-2025` | PC/Web 客户端，基于 Electron、Vue3、TypeScript |
| `v-im-server-2025/v-im-server` | V-IM 核心服务模块，包含用户、会话、消息、群组、好友等能力 |
| `v-im-server-2025/v-im-server-ry-plus` | 与 ruoyi-vue-plus 的集成模块，可参考其 Bridge 实现方式 |
| `doc/v-im.sql` | V-IM 主库初始化 SQL |
| `doc/sys.sql` | 简化启动时可用的用户体系示例 SQL |
| `img` | V-IM PRO 企业版截图资源 |

---

## 开源版适合谁

- 想学习即时通讯系统整体架构的开发者
- 想了解 Electron + Vue3 + Java 服务端协作方式的团队
- 想基于开源 IM 做二次开发验证的项目负责人
- 需要快速搭建内部沟通原型的中小团队
- 正在评估企业 IM、统一消息中心、私有化沟通系统的技术团队

> 说明：当前仓库暂无单独整理的开源版截图。文档后面的截图主要展示 V-IM PRO 企业版能力，避免误解，已统一放在企业版章节。

---

## 功能概览

| 模块 | 开源版能力 |
| :--- | :--- |
| 基础即时通讯 | 单聊、群聊、文本、表情、图片、文件消息 |
| 消息能力 | 离线消息、聊天记录、断线重连、基础消息收发 |
| 好友与群组 | 好友添加、好友管理、群组创建、群成员管理 |
| 用户与组织 | 支持 ruoyi-vue-plus 用户体系，可通过 `VimBridgeService` 对接自有用户、部门、组织和登录逻辑 |
| 客户端 | PC 桌面端、Web 访问能力、基础聊天窗口、会话列表、联系人、群组等界面 |
| 服务端 | 用户管理、会话管理、消息管理、群组管理、好友管理、WebSocket 通讯 |
| 基础依赖 | MySQL、Redis、MongoDB |

---

## 快速启动

### Docker Compose 一键启动

推荐先用 Docker Compose 启动服务端和依赖服务，降低首次体验成本。

```bash
cd v-im-server-2025/docker
docker compose up -d --build
```

启动内容：

| 服务 | 地址 |
| :--- | :--- |
| V-IM Server | `http://localhost:8080` |
| MySQL | `localhost:3306` |
| Redis | `localhost:6379` |
| MongoDB | `localhost:27017` |

查看日志：

```bash
docker compose logs -f app
```

更多说明请参考：[v-im-server-2025/docker/README.md](./v-im-server-2025/docker/README.md)

### 手动启动服务端

服务端入口：

```text
v-im-server-2025/v-im-server-ry-plus/src/main/java/com/vim/VimApplication.java
```

数据库脚本：

- `doc/v-im.sql` 导入到 V-IM 主库
- `doc/sys.sql` 可作为快速启动时的用户体系示例库
- 如果接入完整 ruoyi-vue-plus，请按 ruoyi-vue-plus 的数据库说明导入对应 SQL

数据库配置位置：

```text
v-im-server-2025/v-im-server/src/main/resources/application.yml
```

更多服务端说明：

- [v-im-server-2025/readme.md](./v-im-server-2025/readme.md)
- [v-im-server-2025/docker/README.md](./v-im-server-2025/docker/README.md)

### 启动客户端

```bash
cd v-im-pc-2025
npm install
npm run dev
```

构建客户端：

```bash
# Windows
npm run build:win

# macOS
npm run build:mac

# Linux
npm run build:linux
```

更多客户端说明：

- [v-im-pc-2025/README.md](./v-im-pc-2025/README.md)

---

## 技术栈

### PC/Web 客户端

![Electron](https://img.shields.io/badge/-Electron-47848F?style=flat-square&logo=electron&logoColor=white)
![Vue3](https://img.shields.io/badge/-Vue3-4FC08D?style=flat-square&logo=vue.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white)
![Vite](https://img.shields.io/badge/-Vite-646CFF?style=flat-square&logo=vite&logoColor=white)

- Electron
- Vue3
- TypeScript
- Vite
- Element Plus
- Pinia

### 服务端

![SpringBoot](https://img.shields.io/badge/-SpringBoot-6DB33F?style=flat-square&logo=springboot&logoColor=white)
![Redis](https://img.shields.io/badge/-Redis-DC382D?style=flat-square&logo=redis&logoColor=white)
![MySQL](https://img.shields.io/badge/-MySQL-4479A1?style=flat-square&logo=mysql&logoColor=white)

- Spring Boot
- T-IO / WebSocket
- Sa-Token
- MySQL
- Redis
- MongoDB

---

## 在线体验

当前在线 Demo 展示的是 **V-IM PRO 企业版** 的完整产品形态，适合快速了解系统上限和交互体验。

> 当前环境为测试环境，公网可访问。开源版请优先参考上方快速启动说明在本地运行。

| 项目 | 地址 |
| :--- | :--- |
| 服务端地址 | `42.202.135.80` |
| Web 体验 | [https://42.202.135.80/#/](https://42.202.135.80/#/) |

---

## V-IM PRO 企业版

V-IM PRO 是开源版之后的升级路径，面向商业项目交付、私有化部署、系统集成和二次开发。你可以先用开源版学习、运行和验证方向；当项目进入客户交付、长期维护和完整协同时，再升级到企业版获得更完整的产品能力与技术支持。

### 适合场景

- 软件公司、系统集成商、外包团队承接企业 IM 或协同办公项目
- 企业需要建设内部统一沟通协同入口
- 项目需要对接现有 OA、ERP、CRM、审批、工单等系统
- 需要 PC、Web、移动端、后台管理端等多端一致交付
- 需要视频会议、云盘、邮箱、插件、SSO、集群和技术支持

### 核心能力

| 能力 | 说明 |
| :--- | :--- |
| 多端一体 | Windows、Linux、macOS、Web、Uni-App、Flutter |
| 高级消息 | 转发、撤回、引用、收藏、多选、已读、免打扰、置顶、@提醒 |
| 音视频协同 | 语音通话、视频通话、视频会议、屏幕共享、会议录制 |
| 文件协同 | 个人云盘、团队云盘、文件管理、文件去重、多存储支持 |
| 组织治理 | 更完整的群管理、权限控制、日志、敏感词、后台治理能力 |
| 插件生态 | 零入侵插件架构，支持办公插件和业务系统扩展 |
| 系统集成 | OAuth2、OpenID、Bridge 集成思路，便于接入客户现有系统 |
| AI 扩展 | 支持 AI 聊天、MCP / Skill 扩展，适合机器人和自动化办公场景 |
| 项目支持 | 商业授权、源码交付、技术答疑、Bug 优先修复、定制开发 |

### 企业版截图

以下截图展示 V-IM PRO 企业版的 PC、移动端和协同能力。

> 截图仅供参考，具体功能与界面以实际版本为准。

<div align="center">
  <img src="./img/pc%20(1).png" width="30%" />
  <img src="./img/pc%20(7).png" width="30%" />
  <img src="./img/pc%20(8).png" width="30%" />
  <br/><br/>
  <img src="./img/pc%20(9).png" width="30%" />
  <img src="./img/pc%20(10).png" width="30%" />
  <img src="./img/pc%20(11).png" width="30%" />
  <br/><br/>
  <img src="./img/pc%20(12).png" width="30%" />
  <img src="./img/pc%20(13).png" width="30%" />
  <img src="./img/pc%20(14).png" width="30%" />
  <br/><br/>
  <img src="./img/pc%20(15).png" width="30%" />
  <img src="./img/pc%20(16).png" width="30%" />
  <img src="./img/pc%20(17).png" width="30%" />
  <br/><br/>
  <img src="./img/flutter%20(1).jpg" width="30%" />
  <img src="./img/flutter%20(2).jpg" width="30%" />
  <img src="./img/flutter%20(3).jpg" width="30%" />
  <br/><br/>
  <img src="./img/flutter%20(4).jpg" width="30%" />
  <img src="./img/flutter%20(5).jpg" width="30%" />
  <img src="./img/flutter%20(6).jpg" width="30%" />
  <br/><br/>
  <img src="./img/flutter%20(7).jpg" width="30%" />
  <img src="./img/flutter%20(8).jpg" width="30%" />
  <img src="./img/flutter%20(9).jpg" width="30%" />
  <br/><br/>
  <img src="./img/flutter%20(10).jpg" width="30%" />
  <img src="./img/flutter%20(11).jpg" width="30%" />
  <img src="./img/flutter%20(12).jpg" width="30%" />
  <br/><br/>
  <img src="./img/flutter%20(13).jpg" width="30%" />
  <img src="./img/flutter%20(14).jpg" width="30%" />
  <img src="./img/微信图片_20260117194810_67_81.jpg" width="30%" />
  <br/><br/>
  <img src="./img/微信图片_20260117194811_68_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194812_69_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194813_70_81.jpg" width="30%" />
  <br/><br/>
  <img src="./img/微信图片_20260117194814_71_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194815_72_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194816_73_81.jpg" width="30%" />
  <br/><br/>
  <img src="./img/微信图片_20260117194817_74_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194818_75_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194819_76_81.jpg" width="30%" />
  <br/><br/>
  <img src="./img/微信图片_20260117194820_77_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194821_78_81.jpg" width="30%" />
  <img src="./img/微信图片_20260117194822_79_81.jpg" width="30%" />
</div>

---

## 开源版 vs 企业版

| 对比项 | 开源版 | 企业版 |
| :--- | :--- | :--- |
| 定位 | 学习、体验、二开验证、原型搭建 | 商业交付、私有化部署、系统集成 |
| 端侧范围 | 主要覆盖 PC / Web | 覆盖 PC / Web / Uni-App / Flutter 等多端 |
| 基础聊天 | 支持文本、表情、图片、文件、单聊、群聊、离线消息、聊天记录 | 全端覆盖基础聊天能力 |
| 组织与关系链 | 支持基础好友、群组、组织集成 | 更完整的好友审核、群治理、权限控制 |
| 高级消息 | 基础能力为主 | 支持转发、撤回、引用、收藏、已读、免打扰、置顶等 |
| 音视频 | 不作为开源版重点能力 | 支持语音、视频、会议、屏幕共享、录制等 |
| 文件协同 | 基础文件发送 | 支持云盘、文件管理、文件去重、多存储 |
| 插件体系 | 不作为开源版重点能力 | 支持零入侵插件架构 |
| 系统集成 | 可通过 Bridge 扩展 | 支持更完整的 OAuth2、OpenID 和项目集成方案 |
| 集群部署 | 不作为开源版重点能力 | 支持服务端多节点集群部署 |
| 技术支持 | 社区交流为主 | 商业支持、源码交付、定制开发 |

一句话理解：

- **开源版**：适合先学习、先运行、先验证
- **企业版**：适合真交付、做私有化、做系统集成

---

## 企业版客户端下载

以下下载内容为 **V-IM PRO 企业版测试体验包**。

| 平台 | 版本/架构 | 下载 | 备注 |
| :--- | :--- | :--- | :--- |
| Windows x64 | Win 10 / 11 | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/pc/x64/v-im-pro_x64.exe) | 最新版 |
| Linux x64 | AMD64 | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/pc/x64/v-im-pro_x64.deb) | 仅支持 AMD64 架构 |
| macOS | ARM64 | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/pc/arm64/v-im-pro_arm64.dmg) | 暂无签名，暂不支持自动更新 |
| Linux ARM64 | ARM64 | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/pc/arm64/v-im-pro_arm64.deb) |  |
| Windows ARM64 | ARM64 | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/pc/arm64/v-im-pro_arm64.exe) |  |
| Android | Uni-App | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/mobile/uni-app.apk) | Android 测试包 |
| Android | Flutter | [立即下载](https://v-im-oss.oss-cn-beijing.aliyuncs.com/v-im-pro/flutter/app-release.apk) | Android 测试包 |

macOS 安装异常可参考：[安装出错/无法更新修复教程](https://juejin.cn/post/7584073390694662159)

---

## 企业版更新路线

| 时间节点 | 更新内容 |
| :--- | :--- |
| 2026.03 | skills + mcp：新增 MCP 接口和 Skill，支持 AI 调用给好友或群发消息 |
| 2026.02 | AI 聊天：支持多种大模型接入，支持和大模型进行文本聊天 |
| 2026.02 | 扫码登录：支持手机扫码登录 PC 端 |
| 2026.01 | 地图定位：接入高德地图，支持发送定位 |
| 2025.12 | 视频加强：会议录制、视频界面重构、会议和视频后台挂起 |
| 2025.11 | 国际化：中英文切换，多语言扩展架构支持 |
| 2025.10 | 安全与云盘：团队云盘权限精细化、敏感词过滤、Flutter 版测试 |
| 2025.07 | 暗黑模式：PC 端支持自定义主题色与深色模式 |
| 2025.06 | 云盘上线：PC 端集成企业云盘功能 |
| 2025.05 | 重大更新：零入侵插件、视频会议、OAuth2 SSO、内部邮件、集群方案 |
| 2024.12 | 效率工具：接龙功能、无入侵插件方案升级 |
| 2024.10 | 文档预览：Office/PDF 在线预览、ARM Linux 支持、体验优化 |

---

## 文档与资源

- V-IM 开源版文档：[掘金专栏](https://juejin.cn/column/7515468131328180260)
- V-IM PRO 企业版文档：[掘金专栏](https://juejin.cn/column/7508566000351494155)
- 功能白皮书：[企业级即时通讯功能详解](https://juejin.cn/post/7562037671847493659)
- Gitee 主页：[https://gitee.com/alyouge/V-IM](https://gitee.com/alyouge/V-IM)

---

## 商务咨询与授权

如需获取 V-IM PRO 企业版源码、商业授权或定制开发服务，可以扫描下方二维码联系。

<div align="center">
  <img src="https://v-im-oss.oss-cn-beijing.aliyuncs.com/2025/wx.png" width="200" title="微信二维码" alt="微信二维码">
  <p>添加请备注：<b>v-im</b></p>
</div>

如果项目对你有帮助，欢迎 Star 支持。

---

## FAQ

### 开源版可以商用吗？

本仓库开源版本遵循 [AGPL-3.0 License](./LICENSE)。如果你的使用方式符合 AGPL-3.0 的要求，可以按开源协议使用；如果用于闭源商业项目、客户交付、商业发行或不方便履行 AGPL-3.0 义务，建议购买企业版商业授权。

### 开源版和企业版是什么关系？

开源版是学习、体验、二开验证和原型搭建的起点；企业版是面向项目交付、私有化部署、系统集成、多端协同和商业支持的增强方案。两者不是互相替代关系，而是适合不同阶段。

### 开源版是否持续维护？

开源版会保留基础 IM 能力和可运行的项目结构，方便开发者学习和评估。更完整的多端能力、会议、云盘、插件、SSO、集群和商业支持会优先放在 V-IM PRO 企业版中持续迭代。

### 是否支持接入自己的用户体系？

支持。项目通过 `VimBridgeService` 提供 Bridge 集成思路，你可以参考 `v-im-server-2025/v-im-server-ry-plus` 中对 ruoyi-vue-plus 的集成方式，对接自己的用户、部门、组织和登录逻辑。

### 如何获取企业版源码和授权？

可以通过上方“商务咨询与授权”中的二维码联系，备注 `v-im`，说明你的项目场景、部署方式和需要的端侧范围，方便评估授权、源码交付、技术支持或定制开发方案。

---

## License 与法律声明

本仓库开源版本遵循 [AGPL-3.0 License](./LICENSE)。

请勿使用本软件从事任何违法行为。使用本软件产生的任何后果由使用者自行承担。

如需将 V-IM 用于闭源商业项目、客户交付、商业发行或不符合 AGPL-3.0 要求的场景，请购买企业版商业授权。