设计规范 🔥 持续更新

MyBatis XML 使用规范

cnadmin 采用 MyBatis Plus（MyBatis 的增强框架） 作为 ORM 框架，MP 的集成带来了诸多特性，减少了大量的 CRUD XML SQL。

甚至有同学已经必须通过 MP Java 代码来编写 SQL 操作，对于多表查询，更是要引入 mybatis-plus-join。

cnadmin 目前关于 MyBatis 的使用有如下规范：

1. 【强制】单张数据表的完整增删改查，使用 MP Java 代码来处理
2. 【强制】多张数据表查询，在 XML 或 Mapper 接口（>= Java 17，可使用文本块语法）中编写动态 SQL 处理
3. 【建议】单张数据表个别字段查询，如复用 >= 3次，在 Mapper 接口中使用 @Select 注解来完成
4. 【建议】如需编写 SQL，但又无动态 SQL，可无需创建 XML 文件，在 Mapper 接口中通过注解来完成