mybatis-patterns
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseMyBatis 核心 ORM
MyBatis 核心 ORM
Capability Boundaries
能力边界
✅ Strong Suits
✅ 适用场景
- XML vs 注解选择 — 简单CRUD用注解,复杂查询/动态SQL用XML
- ResultMap复用 — extends继承、discriminator鉴别器、columnPrefix 同表多JOIN
- 关联查询 — association(一对一)/collection(一对多),Join查询(推荐) vs 嵌套select(N+1风险)
- 动态SQL — if/choose/when/otherwise/where/set/foreach/trim/return
- 防注入 — #{}预编译 vs ${}表名/列名(必须白名单校验)
- 分页 — RowBounds(不推荐) / PageHelper(推荐) 物理分页
- sql片段 + include — 公共SQL片段复用
- XML 与注解的选择 — 简单 CRUD 使用注解,复杂查询/动态 SQL 使用 XML
- ResultMap 复用 — 使用 extends 继承、discriminator 鉴别器,通过 columnPrefix 处理同表多次 JOIN
- 关联查询 — association(一对一)/collection(一对多),Join 查询(推荐)与嵌套 select(N+1 风险)
- 动态 SQL — if/choose/when/otherwise/where/set/foreach/trim/return
- 防注入 — #{} 预编译与 ${} 表名/列名(必须进行白名单校验)
- 分页 — RowBounds(不推荐)/ PageHelper(推荐)物理分页
- sql 片段 + include — 复用公共 SQL 片段
❌ Out of Scope
❌ 不在范围内
- MyBatis-Plus LambdaWrapper → mybatis-plus-patterns
- Spring Data JPA → spring-data-jpa(已有技能)
- MyBatis-Plus LambdaWrapper → mybatis-plus-patterns
- Spring Data JPA → spring-data-jpa(已有 skill)
LLM最常犯的错误
LLM最常犯的错误
| # | 错误 | 正确做法 |
|---|---|---|
| 1 | 简单CRUD也用XML写 | |
| 2 | N+1查询:循环查子表 | Join查询(推荐) 或 association/collection + batch select |
| 3 | | 先检查 columnName 是否在白名单中,否则 SQL 注入 |
| 4 | 不配置 resultMap 用别名映射 | 定义 |
| 5 | | 只查需要的字段(尤其大字段/TEXT/BLOB) |
| 6 | 模糊查询 | |
| 7 | 多表 JOIN 不处理列名冲突 | 用别名 + resultMap column 映射 |
| 8 | 不同表 JOIN 同表两次,手动写所有列 | 用 |
| # | 错误 | 正确做法 |
|---|---|---|
| 1 | 简单 CRUD 也使用 XML | |
| 2 | N+1 查询:循环查询子表 | Join 查询(推荐),或使用 association/collection + 批量 select |
| 3 | | 先检查 columnName 是否位于白名单中,否则会有 SQL 注入风险 |
| 4 | 不配置 resultMap 而使用别名映射 | 定义 |
| 5 | 使用 | 只查询需要的字段(尤其是大字段/TEXT/BLOB) |
| 6 | 模糊查询 | 使用 |
| 7 | 多表 JOIN 不处理列名冲突 | 使用别名 + resultMap column 映射 |
| 8 | 不同的表 JOIN 同一张表两次,手动编写所有列 | 使用 |
核心模式
核心模式
模式 1: ResultMap 复用 + extends
模式 1: ResultMap 复用 + extends
xml
<!-- 基础 ResultMap -->
<resultMap id="BaseResultMap" type="com.example.User">
<id column="id" property="id"/>
<result column="user_name" property="userName"/>
<result column="email" property="email"/>
<result column="status" property="status"/>
</resultMap>
<!-- 继承 + 关联(推荐 Join 方式) -->
<resultMap id="UserWithDept" extends="BaseResultMap" type="com.example.UserVO">
<association property="dept" javaType="Department"
resultMap="com.example.DeptMapper.BaseResultMap"
columnPrefix="dept_"/> <!-- ← 同名字段加前缀 -->
<collection property="roles" ofType="Role"
resultMap="com.example.RoleMapper.BaseResultMap"
columnPrefix="role_"/>
</resultMap>xml
<!-- 基础 ResultMap -->
<resultMap id="BaseResultMap" type="com.example.User">
<id column="id" property="id"/>
<result column="user_name" property="userName"/>
<result column="email" property="email"/>
<result column="status" property="status"/>
</resultMap>
<!-- 继承 + 关联(推荐 Join 方式) -->
<resultMap id="UserWithDept" extends="BaseResultMap" type="com.example.UserVO">
<association property="dept" javaType="Department"
resultMap="com.example.DeptMapper.BaseResultMap"
columnPrefix="dept_"/> <!-- ← 同名字段加前缀 -->
<collection property="roles" ofType="Role"
resultMap="com.example.RoleMapper.BaseResultMap"
columnPrefix="role_"/>
</resultMap>模式 2: Join 查询(推荐,替代嵌套 select)
模式 2: Join 查询(推荐,替代嵌套 select)
xml
<!-- ✅ 推荐:Join 查询 → 一次SQL,无N+1 -->
<select id="selectUserWithDept" resultMap="UserWithDept">
SELECT u.id, u.user_name, u.email, u.status,
d.id AS dept_id, d.dept_name AS dept_dept_name, <!-- ← 加前缀 -->
r.id AS role_id, r.role_name AS role_role_name
FROM sys_user u
LEFT JOIN sys_dept d ON u.dept_id = d.id
LEFT JOIN sys_user_role ur ON u.id = ur.user_id
LEFT JOIN sys_role r ON ur.role_id = r.id
WHERE u.id = #{id}
</select>
<!-- ❌ 避免:嵌套 select 导致 N+1 -->
<resultMap id="UserWithDeptNested" extends="BaseResultMap" type="com.example.UserVO">
<association property="dept" javaType="Department"
column="dept_id" select="selectDeptById"/> <!-- ← 每次查询一个部门 -->
</resultMap>
<!-- 如果查100个用户 → 1(主查询) + 100(部门查询) = 101次SQL -->xml
<!-- ✅ 推荐:Join 查询 → 一次SQL,无N+1 -->
<select id="selectUserWithDept" resultMap="UserWithDept">
SELECT u.id, u.user_name, u.email, u.status,
d.id AS dept_id, d.dept_name AS dept_dept_name, <!-- ← 加前缀 -->
r.id AS role_id, r.role_name AS role_role_name
FROM sys_user u
LEFT JOIN sys_dept d ON u.dept_id = d.id
LEFT JOIN sys_user_role ur ON u.id = ur.user_id
LEFT JOIN sys_role r ON ur.role_id = r.id
WHERE u.id = #{id}
</select>
<!-- ❌ 避免:嵌套 select 导致 N+1 -->
<resultMap id="UserWithDeptNested" extends="BaseResultMap" type="com.example.UserVO">
<association property="dept" javaType="Department"
column="dept_id" select="selectDeptById"/> <!-- ← 每次查询一个部门 -->
</resultMap>
<!-- 如果查100个用户 → 1(主查询) + 100(部门查询) = 101次SQL -->模式 3: 动态 SQL 完整模式
模式 3: 动态 SQL 完整模式
xml
<select id="findByCondition" resultMap="BaseResultMap">
SELECT id, user_name, email, status, create_time
FROM sys_user
<where> <!-- ← 自动处理 AND/OR 前缀 -->
<if test="username != null and username != ''">
AND user_name LIKE CONCAT('%', #{username}, '%') <!-- ✅ 防注入 -->
</if>
<if test="status != null">
AND status = #{status}
</if>
<if test="deptId != null">
AND dept_id = #{deptId}
</if>
</where>
<if test="orderBy != null">
ORDER BY ${orderBy} <!-- ⚠️ 必须白名单校验 -->
</if>
</select>
<!-- 批量插入 -->
<insert id="batchInsert">
INSERT INTO sys_user (user_name, email, status)
VALUES
<foreach collection="list" item="user" separator=",">
(#{user.userName}, #{user.email}, #{user.status})
</foreach>
</insert>
<!-- 动态更新(set 自动去尾逗号) -->
<update id="updateSelective">
UPDATE sys_user
<set>
<if test="userName != null">user_name = #{userName},</if>
<if test="email != null">email = #{email},</if>
<if test="status != null">status = #{status},</if>
</set>
WHERE id = #{id}
</update>
<!-- choose/when/otherwise 多分支 -->
<select id="findByCondition" resultMap="BaseResultMap">
SELECT * FROM sys_user
<where>
<choose>
<when test="queryType == 'name'">AND user_name LIKE CONCAT('%', #{keyword}, '%')</when>
<when test="queryType == 'email'">AND email = #{keyword}</when>
<otherwise>AND status = 'ACTIVE'</otherwise>
</choose>
</where>
</select>xml
<select id="findByCondition" resultMap="BaseResultMap">
SELECT id, user_name, email, status, create_time
FROM sys_user
<where> <!-- ← 自动处理 AND/OR 前缀 -->
<if test="username != null and username != ''">
AND user_name LIKE CONCAT('%', #{username}, '%') <!-- ✅ 防注入 -->
</if>
<if test="status != null">
AND status = #{status}
</if>
<if test="deptId != null">
AND dept_id = #{deptId}
</if>
</where>
<if test="orderBy != null">
ORDER BY ${orderBy} <!-- ⚠️ 必须白名单校验 -->
</if>
</select>
<!-- 批量插入 -->
<insert id="batchInsert">
INSERT INTO sys_user (user_name, email, status)
VALUES
<foreach collection="list" item="user" separator=",">
(#{user.userName}, #{user.email}, #{user.status})
</foreach>
</insert>
<!-- 动态更新(set 自动去尾逗号) -->
<update id="updateSelective">
UPDATE sys_user
<set>
<if test="userName != null">user_name = #{userName},</if>
<if test="email != null">email = #{email},</if>
<if test="status != null">status = #{status},</if>
</set>
WHERE id = #{id}
</update>
<!-- choose/when/otherwise 多分支 -->
<select id="findByCondition" resultMap="BaseResultMap">
SELECT * FROM sys_user
<where>
<choose>
<when test="queryType == 'name'">AND user_name LIKE CONCAT('%', #{keyword}, '%')</when>
<when test="queryType == 'email'">AND email = #{keyword}</when>
<otherwise>AND status = 'ACTIVE'</otherwise>
</choose>
</where>
</select>模式 4: SQL 片段复用
模式 4: SQL 片段复用
xml
<sql id="BaseColumns">
id, user_name, email, status, create_time, update_time
</sql>
<select id="selectById" resultMap="BaseResultMap">
SELECT <include refid="BaseColumns"/>
FROM sys_user WHERE id = #{id}
</select>xml
<sql id="BaseColumns">
id, user_name, email, status, create_time, update_time
</sql>
<select id="selectById" resultMap="BaseResultMap">
SELECT <include refid="BaseColumns"/>
FROM sys_user WHERE id = #{id}
</select>模式 5: 注解方式(简单查询)
模式 5: 注解方式(简单查询)
java
@Select("SELECT * FROM sys_user WHERE id = #{id}")
@Results(id = "userMap", value = {
@Result(column = "user_name", property = "userName"),
@Result(column = "dept_id", property = "deptId")
})
User findById(Long id);java
@Select("SELECT * FROM sys_user WHERE id = #{id}")
@Results(id = "userMap", value = {
@Result(column = "user_name", property = "userName"),
@Result(column = "dept_id", property = "deptId")
})
User findById(Long id);模式 6: 排序字段白名单校验
模式 6: 排序字段白名单校验
java
// ✅ 安全:校验排序字段在白名单中
private static final Set<String> SORT_COLUMNS = Set.of(
"create_time", "update_time", "user_name", "status"
);
public List<User> findByCondition(String orderBy, boolean asc) {
if (!SORT_COLUMNS.contains(orderBy)) {
throw new SecurityException("非法排序字段: " + orderBy);
}
// 传入 ${orderBy} 安全使用
}java
// ✅ 安全:校验排序字段在白名单中
private static final Set<String> SORT_COLUMNS = Set.of(
"create_time", "update_time", "user_name", "status"
);
public List<User> findByCondition(String orderBy, boolean asc) {
if (!SORT_COLUMNS.contains(orderBy)) {
throw new SecurityException("非法排序字段: " + orderBy);
}
// 传入 ${orderBy} 安全使用
}Gotchas
常见陷阱
- 会加引号自动转义,
#{}直接拼接 — 用户输入必须用 #{}${} - 用于动态表名/列名/排序时 — 必须白名单校验,否则 SQL 注入
${} - association 的 select 属性是延迟加载 — 每个关联触发一次查询 = N+1,用 Join 查询替代
- resultType 和 resultMap 不能同时使用 — 二选一
- Mapper 接口和 XML 必须在同一 package 路径 — 否则配置 mybatis.mapper-locations
- Spring Boot 默认开启驼峰映射 —
mybatis.configuration.map-underscore-to-camel-case=true - @Select/@Results 不定义 @ResultMap ID — 不能在 XML 中复用
- JOIN 查询中 resultMap columnPrefix — 解决同名字段的唯一方式,比写别名更简洁
- 不如
WHERE 1=1—<where>自动处理 AND/OR 前缀,更优雅<where> - 注意 IN 列表为空 — 空列表导致 SQL 语法错误,提前判空
<foreach> - PageHelper 分页的原理是 ThreadLocal — 分页后必须紧跟查询,中间不能有其他操作
- MyBatis 二级缓存慎用 — 跨 session 缓存导致数据不一致,分布式环境不要用
- 会添加引号并自动转义,
#{}直接拼接 — 用户输入必须使用${}#{} - 在动态表名、列名或排序中使用 时 — 必须进行白名单校验,否则会有 SQL 注入风险
${} - association 的 select 属性是延迟加载 — 每个关联都会触发一次查询,即 N+1,请改用 Join 查询
- resultType 和 resultMap 不能同时使用 — 二选一
- Mapper 接口和 XML 必须位于同一 package 路径 — 否则需要配置
mybatis.mapper-locations - Spring Boot 默认启用驼峰映射 —
mybatis.configuration.map-underscore-to-camel-case=true - @Select/@Results 未定义 @ResultMap ID — 无法在 XML 中复用
- JOIN 查询中的 resultMap columnPrefix — 是解决同名字段问题的唯一方式,比编写别名更简洁
- 不如
WHERE 1=1—<where>会自动处理 AND/OR 前缀,更加简洁<where> - 使用 时注意 IN 列表为空 — 空列表会导致 SQL 语法错误,应提前判空
<foreach> - PageHelper 分页基于 ThreadLocal 实现 — 分页后必须紧跟查询,中间不能执行其他操作
- 谨慎使用 MyBatis 二级缓存 — 跨 session 缓存可能导致数据不一致,在分布式环境中不要使用
Data Privacy
数据隐私
本技能不收集、存储或传输任何用户数据。
本 skill 不收集、存储或传输任何用户数据。