Java / MyBatis if 和多数据库支持

MyBatis if 和多数据库支持

1. 前言

动态 SQL 是 MyBatis 最标志性的特性之一。在其它框架中,你可能需要根据不同的条件来拼接 SQL,辗转在符号与条件的判断上,处理起来麻烦而且易错,而 MyBatis 的动态 SQL 可以让我们摆脱这种痛苦,简单而又高效的书写 SQL。

MyBatis 动态 SQL 由 OGNL 表达式和条件标签两部 分组成,我们将会分为多个小节进行介绍。

OGNL 表达式是动态 SQL 的基础,如果你还不了解,请务必点击学习一下。条件标签部分我们将会在四个小节中分别介绍,它们分别是MyBatis if 和多数据库支持(本小节),MyBatis choose和bind小节MyBatis where、set、trim小节MyBatis foreach小节

本小节,我们先来学习最基础的条件标签 if,以及如何使用 if 来让 MyBatis 来支持多数据库。

2. 定义

慕课解释:if 常用于 where 语句中,通过判断参数来决定在 select 语句中是否使用某个查询条件,或者在 update 语句中判断是否更新一个字段,还可以在 insert 语句中决定是否插入一个满足条件的值。

3. 实例

我们以一个实际的例子来看一下 if 是如何工作的。

<select id="selectUserByAgeAndScore" parameterType="com.imooc.mybatis.model.User" resultMap="userMap">
  SELECT * FROM imooc_user
  WHERE age = #{age}
  <if test="score != null">
    AND score = #{score}
  </if>
</select>

在 if 标签中,test 属性是 OGNL 的判断表达式。

selectUserByAgeAndScore 的作用是通过用户年龄和积分来查询用户,当 score 值为 null 时,if 判断不成立,此时生成的 SQL 语句为:

SELECT * FROM imooc_user WHERE age = ?

而当 if 成立时,生成的 SQL 语句为:

SELECT * FROM imooc_user WHERE age = ? AND score = ?

通过这样条件判断方式,MyBatis 能根据实际情况来动态生成 SQL 语句。

4. 实践

4.1 例1、动态查询用户

请使用 MyBatis 完成对 imooc_user 表动态查询用户的功能, username为必须的查询条件,年龄和积分若为 null 则不使用该字段进行过滤。

分析:

按照 MyBatis 的开发模式,先在 UserMapper.xml 文件中添加动态查询用户的 select 标签,然后在 UserMapper.java 中增加上对应的方法。

步骤:

首先,在 UserMapper.xml 中添加 select 标签,并在标签中写入 SQL,使用 if 来判断属性值是否为 null,若为 null,则不使用该字段进行查询。如下:

<select id="selectUserByNameCondition" parameterType="com.imooc.mybatis.model.User"
        resultType="com.imooc.mybatis.model.User">
  SELECT * FROM imooc_user
  WHERE username = #{username}
  <if test="age != null">
    AND age = #{age}
  </if>
  <if test="score != null">
    AND score = #{score}
  </if>
</select>

通过 if 对属性的判断,SQL 的过滤条件就会发生相应的变化。

然后在 UserMapper.java 中添加上对应的接口方法,方法接受 User对象作为参数。

package com.imooc.mybatis.mapper;

import org.apache.ibatis.annotations.Mapper;
import com.imooc.mybatis.model.User;

@Mapper
public interface UserMapper {
   User selectUserByNameCondition(User user);
}

结果:

通过如下代码,我们运行 selectUserByNameCondition 这个方法。

UserMapper userMapper = session.getMapper(UserMapper.class);
User condition = new User();
condition.setUsername("pedro");
condition.setScore(200);
User pedro = userMapper.selectUserByNameCondition(condition);
System.out.println(pedro);

condition 对象 username 和 score 属性均不为空,而 age 属性为空,因此最后所执行的 SQL 为:

SELECT * FROM imooc_user WHERE username = ? AND score = ? 

成功后,结果为:

User{id=2, username='pedro', age=24, score=200}

5. 多数据库支持

MyBatis 可以根据不同的数据库厂商执行不同的语句,这种多厂商的支持是基于配置文件中的 databaseId。

5.1 配置

首先在 MyBatis 的全局配置文件中添加如下配置:

<?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>
  <databaseIdProvider type="DB_VENDOR" />
</configuration>

在 configuration 中加入 databaseIdProvider 后,还需要在 databaseIdProvider 标签中添加上需要使用到的数据库名称,如:SQL Server。每一个 property 属性都代表了一个数据库,name 表示数据库厂商名称,value 用来设置别名。

<?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>
  <databaseIdProvider type="DB_VENDOR">
    <property name="SQL Server" value="sqlserver"/>
    <property name="MySQL" value="mysql"/>
    <property name="PostgreSQL" value="postgre"/>
  </databaseIdProvider>
</configuration>

5.2 使用

配置完毕后,我们就可以在 mapper xml 文件中,通过 if 来判断当前的数据库厂商,从而动态生成不同数据库的 SQL。

例如,PostgreSQL 支持使用 ||来拼接字符串,而 MySQL 需要使用 concat函数来拼接字符串。

因此,如果在模糊查询的时候,不同的数据库厂商需要不同的 SQL 语句,通过 if 来判断数据库厂商来生成对于的 SQL 语句。

如下:

<select id="selectUserByLikeName" resultType="com.imooc.mybatis.model.User">
  SELECT * FROM imooc_user
  WHERE username LIKE
  <if test="_databaseId == 'mysql'">
    CONCAT('%',#{username},'%')
  </if>
  <if test="_databaseId == 'postgre'">
    '%' || #{username} || '%'
  </if>
</select>

注意,这里 _databaseId 参数是由 MyBatis 提供的内置参数,对应于 databaseIdProvider 中配置的数据库名称。

通过 databaseIdProvider 配置,即时数据库厂商之间存在差异,但仍然可以通过动态 SQL 的形式来支持多数据库。

6. 小结

  • if 简单且好用,是动态 SQL 中的最基础的标签,一看便会。
  • 多数据库支持的应用场景其实较少,但如果真的需要,也可通过 MyBatis 来方便的实现。