MyBatis的 `Mapper.xml` 文件配置详解（含完整代码示例）

MyBatis的 Mapper.xml 文件配置详解（含完整代码示例）

1. 核心配置标签及示例

1.1 根标签

所有配置必须包裹在 标签中，并指定命名空间（通常为 Mapper 接口的全限定名）。

PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

1.2 缓存配置

启用当前命名空间的二级缓存。

type="org.mybatis.caches.ehcache.EhcacheCache"

eviction="LRU"

flushInterval="60000"

size="1024"

readOnly="false"/>

1.3 结果映射

定义结果集到对象的映射关系，处理复杂字段（如关联查询）。

select="com.example.mapper.OrderMapper.selectOrdersByUserId"/>

1.4 基础 SQL 语句标签

SELECT * FROM user WHERE id = #{id}

SELECT * FROM user WHERE name = #{name}

INSERT INTO user (name, age) VALUES (#{name}, #{age})

SELECT LAST_INSERT_ID()

UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}

DELETE FROM user WHERE id = #{id}

1.5 动态 SQL 标签

SELECT * FROM user

AND name = #{name}

AND age > #{age}

SELECT * FROM user

WHERE id IN

#{id}

SELECT * FROM user

AND status = 1

AND status = 2

AND status = 0

1.6 和 代码片段复用

id, name, age, create_time

SELECT

FROM user

WHERE id = #{id}

1.7 动态 SQL 生成

通过 Java 类生成 SQL 语句：

// 动态 SQL 生成器类（DynamicSqlProvider.java）

public class DynamicSqlProvider {

public String selectUsersByCondition(Map params) {

String sql = "SELECT * FROM user WHERE 1=1";

if (params.containsKey("name")) {

sql += " AND name = #{name}";

}

return sql;

}

}

resultType="User"

parameterType="map"

flushCache="true"

timeout="10000"

statementType="PREPARED"

resultOrdered="true"

useCache="false">

FROM user

AND name = #{name}

1.8 主键生成

INSERT INTO user (name, age) VALUES (#{name}, #{age})

SELECT LAST_INSERT_ID()

1.9 结果映射高级用法

select="com.example.mapper.OrderMapper.selectOrdersByUserId"/>

1.10 标签

在 SQL 中动态绑定变量：

SELECT * FROM user WHERE name LIKE #{dynamicParam}

1.11 标签的高级属性

resultType="User"

parameterType="long"

flushCache="true"

timeout="10000"

statementType="PREPARED"

resultOrdered="true"

useCache="false">

SELECT * FROM user WHERE id = #{id}

2. 完整 Mapper.xml 示例

PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-mapper.dtd">

id, name, age, create_time

SELECT

u.id, u.name, u.age,

d.dept_id, d.dept_name

FROM user u

LEFT JOIN department d ON u.dept_id = d.dept_id

WHERE u.id = #{id}

SELECT

FROM user

AND name = #{name}

AND age > #{age}

INSERT INTO user (name, age) VALUES (#{name}, #{age})

SELECT LAST_INSERT_ID()

UPDATE user

name = #{name},

age = #{age},

WHERE id = #{id}

DELETE FROM user WHERE id = #{id}

SELECT

FROM user

WHERE id = #{id}

SELECT * FROM user

WHERE id IN

#{id}

select="com.example.mapper.OrderMapper.selectOrdersByUserId"/>

SELECT * FROM user WHERE id = #{id}

3. 标签分类及作用表格

标签作用示例关键属性定义 Mapper 的根标签，指定命名空间。namespace（必填）启用当前命名空间的二级缓存。type, eviction, flushInterval, size, readOnly定义结果集到对象的映射关系。...id, type, extends映射主键字段。column, property映射普通字段。column, property映射一对一关联对象。...property, javaType, columnPrefix映射一对多关联对象。property, ofType, column, select定义查询语句。...id, resultType, resultMap, parameterType, flushCache, useCache定义插入语句。...id, parameterType, useGeneratedKeys, keyProperty定义更新语句。...id, parameterType, flushCache, timeout定义删除语句。...id, parameterType, flushCache定义可复用的 SQL 片段。id, name, ageid引用 定义的片段。refid条件判断。AND name = #{name}test, , 多条件分支。 ... ... test自动处理 WHERE 子句前缀。 AND name = #{name} 无自动处理 UPDATE 的 SET 子句。 name = #{name}, 无遍历集合参数（如 IN 子句）。item, collection, open, separator, close在 SQL 中动态绑定变量。name, value自定义主键生成逻辑。...keyProperty, resultType, order通过 Java 类动态生成 SQL。 factory, method, paramETER

4. 标签属性详解

4.1 标签属性

属性说明id唯一标识符，对应 Mapper 接口方法名。resultType返回结果的 Java 类型（全限定名或别名）。resultMap引用 的 ID。parameterType参数类型（可选，MyBatis 可自动推断）。flushCache是否刷新缓存（默认 false）。useCache是否使用二级缓存（默认根据全局配置）。

4.2 标签属性

属性说明id唯一标识符，供其他标签引用。type映射的目标类（全限定名或别名）。extends继承其他 的配置。

4.3 动态 SQL 标签属性

标签属性说明test条件表达式。无相当于 Java 的 switch。test分支条件。无默认分支。collection需要遍历的集合参数名。item当前元素的变量名。open, close遍历结果的前后缀（如 ( 和 )）。separator元素之间的分隔符（如逗号）。

5. 关联查询示例

select="com.example.mapper.OrderMapper.selectOrdersByUserId"/>

5. 完整示例代码说明

5.1 实体类（User.java）

public class User {

private Long id;

private String name;

private Integer age;

private Department department; // 一对一关联

private List orders; // 一对多关联

// Getters and Setters

}

5.2 Department.java

public class Department {

private Long deptId;

private String deptName;

// Getters and Setters

}

5.3 Order.java

public class Order {

private Long orderId;

private Long userId;

private String orderNo;

// Getters and Setters

}

6. 配置项总结表格

标签描述示例关键属性定义 Mapper 的根标签。namespace（必填）启用二级缓存。type, eviction, flushInterval, size, readOnly定义结果集映射规则。...id, type, extends映射主键字段。column, property映射普通字段。column, property映射一对一关联对象。...property, javaType, columnPrefix映射一对多关联对象。property, ofType, column, select

定义查询语句。...id, resultType, resultMap, parameterType定义插入语句。...id, useGeneratedKeys, keyProperty定义更新语句。...id, timeout, flushCache定义删除语句。...id, flushCache定义可复用的 SQL 片段。...id引用 定义的片段。refid条件判断。...test自动处理 WHERE 子句的 AND/OR 前缀。 ... 无自动处理 UPDATE 的 SET 子句的逗号。 ... 无遍历集合参数（如 IN 子句）。collection, item, open, separator, close动态绑定变量。name, value自定义主键生成逻辑。keyProperty, resultType, order通过 Java 类动态生成 SQL。...factory, method, paramETER

7. 关键配置说明

7.1 的高级用法

嵌套结果（嵌套查询）：

javaType="Department"

select="com.example.mapper.DepartmentMapper.selectById"/>

延迟加载：

column="dept_id"

select="com.example.mapper.DepartmentMapper.selectById"

fetchType="lazy"/>

7.2 动态 SQL 组合示例

SELECT * FROM user

AND name LIKE CONCAT('%', #{name}, '%')

AND age > #{age}

AND status = 1

AND status = 0

8. 常见问题与最佳实践

Q：如何处理一对多关联？

同步查询：在 SQL 中直接 JOIN 并使用 映射。延迟加载：通过 的 select 属性引用其他 Mapper 的查询方法。

Q：如何避免 SQL 注入？

使用 #{} 占位符，MyBatis 会自动进行预编译。对动态条件使用 和 标签。

Q：如何复用 SQL 片段？

通过 定义片段，用 引用。

9. 总结

核心标签：, , , 是基本 CRUD 操作。复杂场景：

使用 处理关联对象。通过 , , 实现动态 SQL。用 管理查询缓存。

通过合理使用这些标签，可以灵活实现复杂查询和对象映射。

Copyright © 2088 世界杯比赛用球_梅西世界杯 - shigushuilong.com All Rights Reserved.

友情链接