数据库操作不再困难,MyBatis动态Sql标签解析

举报
战斧 发表于 2023/09/21 18:48:27 2023/09/21
【摘要】 使用MyBatis,或者MyBatis-plus,有一项重要的开发技能就是写动态sql,动态sql能帮我们省略很多复杂逻辑,也能帮我们解决一些格式问题,所以今天我们就来帮大家掌握这个动态sql一、动态sql是什么?假设有一个电商网站,需要根据用户提供的不同条件查询商品信息,比如说价格、商品名、类别等等,我们需要写出每个查询信息对应的SQL语句,例如SELECT * FROM Product ...




在这里插入图片描述

使用MyBatis,或者MyBatis-plus,有一项重要的开发技能就是写动态sql,动态sql能帮我们省略很多复杂逻辑,也能帮我们解决一些格式问题,所以今天我们就来帮大家掌握这个动态sql


一、动态sql是什么?

假设有一个电商网站,需要根据用户提供的不同条件查询商品信息,比如说价格、商品名、类别等等,我们需要写出每个查询信息对应的SQL语句,例如
SELECT * FROM Product WHERE price <= #{price};
SELECT * FROM Product WHERE productname = #{name}
SELECT * FROM Product WHERE type = #{type};

如果这样各种各样的筛选逻辑很多,我们就需要写很多条类似的SQL语句,而且还需要判断入参是否合理,是否为空等等。这样我们的sql就会非常的难以维护。此时,我们就需要利用到MyBatis的动态SQL

MyBatis的动态SQL是指在SQL语句中可以根据不同的条件动态生成不同的SQL语句,以适应不同的需求。动态SQL可以根据条件生成不同的SQL语句,比如WHERE条件、ORDER BY、动态判断等等,从而实现更灵活的SQL编写。动态SQL的主要作用是让SQL语句更加灵活、可重用和易维护,提高应用程序的灵活性和可扩展性

二、动态sql原理

MyBatis动态sql标签的实现原理主要是通过OGNL表达式和Java反射机制来实现的。

首先,MyBatis会将动态sql标签中的OGNL表达式解析成Java代码。解析过程中,MyBatis会根据OGNL表达式的类型来生成相应的Java代码片段。例如,当解析if标签时,如果判断条件中的OGNL表达式为布尔类型,则会生成一个if语句的Java代码片段。

其次,MyBatis会使用Java反射机制获取实体类的属性值,并将属性值传递给动态sql标签中的OGNL表达式进行判断。如果判断条件满足,则会将动态sql标签中的内容添加到SQL语句中;反之,则会忽略动态sql标签中的内容

总体来讲,MyBatis动态sql标签的实现原理就是将OGNL表达式解析成Java代码,并使用Java反射机制获取实体类属性值进行判断,以实现SQL语句的动态生成。myBtais整体运行流程可以看往期的 MyBatis+Springboot 启动到SQL执行全流程

三、动态标签解释

1. if 标签

<if>标签允许你根据条件判断是否包含特定的SQL片段,用于构建灵活的查询语句,该标签的使用方法如下:

  1. 在需要动态生成条件的SQL语句中使用<if>标签。
  2. <if>标签中添加一个test属性,用于指定一个boolean表达式,这个表达式会决定是否将当前条件语句包含在生成的SQL语句中。
  3. <if>  </if>标签中设置需要动态生成的条件语句。
<select id="getUser" resultMap="userResultMap">
  SELECT * FROM user
  where 1 = 1
    <if test="name != null">
      AND name = #{name}
    </if>
    <if test="age != null">
      AND age = #{age}
    </if>
</select>

在这个示例中,<if>标签用于根据条件动态生成SQL语句中的条件语句。如果传递到这个方法的参数中包含一个非空的name属性,那么就会在SQL语句中添加一个“name = #{name}”的条件语句;如果包含一个非空的age属性,那么就会在SQL语句中添加一个“age = #{age}”的条件语句。

需要注意的是,使用标签时,必须要用“AND”或“OR”将多个<if>标签组合在一起,否则会出现语法错误。此外,还需要注意在使用标签时,SQL语句的正确性和性能的折中。太多的动态条件可能会导致SQL语句生成的复杂度增加,从而影响查询的性能

2 choose、when 和 otherwise 标签

<choose><when><otherwise>标签通常一起使用来实现条件分支查询。这种方式类似于Java中的switch语句或者if-else语句

  • 其中,<choose>标签类似于Java中的switch语句,表示一个选择分支,包含多个<when><otherwise>标签。
  • <when>标签类似于Java中的case语句,用于指定分支条件。当条件满足时,执行<when>标签内的SQL语句。
  • <otherwise>标签类似于Java中的default语句,用于指定默认条件分支。当其他分支条件都不满足时,执行<otherwise>标签内的SQL语句。
<select id="getUsersByAgeAndName" parameterType="map" resultMap="userMap">
  SELECT * FROM users
  <where>
    <choose>
      <when test="age != null and name != null">
        age = #{age} AND name = #{name}
      </when>
      <when test="age != null">
        age = #{age}
      </when>
      <when test="name != null">
        name = #{name}
      </when>
      <otherwise>
        1=1
      </otherwise>
    </choose>
  </where>
</select>

如上,我们使用<choose><when><otherwise>标签来实现条件分支查询。这个查询可以根据参数中的年龄和名字来查找用户记录,也可以只根据年龄或者名字来查找,或者不加任何条件查询所有的用户记录

3 trim 标签

<trim>标签用于修剪生成的SQL语句,可以用于移除不必要的关键字,特别是在拼接多个条件时非常有用,其主要是用于确定子句中的前缀与后缀。

<trim> 标签具有以下属性:
prefixOverrides:要删除的前缀字符串,可以以“|”分割,添加多个词
suffixOverrides:要删除的后缀字符串,可以以“|”分割,添加多个词
prefix:要添加到 SQL 语句的前缀字符串
suffix:要添加到 SQL 语句的后缀字符串

<select id="findUserByName" parameterType="java.lang.String" resultType="User">
  SELECT * FROM user
  <trim prefix="WHERE" prefixOverrides="OR | AND ">
    <if test="name != null and name != ''">
      AND name = #{name}
    </if>
    <if test="age != null">
      AND age = #{age}
    </if>
  </trim>
</select>

在这个示例中, <trim> 标签用于动态构建 WHERE 子句。如果它会删除前缀中的 OR 或 AND 关键字,并将 WHERE 关键字添加到 SQL 语句中。

当然,你也许会想,如果我把 prefixOverrides 和 prefix 是设置成一个词,那这个词还会不会插入到子句句首呢?答案是会的,因为这里的逻辑是先删除prefixOverrides指定字符串,再添加prefix指定字符串

4 foreach 标签

标签用于循环处理集合类型的参数,生成多次重复的SQL片段,该标签可以用于循环遍历一个集合或数组,并在SQL语句中使用它的值。以下是标签的使用方法:。

遍历集合

<select id="findUserById" parameterType="java.lang.Integer">
	SELECT * FROM table WHERE id IN
	<foreach collection="list" item="item" open="(" separator="," close=")">
  		#{item}
	</foreach>
</select>

其中,collection属性指定要遍历的集合,item属性指定集合中每个元素的别名,open属性指定在开始时添加的字符串,separator属性指定在每个元素之间添加的字符串,close属性指定在结束时添加的字符串。

例如,如果list是一个包含1、2、3的List对象,这个标签会生成以下SQL语句:

SELECT * FROM table WHERE id IN (1,2,3)

遍历数组

<foreach collection="array" item="item" open="(" separator="," close=")">
  #{item}
</foreach>

这个标签与遍历集合的标签非常相似,只不过把collection属性改为了数组对象

遍历Map

假设我们有这样一个map

Map<String, Object> searchCriteria = new HashMap<>();
searchCriteria.put("username", "john");
searchCriteria.put("age", 25);
searchCriteria.put("city", "New York");

然后我们配上这样的xml

<select id="searchUsers" parameterType="map" resultType="User">
    SELECT * FROM user
    <foreach collection="searchCriteria" item="value" index="key" separator="AND" open="WHERE">
          ${key} = #{value}
    </foreach>
</select>

其中,collection属性指定要遍历的Map集合,index属性指定键的别名,item属性指定值的别名,open属性指定在开始时添加的字符串,separator属性指定在每个元素之间添加的字符串。

最后我们能得到这样的sql

SELECT * FROM user WHERE username = "john" AND age = 25 AND city = "New York"

5 set 标签

标签通常用于动态生成UPDATE语句的SET部分,可自动生成逗号分隔的键值对,<set>标签通常包含多个标签或者标签,用于动态生成要更新的列和值。

  UPDATE user
    <set>
      <if test="username != null">
        username = #{username},
      </if>
      <if test="password != null">
        password = #{password},
      </if>
      <if test="email != null">
        email = #{email},
      </if>
    </set>
  WHERE id = #{id}
</update>

在这个示例中,标签根据传入的参数动态生成SET部分。set 元素会动态地在行首插入 SET 关键字,并会删掉额外的逗号

6 bind 标签

<bind>用于将一个表达式绑定到一个变量上。绑定的变量可以在后面的SQL语句中引用。通常,标签被用于简化SQL语句中的重复表达式,提高SQL语句的可读性和可维护性。

<select id="findUsers" parameterType="String" resultMap="userResultMap">
  <bind name="pattern" value="'%' + name + '%'"/>
  SELECT * FROM user WHERE name LIKE #{pattern}
</select>

在上面的例子中,标签用于将一个字符串表达式绑定到名为pattern的变量上。变量的值是一个由‘%’,‘name’和‘%’组成的字符串,其中‘name’是一个参数。在后面的SQL语句中,#{pattern}即可引用绑定的变量。

在标签中,name属性指定变量的名称,value属性指定变量的值。可以在value属性中使用表达式,变量名和参数Map中的键。

除了绑定表达式到变量上,标签还可以用于绑定参数值到变量上。例如:

<select id="findUsersByAge" parameterType="int" resultMap="userResultMap">
  <bind name="minAge" value="age - 5"/>
  <bind name="maxAge" value="age + 5"/>
  SELECT * FROM user WHERE age BETWEEN #{minAge} AND #{maxAge}
</select>

在上面的例子中,<bind>标签用于将一个整数参数值绑定到名为minAge和maxAge的变量上。变量的值是通过计算参数值得到的。在后面的SQL语句中,#{minAge}和#{maxAge}即可引用绑定的变量。

总之,<bind>标签是一个非常强大的MyBatis功能,可以提高SQL语句的可读性和可维护性。在开发MyBatis应用程序时,应该灵活使用标签,以便更好地管理SQL语句。

7 sql 与 include 标签

<sql>标签用于定义可重用的SQL片段。在一个或多个SQL语句中,可以使用标签来引用这些SQL片段。


<sql id="userColumns">
	id, username, age
</sql>

<select id="getAllUsers" resultType="User">
    SELECT <include refid="userColumns" />
    FROM user
</select>

<select id="getUsersByName" parameterType="String" resultType="User">
    SELECT <include refid="userColumns" />
    FROM user
    WHERE
    NAME = #{name}
</select>

上述例子中,<include>标签引用了一个名为"userColumns"的SQL片段。引用的方式是通过refid属性指定片段的ID。所有引用的SQL片段都会被添加到原始SQL语句中。这样,其他sql,如果也是使用这几个字段,则都可以引用

8. where 标签

<where> 标签的作用是用来包裹一个或多个 SQL 条件语句,如果这些条件都满足,则会被加入到 SELECT 或 UPDATE 语句中,否则不会。它的使用方法如下:

1.将多个条件语句用 标签包裹起来。

<select id="selectByCondition" parameterType="java.util.Map" resultMap="userMap">
  select * from user
  <where>
    <if test="name != null and name!=''">
      and name like CONCAT('%',#{name},'%')
    </if>
    <if test="age != null">
      and age = #{age}
    </if>
  </where>
</select>

2.在 SQL 语句中使用 <where> 标签时,会自动移除掉多余的 AND 或 OR,而在没有任何条件语句时,<where> 标签也会自动删除自身,以避免 SQL 语法错误。例如,上述代码在没有任何条件时,生成的 SQL 语句为:

select * from user

而当输入 age=20 时,生成的 SQL 语句为:

select * from user
  where age = 20

可以看出<where> 标签是 MyBatis 中一个非常有用的标签,它可以帮助我们更加方便地动态构建 SQL 语句,提高代码的可读性和可维护性。


总结

MyBatis的动态SQL功能极大地简化了数据库操作,使得针对不同查询需求的SQL语句生成变得灵活而高效。通过深入了解和掌握<if>、<choose>、<when>、<otherwise>、<trim>、<foreach>、<set>、<bind>和<sql>等核心标签,开发人员将大幅度减少因为参数不同,而写不同sql的麻烦,此时的sql会自己按预设逻辑变成不同的样式。因此,需要牢牢掌握。

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。