MyBatis 入门之动态 SQL

在 Java 开发中，MyBatis 是一个非常流行的持久层框架，它提供了强大的 SQL 映射功能和动态 SQL 支持。动态 SQL 可以根据不同的条件动态地生成 SQL 语句，使得我们在处理复杂的数据库查询和更新操作时更加灵活和高效。本文将介绍 MyBatis 中的动态 SQL，并通过示例代码帮助大家快速入门。

一、什么是动态 SQL

动态 SQL 是指在 SQL 语句中包含一些逻辑判断和变量，根据不同的条件动态地生成不同的 SQL 语句。在 MyBatis 中，动态 SQL 是通过使用各种标签和表达式来实现的。这些标签和表达式可以根据传入的参数值来决定是否生成相应的 SQL 片段，从而实现动态的 SQL 语句生成。

二、MyBatis 中的动态 SQL 标签

MyBatis 提供了以下几种常用的动态 SQL 标签：

1. if 标签：用于根据条件判断是否生成 SQL 片段。如果条件成立，则生成相应的 SQL 片段；否则，不生成。

<select id="findUsersByCondition" parameterType="User" resultType="User">
	select * from user
	<where>
		<if test="username!= null">
			and username = #{username}
		</if>
		<if test="age!= null">
			and age = #{age}
		</if>
	</where>
</select>

在上面的代码中，findUsersByCondition 方法根据传入的 User 对象的 username 和 age 属性的值来动态生成 SQL 语句。如果 username 不为空，则在 SQL 语句中添加 and username = #{username} 条件；如果 age 不为空，则添加 and age = #{age} 条件。
2. choose、when、otherwise 标签：用于实现类似 switch-case-default 的逻辑。当有多个条件需要判断时，可以使用 choose 标签来包裹多个 when 标签和一个可选的 otherwise 标签。

<select id="findUsersByCondition" parameterType="User" resultType="User">
	select * from user
	<where>
		<choose>
			<when test="username!= null">
				and username = #{username}
			</when>
			<when test="age!= null">
				and age = #{age}
			</when>
			<otherwise>
				and gender = 'male'
			</otherwise>
		</choose>
	</where>
</select>

在上面的代码中，如果 username 不为空，则生成 and username = #{username} 条件；如果 age 不为空，则生成 and age = #{age} 条件；如果都不满足，则生成 and gender = 'male' 条件。

3. foreach 标签：用于遍历集合类型的参数，并根据遍历的结果生成 SQL 片段。

<select id="findUsersByIds" parameterType="java.util.List" resultType="User">
	select * from user
	<where>
		<if test="ids!= null and ids.size > 0">
			id in
			<foreach collection="ids" item="id" open="(" separator="," close=")">
				#{id}
			</foreach>
		</if>
	</where>
</select>

在上面的代码中，findUsersByIds 方法根据传入的 ids 列表参数来动态生成 SQL 语句。如果 ids 不为空且长度大于 0，则在 SQL 语句中添加 id in (...) 条件，并使用 foreach 标签遍历 ids 列表，将每个 id 值作为参数传入。

4. trim、where、set 标签：
   • trim 标签可以用来在 SQL 片段的前后添加或删除特定的字符串，并可以控制是否在条件存在时添加连接符（如 and、or）。
   • where 标签用于在 SQL 语句中添加 WHERE 关键字，并自动处理条件前面的多余连接符。
   • set 标签用于在 SQL 语句中添加 SET 关键字，并自动处理条件后面的多余逗号。

<update id="updateUser" parameterType="User">
	update user
	<set>
		<if test="username!= null">
			username = #{username},
		</if>
		<if test="age!= null">
			age = #{age},
		</if>
		<if test="gender!= null">
			gender = #{gender}
		</if>
	</set>
	<where>
		id = #{id}
	</where>
</update>

在上面的代码中，updateUser 方法根据传入的 User 对象的属性值来动态生成 SQL 语句。set 标签用于设置更新的字段，如果某个属性不为空，则将其添加到 SET 子句中，并在后面添加逗号。where 标签用于添加 WHERE 条件，确保只更新指定的用户。

三、动态 SQL 的使用示例

下面通过一个完整的示例来演示 MyBatis 中动态 SQL 的使用。假设我们有一个用户管理系统，需要根据不同的条件查询用户信息，并可以更新用户的信息。

1. 首先，创建一个 User 实体类：

public class User {
	private Integer id;
	private String username;
	private Integer age;
	private String gender;
	// 省略 getter 和 setter 方法
}

2. 然后，创建一个 UserMapper 接口：

public interface UserMapper {
	List<User> findUsersByCondition(User user);
	void updateUser(User user);
}

3. 接着，在 UserMapper.xml 文件中编写 SQL 映射语句：

<mapper namespace="com.example.UserMapper">
	<select id="findUsersByCondition" parameterType="User" resultType="User">
		select * from user
		<where>
			<if test="username!= null">
				and username = #{username}
			</if>
			<if test="age!= null">
				and age = #{age}
			</if>
			<if test="gender!= null">
				and gender = #{gender}
			</if>
		</where>
	</select>
	<update id="updateUser" parameterType="User">
		update user
		<set>
			<if test="username!= null">
				username = #{username},
			</if>
			<if test="age!= null">
				age = #{age},
			</if>
			<if test="gender!= null">
				gender = #{gender}
			</if>
		</set>
		<where>
			id = #{id}
		</where>
	</update>
</mapper>

4. 最后，在测试类中调用 UserMapper 的方法：

public class MyBatisTest {
	public static void main(String[] args) throws IOException {
		// 加载 MyBatis 配置文件
		String resource = "mybatis-config.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		// 获取 SqlSession
		SqlSession sqlSession = sqlSessionFactory.openSession();
		try {
			// 获取 UserMapper 接口的代理对象
			UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
			// 查询用户信息
			User user = new User();
			user.setUsername("admin");
			user.setAge(30);
			List<User> users = userMapper.findUsersByCondition(user);
			for (User u : users) {
				System.out.println(u);
			}
			// 更新用户信息
			User updateUser = new User();
			updateUser.setId(1);
			updateUser.setUsername("updatedAdmin");
			updateUser.setAge(35);
			userMapper.updateUser(updateUser);
			// 提交事务
			sqlSession.commit();
		} finally {
			// 关闭 SqlSession
			sqlSession.close();
		}
	}
}

在上面的示例中，我们首先通过 SqlSessionFactoryBuilder 构建了一个 SqlSessionFactory，然后从 SqlSessionFactory 中获取了一个 SqlSession。接着，通过 SqlSession 获取了 UserMapper 接口的代理对象，并调用了 findUsersByCondition 和 updateUser 方法来查询和更新用户信息。

四、总结

MyBatis 的动态 SQL 功能使得我们在处理复杂的数据库查询和更新操作时更加灵活和高效。通过使用各种动态 SQL 标签，我们可以根据不同的条件动态地生成 SQL 语句，从而减少了硬编码 SQL 的工作量，提高了代码的可维护性和可读性。在实际开发中，我们可以根据具体的业务需求，灵活运用 MyBatis 的动态 SQL 功能，来实现更加复杂的数据库操作。