docs(实体规则): 更新实体类目录结构和接口规范

- 将业务领域实体类按领域划分到不同目录
- 明确基础实体类和特定领域接口的存放位置
- 补充业务领域目录结构示例
This commit is contained in:
2025-10-09 18:32:16 +08:00
parent c4eec0a9dd
commit 35e8fba805

View File

@@ -1,8 +1,13 @@
# 实体类规则
## 1. 目录结构
- 实体类统一放置在 `common/src/main/java/com/ecep/contract/model/` 目录下
- 按业务领域组织,不使用子目录
- **基础实体类和接口**放置在 `common/src/main/java/com/ecep/contract/model/` 目录下
- **业务领域实体类**:放置在 `server/src/main/java/com/ecep/contract/ds/{业务领域}/model/` 目录下,按业务领域组织
- 例如:公司相关实体在 `ds/company/model/` 目录下
- 合同相关实体在 `ds/contract/model/` 目录下
- 客户相关实体在 `ds/customer/model/` 目录下
- 项目相关实体在 `ds/project/model/` 目录下
- 供应商相关实体在 `ds/vendor/model/` 目录下
## 2. 命名规范
- 类名:使用驼峰命名法,首字母大写,如 `Contract.java``Company.java`
@@ -15,7 +20,8 @@
- `BasedEntity`提供toPrettyString()方法
- `NamedEntity`提供name属性的getter/setter适用于有名称的实体
- `Voable<T>`提供toVo()方法用于将实体转换为对应的VO对象
- 特定领域接口`CompanyBasedEntity``ContractBasedEntity``ProjectBasedEntity`
- **特定领域接口**:放置在对应的业务领域目录下,`CompanyBasedEntity``ds/company/model/` 目录下
- 特定领域接口定义与某一业务领域相关的通用方法如getter/setter
## 4. 注解规范
- **JPA注解**