MyBatis 动态SQL

已于 2024-07-24 12:40:46 修改
阅读量717 收藏 24
点赞数 29
CC 4.0 BY-SA版权
分类专栏： web 文章标签： mybatis sql tomcat
于 2024-07-24 12:29:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/xycxycooo/article/details/140659799

MyBatis是一个优秀的持久层框架，它支持定制化SQL、存储过程以及高级映射。MyBatis的动态SQL是其核心特性之一，它允许我们在XML配置文件或注解中根据不同的条件动态生成SQL语句。动态SQL大大简化了SQL编写的复杂度，特别是在需要根据不同条件拼接SQL语句时。

目录

动态SQL的概念

动态SQL是指在运行时根据不同的条件动态生成SQL语句的技术。在MyBatis中，动态SQL主要通过以下几种元素来实现：

  1. if：用于条件判断，如果条件为真，则包含其中的SQL片段。
  2. choose (when, otherwise)：类似于Java中的switch语句，用于多条件选择。
  3. where：自动处理SQL中的WHERE关键字，避免手动拼接时出现语法错误。
  4. set：用于更新语句，自动处理SQL中的SET关键字。
  5. foreach：用于循环处理集合或数组，常用于批量操作。
  6. trim：用于自定义SQL片段的前后缀处理。

XML配置方式

1. if 元素

if元素用于条件判断，如果条件为真，则包含其中的SQL片段。

<select id="findActiveBlogWithTitleLike" resultType="Blog">
  SELECT * FROM Blog
  WHERE state = 'ACTIVE'
  <if test="title != null">
    AND title like #{title}
  </if>
</select>

在这个例子中，如果传入的参数title不为空，则会拼接AND title like #{title}到SQL语句中。

2. choose (when, otherwise) 元素

choose元素类似于Java中的switch语句，用于多条件选择。

<select id="findActiveBlog" resultType="Blog">
  SELECT * FROM Blog
  WHERE state = 'ACTIVE'
  <choose>
    <when test="title != null">
      AND title like #{title}
    </when>
    <when test="author != null and author.name != null">
      AND author_name like #{author.name}
    </when>
    <otherwise>
      AND featured = 1
    </otherwise>
  </choose>
</select>

在这个例子中，根据不同的条件选择不同的SQL片段。

3. where 元素

where元素自动处理SQL中的WHERE关键字，避免手动拼接时出现语法错误。

<select id="findActiveBlog" resultType="Blog">
  SELECT * FROM Blog
  <where>
    <if test="state != null">
      state = #{state}
    </if>
    <if test="title != null">
      AND title like #{title}
    </if>
    <if test="author != null and author.name != null">
      AND author_name like #{author.name}
    </if>
  </where>
</select>

在这个例子中，where元素会自动处理WHERE关键字，并去除不必要的AND或OR。

4. set 元素

set元素用于更新语句，自动处理SQL中的SET关键字。

<update id="updateBlog" parameterType="Blog">
  UPDATE Blog
  <set>
    <if test="title != null">title = #{title},</if>
    <if test="author != null">author_name = #{author.name}</if>
  </set>
  WHERE id = #{id}
</update>

在这个例子中，set元素会自动处理SET关键字，并去除不必要的逗号。

5. foreach 元素

foreach元素用于循环处理集合或数组，常用于批量操作。

<select id="selectPostIn" resultType="Post">
  SELECT * FROM Post
  WHERE id IN
  <foreach item="item" index="index" collection="list" open="(" separator="," close=")">
    #{item}
  </foreach>
</select>

在这个例子中，foreach元素会遍历传入的集合，生成IN子句。

6. trim 元素

trim元素用于自定义SQL片段的前后缀处理。

<select id="findActiveBlog" resultType="Blog">
  SELECT * FROM Blog
  <trim prefix="WHERE" prefixOverrides="AND |OR ">
    <if test="state != null">
      state = #{state}
    </if>
    <if test="title != null">
      AND title like #{title}
    </if>
  </trim>
</select>

在这个例子中，trim元素会自动添加WHERE前缀，并去除不必要的AND或OR。

在MyBatis中，<include>标签用于引用SQL片段，从而实现SQL语句的复用。通过定义和引用SQL片段，可以避免重复编写相同的SQL代码，提高代码的可维护性和可读性。

<include>标签的使用

1. 定义SQL片段

首先，我们需要在Mapper XML文件中定义SQL片段，使用<sql>标签来包裹这些片段。

<sql id="userColumns">
  id, name, email
</sql>

在这个例子中，我们定义了一个名为userColumns的SQL片段，包含了用户表的列名。

2. 引用SQL片段

接下来，我们可以在其他SQL语句中使用<include>标签来引用这些定义好的SQL片段。

<select id="findUserById" resultType="User">
  SELECT
    <include refid="userColumns"/>
  FROM user
  WHERE id = #{id}
</select>

在这个例子中，我们在SELECT语句中引用了之前定义的userColumns片段，从而避免了重复编写列名。

3. 带参数的SQL片段

有时候，我们可能需要在SQL片段中使用参数。可以通过在<include>标签中使用<property>子标签来传递参数。

<sql id="userColumns">
  ${alias}.id, ${alias}.name, ${alias}.email
</sql>

<select id="findUserById" resultType="User">
  SELECT
    <include refid="userColumns">
      <property name="alias" value="u"/>
    </include>
  FROM user u
  WHERE u.id = #{id}
</select>

在这个例子中，我们在SQL片段中使用了${alias}占位符，并在引用时通过<property>标签传递了具体的值u。

示例代码

以下是一个完整的示例，展示了如何定义和引用SQL片段：

<?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.demo.mapper.UserMapper">

  <!-- 定义SQL片段 -->
  <sql id="userColumns">
    id, name, email
  </sql>

  <!-- 引用SQL片段 -->
  <select id="findUserById" resultType="com.example.demo.entity.User">
    SELECT
      <include refid="userColumns"/>
    FROM user
    WHERE id = #{id}
  </select>

  <!-- 带参数的SQL片段 -->
  <sql id="userColumnsWithAlias">
    ${alias}.id, ${alias}.name, ${alias}.email
  </sql>

  <select id="findUserByIdWithAlias" resultType="com.example.demo.entity.User">
    SELECT
      <include refid="userColumnsWithAlias">
        <property name="alias" value="u"/>
      </include>
    FROM user u
    WHERE u.id = #{id}
  </select>

</mapper>

注解配置方式

MyBatis也支持使用注解来配置动态SQL，虽然注解方式在处理复杂SQL时不如XML灵活，但在简单场景下非常方便。

1. @SelectProvider

@SelectProvider注解用于动态生成查询语句。

public interface UserMapper {
  @SelectProvider(type = UserSqlProvider.class, method = "findUserById")
  User findUserById(int id);
}

public class UserSqlProvider {
  public String findUserById(int id) {
    return new SQL() {{
      SELECT("*");
      FROM("user");
      WHERE("id = #{id}");
    }}.toString();
  }
}

在这个例子中，@SelectProvider注解指定了生成SQL的类和方法。

2. @InsertProvider

@InsertProvider注解用于动态生成插入语句。

public interface UserMapper {
  @InsertProvider(type = UserSqlProvider.class, method = "insertUser")
  void insertUser(User user);
}

public class UserSqlProvider {
  public String insertUser(User user) {
    return new SQL() {{
      INSERT_INTO("user");
      VALUES("name", "#{name}");
      VALUES("email", "#{email}");
    }}.toString();
  }
}

在这个例子中，@InsertProvider注解指定了生成SQL的类和方法。

3. @UpdateProvider

@UpdateProvider注解用于动态生成更新语句。

public interface UserMapper {
  @UpdateProvider(type = UserSqlProvider.class, method = "updateUser")
  void updateUser(User user);
}

public class UserSqlProvider {
  public String updateUser(User user) {
    return new SQL() {{
      UPDATE("user");
      SET("name = #{name}");
      SET("email = #{email}");
      WHERE("id = #{id}");
    }}.toString();
  }
}

在这个例子中，@UpdateProvider注解指定了生成SQL的类和方法。

4. @DeleteProvider

@DeleteProvider注解用于动态生成删除语句。

public interface UserMapper {
  @DeleteProvider(type = UserSqlProvider.class, method = "deleteUser")
  void deleteUser(int id);
}

public class UserSqlProvider {
  public String deleteUser(int id) {
    return new SQL() {{
      DELETE_FROM("user");
      WHERE("id = #{id}");
    }}.toString();
  }
}

在这个例子中，@DeleteProvider注解指定了生成SQL的类和方法。

总结

MyBatis的动态SQL功能非常强大，能够大大简化SQL语句的编写和维护。无论是使用XML配置还是注解配置，都能灵活地处理各种复杂的SQL需求。通过合理使用动态SQL元素，可以有效提高开发效率和代码的可读性。希望以上内容能帮助你更好地理解和使用MyBatis的动态SQL功能。

mybatis 动态sql及参数传递
12-14
在实际开发过程中，我们往往需要编写复杂的SQL语句,拼接稍有不注意就会导致错误，Mybatis给开发者提供了动态SQL，大大降低了拼接SQL导致的错误。 动态标签 if标签 if标签通常用那个胡where语句,update语句,insert...
mybatis动态sql
04-28
MyBatis 提供了强大的动态 SQL 功能，它允许你根据参数的值来动态地构建 SQL 语句。这使得 SQL 语句更加灵活，能够适应不同的业务场景。 以下是一些常用的 MyBatis 动态 SQL 元素： <if>：用于条件判断。 xml ...
MyBatis动态SQL
buhuisuanfa的博客
05-22 3405
动态sql是Mybatis的强大功能特性之一，能够完成不同条件下的sql拼接以上是官方文档对动态SQL的介绍，简单来说动态SQL就是随着用户的输入或外部的条件的变化而变化的SQL语句，我们称为动态SQL。
MyBatis动态 SQL 的执行原理
些许风霜罢了
12-26 1487
MyBatis 的动态 SQL 提供了强大的功能，使得开发者能够灵活地生成复杂的 SQL 查询。通过使用。
Java MyBatis动态SQL
WYSCODER的博客
04-20 3258
MyBatis动态SQL
Mybatis 动态SQL
weixin_48644805的博客
04-02 1万+
Mybatis 动态SQL 一 .动态SQL 数组 array 使用foreach 标签 <!-- mybatis的集合操作 知识点: 如果遇到集合参数传递,需要将集合遍历 标签: foreach 循环遍历集合 标签属性说明: 1.collection 表示遍历的集合类型 1.1 数组 关键字 array 1.2 List集合 关键字 lis
Mybatis动态SQL语句大全
小学生波波
10-20 2467
Mybatis动态SQL语句大全
MyBatis动态SQL详解
热门推荐
SGLP521的博客
11-24 3万+
MyBatis动态SQL
mybatis动态SQL
weixin_52994410的博客
05-14 3236
一、动态sql的简述 什么是动态sql:在不同条件下拼接不同的sql Mybatis框架的动态sql技术是一种根据特定条件动态拼接SQl语句的功能，他存在的意义是为了解决拼接SQL语句字符串时的痛点问题。比如我们在用淘宝之类的软件在进行商品属性选择的时候，我们会发现我们可以选择的商品的属性有很多条件，其中一些条件可以选择也可以不选择，那么如果使用传统的方式进行查询，反而在拼接sql的时候会造成一些列的问题。 二、动态sql的使用案例 1.<if> 标签 根据 username 和
Mybatis动态sql
weixin_52394141的博客
07-18 1万+
Mybatis缓存以及实现动态sql
Mybatis动态SQL解析
想着百万年薪努力的小赵
07-20 1万+
由于前台传入的查询参数不同，所以写了很多的ifelse，还需要非常注意SQL语句里面的and、空格、逗号和转移的单引号这些，拼接和调试SQL就是一件非常耗时的工作。MyBaits的动态SQL就帮助我们解决了这个问题，它是基于OGNL表达式的。......
Mybatis-动态SQL
actavy的博客
09-01 2673
在页面原型中，列表上方的条件是动态的，是可以不传递的，也可以只传递其中的1个或者2个或者全部。而在我们刚才编写的SQL语句中，我们会看到，我们将三个条件直接写死了。如果页面只传递了参数姓名name 字段，其他两个字段 性别 和 入职时间没有传递，那么这两个参数的值就是null。此时，执行的SQL语句为：这个查询结果是不正确的。正确的做法应该是：传递了参数，再组装这个查询条件；如果没有传递参数，就不应该组装这个查询条件。
mybatis动态sql.zip
04-28
mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。 mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。mybatis动态sql，...
mybatis动态SQL语句
04-28
if 、where、set、trim、choose 、foreach等在mybatis中的具体用法，有具体实例可供参考，玩转mybatis
自己动手实现mybatis动态sql的方法
08-28
自己动手实现MyBatis动态SQL的方法 MyBatis是当前最流行的持久化层框架之一，它提供了强大的动态SQL功能，能够根据实际情况生成不同的SQL语句。dynamic SQL是MyBatis的核心功能之一，它能够根据用户的输入参数生成...
MybatisPlus的LambdaQueryWrapper用法
2301_79693537的博客
08-21 6360
【代码】MybatisPlus的LambdaQueryWrapper用法。
[特殊字符] 第9篇：《SQL高阶 SELECT 技巧：DISTINCT、ORDER BY、LIMIT 全家桶》
最新发布
张羽的博客
07-25 653
本文介绍了SQL查询的进阶技巧： 1️⃣ DISTINCT去重查询，获取唯一值 2️⃣ ORDER BY实现升序/降序排序，支持多条件 3️⃣ LIMIT限制返回条数，获取TOP N数据 4️⃣ LIMIT+OFFSET组合实现分页查询 通过实际案例演示了这些关键字的用法，并提供了分页查询的口诀和练习题，帮助开发者掌握SQL查询优化技巧，提升查询效率。
2025年PostgreSQL 详细安装教程（windows）
m0_71071763的博客
07-24 1198
PostgreSQL 详细安装教程
SQL中的占位符、@Param注解和方法参数
2401_83708850的博客
07-24 206
@Param("username") ：给参数 命名 ，告诉MyBatis“这个参数对应SQL中的 #{username} ”- String username ：方法的 形参变量 ，接收外部传入的用户名（比如用户登录时输入的值）- 作用 ：MyBatis的 参数占位符 ，会被替换成 @Param("username") 注解的参数值。- 分层设计 ：Java代码（方法参数）→ ORM框架（MyBatis注解）→ 数据库（表字段）的 解耦。- 位置 ：方法参数前的注解。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

需要重新演唱

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值