Oak-Team
/
oak-book
13
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

更新目录

This commit is contained in:
pqcqaq 2025-10-26 11:11:10 +08:00
parent 275b600ff8
commit 557f4fe621
1 changed files with 277 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

278
src/genernal-business/summary.md
View File

@ -1 +1,277 @@
# Oak 通用业务逻辑
# oak-general-business 功能列表
本文档列出了 oak-general-business 公共业务模块目前支持的所有功能模块。每个功能模块都有对应的详细文档。
---
## 功能模块概览
本模块共包含 **16 个**功能模块，涵盖用户管理、应用管理、微信生态、文件管理、消息通知、权限管理等多个方面。
### 核心功能
1. **用户系统** - 完整的用户管理体系
1. **OAuth 第三方登录** - 标准化的第三方认证
1. **令牌管理** - 安全的访问令牌机制
1. **应用管理** - 多应用统一管理
1. **微信生态集成** - 微信公众号、小程序集成
### 业务功能
1. **会话与消息** - 实时通信能力
1. **文件管理** - 完善的文件上传和管理
1. **文章系统** - 富文本内容管理
1. **地址管理** - 地理位置相关功能
1. **用户授权** - 灵活的实体权限系统
1. **待办事项** - 任务协作管理
### 扩展功能
1. **短信服务** - 多渠道短信发送
1. **订阅号管理** - 微信订阅号集成
1. **寄生模式** - 临时用户唤醒机制
1. **直播功能** - 直播管理能力
1. **系统配置** - 全局配置管理
---
## 功能模块关系图
```mermaid
graph TB
User[用户系统] --> Token[令牌管理]
User --> Session[会话消息]
User --> Grant[用户授权]
User --> Address[地址管理]
User --> ToDo[待办事项]
Application[应用管理] --> Token
Application --> WeChat[微信生态]
Application --> File[文件管理]
Application --> SMS[短信服务]
Application --> System[系统配置]
OAuth[OAuth登录] --> User
OAuth --> Token
WeChat --> User
WeChat --> Session
WeChat --> Subscription[订阅号]
Article[文章系统] --> File
Session --> Message[消息推送]
Message --> SMS
Message --> WeChat
Parasite[寄生模式] --> User
Parasite --> Token
Livestream[直播功能] --> Application
```
---
## 文档编写完成情况
✅ **所有 16 个功能模块文档已编写完成！**
每个模块文档都包含以下标准章节：
- 功能概述
- 实体定义详解
- 业务逻辑说明
- 前端组件使用
- 接入指南
- API 接口说明
- 总结
---
## 快速导航
### 用户相关
- [用户系统](./users.md) - 用户注册、登录、信息管理
- [OAuth 登录](./oauth.md) - 第三方登录集成
- [用户授权](./grant.md) - 实体权限授予和管理
### 应用与配置
- [应用管理](./application.md) - 多应用统一管理
- [系统配置](./system.md) - 全局配置管理
- [令牌管理](./token.md) - 访问令牌机制
### 微信生态
- [微信生态](./wechat.md) - 微信公众号、小程序集成
- [订阅号管理](./subscription.md) - 微信订阅号配置
### 内容管理
- [文章系统](./article.md) - 富文本内容管理
- [文件管理](./extrafile.md) - 文件上传和管理
### 通信与协作
- [会话消息](./session.md) - 实时通信能力
- [短信服务](./sms.md) - 多渠道短信发送
- [待办事项](./todo.md) - 任务协作管理
### 其他功能
- [地址管理](./address.md) - 地理位置相关功能
- [寄生模式](./parasite.md) - 临时用户唤醒机制
- [直播功能](./livestream.md) - 直播管理能力
---
## 详细文档列表
以下是所有 16 个功能模块的详细文档，每个模块都包含完整的实体定义、业务逻辑、前端组件和 API 接口说明。
- [x] **OAuth 第三方登录** - 详见 [OAuth](./oauth.md)
- [概述](./oauth.md#概述)
- [OAuth 2.0 标准实现](./oauth.md#oauth-20-标准实现)
- [系统架构](./oauth.md#系统架构)
- [实体说明](./oauth.md#实体说明)
- [OAuth 流程详解](./oauth.md#oauth-流程详解)
- [配置指南](./oauth.md#配置指南)
- [扩展开发](./oauth.md#扩展开发)
- [API 端点](./oauth.md#api-端点)
- [安全注意事项](./oauth.md#安全注意事项)
- [x] **用户系统** - 详见 [用户系统](./users.md)
- [功能概述](./users.md#1-功能概述)
- [实体定义详解](./users.md#2-实体定义详解)
- [业务逻辑说明](./users.md#3-业务逻辑说明)
- [前端组件使用](./users.md#4-前端组件使用)
- [接入指南](./users.md#5-接入指南)
- [API 接口说明](./users.md#6-api接口说明)
- [未来规划](./users.md#7-未来规划)
- [x] **应用管理** - 详见 [应用管理](./application.md)
- [功能概述](./application.md#1-功能概述)
- [实体定义详解](./application.md#2-实体定义详解)
- [业务逻辑说明](./application.md#3-业务逻辑说明)
- [前端组件使用](./application.md#4-前端组件使用)
- [接入指南](./application.md#5-接入指南)
- [API 接口说明](./application.md#6-api-接口说明)
- [x] **微信生态集成** - 详见 [微信生态](./wechat.md)
- [功能概述](./wechat.md#1-功能概述)
- [实体定义详解](./wechat.md#2-实体定义详解)
- [业务逻辑说明](./wechat.md#3-业务逻辑说明)
- [前端组件使用](./wechat.md#4-前端组件使用)
- [接入指南](./wechat.md#5-接入指南)
- [API 接口说明](./wechat.md#6-api-接口说明)
- [未来规划](./wechat.md#7-未来规划)
- [参考资源](./wechat.md#8-参考资源)
- [x] **令牌管理** - 详见 [令牌管理](./token.md)
- [功能概述](./token.md#1-功能概述)
- [实体定义详解](./token.md#2-实体定义详解)
- [业务逻辑说明](./token.md#3-业务逻辑说明)
- [前端组件使用](./token.md#4-前端组件使用)
- [接入指南](./token.md#5-接入指南)
- [API 接口说明](./token.md#6-api-接口说明)
- [总结](./token.md#7-总结)
- [x] **会话与消息** - 详见 [会话消息](./session.md)
- [功能概述](./session.md#1-功能概述)
- [实体定义详解](./session.md#2-实体定义详解)
- [业务逻辑说明](./session.md#3-业务逻辑说明)
- [前端组件使用](./session.md#4-前端组件使用)
- [接入指南](./session.md#5-接入指南)
- [API 接口说明](./session.md#6-api-接口说明)
- [附录](./session.md#7-附录)
- [x] **文件管理** - 详见 [文件管理](./extrafile.md)
- [功能概述](./extrafile.md#1-功能概述)
- [实体定义详解](./extrafile.md#2-实体定义详解)
- [业务逻辑说明](./extrafile.md#3-业务逻辑说明)
- [前端组件使用](./extrafile.md#4-前端组件使用)
- [接入指南](./extrafile.md#5-接入指南)
- [API 接口说明](./extrafile.md#6-api-接口说明)
- [总结](./extrafile.md#7-总结)
- [x] **文章系统** - 详见 [文章系统](./article.md)
- [功能概述](./article.md#1-功能概述)
- [实体定义详解](./article.md#2-实体定义详解)
- [业务逻辑说明](./article.md#3-业务逻辑说明)
- [前端组件使用](./article.md#4-前端组件使用)
- [接入指南](./article.md#5-接入指南)
- [API 接口说明](./article.md#6-api-接口说明)
- [总结](./article.md#7-总结)
- [x] **地址管理** - 详见 [地址管理](./address.md)
- [功能概述](./address.md#1-功能概述)
- [实体定义详解](./address.md#2-实体定义详解)
- [业务逻辑说明](./address.md#3-业务逻辑说明)
- [前端组件使用](./address.md#4-前端组件使用)
- [接入指南](./address.md#5-接入指南)
- [API 接口说明](./address.md#6-api-接口说明)
- [总结](./address.md#7-总结)
- [x] **用户授权** - 详见 [用户授权](./grant.md)
- [功能概述](./grant.md#1-功能概述)
- [实体定义详解](./grant.md#2-实体定义详解)
- [业务逻辑说明](./grant.md#3-业务逻辑说明)
- [前端组件使用](./grant.md#4-前端组件使用)
- [接入指南](./grant.md#5-接入指南)
- [API 接口说明](./grant.md#6-api-接口说明)
- [总结](./grant.md#7-总结)
- [x] **短信服务** - 详见 [短信服务](./sms.md)
- [功能概述](./sms.md#1-功能概述)
- [实体定义详解](./sms.md#2-实体定义详解)
- [业务逻辑说明](./sms.md#3-业务逻辑说明)
- [前端组件使用](./sms.md#4-前端组件使用)
- [接入指南](./sms.md#5-接入指南)
- [API 接口说明](./sms.md#6-api-接口说明)
- [总结](./sms.md#7-总结)
- [x] **订阅号管理** - 详见 [订阅号管理](./subscription.md)
- [功能概述](./subscription.md#1-功能概述)
- [实体定义详解](./subscription.md#2-实体定义详解)
- [业务逻辑说明](./subscription.md#3-业务逻辑说明)
- [前端组件使用](./subscription.md#4-前端组件使用)
- [接入指南](./subscription.md#5-接入指南)
- [API 接口说明](./subscription.md#6-api-接口说明)
- [总结](./subscription.md#7-总结)
- [x] **寄生模式** - 详见 [寄生模式](./parasite.md)
- [功能概述](./parasite.md#1-功能概述)
- [实体定义详解](./parasite.md#2-实体定义详解)
- [业务逻辑说明](./parasite.md#3-业务逻辑说明)
- [前端组件使用](./parasite.md#4-前端组件使用)
- [接入指南](./parasite.md#5-接入指南)
- [API 接口说明](./parasite.md#6-api-接口说明)
- [总结](./parasite.md#7-总结)
- [x] **待办事项** - 详见 [待办事项](./todo.md)
- [功能概述](./todo.md#1-功能概述)
- [实体定义详解](./todo.md#2-实体定义详解)
- [业务逻辑说明](./todo.md#3-业务逻辑说明)
- [前端组件使用](./todo.md#4-前端组件使用)
- [接入指南](./todo.md#5-接入指南)
- [API 接口说明](./todo.md#6-api-接口说明)
- [总结](./todo.md#7-总结)
- [x] **系统配置** - 详见 [系统配置](./system.md)
- [功能概述](./system.md#1-功能概述)
- [实体定义详解](./system.md#2-实体定义详解)
- [业务逻辑说明](./system.md#3-业务逻辑说明)
- [前端组件使用](./system.md#4-前端组件使用)
- [接入指南](./system.md#5-接入指南)
- [API 接口说明](./system.md#6-api-接口说明)
- [总结](./system.md#7-总结)
- [x] **直播功能** - 详见 [直播功能](./livestream.md)
- [功能概述](./livestream.md#1-功能概述)
- [实体定义详解](./livestream.md#2-实体定义详解)
- [业务逻辑说明](./livestream.md#3-业务逻辑说明)
- [前端组件使用](./livestream.md#4-前端组件使用)
- [接入指南](./livestream.md#5-接入指南)
- [API 接口说明](./livestream.md#6-api-接口说明)
- [总结](./livestream.md#7-总结)