|
|
@@ -1,14 +1,61 @@
|
|
|
# 开心农场系统模块目录
|
|
|
|
|
|
-> 更新时间:2025年06月13日 18:19:11 CST
|
|
|
+> 更新时间:2025年06月14日 18:25:57 CST
|
|
|
|
|
|
## 模块概览
|
|
|
|
|
|
-开心农场系统采用模块化架构设计,将不同的业务功能拆分为独立的模块,每个模块负责特定的业务领域。系统共包含 **34个模块**,分为核心业务模块、基础服务模块、工具模块和扩展模块四大类。
|
|
|
+开心农场系统采用模块化架构设计,将不同的业务功能拆分为独立的模块,每个模块负责特定的业务领域。系统共包含 **35个模块**,分为核心业务模块、基础服务模块、工具模块和扩展模块四大类。
|
|
|
+
|
|
|
+## 模块列表
|
|
|
+
|
|
|
+### 🎮 [核心业务模块](#核心业务模块) (9个)
|
|
|
+- [AppGame - 游戏适配模块](#1-appgame---游戏适配模块) ✅
|
|
|
+- [Farm - 农场模块](#2-farm---农场模块) 📋
|
|
|
+- [GameItems - 游戏物品模块](#3-gameitems---游戏物品模块) ✅
|
|
|
+- [Pet - 宠物模块](#4-pet---宠物模块) ✅
|
|
|
+- [Shop - 商店模块](#5-shop---商店模块) ✅
|
|
|
+- [Activity - 活动模块](#6-activity---活动模块) 📋
|
|
|
+- [Task - 任务模块](#7-task---任务模块) ✅
|
|
|
+- [Promotion - 团队模块](#8-promotion---团队模块) ✅
|
|
|
+- [Promotionurs - 团队模块(增强版)](#9-promotionurs---团队模块增强版) ✅
|
|
|
+
|
|
|
+### 💰 [资金管理模块](#资金管理模块) (3个)
|
|
|
+- [Fund - 资金模块](#10-fund---资金模块) ✅
|
|
|
+- [Point - 积分模块](#11-point---积分模块) ✅
|
|
|
+- [Mex - 交易所模块](#12-mex---交易所模块) ✅
|
|
|
+
|
|
|
+### 👥 [用户与社交模块](#用户与社交模块) (3个)
|
|
|
+- [User - 用户模块](#13-user---用户模块) 🔧
|
|
|
+- [Friend - 好友模块](#14-friend---好友模块) ✅
|
|
|
+- [Game - 游戏统筹模块](#15-game---游戏统筹模块) ✅
|
|
|
+
|
|
|
+### 🔧 [基础服务模块](#基础服务模块) (10个)
|
|
|
+- [ThirdParty - 第三方服务管理模块](#16-thirdparty---第三方服务管理模块) ✅
|
|
|
+- [OpenAPI - 对外开放API管理模块](#17-openapi---对外开放api管理模块) ✅
|
|
|
+- [Admin - 后台基础功能扩展模块](#18-admin---后台基础功能扩展模块) ✅
|
|
|
+- [System - 系统模块](#19-system---系统模块) ✅
|
|
|
+- [File - 文件模块](#20-file---文件模块) ✅
|
|
|
+- [Notification - 通知模块](#21-notification---通知模块) ✅
|
|
|
+- [Sms - 短信模块](#22-sms---短信模块) ✅
|
|
|
+- [Mail - 邮件模块](#23-mail---邮件模块) ✅
|
|
|
+- [Push - 推送模块](#24-push---推送模块) ✅
|
|
|
+- [OAuth - OAuth认证模块](#25-oauth---oauth认证模块) ✅
|
|
|
+
|
|
|
+### 🛠️ [工具模块](#工具模块) (6个)
|
|
|
+- [LCache - 本地缓存模块](#26-lcache---本地缓存模块) ✅
|
|
|
+- [DelayQueue - 延迟队列模块](#27-delayqueue---延迟队列模块) ✅
|
|
|
+- [Test - 测试模块](#28-test---测试模块) ✅
|
|
|
+- [Dev - 开发者模块](#29-dev---开发者模块) ✅
|
|
|
+- [Ulogic - 用户逻辑模块](#30-ulogic---用户逻辑模块) ✅
|
|
|
+- [Protobuf - Protobuf模块](#31-protobuf---protobuf模块) ✅
|
|
|
+
|
|
|
+### 📝 [内容模块](#内容模块) (2个)
|
|
|
+- [Article - 文章模块](#32-article---文章模块) 🔧
|
|
|
+- [China - 中国特殊内容模块](#33-china---中国特殊内容模块) ✅
|
|
|
|
|
|
## 模块分类
|
|
|
|
|
|
-### 🎮 核心业务模块 (8个)
|
|
|
+### 🎮 核心业务模块 (9个)
|
|
|
|
|
|
这些模块构成了开心农场游戏的核心玩法和业务逻辑:
|
|
|
|
|
|
@@ -97,11 +144,25 @@
|
|
|
- 团队数据统计
|
|
|
- 推荐码生成
|
|
|
|
|
|
+#### 9. **Promotionurs** - 团队模块(增强版)
|
|
|
+- **路径**: `app/Module/Promotionurs`
|
|
|
+- **功能**: 完整的团队推荐系统,提供更强大的团队管理和收益分成功能
|
|
|
+- **状态**: ✅ 已完成
|
|
|
+- **核心功能**:
|
|
|
+ - 扁平化推荐关系存储(高效查询)
|
|
|
+ - 灵活的达人等级配置系统
|
|
|
+ - 多来源收益分成机制
|
|
|
+ - 团队关系缓存优化
|
|
|
+ - 推荐码管理和使用统计
|
|
|
+ - 邀请奖励系统
|
|
|
+ - 团队任务系统
|
|
|
+- **特点**: 采用事件驱动架构,支持异步处理,具备完整的缓存策略
|
|
|
+
|
|
|
### 💰 资金管理模块 (3个)
|
|
|
|
|
|
专门处理游戏内各种资金和积分的管理:
|
|
|
|
|
|
-#### 9. **Fund** - 资金模块
|
|
|
+#### 10. **Fund** - 资金模块
|
|
|
- **路径**: `app/Module/Fund`
|
|
|
- **功能**: 资金管理系统,处理用户资金相关操作
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -114,7 +175,7 @@
|
|
|
- 货币类型管理
|
|
|
- **特点**: 使用DECIMAL(30,10)存储,支持10位小数精度
|
|
|
|
|
|
-#### 10. **Point** - 积分模块
|
|
|
+#### 11. **Point** - 积分模块
|
|
|
- **路径**: `app/Module/Point`
|
|
|
- **功能**: 积分管理系统,专注于整数型积分逻辑处理
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -127,7 +188,7 @@
|
|
|
- 积分类型管理
|
|
|
- **特点**: 基于Fund模块创建,专注整数型积分,无小数运算
|
|
|
|
|
|
-#### 11. **Mex** - 交易所模块
|
|
|
+#### 12. **Mex** - 交易所模块
|
|
|
- **路径**: `app/Module/Mex`
|
|
|
- **功能**: 物品交易所系统,用户买入卖出物品撮合交易
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -143,13 +204,13 @@
|
|
|
|
|
|
处理用户管理和社交功能:
|
|
|
|
|
|
-#### 12. **User** - 用户模块
|
|
|
+#### 13. **User** - 用户模块
|
|
|
- **路径**: `app/Module/User`
|
|
|
- **功能**: 用户服务
|
|
|
- **状态**: 🔧 基础功能
|
|
|
- **核心功能**: 用户基础信息管理
|
|
|
|
|
|
-#### 13. **Friend** - 好友模块
|
|
|
+#### 14. **Friend** - 好友模块
|
|
|
- **路径**: `app/Module/Friend`
|
|
|
- **功能**: 好友系统
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -158,7 +219,7 @@
|
|
|
- 好友请求处理
|
|
|
- 好友状态管理
|
|
|
|
|
|
-#### 14. **Game** - 游戏统筹模块
|
|
|
+#### 15. **Game** - 游戏统筹模块
|
|
|
- **路径**: `app/Module/Game`
|
|
|
- **功能**: 游戏的统筹模块,对逻辑进行统筹管理
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -168,7 +229,7 @@
|
|
|
|
|
|
提供系统基础功能和服务:
|
|
|
|
|
|
-#### 15. **ThirdParty** - 第三方服务管理模块
|
|
|
+#### 16. **ThirdParty** - 第三方服务管理模块
|
|
|
- **路径**: `app/Module/ThirdParty`
|
|
|
- **功能**: 专门处理接入第三方服务的需求,提供统一的第三方服务管理、认证、监控和调用功能
|
|
|
- **状态**: ✅ 已完成
|
|
|
@@ -347,18 +408,136 @@
|
|
|
|
|
|
## 模块状态分布
|
|
|
|
|
|
-- ✅ 已完成: 28个模块 (82%)
|
|
|
-- 🔧 基础功能: 2个模块 (6%)
|
|
|
-- 📋 文档阶段: 2个模块 (6%)
|
|
|
-- 其他: 2个模块 (6%)
|
|
|
+### 状态分布图表
|
|
|
+
|
|
|
+```mermaid
|
|
|
+pie title 模块状态分布 (总计35个模块)
|
|
|
+ "✅ 已完成" : 29
|
|
|
+ "🔧 基础功能" : 2
|
|
|
+ "📋 文档阶段" : 2
|
|
|
+ "其他" : 2
|
|
|
+```
|
|
|
+
|
|
|
+### 详细统计
|
|
|
+- ✅ **已完成**: 29个模块 (83%) - 功能完整,可正常使用
|
|
|
+- 🔧 **基础功能**: 2个模块 (6%) - 基本功能可用,需进一步完善
|
|
|
+- 📋 **文档阶段**: 2个模块 (6%) - 处于设计文档阶段,未开始开发
|
|
|
+- **其他**: 2个模块 (6%) - 包含开发中、暂停等状态
|
|
|
|
|
|
## 模块依赖关系
|
|
|
|
|
|
+### 模块依赖关系图
|
|
|
+
|
|
|
+```mermaid
|
|
|
+graph TD
|
|
|
+ %% 适配层
|
|
|
+ AppGame[AppGame<br/>游戏适配模块]
|
|
|
+
|
|
|
+ %% 业务层
|
|
|
+ Farm[Farm<br/>农场模块]
|
|
|
+ GameItems[GameItems<br/>游戏物品模块]
|
|
|
+ Pet[Pet<br/>宠物模块]
|
|
|
+ Shop[Shop<br/>商店模块]
|
|
|
+ Activity[Activity<br/>活动模块]
|
|
|
+ Task[Task<br/>任务模块]
|
|
|
+ Promotion[Promotion<br/>团队模块]
|
|
|
+ Promotionurs[Promotionurs<br/>团队模块增强版]
|
|
|
+
|
|
|
+ %% 资金层
|
|
|
+ Fund[Fund<br/>资金模块]
|
|
|
+ Point[Point<br/>积分模块]
|
|
|
+ Mex[Mex<br/>交易所模块]
|
|
|
+
|
|
|
+ %% 用户层
|
|
|
+ User[User<br/>用户模块]
|
|
|
+ Friend[Friend<br/>好友模块]
|
|
|
+ Game[Game<br/>游戏统筹模块]
|
|
|
+
|
|
|
+ %% 基础服务层
|
|
|
+ ThirdParty[ThirdParty<br/>第三方服务]
|
|
|
+ OpenAPI[OpenAPI<br/>对外API]
|
|
|
+ Admin[Admin<br/>后台基础功能]
|
|
|
+ System[System<br/>系统模块]
|
|
|
+ File[File<br/>文件模块]
|
|
|
+ Notification[Notification<br/>通知模块]
|
|
|
+ Sms[Sms<br/>短信模块]
|
|
|
+ Mail[Mail<br/>邮件模块]
|
|
|
+ Push[Push<br/>推送模块]
|
|
|
+ OAuth[OAuth<br/>认证模块]
|
|
|
+
|
|
|
+ %% 工具模块
|
|
|
+ LCache[LCache<br/>本地缓存]
|
|
|
+ DelayQueue[DelayQueue<br/>延迟队列]
|
|
|
+ Ulogic[Ulogic<br/>用户逻辑]
|
|
|
+
|
|
|
+ %% 依赖关系
|
|
|
+ AppGame --> Farm
|
|
|
+ AppGame --> GameItems
|
|
|
+ AppGame --> Pet
|
|
|
+ AppGame --> Shop
|
|
|
+ AppGame --> Activity
|
|
|
+ AppGame --> Task
|
|
|
+ AppGame --> Promotion
|
|
|
+ AppGame --> Promotionurs
|
|
|
+
|
|
|
+ Farm --> GameItems
|
|
|
+ Pet --> GameItems
|
|
|
+ Shop --> GameItems
|
|
|
+ Activity --> GameItems
|
|
|
+ Task --> GameItems
|
|
|
+
|
|
|
+ Shop --> Fund
|
|
|
+ Activity --> Fund
|
|
|
+ Mex --> Fund
|
|
|
+ Point --> Fund
|
|
|
+
|
|
|
+ Mex --> GameItems
|
|
|
+ Pet --> Game
|
|
|
+
|
|
|
+ Fund --> User
|
|
|
+ Point --> User
|
|
|
+ GameItems --> User
|
|
|
+ Pet --> User
|
|
|
+ Shop --> User
|
|
|
+ Activity --> User
|
|
|
+ Task --> User
|
|
|
+ Promotion --> User
|
|
|
+ Promotionurs --> User
|
|
|
+ Friend --> User
|
|
|
+
|
|
|
+ Notification --> Sms
|
|
|
+ Notification --> Mail
|
|
|
+ Notification --> Push
|
|
|
+
|
|
|
+ ThirdParty --> System
|
|
|
+ ThirdParty --> User
|
|
|
+ OpenAPI --> OAuth
|
|
|
+ OpenAPI --> User
|
|
|
+ OpenAPI --> Admin
|
|
|
+ OpenAPI --> System
|
|
|
+ Admin --> System
|
|
|
+ Admin --> File
|
|
|
+ Admin --> User
|
|
|
+
|
|
|
+ %% 样式定义
|
|
|
+ classDef coreModule fill:#e1f5fe,stroke:#01579b,stroke-width:2px
|
|
|
+ classDef fundModule fill:#f3e5f5,stroke:#4a148c,stroke-width:2px
|
|
|
+ classDef userModule fill:#e8f5e8,stroke:#1b5e20,stroke-width:2px
|
|
|
+ classDef serviceModule fill:#fff3e0,stroke:#e65100,stroke-width:2px
|
|
|
+ classDef toolModule fill:#fce4ec,stroke:#880e4f,stroke-width:2px
|
|
|
+
|
|
|
+ class AppGame,Farm,GameItems,Pet,Shop,Activity,Task,Promotion,Promotionurs coreModule
|
|
|
+ class Fund,Point,Mex fundModule
|
|
|
+ class User,Friend,Game userModule
|
|
|
+ class ThirdParty,OpenAPI,Admin,System,File,Notification,Sms,Mail,Push,OAuth serviceModule
|
|
|
+ class LCache,DelayQueue,Ulogic toolModule
|
|
|
+```
|
|
|
+
|
|
|
### 核心依赖链
|
|
|
```
|
|
|
AppGame (适配层)
|
|
|
↓
|
|
|
-Farm + GameItems + Pet + Shop + Activity + Task + Promotion (业务层)
|
|
|
+Farm + GameItems + Pet + Shop + Activity + Task + Promotion + Promotionurs (业务层)
|
|
|
↓
|
|
|
Fund + Point + Mex (资金层)
|
|
|
↓
|
|
|
@@ -421,6 +600,6 @@ app/Module/ModuleName/
|
|
|
|
|
|
## 最后更新
|
|
|
|
|
|
-本文档最后更新时间:**2025年06月13日 21:39:44 CST**
|
|
|
+本文档最后更新时间:**2025年06月14日 18:25:57 CST**
|
|
|
|
|
|
如需了解具体模块的详细信息,请查看各模块目录下的README.md文件。
|