MySQL 数据库-ORM 映射规约

MySQL 数据库-ORM 映射规约

字段

POJO 类的布尔属性不能加 is，而数据库字段必须加 is_

【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。

说明：参见定义 POJO 类以及数据库字段定义规定，在 sql.xml 增加映射，是必须的。

查询

不要使用 * 作为查询的字段列表

【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络

消耗，尤其是 text 类型的字段。

使用 #{}，#param# 不要使用${}

【强制】sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。

不使用 iBATIS 自带的 queryForList

【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。

说明：其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取 start,size 的子集合。

正例：

Map<String, Object> map = new HashMap<>(16);
map.put("start", start);
map.put("size", size);

isEqual、isNotEmpty、isNotNull

【参考】<isEqual>中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带上此条件；<isNotEmpty>表示不为空且不为 null 时执行；<isNotNull>表示不为 null 值时执行。

更新

更新 update_time 字段

【强制】更新数据表记录时，必须同时更新记录对应的 update_time 字段值为当前时间。

大而全的数据更新接口

【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字段，都进行

update table set c1=value1,c2=value2,c3=value3;

这是不对的。执行 SQL 时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。

@Transactional 事务不要滥用

【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需

要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

结果集

不要用 resultClass 当返回结果

【强制】不要用 resultClass 当返回结果，即使所有类属性名与数据库字段一一对应，也需要

定义 <resultMap>；反过来，每一个表也必然有一个 <resultMap> 与之对应。

说明：配置映射关系，使字段与 DO 类解耦，方便维护。

不要用 HashMap 与 Hashtable 当返回结果

【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。

反例：某同学为避免写一个<resultMap>xxx</resultMap>，直接使用 HashTable 来接收数据库返回结果，结果出现把 bigint 转成 Long 值，而线上由于数据库版本不一样，解析成 BigInteger，导致线上问题。