当前位置: 开发笔记 > 数据库 > 正文

SpringBoot整合mybatis使用注解实现动态Sql、参数传递等常用操作(实现方法)

作者：手机用户2502908011 | 来源：互联网 | 2022-02-03 15:40

这篇文章主要介绍了SpringBoot整合mybatis使用注解实现动态Sql、参数传递等常用操作(实现方法),本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

前面介绍了Spring Boot 整合mybatis 使用注解的方式实现数据库操作，介绍了如何自动生成注解版的mapper 和pojo类。接下来介绍使用mybatis 常用注解以及如何传参数等数据库操作中的常用操作。

其实，mybatis 注解方式和 XML配置方式两者的使用基本上相同，只有在构建 SQL 脚本有所区别，所以这里重点介绍两者之间的差异，以及增删改查，参数传递等注解的常用操作。

详解SpringBoot 快速整合Mybatis（去XML化+注解进阶)已经介绍过了，不清楚的朋友可以看看之前的文章：https://www.jb51.net/article/127473.htm

注解介绍

mybatis 注解方式的最大特点就是取消了Mapper的XML配置，具体的 SQL 脚本直接写在 Mapper 类或是 SQLProvider 中的方法动态生成。
mybatis 提供的常用注解有：@Insert 、@Update 、@Select、 @Delete等标签，这些注解其实就是 MyBatis 提供的来取代其 XML配置文件的。

1、@Select 注解

@Select，主要在查询的时候使用，查询类的注解，一般简单的查询可以使用这个注解。

@Select({
 "select",
 "id, company_id, username, password, nickname, age, sex, job, face_image, province, ",
 "city, district, address, auth_salt, last_login_ip, last_login_time, is_delete, ",
 "regist_time",
 "from sys_user",
 "where id = #{id,jdbcType=VARCHAR}"
})
@Results({
 @Result(column="id", property="id", jdbcType=JdbcType.VARCHAR, id=true),
 @Result(column="company_id", property="companyId", jdbcType=JdbcType.VARCHAR),
 @Result(column="face_image", property="faceImage", jdbcType=JdbcType.VARCHAR),
 @Result(column="auth_salt", property="authSalt", jdbcType=JdbcType.VARCHAR),
 @Result(column="last_login_ip", property="lastLoginIp", jdbcType=JdbcType.VARCHAR),
 @Result(column="last_login_time", property="lastLoginTime", jdbcType=JdbcType.TIMESTAMP),
 @Result(column="is_delete", property="isDelete", jdbcType=JdbcType.INTEGER),
 @Result(column="regist_time", property="registTime", jdbcType=JdbcType.TIMESTAMP)
})
User selectByPrimaryKey(String id);

注意：如果是多个参数，需要将 #后面的参数和传入的变量名保持一致。

2、@Insert 注解

@Insert，插入数据时使用，直接传入数据实体类，mybatis 会属性自动解析到对应的参数。所以需要将 #后面的参数和实体类属性保持一致。

 @Insert({
  "insert into sys_user (id, company_id, ",
  "username, password, ",
  "nickname, age, sex, ",
  "job, face_image, ",
  "province, city, ",
  "district, address, ",
  "auth_salt, last_login_ip, ",
  "last_login_time, is_delete, ",
  "regist_time)",
  "values (#{id,jdbcType=VARCHAR}, #{companyId,jdbcType=VARCHAR}, ",
  "#{username,jdbcType=VARCHAR}, #{password,jdbcType=VARCHAR}, ",
  "#{nickname,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER}, #{sex,jdbcType=INTEGER}, ",
  "#{job,jdbcType=INTEGER}, #{faceImage,jdbcType=VARCHAR}, ",
  "#{province,jdbcType=VARCHAR}, #{city,jdbcType=VARCHAR}, ",
  "#{district,jdbcType=VARCHAR}, #{address,jdbcType=VARCHAR}, ",
  "#{authSalt,jdbcType=VARCHAR}, #{lastLoginIp,jdbcType=VARCHAR}, ",
  "#{lastLoginTime,jdbcType=TIMESTAMP}, #{isDelete,jdbcType=INTEGER}, ",
  "#{registTime,jdbcType=TIMESTAMP})"
 })
 int insert(User record);

注意：需要将 #后面的参数和实体类属性保持一致。

3、@Update 注解

@Update，一般数据更新操作可以使用 @Update注解实现。

@Update({
  "update sys_user",
  "set company_id = #{companyId,jdbcType=VARCHAR},",
   "username = #{username,jdbcType=VARCHAR},",
   "password = #{password,jdbcType=VARCHAR},",
   "nickname = #{nickname,jdbcType=VARCHAR},",
   "age = #{age,jdbcType=INTEGER},",
   "sex = #{sex,jdbcType=INTEGER},",
   "job = #{job,jdbcType=INTEGER},",
   "face_image = #{faceImage,jdbcType=VARCHAR},",
   "province = #{province,jdbcType=VARCHAR},",
   "city = #{city,jdbcType=VARCHAR},",
   "district = #{district,jdbcType=VARCHAR},",
   "address = #{address,jdbcType=VARCHAR},",
   "auth_salt = #{authSalt,jdbcType=VARCHAR},",
   "last_login_ip = #{lastLoginIp,jdbcType=VARCHAR},",
   "last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP},",
   "is_delete = #{isDelete,jdbcType=INTEGER},",
   "regist_time = #{registTime,jdbcType=TIMESTAMP}",
  "where id = #{id,jdbcType=VARCHAR}"
 })
 int updateByPrimaryKey(User record);

4、@Delete 注解
@Delete 数据删除的注解

 @Delete({
  "delete from sys_user",
  "where id = #{id,jdbcType=VARCHAR}"
 })
 int deleteByPrimaryKey(String id);

5、@Results和@Result注解

@Results 和 @Result 主要作用是，当有一些特殊的场景需要处理，查询的返回结果与期望的数据格式不一致时，可以将将数据库中查询到的数值自动转化为具体的属性或类型，，修饰返回的结果集。比如查询的对象返回值属性名和字段名不一致，或者对象的属性中使用了枚举等。如果实体类属性和数据库属性名保持一致，就不需要这个属性来修饰。

@Select({
 "select",
 "id, company_id, username, password, nickname, age, sex, job, face_image, province, ",
 "city, district, address, auth_salt, last_login_ip, last_login_time, is_delete, ",
 "regist_time",
 "from sys_user",
 "where id = #{id,jdbcType=VARCHAR}"
})
@Results({
 @Result(column="id", property="id", jdbcType=JdbcType.VARCHAR, id=true),
 @Result(column="company_id", property="companyId", jdbcType=JdbcType.VARCHAR),
 @Result(column="face_image", property="faceImage", jdbcType=JdbcType.VARCHAR),
 @Result(column="auth_salt", property="authSalt", jdbcType=JdbcType.VARCHAR),
 @Result(column="last_login_ip", property="lastLoginIp", jdbcType=JdbcType.VARCHAR),
 @Result(column="last_login_time", property="lastLoginTime", jdbcType=JdbcType.TIMESTAMP),
 @Result(column="is_delete", property="isDelete", jdbcType=JdbcType.INTEGER),
 @Result(column="regist_time", property="registTime", jdbcType=JdbcType.TIMESTAMP)
})
User selectByPrimaryKey(String id);

上面的例子可以看到，数据库中的company_id 字段和实体类中定义的 companyId 属性的名称不一致，需要Result 转换。

以上就是项目中常用的增、删、改、查的操作，其实这些在基本的方法不需要手动写，用前面讲过的mybatis generator 自动生成即可。讲这些主要是熟悉这些常用的注解。

传参方式

上面介绍了mybatis 常用的注解，如何实现增删改查的操作，相信很多人会有疑问了： mybatis 是如何将参数传递到 SQL 中的呢，都有哪几种传参方式呢？下面就来一一介绍mybatis 注解版的传参方式。

1、直接传参

对于单个参数的方法，可直接使用 #{id} 的方式接收同名的变量参数。

@Delete("delete from sys_user where id = #{id,jdbcType=VARCHAR}")
int deleteByPrimaryKey(String id);

2、使用@Param 注解

@Param注解的作用是给参数命名，参数命名后就能根据名字得到参数值，正确的将参数传入sql语句中。如果你的方法有多个参数，@Param注解会在方法的参数上就能为它们取自定义名字，参数则先以 "param" 作前缀，再加上它们的参数位置作为参数别名。例如， #{param1}、 #{param2}，这个是默认值。如果注解是 @Param("person")，那么参数就会被命名为 #{person}。

@Select("SELECT * FROM sys_user WHERE username = #{username} and password = #{password}")
List getListByUserSex(@Param("username") String userName, @Param("password") String password);

// 不自定义param 时，默认使用 param + 参数序号 或者 0，1，值就是参数的值。
@Select("SELECT * FROM sys_user WHERE username = #{param1} and password = #{param2}")
List getListByUserSex(String userName, String password);

3、Map 传值
需要传送多个参数时，也可以考虑使用Map的形式。

@Select("SELECT * FROM sys_user WHERE username=#{username} AND password = #{password}")
List getListByNameAndSex(Map map);

调用时将参数依次加入到 Map 中即可。

Map param= new HashMap();
param.put("username","admin");
param.put("password","123456");
List users = userMapper.getListByNameAndSex(param)

4、使用pojo对象
使用pojo对象传参是比较常用的传参方式。像上面的insert、update 等方法。都是直接传入user对象。

@Update({
 "update sys_user",
 "set company_id = #{companyId,jdbcType=VARCHAR},",
  "username = #{username,jdbcType=VARCHAR},",
  "password = #{password,jdbcType=VARCHAR},",
  "nickname = #{nickname,jdbcType=VARCHAR},",
  "age = #{age,jdbcType=INTEGER},",
  "sex = #{sex,jdbcType=INTEGER},",
  "job = #{job,jdbcType=INTEGER},",
  "face_image = #{faceImage,jdbcType=VARCHAR},",
  "province = #{province,jdbcType=VARCHAR},",
  "city = #{city,jdbcType=VARCHAR},",
  "district = #{district,jdbcType=VARCHAR},",
  "address = #{address,jdbcType=VARCHAR},",
  "auth_salt = #{authSalt,jdbcType=VARCHAR},",
  "last_login_ip = #{lastLoginIp,jdbcType=VARCHAR},",
  "last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP},",
  "is_delete = #{isDelete,jdbcType=INTEGER},",
  "regist_time = #{registTime,jdbcType=TIMESTAMP}",
 "where id = #{id,jdbcType=VARCHAR}"
})
int updateByPrimaryKey(User record);

以上，就是Mybatis 传参的四种方式。根据方法的参数选择合适的传值方式。

动态 SQL

实际项目中，除了使用一些常用的增删改查的方法之外，有些复杂的需求，可能还需要执行一些自定义的动态sql。mybatis 除了提供了@Insert、@Delete 这些常用的注解，还提供了多个注解如：@InsertProvider,@UpdateProvider,@DeleteProvider和@SelectProvider，用来建立动态sql 和让 mybatis 执行这些sql 的注解。下面就来实现按字段更新的功能。

1、首先在 UserSqlProvider 中创建拼接sql的方法。

public String updateByPrimaryKeySelective(User record) {
  BEGIN();
  UPDATE("sys_user");
  
  if (record.getCompanyId() != null) {
   SET("company_id = #{companyId,jdbcType=VARCHAR}");
  }
  
  if (record.getUsername() != null) {
   SET("username = #{username,jdbcType=VARCHAR}");
  }
  
  if (record.getPassword() != null) {
   SET("password = #{password,jdbcType=VARCHAR}");
  }
  
  if (record.getNickname() != null) {
   SET("nickname = #{nickname,jdbcType=VARCHAR}");
  }
  
  if (record.getAge() != null) {
   SET("age = #{age,jdbcType=INTEGER}");
  }
  
  if (record.getSex() != null) {
   SET("sex = #{sex,jdbcType=INTEGER}");
  }
  
  if (record.getJob() != null) {
   SET("job = #{job,jdbcType=INTEGER}");
  }
  
  if (record.getFaceImage() != null) {
   SET("face_image = #{faceImage,jdbcType=VARCHAR}");
  }
  
  if (record.getProvince() != null) {
   SET("province = #{province,jdbcType=VARCHAR}");
  }
  
  if (record.getCity() != null) {
   SET("city = #{city,jdbcType=VARCHAR}");
  }
  
  if (record.getDistrict() != null) {
   SET("district = #{district,jdbcType=VARCHAR}");
  }
  
  if (record.getAddress() != null) {
   SET("address = #{address,jdbcType=VARCHAR}");
  }
  
  if (record.getAuthSalt() != null) {
   SET("auth_salt = #{authSalt,jdbcType=VARCHAR}");
  }
  
  if (record.getLastLoginIp() != null) {
   SET("last_login_ip = #{lastLoginIp,jdbcType=VARCHAR}");
  }
  
  if (record.getLastLoginTime() != null) {
   SET("last_login_time = #{lastLoginTime,jdbcType=TIMESTAMP}");
  }
  
  if (record.getIsDelete() != null) {
   SET("is_delete = #{isDelete,jdbcType=INTEGER}");
  }
  
  if (record.getRegistTime() != null) {
   SET("regist_time = #{registTime,jdbcType=TIMESTAMP}");
  }
  
  WHERE("id = #{id,jdbcType=VARCHAR}");
  
  return SQL();
 }

2、Mapper 中引入updateByPrimaryKeySelective方法

 @UpdateProvider(type=UserSqlProvider.class, method="updateByPrimaryKeySelective")
 int updateByPrimaryKeySelective(User record);

说明：

　　type：动态&＃12131;成 SQL 的类

　　method：类中具体的方法名

以上，就是使用sqlprovider 动态创建sql，除了示例中的@UpdateProvider ，，还有 @InsertProvider、 @SelectProvider、@DeleteProvider 提供给插入、查询、删除的时使用。

最后

上面，介绍了使用mybatis 常用注解实现增、删、改、查。以及mybatis 常用的四种参数传递方式。

到此这篇关于Spring Boot整合mybatis使用注解实现动态Sql、参数传递等常用操作(实现方法)的文章就介绍到这了,更多相关Spring Boot整合mybatis内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

推荐阅读

sql
Android 新闻App的本地服务器搭建教程

本文介绍了在开发Android新闻App时，搭建本地服务器的步骤。通过使用XAMPP软件，可以一键式搭建起开发环境，包括Apache、MySQL、PHP、PERL。在本地服务器上新建数据库和表，并设置相应的属性。最后，给出了创建new表的SQL语句。这个教程适合初学者参考。 ... [详细]

蜡笔小新 2023-12-14 17:15:19
sql
Hibernate基础映射

在说Hibernate映射前，我们先来了解下对象关系映射ORM。ORM的实现思想就是将关系数据库中表的数据映射成对象，以对象的形式展现。这样开发人员就可以把对数据库的操作转化为对 ... [详细]

蜡笔小新 2023-12-14 10:57:47
sql
postman测试登录后的接口_使用postman进行接口测试的方法(测试用户管理模块)

本文介绍了使用postman进行接口测试的方法，以测试用户管理模块为例。首先需要下载并安装postman，然后创建基本的请求并填写用户名密码进行登录测试。接下来可以进行用户查询和新增的测试。在新增时，可以进行异常测试，包括用户名超长和输入特殊字符的情况。通过测试发现后台没有对参数长度和特殊字符进行检查和过滤。 ... [详细]

蜡笔小新 2023-12-14 10:29:45
sql
使用 Ubuntu 中的 Python 获取浏览器历史记录

使用Ubuntu中的Python获取浏览器历史记录原文: ... [详细]

蜡笔小新 2023-12-14 08:57:59
sql
的错误消息：

ZSI.generate.Wsdl2PythonError: unsupported local simpleType restriction ... [详细]

蜡笔小新 2023-12-13 20:28:08
sql
Java String与StringBuffer的区别及其应用场景

本文主要介绍了Java中String和StringBuffer的区别，String是不可变的，而StringBuffer是可变的。StringBuffer在进行字符串处理时不生成新的对象，内存使用上要优于String类。因此，在需要频繁对字符串进行修改的情况下，使用StringBuffer更加适合。同时，文章还介绍了String和StringBuffer的应用场景。 ... [详细]

蜡笔小新 2023-12-13 19:21:06
sql
XML介绍与使用的概述及标签规则

本文介绍了XML的基本概念和用途，包括XML的可扩展性和标签的自定义特性。同时还详细解释了XML标签的规则，包括标签的尖括号和合法标识符的组成，标签必须成对出现的原则以及特殊标签的使用方法。通过本文的阅读，读者可以对XML的基本知识有一个全面的了解。 ... [详细]

蜡笔小新 2023-12-13 17:39:50
sql
ASP.NET Tips: 获取插入记录的ID的方法详解

本文详细介绍了在ASP.NET中获取插入记录的ID的几种方法，包括使用SCOPE_IDENTITY()和IDENT_CURRENT()函数，以及通过ExecuteReader方法执行SQL语句获取ID的步骤。同时，还提供了使用这些方法的示例代码和注意事项。对于需要获取表中最后一个插入操作所产生的ID或马上使用刚插入的新记录ID的开发者来说，本文提供了一些有用的技巧和建议。 ... [详细]

蜡笔小新 2023-12-13 17:03:18
数据库
Java验证码——kaptcha的使用配置及样式

本文介绍了如何使用kaptcha库来实现Java验证码的配置和样式设置，包括pom.xml的依赖配置和web.xml中servlet的配置。 ... [详细]

蜡笔小新 2023-12-13 13:58:25
数据库
JavaScript疑难杂症系列相称性推断的知识点详解

本文详细解析了JavaScript中相称性推断的知识点，包括严厉相称和宽松相称的区别，以及范例转换的规则。针对不同类型的范例值，如差别范例值、统一类的原始范例值和统一类的复合范例值，都给出了具体的比较方法。对于宽松相称的情况，也解释了原始范例值和对象之间的比较规则。通过本文的学习，读者可以更好地理解JavaScript中相称性推断的概念和应用。 ... [详细]

蜡笔小新 2023-12-14 19:12:10
数据库
linux查看目录权限命令,linux修改文件目录权限

Linuxchmod目录权限命令图文详解在Linux文件系统模型中，每个文件都有一组9个权限位用来控制谁能够读写和执行该文件的内容。对于目录来说，执行位的作用是控制能否进入或者通过 ... [详细]

蜡笔小新 2023-12-14 19:06:22
elasticsearch
Skywalking系列博客1安装单机版 Skywalking的快速安装方法

本文介绍了如何快速安装单机版的Skywalking，包括下载、环境需求和端口检查等步骤。同时提供了百度盘下载地址和查询端口是否被占用的命令。 ... [详细]

蜡笔小新 2023-12-14 19:05:47
elasticsearch
解决Docker中volume的权限问题的方法

在Docker中，将主机目录挂载到容器中作为volume使用时，常常会遇到文件权限问题。这是因为容器内外的UID不同所导致的。本文介绍了解决这个问题的方法，包括使用gosu和suexec工具以及在Dockerfile中配置volume的权限。通过这些方法，可以避免在使用Docker时出现无写权限的情况。 ... [详细]

蜡笔小新 2023-12-14 18:48:02
elasticsearch
Lodop中特殊符号打印设计和预览样式不同的问题解析

本文主要解析了在Lodop中使用特殊符号打印设计和预览样式不同的问题。由于调用的本机ie引擎版本可能不同，导致在不同浏览器下样式解析不同。同时，未指定文字字体和样式设置也会导致打印设计和预览的差异。文章提出了通过指定具体字体和样式来解决问题的方法，并强调了以打印预览和虚拟打印机测试为准。 ... [详细]

蜡笔小新 2023-12-14 18:29:32
elasticsearch
AJAX的POST请求及实现数据修改功能的方法

本文介绍了使用AJAX的POST请求实现数据修改功能的方法。通过ajax-post技术，可以实现在输入某个id后，通过ajax技术调用post.jsp修改具有该id记录的姓名的值。文章还提到了AJAX的概念和作用，以及使用async参数和open()方法的注意事项。同时强调了不推荐使用async=false的情况，并解释了JavaScript等待服务器响应的机制。 ... [详细]

蜡笔小新 2023-12-14 16:12:01

手机用户2502908011

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章