MyBatis XML 映射文件 （通常是以 .xml 结尾的文件，例如 UserMapper.xml）是 MyBatis 框架的重要组成部分，主要用于定义 SQL语句 、结果映射关系 以及 参数绑定。它的作用是将 Java 方法与 SQL 语句关联起来，实现持久化操作（如查询、插入、更新和删除）。
以下是关于 MyBatis XML 映射文件的详细说明：
1. XML 映射文件的作用
1.1 定义 SQL 语句
- MyBatis 的核心功能是操作数据库，XML 映射文件提供了对 SQL 的直接控制。
- 开发者可以在 XML 中定义复杂的 SQL 查询语句，而不是将其硬编码在 Java 方法中。
1.2 参数绑定
- XML 映射文件可以将 Java 对象的属性（或方法参数）与 SQL 语句中的占位符绑定，从而实现动态参数注入。
1.3 定义结果映射
- 映射文件可以指定 SQL 查询结果如何映射到 Java 对象。
- 支持将数据库表的列映射到 Java 对象的属性上，甚至支持嵌套映射。
1.4 动态 SQL
- XML 文件可以实现动态 SQL，通过
<if>、<choose>、<foreach>等标签动态生成 SQL。
2. XML 映射文件的组成结构
2.1 基本结构
以下是 MyBatis XML 映射文件的基本结构：
xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.UserMapper">
<!-- 查询语句 -->
<select id="getUserById" parameterType="int" resultType="com.example.entity.User">
SELECT * FROM users WHERE id = #{id}
</select>
<!-- 插入语句 -->
<insert id="insertUser" parameterType="com.example.entity.User">
INSERT INTO users (name, email) VALUES (#{name}, #{email})
</insert>
<!-- 更新语句 -->
<update id="updateUser" parameterType="com.example.entity.User">
UPDATE users SET name = #{name}, email = #{email} WHERE id = #{id}
</update>
<!-- 删除语句 -->
<delete id="deleteUserById" parameterType="int">
DELETE FROM users WHERE id = #{id}
</delete>
</mapper>2.2 关键部分说明
-
<mapper>：- 根标签，表示这是一个 MyBatis 映射文件。
namespace：命名空间，用于区分不同的 Mapper 接口。
-
SQL 标签：
<select>：定义SELECT查询语句。<insert>：定义INSERT插入语句。<update>：定义UPDATE更新语句。<delete>：定义DELETE删除语句。
-
属性：
id：映射的方法名，与 Java 接口中的方法对应。parameterType：传入参数的 Java 类型。resultType：返回结果的 Java 类型（<select>中使用）。
3. XML 映射文件的常见功能
3.1 参数绑定
MyBatis 支持通过 #{} 占位符绑定参数。例如：
xml
<select id="getUserById" parameterType="int" resultType="com.example.entity.User">
SELECT * FROM users WHERE id = #{id}
</select>#{id}：表示将方法传入的id参数注入到 SQL 中。
3.2 结果映射
可以将查询结果的字段与 Java 对象的属性映射。例如：
xml
<select id="getUserById" parameterType="int" resultMap="UserResultMap">
SELECT id, name, email FROM users WHERE id = #{id}
</select>
<resultMap id="UserResultMap" type="com.example.entity.User">
<id column="id" property="id" />
<result column="name" property="name" />
<result column="email" property="email" />
</resultMap><resultMap>：定义字段与属性的映射关系。column：数据库表的字段名。property：Java 对象的属性名。
3.3 动态 SQL
MyBatis 提供动态 SQL 标签，用于生成灵活的 SQL 查询：
3.3.1 <if> 标签
根据条件动态生成 SQL：
xml
<select id="getUsersByCondition" parameterType="map" resultType="com.example.entity.User">
SELECT * FROM users WHERE 1=1
<if test="name != null">
AND name = #{name}
</if>
<if test="email != null">
AND email = #{email}
</if>
</select>test：判断条件。
3.3.2 <foreach> 标签
用于处理集合参数（如列表）：
xml
<select id="getUsersByIds" parameterType="list" resultType="com.example.entity.User">
SELECT * FROM users WHERE id IN
<foreach item="id" index="index" collection="list" open="(" separator="," close=")">
#{id}
</foreach>
</select>collection：指定集合参数的名字（如list）。item：每次循环的当前项。separator：分隔符（如,）。open和close：括号或其他包装字符。
3.4 引用公共 SQL 片段
通过 <sql> 定义公共 SQL 片段，并在其他地方引用：
xml
<sql id="BaseColumnList">
id, name, email
</sql>
<select id="getAllUsers" resultType="com.example.entity.User">
SELECT <include refid="BaseColumnList" /> FROM users
</select><include>：用于引用id为BaseColumnList的 SQL 片段。
4. MyBatis XML 映射文件的优点
- SQL 独立性：SQL 语句与 Java 代码分离，便于管理和维护。
- 灵活性：支持复杂的动态 SQL 生成。
- 可重用性 ：通过
<sql>定义公共片段，避免重复代码。 - 可扩展性：支持复杂的结果映射和嵌套查询。
5. XML 映射文件和 Mapper 接口的关系
-
XML 映射文件中的
id属性与 Mapper 接口的方法名一一对应。 -
在接口中定义方法，例如：
javapublic interface UserMapper { User getUserById(int id); void insertUser(User user); } -
配置
Mapper：- XML 文件与接口的
namespace和方法名对应。 - MyBatis 自动将 XML 中的 SQL 映射到接口方法。
- XML 文件与接口的
总结
MyBatis 的 XML 映射文件在持久化操作中承担了非常重要的角色。它的主要作用是：
- 定义 SQL 语句。
- 管理参数和结果的映射关系。
- 实现动态 SQL 和复杂查询。
通过使用 XML 映射文件，开发者可以灵活地管理 SQL 语句，同时保持代码的清晰和可维护性。