|
|
@@ -1,14 +1,14 @@
|
|
|
# 开心农场系统模块目录
|
|
|
|
|
|
-> 更新时间:2025年06月14日 18:33:48 CST
|
|
|
+> 更新时间:2025年07月02日 13:23:44 CST
|
|
|
|
|
|
## 模块概览
|
|
|
|
|
|
-开心农场系统采用模块化架构设计,将不同的业务功能拆分为独立的模块,每个模块负责特定的业务领域。系统共包含 **35个模块**,分为核心业务模块、基础服务模块、工具模块和扩展模块四大类。
|
|
|
+开心农场系统采用模块化架构设计,将不同的业务功能拆分为独立的模块,每个模块负责特定的业务领域。系统共包含 **37个模块**,分为核心业务模块、资金管理模块、用户与社交模块、基础服务模块、工具模块、内容模块和扩展模块七大类。
|
|
|
|
|
|
## 模块列表
|
|
|
|
|
|
-### 🎮 [核心业务模块](#核心业务模块) (9个)
|
|
|
+### 🎮 [核心业务模块](#核心业务模块) (8个)
|
|
|
- [AppGame - 游戏适配模块](#1-appgame---游戏适配模块) ✅
|
|
|
- [Farm - 农场模块](#2-farm---农场模块) ✅
|
|
|
- [GameItems - 游戏物品模块](#3-gameitems---游戏物品模块) ✅
|
|
|
@@ -18,11 +18,11 @@
|
|
|
- [Task - 任务模块](#7-task---任务模块) ✅
|
|
|
- [Promotion - 团队模块](#8-promotion---团队模块) ✅
|
|
|
|
|
|
-
|
|
|
-### 💰 [资金管理模块](#资金管理模块) (3个)
|
|
|
-- [Fund - 资金模块](#10-fund---资金模块) ✅
|
|
|
-- [Point - 积分模块](#11-point---积分模块) ✅
|
|
|
-- [Mex - 交易所模块](#12-mex---交易所模块) ✅
|
|
|
+### 💰 [资金管理模块](#资金管理模块) (4个)
|
|
|
+- [Fund - 资金模块](#9-fund---资金模块) ✅
|
|
|
+- [Point - 积分模块](#10-point---积分模块) ✅
|
|
|
+- [Mex - 交易所模块](#11-mex---交易所模块) ✅
|
|
|
+- [Transfer - 划转模块](#12-transfer---划转模块) ✅
|
|
|
|
|
|
### 👥 [用户与社交模块](#用户与社交模块) (3个)
|
|
|
- [User - 用户模块](#13-user---用户模块) 🔧
|
|
|
@@ -41,21 +41,26 @@
|
|
|
- [Push - 推送模块](#24-push---推送模块) ✅
|
|
|
- [OAuth - OAuth认证模块](#25-oauth---oauth认证模块) ✅
|
|
|
|
|
|
-### 🛠️ [工具模块](#工具模块) (6个)
|
|
|
+### 🛠️ [工具模块](#工具模块) (7个)
|
|
|
- [LCache - 本地缓存模块](#26-lcache---本地缓存模块) ✅
|
|
|
- [DelayQueue - 延迟队列模块](#27-delayqueue---延迟队列模块) ✅
|
|
|
- [Test - 测试模块](#28-test---测试模块) ✅
|
|
|
- [Dev - 开发者模块](#29-dev---开发者模块) ✅
|
|
|
- [Ulogic - 用户逻辑模块](#30-ulogic---用户逻辑模块) ✅
|
|
|
- [Protobuf - Protobuf模块](#31-protobuf---protobuf模块) ✅
|
|
|
+- [Cleanup - 数据清理模块](#32-cleanup---数据清理模块) 🔧
|
|
|
|
|
|
### 📝 [内容模块](#内容模块) (2个)
|
|
|
-- [Article - 文章模块](#32-article---文章模块) 🔧
|
|
|
-- [China - 中国特殊内容模块](#33-china---中国特殊内容模块) ✅
|
|
|
+- [Article - 文章模块](#33-article---文章模块) 🔧
|
|
|
+- [China - 中国特殊内容模块](#34-china---中国特殊内容模块) ✅
|
|
|
+
|
|
|
+### 🚀 [扩展模块](#扩展模块) (2个)
|
|
|
+- [UrsPromotion - URS推广模块](#35-urspromotion---urs推广模块) 🚧
|
|
|
+- [TransferOld - 旧版划转模块](#36-transferold---旧版划转模块) ⏸️
|
|
|
|
|
|
## 模块分类
|
|
|
|
|
|
-### 🎮 核心业务模块 (9个)
|
|
|
+### 🎮 核心业务模块 (8个)
|
|
|
|
|
|
这些模块构成了开心农场游戏的核心玩法和业务逻辑:
|
|
|
|
|
|
@@ -144,21 +149,7 @@
|
|
|
- 团队数据统计
|
|
|
- 推荐码生成
|
|
|
|
|
|
-#### 9. **Promotionurs** - 团队模块(增强版)
|
|
|
-- **路径**: `app/Module/Promotionurs`
|
|
|
-- **功能**: 完整的团队推荐系统,提供更强大的团队管理和收益分成功能
|
|
|
-- **状态**: ✅ 已完成
|
|
|
-- **核心功能**:
|
|
|
- - 扁平化推荐关系存储(高效查询)
|
|
|
- - 灵活的达人等级配置系统
|
|
|
- - 多来源收益分成机制
|
|
|
- - 团队关系缓存优化
|
|
|
- - 推荐码管理和使用统计
|
|
|
- - 邀请奖励系统
|
|
|
- - 团队任务系统
|
|
|
-- **特点**: 采用事件驱动架构,支持异步处理,具备完整的缓存策略
|
|
|
-
|
|
|
-### 💰 资金管理模块 (3个)
|
|
|
+### 💰 资金管理模块 (4个)
|
|
|
|
|
|
专门处理游戏内各种资金和积分的管理:
|
|
|
|
|
|
@@ -200,6 +191,19 @@
|
|
|
- 交易记录
|
|
|
- **特点**: 仓库账户USER_ID为15,调控账户USER_ID为16
|
|
|
|
|
|
+#### 13. **Transfer** - 划转模块
|
|
|
+- **路径**: `app/Module/Transfer`
|
|
|
+- **功能**: 资金划转/流转系统,处理用户与外部系统之间的资金转入转出操作
|
|
|
+- **状态**: ✅ 已完成
|
|
|
+- **核心功能**:
|
|
|
+ - 资金转入/转出管理
|
|
|
+ - 多应用支持和汇率转换
|
|
|
+ - 手续费机制和统计
|
|
|
+ - 订单管理和状态跟踪
|
|
|
+ - 自动化处理和回调
|
|
|
+ - 第三方应用集成
|
|
|
+- **特点**: 基于TransferOld重新设计,采用现代化架构,支持完整的手续费统计功能
|
|
|
+
|
|
|
### 👥 用户与社交模块 (3个)
|
|
|
|
|
|
处理用户管理和社交功能:
|
|
|
@@ -340,7 +344,7 @@
|
|
|
- 客户端管理
|
|
|
- 访问令牌管理
|
|
|
|
|
|
-### 🛠️ 工具模块 (6个)
|
|
|
+### 🛠️ 工具模块 (7个)
|
|
|
|
|
|
提供开发和运维工具:
|
|
|
|
|
|
@@ -384,6 +388,18 @@
|
|
|
- **状态**: ✅ 已完成
|
|
|
- **核心功能**: 枚举验证器
|
|
|
|
|
|
+#### 32. **Cleanup** - 数据清理模块
|
|
|
+- **路径**: `app/Module/Cleanup`
|
|
|
+- **功能**: 专门用于数据清理的系统模块,提供灵活的数据清理配置和执行功能
|
|
|
+- **状态**: 🔧 基础功能(75%完成)
|
|
|
+- **核心功能**:
|
|
|
+ - 灵活表选择(自定义、模块、分类、全量、混合)
|
|
|
+ - 5种清理类型(清空表、删除所有、按时间、按用户、按条件)
|
|
|
+ - 安全机制(多重确认、预览模式、自动备份)
|
|
|
+ - 批量处理和实时监控
|
|
|
+ - 命令行工具和后台管理
|
|
|
+- **特点**: 主要用于测试环境数据清理,支持Model扫描和自动配置生成
|
|
|
+
|
|
|
### 📝 内容模块 (2个)
|
|
|
|
|
|
处理内容管理:
|
|
|
@@ -393,36 +409,60 @@
|
|
|
- **功能**: 文章管理
|
|
|
- **状态**: 🔧 基础功能
|
|
|
|
|
|
-#### 33. **China** - 中国特殊内容模块
|
|
|
+#### 34. **China** - 中国特殊内容模块
|
|
|
- **路径**: `app/Module/China`
|
|
|
- **功能**: 中国特殊内容模块
|
|
|
- **状态**: ✅ 已完成
|
|
|
|
|
|
+### 🚀 扩展模块 (2个)
|
|
|
+
|
|
|
+处理特殊业务需求和扩展功能:
|
|
|
+
|
|
|
+#### 35. **UrsPromotion** - URS推广模块
|
|
|
+- **路径**: `app/Module/UrsPromotion`
|
|
|
+- **功能**: 专门为URS业务场景设计的推广模块,管理URS用户推荐关系和团队收益分成
|
|
|
+- **状态**: 🚧 开发中
|
|
|
+- **核心功能**:
|
|
|
+ - URS推荐关系管理(直推、间推、三推)
|
|
|
+ - URS达人等级系统(6个等级)
|
|
|
+ - URS团队收益分成(推广收益、种植收益)
|
|
|
+ - URS转账手续费配置(基于房屋等级和达人等级)
|
|
|
+ - 用户映射关系管理
|
|
|
+- **特点**: 与Promotion模块完全独立,采用分离映射关系设计,支持跳过机制
|
|
|
+
|
|
|
+#### 36. **TransferOld** - 旧版划转模块
|
|
|
+- **路径**: `app/Module/TransferOld`
|
|
|
+- **功能**: 旧版资金划转系统,已被Transfer模块替代
|
|
|
+- **状态**: ⏸️ 已废弃
|
|
|
+- **说明**: 保留用于数据迁移和兼容性,新功能请使用Transfer模块
|
|
|
+
|
|
|
## 模块状态说明
|
|
|
|
|
|
- ✅ **已完成**: 模块功能完整,可正常使用
|
|
|
- 🔧 **基础功能**: 模块基本功能可用,可能需要进一步完善
|
|
|
- 📋 **文档阶段**: 模块处于设计文档阶段,未开始开发
|
|
|
- 🚧 **开发中**: 模块正在开发中
|
|
|
-- ⏸️ **暂停**: 模块开发暂停
|
|
|
+- ⏸️ **已废弃**: 模块已废弃,不再维护
|
|
|
|
|
|
## 模块状态分布
|
|
|
|
|
|
### 状态分布图表
|
|
|
|
|
|
```mermaid
|
|
|
-pie title 模块状态分布 (总计35个模块)
|
|
|
- "✅ 已完成" : 30
|
|
|
- "🔧 基础功能" : 2
|
|
|
+pie title 模块状态分布 (总计37个模块)
|
|
|
+ "✅ 已完成" : 31
|
|
|
+ "🔧 基础功能" : 3
|
|
|
"📋 文档阶段" : 1
|
|
|
- "其他" : 2
|
|
|
+ "🚧 开发中" : 1
|
|
|
+ "⏸️ 已废弃" : 1
|
|
|
```
|
|
|
|
|
|
### 详细统计
|
|
|
-- ✅ **已完成**: 30个模块 (86%) - 功能完整,可正常使用
|
|
|
-- 🔧 **基础功能**: 2个模块 (6%) - 基本功能可用,需进一步完善
|
|
|
+- ✅ **已完成**: 31个模块 (84%) - 功能完整,可正常使用
|
|
|
+- 🔧 **基础功能**: 3个模块 (8%) - 基本功能可用,需进一步完善
|
|
|
- 📋 **文档阶段**: 1个模块 (3%) - 处于设计文档阶段,未开始开发
|
|
|
-- **其他**: 2个模块 (6%) - 包含开发中、暂停等状态
|
|
|
+- 🚧 **开发中**: 1个模块 (3%) - 正在开发中
|
|
|
+- ⏸️ **已废弃**: 1个模块 (3%) - 已废弃,不再维护
|
|
|
|
|
|
## 模块依赖关系
|
|
|
|
|
|
@@ -441,12 +481,12 @@ graph TD
|
|
|
Activity[Activity<br/>活动模块]
|
|
|
Task[Task<br/>任务模块]
|
|
|
Promotion[Promotion<br/>团队模块]
|
|
|
- Promotionurs[Promotionurs<br/>团队模块增强版]
|
|
|
|
|
|
%% 资金层
|
|
|
Fund[Fund<br/>资金模块]
|
|
|
Point[Point<br/>积分模块]
|
|
|
Mex[Mex<br/>交易所模块]
|
|
|
+ Transfer[Transfer<br/>划转模块]
|
|
|
|
|
|
%% 用户层
|
|
|
User[User<br/>用户模块]
|
|
|
@@ -469,6 +509,10 @@ graph TD
|
|
|
LCache[LCache<br/>本地缓存]
|
|
|
DelayQueue[DelayQueue<br/>延迟队列]
|
|
|
Ulogic[Ulogic<br/>用户逻辑]
|
|
|
+ Cleanup[Cleanup<br/>数据清理]
|
|
|
+
|
|
|
+ %% 扩展模块
|
|
|
+ UrsPromotion[UrsPromotion<br/>URS推广模块]
|
|
|
|
|
|
%% 依赖关系
|
|
|
AppGame --> Farm
|
|
|
@@ -478,7 +522,6 @@ graph TD
|
|
|
AppGame --> Activity
|
|
|
AppGame --> Task
|
|
|
AppGame --> Promotion
|
|
|
- AppGame --> Promotionurs
|
|
|
|
|
|
Farm --> GameItems
|
|
|
Pet --> GameItems
|
|
|
@@ -490,6 +533,7 @@ graph TD
|
|
|
Activity --> Fund
|
|
|
Mex --> Fund
|
|
|
Point --> Fund
|
|
|
+ Transfer --> Fund
|
|
|
|
|
|
Mex --> GameItems
|
|
|
Pet --> Game
|
|
|
@@ -502,7 +546,7 @@ graph TD
|
|
|
Activity --> User
|
|
|
Task --> User
|
|
|
Promotion --> User
|
|
|
- Promotionurs --> User
|
|
|
+ UrsPromotion --> User
|
|
|
Friend --> User
|
|
|
|
|
|
Notification --> Sms
|
|
|
@@ -525,25 +569,29 @@ graph TD
|
|
|
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
|
|
|
+ classDef extModule fill:#f1f8e9,stroke:#33691e,stroke-width:2px
|
|
|
|
|
|
- class AppGame,Farm,GameItems,Pet,Shop,Activity,Task,Promotion,Promotionurs coreModule
|
|
|
- class Fund,Point,Mex fundModule
|
|
|
+ class AppGame,Farm,GameItems,Pet,Shop,Activity,Task,Promotion coreModule
|
|
|
+ class Fund,Point,Mex,Transfer fundModule
|
|
|
class User,Friend,Game userModule
|
|
|
class ThirdParty,OpenAPI,Admin,System,File,Notification,Sms,Mail,Push,OAuth serviceModule
|
|
|
- class LCache,DelayQueue,Ulogic toolModule
|
|
|
+ class LCache,DelayQueue,Ulogic,Cleanup toolModule
|
|
|
+ class UrsPromotion extModule
|
|
|
```
|
|
|
|
|
|
### 核心依赖链
|
|
|
```
|
|
|
AppGame (适配层)
|
|
|
↓
|
|
|
-Farm + GameItems + Pet + Shop + Activity + Task + Promotion + Promotionurs (业务层)
|
|
|
+Farm + GameItems + Pet + Shop + Activity + Task + Promotion (业务层)
|
|
|
↓
|
|
|
-Fund + Point + Mex (资金层)
|
|
|
+Fund + Point + Mex + Transfer (资金层)
|
|
|
↓
|
|
|
User + Friend + Game (用户层)
|
|
|
↓
|
|
|
ThirdParty + OpenAPI + Admin + System + File + Notification + Sms + Mail + Push + OAuth (基础服务层)
|
|
|
+ ↓
|
|
|
+UrsPromotion (扩展层)
|
|
|
```
|
|
|
|
|
|
### 重要依赖关系
|
|
|
@@ -551,10 +599,13 @@ ThirdParty + OpenAPI + Admin + System + File + Notification + Sms + Mail + Push
|
|
|
- **OpenAPI模块**: 为第三方应用提供API接入服务,依赖OAuth、User、Admin、System模块
|
|
|
- **Admin模块**: 为所有模块提供后台基础功能和通用组件,依赖System、File、User模块
|
|
|
- **GameItems模块**: 被Farm、Pet、Shop、Activity、Task等模块依赖
|
|
|
-- **Fund模块**: 被Mex、Shop、Activity等模块依赖,提供资金管理
|
|
|
+- **Fund模块**: 被Mex、Shop、Activity、Transfer等模块依赖,提供资金管理
|
|
|
- **Point模块**: 基于Fund模块架构,专门处理积分
|
|
|
+- **Transfer模块**: 基于Fund模块,提供资金划转功能,替代TransferOld模块
|
|
|
- **Notification模块**: 整合Sms、Mail、Push模块,提供统一通知接口
|
|
|
- **Game模块**: 提供暂存系统,被Pet等模块使用
|
|
|
+- **UrsPromotion模块**: 独立的URS推广系统,与Promotion模块完全分离
|
|
|
+- **Cleanup模块**: 独立的数据清理工具,可清理所有模块数据
|
|
|
|
|
|
## 开发规范
|
|
|
|
|
|
@@ -600,6 +651,15 @@ app/Module/ModuleName/
|
|
|
|
|
|
## 最后更新
|
|
|
|
|
|
-本文档最后更新时间:**2025年06月14日 18:33:48 CST**
|
|
|
+本文档最后更新时间:**2025年07月02日 13:23:44 CST**
|
|
|
+
|
|
|
+### 本次更新内容
|
|
|
+- 更新模块总数从35个到37个
|
|
|
+- 新增Transfer模块(资金划转系统)
|
|
|
+- 新增Cleanup模块(数据清理工具)
|
|
|
+- 新增UrsPromotion模块(URS推广系统)
|
|
|
+- 标记TransferOld模块为已废弃
|
|
|
+- 修正模块分类和依赖关系
|
|
|
+- 更新统计图表和状态分布
|
|
|
|
|
|
如需了解具体模块的详细信息,请查看各模块目录下的README.md文件。
|