项目目录文档.md 6.8 KB
CRMEB 项目目录文档
1. 引言
- 文档目的: 详细说明 CRMEB 项目的目录结构和各目录功能
- 适用范围: 项目开发人员、维护人员、新成员
- 术语定义: 无特殊术语
2. 项目根目录结构
2.1 目录树
CRMEB/
├── .comate/ # Comate 工具配置
├── .env # 环境配置文件
├── .git/ # Git 版本控制
├── .gitignore # Git 忽略文件
├── .idea/ # IDEA 编辑器配置
├── .trae/ # Trae 工具配置
│ ├── rules/ # 规则配置
│ └── skills/ # 技能配置
├── crmeb/ # 核心应用目录
├── docker-compose/ # Docker 配置
├── docs/ # 文档目录
├── docs.zip # 文档压缩包
├── LICENSE # 许可证文件
├── readme/ # 说明文档
├── README.md # 项目说明
├── template/ # 模板文件
└── 安装必读.docx # 安装说明
2.2 根目录说明
- .trae/: Trae 工具配置目录，包含规则和技能配置
- crmeb/: 项目核心应用目录，包含所有业务逻辑
- docker-compose/: Docker 容器配置，用于快速部署
- docs/: 项目文档目录，存放各类说明文档
- readme/: 项目说明文档，包含功能介绍和截图
- template/: 模板文件目录，用于生成代码和配置
3. 核心应用目录结构 (crmeb/)
3.1 目录树
crmeb/
├── .constant # 常量定义
├── .env # 应用环境配置
├── .htaccess # Apache 配置
├── .phpstorm.meta.php # PHPStorm 元数据
├── .travis.yml # Travis CI 配置
├── .version # 版本信息
├── app/ # 应用核心目录
├── backup/ # 备份目录
├── build.example.php # 构建配置示例
├── composer.json # Composer 依赖配置
├── composer.lock # Composer 依赖锁定
├── config/ # 配置文件目录
├── crmeb/ # 核心库目录
├── filetree.txt # 文件树结构
├── index.html # 入口 HTML
├── install.lock # 安装锁定
├── LICENSE.txt # 许可证文件
├── public/ # 静态资源目录
├── README.md # 应用说明
├── route/ # 路由配置目录
├── runtime/ # 运行时目录
├── think # ThinkPHP 命令行工具
├── vendor/ # 依赖库目录
└── workerman.bat # Workerman 启动脚本
3.2 核心目录说明
- app/: 应用核心目录，包含所有业务逻辑
- config/: 配置文件目录，存放应用配置
- crmeb/: 核心库目录，提供基础功能
- public/: 静态资源目录，存放前端文件
- route/: 路由配置目录，定义 URL 路由
- runtime/: 运行时目录，存放缓存和日志
- vendor/: 依赖库目录，Composer 安装的依赖
4. 应用核心目录结构 (app/)
4.1 目录树
app/
├── adminapi/ # 后台 API 接口
├── api/ # 前端 API 接口
├── AppService.php # 应用服务
├── build.php # 构建配置
├── common.php # 公共函数
├── dao/ # 数据访问层
├── event.php # 事件配置
├── ExceptionHandle.php # 异常处理
├── filetree.txt # 文件树结构
├── http/ # HTTP 相关
├── jobs/ # 队列任务
├── kefuapi/ # 客服 API 接口
├── lang/ # 语言包
├── listener/ # 事件监听器
├── middleware.php # 中间件配置
├── model/ # 数据模型
├── outapi/ # 外部 API 接口
├── provider.php # 服务提供者
├── README.md # 目录说明
├── Request.php # 请求基类
├── service.php # 服务配置
└── services/ # 业务逻辑层
4.2 核心目录说明
- adminapi/: 后台管理系统 API 接口，处理后台请求
- api/: 前端应用 API 接口，处理客户端请求
- dao/: 数据访问层，封装数据库操作
- jobs/: 队列任务，处理异步操作
- kefuapi/: 客服系统 API 接口
- model/: 数据模型，定义数据结构
- outapi/: 外部系统 API 接口
- services/: 业务逻辑层，实现核心业务功能
5. 核心模块说明
5.1 控制器层 (api/, adminapi/, kefuapi/)
- 处理 HTTP 请求
- 路由分发
- 参数验证
- 返回响应
5.2 业务逻辑层 (services/)
- 实现核心业务逻辑
- 调用数据访问层
- 处理业务规则
5.3 数据访问层 (dao/)
- 封装数据库操作
- 提供数据查询方法
- 处理数据持久化
5.4 数据模型层 (model/)
- 定义数据结构
- 关联关系
- 数据验证
5.5 配置层 (config/)
- 应用配置
- 数据库配置
- 缓存配置
- 日志配置
6. 静态资源目录 (public/)
- css/: 样式文件
- js/: JavaScript 文件
- images/: 图片文件
- fonts/: 字体文件
- uploads/: 上传文件
7. 配置文件说明
7.1 核心配置文件
- .env: 环境变量配置
- config/app.php: 应用配置
- config/database.php: 数据库配置
- config/cache.php: 缓存配置
7.2 路由配置
- route/api.php: API 路由
- route/adminapi.php: 后台 API 路由
- route/kefuapi.php: 客服 API 路由
8. 核心文件说明
8.1 入口文件
- public/index.php: 应用入口文件
- think: 命令行工具
8.2 基础类
- app/Request.php: 请求基类
- app/ExceptionHandle.php: 异常处理类
- app/AppService.php: 应用服务类
8.3 配置文件
- composer.json: 依赖管理
- .htaccess: Apache 重写规则
9. 目录使用建议
9.1 开发规范
- 新增文件: 按照对应模块目录结构存放
- 修改文件: 保持原有目录结构
- 删除文件: 确认无依赖后删除
9.2 命名规范
- 目录名: 小写单词，无特殊字符
- 文件名: 驼峰命名或小写下划线
- 类名: PascalCase
- 方法名: camelCase
10. 总结
10.1 目录结构特点
- 分层清晰: 遵循 MVC 架构，分层明确
- 模块分离: 按功能模块划分目录
- 配置集中: 配置文件统一管理
- 资源分离: 静态资源单独存放
10.2 后续计划
- 定期更新目录结构文档
- 根据项目演进调整目录结构
- 保持目录结构的合理性和可维护性
版本: 1.0 作者: 系统生成
更新日期: 2026-01-23
提示：该文档由AI生成，仅供参考。