详解SpringBoot 快速整合Mybatis（去XML化+注解进阶）

序言：使用mybatis3提供的注解可以逐步取代xml，例如使用@select注解直接编写sql完成数据查询，使用@selectprovider高级注解还可以编写动态sql，以应对复杂的业务需求。

一. 基础注解

mybatis 主要提供了以下crud注解：

1. @select
2. @insert
3. @update
4. @delete

增删改查占据了绝大部分的业务操作，掌握这些基础注解的使用是很必要的。例如下面这段代码无需xml即可完成数据查询：

@mapper
public interface usermapper {
 @select("select * from t_user")
 list<user> list();
}

使用过hibernate的同学可能会好奇，这里为什么没有配置映射关系也能完成属性注入？在传统项目使用过mybatis的童鞋可能很会就能反应过来，是因为在配置文件中开启了全局驼峰映射，springboot中同样能够做到，并且更为简单快捷。

虽然开启了全局驼峰映射，但你可能还会质疑，如果不符合下划线转驼峰规则的字段，拿查询回来的实体对象属性将获取为null，比如上述user对象属性mobilenum和对应的数据库字段phonenum，则查询结果为：

[
 {
 "userid": "1",
 "username": "admin",
 "password": "admin",
 "mobilenum": null
 },
 {
 "userid": "2",
 "username": "roots",
 "password": "roots",
 "mobilenum": null
 }
]

为了解决对象属性和字段驼峰不一致的问题，我们可以使用映射注解@results来指定映射关系。

二. 映射注解

mybatis主要提供这些映射注解：

1. @results 用于填写结果集的多个字段的映射关系.
2. @result 用于填写结果集的单个字段的映射关系.
3. @resultmap 根据id关联xml里面<resultmap>.

例如上面的list方法，我们可以在查询sql的基础上，指定返回的结果集的映射关系，其中property表示实体对象的属性名，column表示对应的数据库字段名。

 @results({
   @result(property = "userid", column = "user_id"),
   @result(property = "username", column = "username"),
   @result(property = "password", column = "password"),
   @result(property = "mobilenum", column = "phone_num")
 })
 @select("select * from t_user")
 list<user> list();

查询结果如下，：

[
 {
 "userid": "1",
 "username": "admin",
 "password": "admin",
 "mobilenum": "15011791234"
 },
 {
 "userid": "2",
 "username": "roots",
 "password": "roots",
 "mobilenum": "18812342017"
 }
]

为了方便演示和免除手工编写映射关系的烦恼，这里提供了一个快速生成映射结果集的方法，具体内容如下：

 /**
  * 1.用于获取结果集的映射关系
  */
 public static string getresultsstr(class origin) {
  stringbuilder stringbuilder = new stringbuilder();
  stringbuilder.append("@results({\n");
  for (field field : origin.getdeclaredfields()) {
   string property = field.getname();
   //映射关系：对象属性(驼峰)->数据库字段(下划线)
   string column = new propertynamingstrategy.snakecasestrategy().translate(field.getname()).touppercase();
   stringbuilder.append(string.format("@result(property = \"%s\", column = \"%s\"),\n", property, column));
  }
  stringbuilder.append("})");
  return stringbuilder.tostring();
 }

在当前main方法执行效果如下：然后我们将控制台这段打印信息复制到接口方法上即可。

三. 高级注解

mybatis-3 主要提供了以下crud的高级注解：

1. @selectprovider
2. @insertprovider
3. @updateprovider
4. @deleteprovider

见名知意，这些高级注解主要用于动态sql，这里以@selectprovider 为例，主要包含两个注解属性，其中type表示工具类，method 表示工具类的某个方法，用于返回具体的sql。

@mapper
public interface usermapper {
 @selectprovider(type = usersqlprovider.class, method = "list222")
 list<user> list2();
}
工具类代码如下：

public class usersqlprovider {
 public string list222() {
  return "select * from t_user ;
 }

四. 详细教程

对上述注解有所了解之后，我们以具体项目案例来进一步巩固这些注解的实际使用。
具体步骤

1. 引入依赖

为了方便演示，首选搭建web环境，另外数据库选择mysql 5.5+。

 <dependencies>
  <dependency> <!--添加web依赖 -->
   <groupid>org.springframework.boot</groupid>
   <artifactid>spring-boot-starter-web</artifactid>
  </dependency>
  <dependency> <!--添加mybatis依赖 -->
   <groupid>org.mybatis.spring.boot</groupid>
   <artifactid>mybatis-spring-boot-starter</artifactid>
   <version>1.3.1</version>
  </dependency>
  <dependency><!--添加mysql驱动依赖 -->
   <groupid>mysql</groupid>
   <artifactid>mysql-connector-java</artifactid>
   <scope>runtime</scope>
  </dependency>
  <dependency><!--添加test依赖 -->
   <groupid>org.springframework.boot</groupid>
   <artifactid>spring-boot-starter-test</artifactid>
   <scope>test</scope>
  </dependency>
 </dependencies>

2. 添加配置

这里主要是添加数据源，配置驼峰映射和开启sql日志的控制台打印。在项目的资源目录中，添加 application.yml 配置如下：

spring:
 datasource:
 #连接mysql
 url: jdbc:mysql://localhost:3306/socks?usessl=false
 username: root
 password: root
 driver-class-name: com.mysql.jdbc.driver

mybatis:
 configuration:
 #配置项：开启下划线到驼峰的自动转换. 作用：将数据库字段根据驼峰规则自动注入到对象属性。
 map-underscore-to-camel-case: true

logging:
 level:
 #打印sql信息
 com.hehe.mapper: debug

3. 编写数据层代码

这里以我们熟悉的用户信息为例，编写usermapper接口和本案例使用的usersqlprovider。

3.1 usermapper

添加usermapper接口用于数据查询：

package com.hehe.mapper;
@mapper
public interface usermapper {
 /**
  * 方式1：使用注解编写sql。
  */
 @select("select * from t_user")
 list<user> list();

 /**
  * 方式2：使用注解指定某个工具类的方法来动态编写sql.
  */
 @selectprovider(type = usersqlprovider.class, method = "listbyusername")
 list<user> listbyusername(string username);

 /**
  * 延伸：上述两种方式都可以附加@results注解来指定结果集的映射关系.
  *
  * ps：如果符合下划线转驼峰的匹配项可以直接省略不写。
  */
 @results({
   @result(property = "userid", column = "user_id"),
   @result(property = "username", column = "username"),
   @result(property = "password", column = "password"),
   @result(property = "mobilenum", column = "phone_num")
 })
 @select("select * from t_user")
 list<user> listsample();

 /**
  * 延伸：无论什么方式,如果涉及多个参数,则必须加上@param注解,否则无法使用el表达式获取参数。
  */
 @select("select * from t_user where username like #{username} and password like #{password}")
 user get(@param("username") string username, @param("password") string password);

 @selectprovider(type = usersqlprovider.class, method = "getbaduser")
 user getbaduser(@param("username") string username, @param("password") string password);

}

3.2 usersqlprovider

添加usersqlprovider，用于生成sql的工具类 。

package com.hehe.mapper;

/**
 * 主要用途：根据复杂的业务需求来动态生成sql.
 * <p>
 * 目标：使用java工具类来替代传统的xml文件.(例如：usersqlprovider.java <-- usermapper.xml)
 */
public class usersqlprovider {
 /**
  * 方式1：在工具类的方法里,可以自己手工编写sql。
  */
 public string listbyusername(string username) {
  return "select * from t_user where username =#{username}";
 }

 /**
  * 方式2：也可以根据官方提供的api来编写动态sql。
  */
 public string getbaduser(@param("username") string username, @param("password") string password) {
  return new sql() {{
   select("*");
   from("t_user");
   if (username != null && password != null) {
    where("username like #{username} and password like #{password}");
   } else {
    where("1=2");
   }
  }}.tostring();
 }
}

3.3 实体类user

添加实体类user

public class user {
 private string userid;
 private string username;
 private string password;
 private string mobilenum;
 //getters & setters
}

3.4 添加数据库记录

打开navicat 查询窗口，然后只需下面这段脚本。

use `socks`;
drop table if exists `t_user`;
create table `t_user` (
 `user_id` varchar(50) ,
 `username` varchar(50) ,
 `password` varchar(50) ,
 `phone_num` varchar(15) 
) ;

insert into `t_user` values ('1', 'admin', 'admin','15011791234');
insert into `t_user` values ('2', 'roots', 'roots','18812342017');

4. 编写控制层代码

package com.hehe.controller;

@restcontroller
@requestmapping("/user/*")
public class usercontroller {

 @suppresswarnings("all")
 @autowired
 usermapper usermapper;

 @getmapping("list")
 public list<user> list() {
  return usermapper.list();
 }

 @getmapping("list/{username}")
 public list<user> listbyusername(@pathvariable("username") string username) {
  return usermapper.listbyusername(username);
 }

 @getmapping("get/{username}/{password}")
 public user get(@pathvariable("username") string username, @pathvariable("password") string password) {
  return usermapper.get(username, password);
 }

 @getmapping("get/bad/{username}/{password}")
 public user getbaduser(@pathvariable("username") string username, @pathvariable("password") string password) {
  return usermapper.getbaduser(username, password);
 }

}

5. 启动和测试

启动工程后，访问 http://localhost:8080/user/list 可以查看用户列表如下：

访问 http://localhost:8080/user/list/admin 可以查询用户名为admin的信息：

五. 文档

官方文档：mybatis3-中文手册

关于mybatis注解的使用：

优点：无需xml，使用轻量级注解就可以编写sql并返回查询结果，功能强大且方便。

缺点：mybatis使用注解最大的缺点是无法实现实体属性和数据库字段的映射关系，如果不满足驼峰的话，每个查询都要使用@results，会造成一定代码冗余，官方承认把这个重大缺陷甩给了java注解的限制，为了解决这个问题，接下来我们学习如何在项目中快速引入通用mapper，让mapper接口通过泛型继承就能获取基于单个对象的增删改查！！

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。