Spring Boot整合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<User> 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<User> getListByUserSex(String userName, String password);

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

@Select("SELECT * FROM sys_user WHERE username=#{username} AND password = #{password}")
List<User> getListByNameAndSex(Map<String, Object> map);

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

Map param= new HashMap();
param.put("username","admin");
param.put("password","123456");
List<User> 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:动态⽣成 SQL 的类

  method:类中具体的方法名

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

最后

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

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

时间: 2020-08-22

SpringBoot整合MyBatis实现乐观锁和悲观锁的示例

本文以转账操作为例,实现并测试乐观锁和悲观锁. 全部代码:https://github.com/imcloudfloating/Lock_Demo GitHub Page:https://cloudli.top 死锁问题 当 A, B 两个账户同时向对方转账时,会出现如下情况: 时刻 事务 1 (A 向 B 转账) 事务 2 (B 向 A 转账) T1 Lock A Lock B T2 Lock B (由于事务 2 已经 Lock A,等待) Lock A (由于事务 1 已经 Lock B,等

springboot集成mybatisplus实例详解

集成mybatisplus后,简单的CRUD就不用写了,如果没有特别的sql,就可以不用mapper的xml文件的. 目录 pom.xml文件 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-insta

SpringBoot 使用Mybatis分页插件实现详解

这篇文章主要介绍了SpringBoot 使用Mybatis分页插件实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 1.导入分页插件包和jpa包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </depende

springboot集成mybatis-plus遇到的问题及解决方法

在使用spring boot集成mybatis-plus的过程中遇到的问题 如图, 首先我放xml的包的是没问题的,而是引入的架包和配置问题,问题配置如下 解决方法:请将mybatis-plus改成mybatis,mybatis,mybtis,重要的说三遍,必要的架包如下 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring- boot-start

详解springboot集成mybatis xml方式

springboot集成mybatis 关键代码如下: 1,添加pom引用 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.1.1</version> </dependency> <dependency> &l

springboot集成普罗米修斯(Prometheus)的方法

Prometheus 是一套开源的系统监控报警框架.它由工作在 SoundCloud 的 员工创建,并在 2015 年正式发布的开源项目.2016 年,Prometheus 正式加入 Cloud Native Computing Foundation,非常的受欢迎. 简介 Prometheus 具有以下特点: 一个多维数据模型,其中包含通过度量标准名称和键/值对标识的时间序列数据 PromQL,一种灵活的查询语言,可利用此维度 不依赖分布式存储: 单服务器节点是自治的 时间序列收集通过HTTP上

springBoot项目启动类启动无法访问的解决方法

网上也查了一些资料,我这里总结.下不来虚的,也不废话. 解决办法: 1.若是maven项目,则找到右边Maven Projects --->Plugins--->run(利用maven启动)则可以加载到webapp资源 2.上面方法治标不治本.在项目的pom文件中添加<bulid>标签标注路径即可,pom.xml后部分代码如下: 刷新maven加载,重启项目.若还是无法访问,重新导入项目 <dependencies> xxxxxxxxxxxx </dependen

springboot中不能获取post请求参数的解决方法

问题描述 最近在做微信小程序,用的spring boot做后端,突然发现客户端发送post请求的时候服务端接收不到参数.问题简化之后如下: 微信小程序端: 在页面放一个按钮进行测试 <!--index.wxml--> <view class="container"> <button catchtap='testpost'>点击进行测试</button> </view> 绑定一个函数发送post请求 //index.js //获

springboot集成mybatis实例代码

springboot如何配置web项目请参考前一章,在此基础上集成mybatis. 在pom文件中添加mybatis的依赖: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.2.0</version> </dependency

SpringBoot集成MyBatis的分页插件PageHelper实例代码

昨天给各位总结了本人学习springboot整合mybatis第一阶段的一些学习心得和源码,主要就算是敲了一下SpringBoot的门儿,希望能给各位的入门带给一点儿捷径,今天给各位温习一下MyBatis的分页插件PageHelper和SpringBoot的集成,它的使用也非常简单,开发更为高效.因为PageHelper插件是属于MyBatis框架的,所以相信很多哥们儿都已经用烂了,下面带着各位吃一下回头草. 首先说说MyBatis框架的PageHelper插件吧,它是一个非常好用的分页插件,通

SpringBoot集成Mybatis过程步骤图解

添加mybatis的起步依赖 添加数据库的驱动坐标 添加数据库的连接信息(需要重点注意) 与SpringBoot建立联系 创建User表 创建User实体 编写mapper 配置Mapper映射文件 编写测试Controller 测试 在上述的这些步骤中,前面几步是比较核心的东西,后面只是验证SpringBoot和Mybatis是否整合成功,在整合是还需要注意一些细节,比如数据库的版本问题等 以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们.

SpringBoot集成gRPC微服务工程搭建实践的方法

前言 本文将使用Maven.gRPC.Protocol buffers.Docker.Envoy等工具构建一个简单微服务工程,笔者所使用的示例工程是以前写的一个Java后端工程,因为最近都在 学习微服务相关的知识,所以利用起来慢慢的把这个工程做成微服务化应用.在实践过程踩过很多坑,主要是经验不足对微服务还是停留在萌新阶段,通过本文 记录创建微服务工程碰到一些问题,此次实践主要是解决以下问题: 如何解决.统一服务工程依赖管理 SpringBoot集成gRPC 管理Protocol buffers文

SpringBoot集成Beetl后统一处理页面异常的方法

背景 SpringBoot集成Beetl后如果页面出现异常会将出现异常之前的页面输出到客户端,但是由于页面不完整会导致用户看到的页面错乱或者空白,如下 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> 在控制台可以看到 >

SpringBoot集成mybatis实例

一.使用mybatis-spring-boot-starter 1.添加依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.0.0</version> </dependency> 2.启动时导入指定的sql(applic