MyBatis深度解析：XML/注解配置与动态SQL编写实战

news2025/6/7 0:28:18

引言

在现代Java企业级应用开发中，MyBatis作为一款优秀的持久层框架，因其灵活性和易用性广受开发者喜爱。相比Hibernate等全自动ORM框架，MyBatis提供了更接近SQL的开发体验，同时又不失面向对象的优雅。本文将深入探讨MyBatis的核心配置方式（XML与注解）以及强大的动态SQL功能，帮助开发者掌握MyBatis的精髓。

一、MyBatis配置方式详解

1. XML配置方式

XML配置是MyBatis最传统也是最强大的配置方式，提供了完整的配置能力和清晰的层次结构。

1.1 全局配置文件(mybatis-config.xml)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <!-- 环境配置 -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis_db"/>
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
      </dataSource>
    </environment>
  </environments>
  
  <!-- 映射文件配置 -->
  <mappers>
    <mapper resource="mapper/UserMapper.xml"/>
  </mappers>
</configuration>

1.2 Mapper 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.dao.UserMapper">
  
  <!-- 结果映射 -->
  <resultMap id="userResultMap" type="User">
    <id property="id" column="user_id"/>
    <result property="username" column="user_name"/>
    <result property="email" column="user_email"/>
  </resultMap>
  
  <!-- 查询语句 -->
  <select id="selectUserById" resultMap="userResultMap">
    SELECT * FROM users WHERE user_id = #{id}
  </select>
  
  <!-- 插入语句 -->
  <insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
    INSERT INTO users(user_name, user_email) 
    VALUES(#{username}, #{email})
  </insert>
</mapper>

XML配置的优势：

集中管理SQL，便于维护
支持复杂的SQL和结果映射
提供完整的DTD验证，减少错误
支持动态SQL（后文详细介绍）

2. 注解配置方式

MyBatis 3.x开始提供了基于注解的配置方式，适合简单的CRUD操作。

2.1 常用注解

public interface UserMapper {
    
    @Select("SELECT * FROM users WHERE user_id = #{id}")
    @Results(id = "userResult", value = {
        @Result(property = "id", column = "user_id", id = true),
        @Result(property = "username", column = "user_name"),
        @Result(property = "email", column = "user_email")
    })
    User selectUserById(Long id);
    
    @Insert("INSERT INTO users(user_name, user_email) VALUES(#{username}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insertUser(User user);
    
    @Update("UPDATE users SET user_name=#{username}, user_email=#{email} WHERE user_id=#{id}")
    int updateUser(User user);
    
    @Delete("DELETE FROM users WHERE user_id=#{id}")
    int deleteUser(Long id);
}

注解配置的优势：

代码与SQL在一起，直观明了
减少XML文件数量，简化项目结构
适合简单的SQL操作

注解与XML的选择建议：

简单CRUD：使用注解
复杂SQL、动态SQL：使用XML
大型项目：推荐以XML为主，注解为辅

二、动态SQL编写技巧

MyBatis最强大的特性之一就是动态SQL，它允许我们根据不同条件构建不同的SQL语句。

1. if元素

<select id="findUsers" resultType="User">
  SELECT * FROM users
  WHERE 1=1
  <if test="username != null">
    AND user_name LIKE #{username}
  </if>
  <if test="email != null">
    AND user_email = #{email}
  </if>
</select>

2. choose/when/otherwise元素

<select id="findActiveUsers" resultType="User">
  SELECT * FROM users
  WHERE status = 'ACTIVE'
  <choose>
    <when test="searchBy == 'name'">
      AND user_name LIKE #{keyword}
    </when>
    <when test="searchBy == 'email'">
      AND user_email LIKE #{keyword}
    </when>
    <otherwise>
      AND (user_name LIKE #{keyword} OR user_email LIKE #{keyword})
    </otherwise>
  </choose>
</select>

3. where元素

where元素会智能处理WHERE子句，避免出现WHERE AND这样的语法错误。

<select id="findUsers" resultType="User">
  SELECT * FROM users
  <where>
    <if test="username != null">
      user_name LIKE #{username}
    </if>
    <if test="email != null">
      AND user_email = #{email}
    </if>
  </where>
</select>

4. set元素

set元素用于UPDATE语句，智能处理逗号问题。

<update id="updateUser">
  UPDATE users
  <set>
    <if test="username != null">user_name=#{username},</if>
    <if test="email != null">user_email=#{email},</if>
  </set>
  WHERE user_id=#{id}
</update>

5. foreach元素

处理集合遍历，常用于IN条件。

<select id="findUsersByIds" resultType="User">
  SELECT * FROM users
  WHERE user_id IN
  <foreach item="id" collection="ids" open="(" separator="," close=")">
    #{id}
  </foreach>
</select>

6. bind元素

创建变量并绑定到上下文，可用于模糊查询等场景。

<select id="searchUsers" resultType="User">
  <bind name="pattern" value="'%' + keyword + '%'" />
  SELECT * FROM users
  WHERE user_name LIKE #{pattern}
  OR user_email LIKE #{pattern}
</select>

7. 动态SQL的最佳实践

避免过度复杂：动态SQL虽然强大，但过度使用会使SQL难以维护
性能考虑：复杂的动态SQL可能影响执行计划，需关注性能
测试覆盖：确保测试所有可能的条件分支
注释说明：为复杂的动态SQL添加注释

三、高级技巧与性能优化

1. 结果映射的高级用法

<resultMap id="detailedUserResultMap" type="User">
  <constructor>
    <idArg column="user_id" javaType="long"/>
    <arg column="user_name" javaType="String"/>
  </constructor>
  <result property="email" column="user_email"/>
  <association property="department" javaType="Department">
    <id property="id" column="dept_id"/>
    <result property="name" column="dept_name"/>
  </association>
  <collection property="roles" ofType="Role">
    <id property="id" column="role_id"/>
    <result property="name" column="role_name"/>
  </collection>
</resultMap>

2. 缓存配置

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

3. 批量操作优化

// 使用BatchExecutor
SqlSession sqlSession = sqlSessionFactory.openSession(ExecutorType.BATCH);
try {
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    for (User user : users) {
        mapper.insertUser(user);
    }
    sqlSession.commit();
} finally {
    sqlSession.close();
}