MyBatis使用动态SQL注解@SelectProvider、@InsertProvider、@UpdateProvider、@DeleteProvider

最新推荐文章于 2024-06-15 09:16:59 发布
最新推荐文章于 2024-06-15 09:16:59 发布
阅读量1w 收藏 41
点赞数 8
分类专栏： MyBatis 我の原创 文章标签： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/pan_junbiao/article/details/106763772
版权

MyBatis 3.x 版本提供了以下4个CRUD的高级注解。

@SelectProvider：用于构建动态查询SQL。

@InsertProvider：用于构建动态新增SQL。

@UpdateProvider：用于构建动态更新SQL。

@DeleteProvider：用于构建动态删除SQL。

动态SQL注解主要用于编写动态SQL。这里以@SelectProvider为例，它主要包含两个注解属性，其中，type表示工具类，method表示工具类的某个方法（用于返回具体的SQL语句）。

以下代码可以构建动态SQL，实现查询功能：

/**
 * 根据用户ID，获取用户信息
 * @author pan_junbiao
 */
@SelectProvider(type = UserSqlBuilder.class, method = "buildGetUserByIdSql")
public UserInfo getUserById(@Param("userId") int userId);

UserSqlBuilder工具类的代码如下：

public class UserSqlBuilder
{
    public String buildGetUserByIdSql(@Param("userId") int userId)
    {
        return new SQL()
        {
            {
                SELECT("*");
                FROM("tb_user");
                WHERE("user_id = #{userId}");
            }
        }.toString();
    }
}

【实例】使用MyBatis的动态SQL注解，实现用户信息的查询、新增、修改、删除操作。

1、创建数据表

在MySQL数据库中创建用户信息表（tb_user），并添加数据。

-- 判断数据表是否存在，存在则删除
DROP TABLE IF EXISTS tb_user;
 
-- 创建“用户信息”数据表
CREATE TABLE IF NOT EXISTS tb_user
( 
	user_id INT AUTO_INCREMENT PRIMARY KEY COMMENT '用户编号',
	user_name VARCHAR(50) NOT NULL COMMENT '用户名称',
	blog_url VARCHAR(50) NOT NULL COMMENT '博客地址',
	blog_remark VARCHAR(50) COMMENT '博客备注'
) COMMENT = '用户信息表';
 
-- 添加数据
INSERT INTO tb_user(user_name,blog_url,blog_remark) VALUES('pan_junbiao的博客','https://blog.csdn.net/pan_junbiao','您好，欢迎访问 pan_junbiao的博客');

2、创建项目

（1）创建SpringBoot项目，项目结构如下图：

（2）添加pom.xml配置信息

在pom.xml配置文件中添加MyBatis、 MySQL的JDBC数据库驱动。

<!-- MyBatis与SpringBoot整合依赖 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>

<!-- MySQL的JDBC数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.20</version>
</dependency>

（3）配置相关信息

将默认的application.properties文件的后缀修改为“.yml”，即配置文件名称为：application.yml，并配置以下信息：

spring:
  #DataSource数据源
  datasource:
    url: jdbc:mysql://localhost:3306/db_admin?useSSL=false&amp
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

#MyBatis配置
mybatis:
  type-aliases-package: com.pjb.entity #别名定义
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #指定 MyBatis 所用日志的具体实现，未指定时将自动查找
    map-underscore-to-camel-case: true #开启自动驼峰命名规则（camel case）映射
    lazy-loading-enabled: true #开启延时加载开关
    aggressive-lazy-loading: false #将积极加载改为消极加载（即按需加载）,默认值就是false
    lazy-load-trigger-methods: "" #阻挡不相干的操作触发，实现懒加载
    cache-enabled: true #打开全局缓存开关（二级环境），默认值就是true

2.1 创建实体类（Entity层）

在com.pjb.entity包中，创建UserInfo类（用户信息实体类）。

package com.pjb.entity;

/**
 * 用户信息实体类
 * @author pan_junbiao
 **/
public class UserInfo
{
    private int userId; //用户编号
    private String userName; //用户名称
    private String blogUrl; //博客地址
    private String blogRemark; //博客备注

    //省略getter与setter方法...
}

2.2 数据库映射层（Mapper层）

在com.pjb.mapper包中，创建UserMapper接口（用户信息Mapper动态代理接口）。

package com.pjb.mapper;

import com.pjb.entity.UserInfo;
import org.apache.ibatis.annotations.*;
import org.apache.ibatis.jdbc.SQL;
import org.springframework.stereotype.Repository;

/**
 * 用户信息Mapper动态代理接口
 * @author pan_junbiao
 **/
@Mapper
@Repository
public interface UserMapper
{
    /**
     * 根据用户ID，获取用户信息
     */
    @SelectProvider(type = UserSqlBuilder.class, method = "buildGetUserByIdSql")
    public UserInfo getUserById(@Param("userId") int userId);

    /**
     * 新增用户，并获取自增主键
     */
    @InsertProvider(type = UserSqlBuilder.class, method = "buildInsertUserSql")
    @Options(useGeneratedKeys = true, keyColumn = "user_id", keyProperty = "userId")
    public int insertUser(UserInfo user);

    /**
     * 修改用户
     */
    @UpdateProvider(type = UserSqlBuilder.class, method = "buildUpdateUserSql")
    public int updateUser(UserInfo user);

    /**
     * 删除用户
     */
    @DeleteProvider(type = UserSqlBuilder.class, method = "buildDeleteUserSql")
    public int deleteUser(@Param("userId") int userId);

    //建议将SQL Builder以映射器接口内部类的形式进行定义
    public class UserSqlBuilder
    {
        public String buildGetUserByIdSql(@Param("userId") int userId)
        {
            return new SQL()
            {
                {
                    SELECT("*");
                    FROM("tb_user");
                    WHERE("user_id = #{userId}");
                }
            }.toString();
        }

        public String buildInsertUserSql(UserInfo user)
        {
            return new SQL()
            {
                {
                    INSERT_INTO("tb_user");
                    VALUES("user_name", "#{userName}");
                    VALUES("blog_url", "#{blogUrl}");
                    VALUES("blog_remark", "#{blogRemark}");
                }
            }.toString();
        }

        public String buildUpdateUserSql(UserInfo user)
        {
            return new SQL()
            {
                {
                    UPDATE("tb_user");
                    SET("user_name = #{userName} ,blog_url=#{blogUrl} ,blog_remark=#{blogRemark}");
                    WHERE("user_id = #{userId}");
                }
            }.toString();
        }

        public String buildDeleteUserSql(@Param("userId") int userId)
        {
            return new SQL()
            {
                {
                    DELETE_FROM("tb_user");
                    WHERE("user_id = #{userId}");
                }
            }.toString();
        }
    }
}

3、运行测试

31. 查询操作

@Autowired
private UserMapper userMapper;

/**
 * 根据用户ID，获取用户信息
 * @author pan_junbiao
 */
@Test
public void getUserById()
{
    //获取用户编号为1的用户信息
    UserInfo userInfo = userMapper.getUserById(1);

    //打印结果
    System.out.println("用户编号：" + userInfo.getUserId());
    System.out.println("用户姓名：" + userInfo.getUserName());
    System.out.println("博客地址：" + userInfo.getBlogUrl());
    System.out.println("备注信息：" + userInfo.getBlogRemark());
}

执行结果： 

控制台打印的SQL语句与执行结果如下图：

3.2 新增操作

@Autowired
private UserMapper userMapper;

/**
 * 新增用户，并获取自增主键
 * @author pan_junbiao
 */
@Test
public void insertUser()
{
    //创建新用户
    UserInfo userInfo = userMapper.getUserById(1);
    userInfo.setUserName("pan_junbiao的博客");
    userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
    userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");

    //执行新增操作
    int result = userMapper.insertUser(userInfo);

    //打印结果
    System.out.println("新增用户完成！");
    System.out.println("执行结果：" + result);
    System.out.println("自增主键：" + userInfo.getUserId());
}

执行结果： 

控制台打印的SQL语句与执行结果如下图：

3.3 修改操作

@Autowired
private UserMapper userMapper;

/**
 * 修改用户
 * @author pan_junbiao
 */
@Test
public void updateUser()
{
    //修改用户
    UserInfo userInfo = userMapper.getUserById(2);
    userInfo.setUserName("pan_junbiao的博客_02");
    userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
    userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");

    //执行修改操作
    int result = userMapper.updateUser(userInfo);

    //打印结果
    System.out.println("修改用户完成！");
    System.out.println("修改结果：" + result);
}

执行结果： 

控制台打印的SQL语句与执行结果如下图：

3.4 删除操作

@Autowired
private UserMapper userMapper;

/**
 * 删除用户
 * @author pan_junbiao
 */
@Test
public void deleteUser()
{
    //执行修改操作
    int result = userMapper.deleteUser(2);

    //打印结果
    System.out.println("删除用户完成！");
    System.out.println("删除结果：" + result);
}

执行结果： 

控制台打印的SQL语句与执行结果如下图：

 

pan_junbiao
关注
  • 8
    点赞
  • 踩
  • 41
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
mybatis注解---@SelectProvider 使用手册
罗罗的1024
03-24 563
实现自己的UserSqlProvider，拼接SQL（参数最好是占位符#{}，防止sql 注入）并返回。注解 @SelectProvider 示例如下，其他@XXXProvider 参照即可。
mybatis 的@SelectProvider注解的使用
qq_38392777的博客
01-27 9539
又学习到了，今天翻着队友写的代码，我看到了个注解，起初还以为是自定义的，我搜了下才发现，竟然是mybatis自带的这个注解，我竟然不知道，又是孤陋寡闻的一天，记录一下这个注解。 查找了下这个注解发现这个注解是四个: 我看了下与@Select有啥区别，这个@SelectProvider是能够加多条件判断的，看下面的代码示例： @SelectProvider：用于构建动态查询SQL。 @InsertProvider：用于构建动态新增SQL。 @UpdateProvider：用于构建动态更新SQL。 @Delet
MyBatis 的 @SelectProvider 注解构建动态 SQL
最新发布
dazhong2012的专栏
06-15 855
是 MyBatis 提供的一个注解，它允许开发者通过编写 Java 方法来动态构建 SQL 语句。这种方法为开发者提供了更大的灵活性，可以根据业务需求或参数条件来构建复杂的 SQL 语句。首先，开发者需要定义一个 Java 类作为 SQL 提供者，该类中包含一个或多个返回 SQL 语句字符串的方法。// 根据参数动态构建 SQL注意：在上面的示例中，我们使用了 #{name} 和 #{age} 作为参数占位符。MyBatis 会自动将这些占位符替换为实际参数的值。
@SelectProvider的用法
weixin_45507672的博客
08-20 5333
首先在mapper里面写个方法 @SelectProvider(type = SalesOrderProvider.class, method = "selectSalesInformation") List<SalesInformation> selectSalesInformation(@Param("createDateStart") String createDateStart, @Param("createDateEnd") String createDateEnd);
Mybatis的SQL语句拼接之@SelectProvider用法
yuan__once的博客
09-14 1639
mybatis使用@SelectProvider、@InsertProvider动态拼接SQL语句。
mybatis示例：使用@SelectProvider注解，表的列名、比较操作符、待比较的值通过sql provider的方法参数传入
听海边涛声
01-06 655
mybatis示例：使用@SelectProvider注解，表的列名、比较操作符、待比较的值通过sql provider的方法参数传入
mybatis使用注解替代xml配置，动态生成Sql
05-10 368
mybatis使用注解替代xml配置时，遇到判断条件是否为null或者为空时，@Select很难搞定，不知道怎么办？ mybatis3中增加了使用注解来配置Mapper的新特性，使用 SelectProvider来动态生成sql。 典型的使用场景 1. 无参数@SelectProvide方法在Mapper接口方法上和@SelectProvide指定类方法上，均无参数：UserMap...
Mybatis使用@param注解四种情况解析
09-07
当一个方法接收多个参数时，如果不使用`@Param`注解，Mybatis将按照参数定义的顺序来匹配SQL语句中的占位符。例如： ```java @Mapper public interface UserMapper { Integer insert(@Param("username") String ...
SpringBoot整合MybatisSQL过滤@Intercepts的实现
08-19
在SpringBoot项目中，我们经常使用Mybatis作为持久层框架，而Mybatis的拦截器（@Intercepts）机制则提供了一种灵活的方式来扩展和定制SQL查询。本篇将详细讲解如何在SpringBoot环境中利用Mybatis的拦截器实现SQL过滤...
mybatis @Alias注解在类上的使用方式(推荐)
08-27
在MyBatis框架中，`@Alias`注解是一个非常实用的功能，它允许我们为Java实体类定义一个简短的别名，以便在Mapper XML文件中的`resultType`或者SQL查询中引用。这样做的好处是提高了代码的可读性和可维护性，避免了...
Mybatis中注解@MapKey的使用详解
09-01
在Mybatis框架中，@MapKey注解是一个非常实用的功能，它允许我们将查询结果转换成一个Map对象，其中键(key)由我们指定的字段值决定，值(value)则是查询返回的完整行数据。这在处理多条记录时特别有用，尤其是在结果...
mybatis-plus使用@EnumValue处理枚举类型的示例代码
09-07
在MyBatis-Plus中，`@EnumValue`是一个用于处理枚举类型的注解，它使得枚举可以与数据库中的字段进行映射。这个注解主要用于解决枚举类型在序列化和反序列化过程中的问题，确保数据在数据库和Java对象之间能够正确地...
MyBatis-Plus 如何在Mapper接口上使用@UpdateProvider注解？
奇妙的Bug之旅
01-05 1079
在实际开发中，我们有时候需要执行一些特定的更新操作，MyBatis-Plus提供了灵活的方式来实现这一点。我们可以使用@Update注解在Mapper接口中编写自定义的更新SQL语句。下面我们将演示如何在MyBatis-Plus中使用自定义SQL语句进行更新操作，并提供一个完整的实例来展示其用法。本文详细介绍了在MyBatis-Plus中如何在Mapper接口上使用@UpdateProvider注解，并提供了一个使用自定义SQL语句进行更新操作的实例。
@UpdateProvider 根据主键进行批量更新
MTonj的博客
02-19 1169
Mybatis中使用@UpdateProvider对数据进行批量更新 示例如下： InfoYearMapper中@UpdateProvider注解的接口是： @UpdateProvider(type = InfoYearMapperProvider.class, method = "batchUpdate") int batchUpdate(List<InfoYear> oldInfo); InfoYearMapperProvider中实现的方法是： public String bat
Mybatis @InsertProvider注解使用实例
meser88的博客
01-01 1735
@InsertProvider(type = FaceRecognizeResultMapperSql.class, method = "insertFaceRecognizeResult") public int insertFaceRecognizeResult(@Param("faceRecognizeDTO")FaceRecognizeDTO bean1, @Param("fac...
mybatis之动态SQL
m0_47743175的博客
10-25 915
mybatis动态sql配置
mybatis动态SQL语句
weixin_43808717的博客
04-28 760
1. mybatis 与 JDBC对比 传统JDBC动态SQL 在学习mybatis动态SQL语句之前，先来回忆一下JDBC的SQL操作。看看传统的JDBC操作是多么的难受，手动控制一些参数条件。 StringBuffer sql = new StringBuffer(); ArrayList<Object> obj = new ArrayList<>(); sql.append("select * from smbms_provider"); boolean f = false;
Mybatis之动态构建SQL语句
SHUIHAN_007的博客
12-06 734
今天一个新同事问我，我知道如何利用XML的方式来构建动态SQL，可是Mybatis是否能够利用注解完成动态SQL的构建呢?!!答案是肯定的，MyBatis 提供了注解，@InsertProvider,@UpdateProvider,@DeleteProvider 和@SelectProvider，来帮助构建动态 SQL 语句，然后让MyBatis 执行这些 SQL 语句。 1.@InsertProvider 1.1简单示例使用 创建一个 TutorDynaSqlProvider.java 类，以及 find
@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider详细用法
06-13
这四个注解都是 MyBatis 提供的，用于动态生成 SQL 语句。 @SelectProvider 用于动态生成查询语句，常用于复杂查询，可以根据传入的参数来动态生成 WHERE 条件和 ORDER BY 子句等。 @UpdateProvider 用于动态生成更新语句，常用于批量更新或者根据不同的条件更新不同的字段。 @InsertProvider 用于动态生成插入语句，常用于批量插入或者根据不同的条件插入不同的字段。 @DeleteProvider 用于动态生成删除语句，常用于根据不同的条件删除不同的数据。 这四个注解都需要指定一个 Provider 类来生成 SQL 语句，Provider 类需要实现一个方法，方法的返回值是一个字符串，表示生成的 SQL 语句。这个方法必须是 public 类型的，并且必须是静态方法或者是非静态方法，但是需要有一个空构造函数。 这四个注解的使用方法都类似，下面以 @SelectProvider 为例进行说明： ```java @SelectProvider(type = UserSqlProvider.class, method = "selectUsers") List<User> selectUsers(UserQuery userQuery); ``` 其中，type 属性指定了 Provider 类的类型，method 属性指定了 Provider 类中用于生成 SQL 语句的方法名。在 UserSqlProvider 类中，需要实现一个名为 selectUsers 的方法，并返回一个字符串，这个字符串就是生成的 SQL 语句。在 selectUsers 方法中可以根据传入的参数动态生成 SQL 语句，例如： ```java public class UserSqlProvider { public static String selectUsers(UserQuery userQuery) { return new SQL() .SELECT("id, username, age") .FROM("user") .WHERE("username like #{username}") .WHERE("age > #{minAge}") .ORDER_BY("age desc") .toString(); } } ``` 通过这样的方式，可以灵活地生成各种复杂的 SQL 语句。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

pan_junbiao

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

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

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

打赏作者

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

抵扣说明：

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

余额充值