1. 文档教程
壹信-开源即时通讯
  • 壹信 — 即时通讯系统
  • 项目源码结构与功能说明书
  • 功能核心分类明细
  • 客户端打包教程
  • Android安卓打包教程
  • iOS苹果打包教程
  • 苹果推送apns配置教程
  • macOS电脑打包教程
  • Windowsn桌面端打包教程
  • mac编译环境配置
  • windows编译环境配置
  • Docker部署后端教程
  • 用宝塔面板搭建服务端
  • API全局接口
  • 并发压力测试报告
  • 服务器配置推荐
  • 适用于上架的隐私协议
  • 端口说明
  • 更新日志
  • 法律声明
文档教程
文档教程
  1. 文档教程

功能核心分类明细

目标:按「Flutter 客户端 + Go 后端 + Vue 管理端」核心功能归类源码入口。

0) 工程/文档/脚本#

README.md: 项目总览、API 约定与模块说明
PROJECT_STRUCTURE.md: 目录结构与功能说明书
安装依赖教程.txt: 环境依赖与运行步骤
项目目录结构.txt: 目录树说明(交付清单)
免责协议.txt: 交付与使用免责条款
pubspec.yaml: Flutter 依赖与资源声明
analysis_options.yaml: Dart 静态分析规则
build_apk.sh: Android 打包脚本
install_ios.sh: iOS 安装/部署脚本

1) 基础设施(后端框架/鉴权/配置/中间件)#

后端(Go / Gin)
backend/cmd/server/main.go: 服务入口(初始化 MySQL/Mongo/Redis/WS)
backend/internal/config/config.go: 配置加载与结构体映射
backend/internal/middleware/middleware.go: JWT/CORS/限流/管理员权限
backend/pkg/jwt/jwt.go: JWT 生成与校验
backend/pkg/response/response.go: 统一响应体封装
客户端(Flutter 基础能力)
lib/main.dart: Flutter 入口(初始化应用)
lib/app.dart: App 壳(路由/主题/全局注入)
lib/core/router/app_router.dart: 路由表(go_router)
lib/core/theme/: 主题系统(明暗色/字体/Provider)
lib/core/i18n/app_localizations.dart: 多语言加载
管理端(Vue 基础能力)
admin/src/main.ts: 管理端入口(创建应用/挂载)
admin/src/router/: 路由、菜单与权限守卫
admin/src/store/: Pinia 状态模块(用户/菜单/设置)
admin/src/utils/http/: Axios 封装与错误处理

2) 实时连接(WebSocket / 心跳 / 订阅 / 推送)#

后端(WS Hub)
backend/internal/ws/hub.go: 连接池、订阅映射、广播分发
backend/internal/ws/client.go: 客户端读写、心跳、断线回收
backend/internal/handlers/ws_handler.go: WS 升级与鉴权入口
客户端(WS 连接维系)
lib/core/services/api/websocket_service.dart: 心跳/重连/订阅/事件分发
lib/core/services/offline_message_queue.dart: 离线队列与网络恢复重发
管理端(可选 WS)
admin/src/utils/socket/index.ts: 管理端 WS 客户端封装

3) 会话与聊天(Chat / 成员 / 置顶 / 静音)#

后端(MySQL 为主)
backend/internal/handlers/chat_handler.go: 会话创建、成员与权限管理
backend/internal/models/chat.go: chats/chat_members/user_chats 表模型(MySQL)
客户端(UI + 状态)
lib/features/chat/pages/: 会话列表/聊天详情/群频道资料等页面
lib/features/chat/providers/: 会话与消息状态(Riverpod)
lib/features/chat/widgets/: 聊天输入栏、消息气泡、表情等组件
lib/core/services/api/chat_service.dart: 会话/消息 REST API 封装
lib/core/services/storage/models/chat_model.dart: Isar 会话缓存
管理端(会话管理)
backend/internal/handlers/chat_mgmt_handler.go: 后台会话管理 API
admin/src/views/:(通常在)会话/用户相关管理页面

4) 消息系统(发送/序号/历史/已读/撤回/回应)#

后端(Mongo + Redis + MySQL)
backend/internal/handlers/message_handler.go: 发送、同步、已读、撤回等 API
backend/internal/services/message_service.go: 入库、序号、广播、同步编排
backend/internal/models/message.go: 消息文档模型(MongoDB)
backend/internal/cache/cache.go: 消息序号/缓存/限流(Redis)
backend/internal/shard/shard_lock.go: 分片锁(序号原子性)
backend/internal/mq/queue.go: 异步队列(可用于延迟/补偿)
客户端(本地缓存 + UI)
lib/core/services/storage/models/message_model.dart: Isar 消息缓存
lib/features/chat/widgets/message_bubble.dart: 消息渲染入口(气泡)
lib/features/chat/providers/message_provider.dart: 消息流与同步状态

5) 用户与联系人(资料/设备/黑名单/联系人)#

后端(MySQL)
backend/internal/handlers/auth_handler.go: 注册/登录/Token 刷新
backend/internal/handlers/user_handler.go: 用户资料、隐私与设置
backend/internal/handlers/contact_handler.go: 联系人/好友关系
backend/internal/models/user.go: 用户表与关联模型(MySQL)
客户端(页面/设置)
lib/features/auth/pages/: 登录/注册/协议页面
lib/features/contacts/pages/: 联系人列表/添加联系人
lib/features/contacts/providers/contact_provider.dart: 联系人状态管理
lib/core/services/api/auth_service.dart: Token 与用户态管理
lib/core/services/device_service.dart: 设备信息采集/上报
lib/features/settings/pages/blocked_users_page.dart: 黑名单管理入口
管理端
backend/internal/handlers/user_mgmt_handler.go: 后台用户管理 API
admin/src/views/auth/: 管理端登录/注册页面

6) 动态/朋友圈(Moments:发布/点赞/评论/话题/屏蔽)#

后端(MySQL)
backend/internal/handlers/moment_handler.go: 动态发布/点赞/评论/话题等 API
backend/internal/handlers/moment_mgmt_handler.go: 后台审核/删除/敏感词等
backend/internal/models/moment.go: 动态与互动数据模型(MySQL)
客户端
lib/features/moments/pages/moments_page.dart: 动态流页面
lib/features/moments/providers/moment_provider.dart: 动态状态管理
管理端
admin/src/views/moment/: 动态管理页面

7) 钱包与交易(余额/流水/充值/提现/转账/红包)#

后端(MySQL + Redis 定时/补偿)
backend/internal/handlers/wallet_handler.go: 钱包用户侧 API
backend/internal/handlers/wallet_admin_handler.go: 后台审核/管理 API
backend/internal/models/wallet.go: 钱包/交易/订单模型(MySQL)
backend/internal/services/wallet_cron_service.go: 红包过期退款等定时任务
客户端
lib/features/wallet/wallet.dart: 钱包模块聚合导出
lib/features/wallet/pages/: 余额、流水、充值、提现、转账、红包页面
lib/features/wallet/providers/wallet_provider.dart: 钱包状态管理
lib/features/wallet/services/wallet_service.dart: 钱包 API 封装
lib/features/wallet/widgets/: 金额/支付密码/红包气泡组件
管理端
admin/src/views/wallet/: 钱包与交易管理页面

8) 音视频通话(Agora:发起/接听/挂断/来电)#

后端
backend/internal/handlers/call_handler.go: 通话创建/接听/拒绝/结束 API
backend/internal/handlers/call_admin_handler.go: 通话记录后台管理
backend/internal/models/call.go: 通话记录与状态模型(MySQL)
backend/internal/services/agora_service.go: Agora Token/配置获取
客户端
lib/core/services/call_service.dart: Agora/CallKit 业务封装
lib/features/call/pages/: 通话中/来电页面
lib/features/call/widgets/call_overlay.dart: 通话浮层组件
管理端
admin/src/views/call/: 通话管理页面

9) 系统设置/统计/举报(运营能力)#

后端(MySQL)
backend/internal/handlers/setting_handler.go: 系统开关/配置管理 API
backend/internal/handlers/stats_handler.go: 统计面板数据 API
backend/internal/handlers/report_handler.go: 举报提交与处理 API
backend/internal/models/system_setting.go: 系统设置模型(MySQL)
backend/internal/models/report.go: 举报模型(MySQL)
客户端
lib/core/services/api/system_settings_service.dart: 系统设置拉取
lib/features/settings/pages/: 隐私/通知/设备/FAQ 等设置页
管理端
admin/src/api/system-manage.ts: 系统管理相关接口封装
admin/src/views/system/: 系统配置、日志或权限相关页面
admin/src/views/dashboard/: 运营统计面板

10) 媒体与文件(上传/压缩/语音/通知)#

后端
backend/internal/handlers/upload_handler.go: 图片/视频/文件上传 API
backend/uploads/: 上传文件落盘目录
客户端
lib/core/services/upload_service.dart: 上传服务封装
lib/core/utils/image_compress_util.dart: 图片压缩
lib/core/services/voice_record_service.dart: 语音录制/编码
lib/core/services/notification_sound_service.dart: 通知音效播放
lib/core/services/push_notification_service.dart: 推送注册与处理
lib/core/services/desktop_notification_service.dart: 桌面通知封装

11) 部署与初始化(Docker/宝塔/SQL)#

backend/deployments/: Dockerfile + docker-compose(含 DB 组件)
backend/scripts/init.sql: MySQL 初始化表结构
backend/baota/: 宝塔部署脚本、配置与一键服务文件
修改于 2026-03-05 16:46:34
上一页
项目源码结构与功能说明书
下一页
客户端打包教程
Built with