diff --git a/.trae/rules/entity_rules.md b/.trae/rules/entity_rules.md index be1e0b4..7ddf915 100644 --- a/.trae/rules/entity_rules.md +++ b/.trae/rules/entity_rules.md @@ -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`:提供toVo()方法,用于将实体转换为对应的VO对象 - - 特定领域接口:如 `CompanyBasedEntity`、`ContractBasedEntity`、`ProjectBasedEntity` 等 + - **特定领域接口**:放置在对应的业务领域目录下,如 `CompanyBasedEntity` 在 `ds/company/model/` 目录下 + - 特定领域接口定义与某一业务领域相关的通用方法(如getter/setter) ## 4. 注解规范 - **JPA注解**: