mybatisplus实体类命名

### MyBatis-Plus 实体类命名规范与最佳实践 在使用 MyBatis-Plus 进行开发时，实体类的设计和命名是非常重要的环节之一。良好的命名习惯不仅有助于提升代码的可读性和维护性，还能减少潜在的错误。 #### 1. **实体类命名** 实体类通常对应数据库中的表结构，因此其命名应遵循一定的规则以便于理解。一般情况下，实体类的名字应该采用单数形式的大驼峰命名法（PascalCase），并与对应的数据库表名保持一致或语义相近。例如： - 如果数据库表名为 `user_info`，则实体类可以命名为 `UserInfo`。 - 如果数据库表名为 `order_detail`，则实体类可以命名为 `OrderDetail`。 这种命名方式可以通过 `@TableName` 注解显式指定表名映射关系[^2]。 ```java import com.baomidou.mybatisplus.annotation.TableName; @TableName("user_info") public class UserInfo { private Long id; private String name; } ``` #### 2. **字段命名** 字段命名同样需要清晰明了，建议使用小驼峰命名法（camelCase）。如果数据库字段带有前缀（如 `is_` 或其他特定标志位），可以在实体类中通过 `@TableField` 注解进行自定义映射。 - 数据库字段为 `is_deleted`，实体类字段推荐命名为 `deleted` 并用注解放置： ```java import com.baomidou.mybatisplus.annotation.TableField; public class User { @TableField("is_deleted") private Boolean deleted; // 使用 Boolean 类型更直观表达布尔含义 } ``` 对于逻辑删除场景，还可以利用 `@TableLogic` 注解进一步增强功能[^3]。 ```java import com.baomidou.mybatisplus.annotation.TableLogic; public class User { @TableLogic private Integer deleted; // 默认值未删0, 已删1 (具体取决于业务需求) } ``` #### 3. **注解的最佳实践** 为了使实体类更加灵活且易于扩展，在实际应用中可以根据不同情况合理选用各类注解工具。比如当存在特殊列或者非标准映射时，务必借助 `@TableField` 明确指出关联关系；而对于主键，则需标注清楚是否自动增长以及类型等信息。 ##### 主键标识 ```java import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.IdType; public class Product { @TableId(type = IdType.AUTO) // 自增策略 private Long productId; private String productName; } ``` 以上展示了如何设置主键并指定了 ID 自动生成的方式为 AUTO_INCREMENT[^1]。 --- ### 总结 综上所述，MyBatis-Plus 的实体类设计应当注重以下几个方面： - 表名与实体类名之间的一致性； - 字段的小驼峰命名风格配合必要的注解调整差异； - 利用丰富的内置特性完成诸如逻辑删除等功能的支持。 这些原则共同构成了高效、简洁而强大的数据访问层解决方案。