第006课：Spring Boot集成MyBatis
1. MyBatis 介绍
MyBatis原本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。
iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAO）
MyBatis 是支持普通 SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Ordinary Java Objects，普通的 Java对象）映射成数据库中的记录。
2. MyBatis 配置
2.1 依赖导入
Spring Boot 集成 MyBatis，需要导入 mybatis-spring-boot-starter 和 mysql 的依赖，这里我们使用的版本时 1.3.2，如下：
org.mybatis.spring.boot
mybatis-spring-boot-starter
1.3.2
mysql
mysql-connector-java
runtime
2.2 properties.yml配置
集成 MyBatis 时需要在 properties.yml 配置文件做如下配置：
# 服务端口号
server:
port: 8080
context-path: /
spring:
application:
name: springboot-mybatis
datasource: # 数据库配置
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/db_mybatis?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: 123456
hikari:
maximum-pool-size: 10 # 最大连接池数
max-lifetime: 1770000
mybatis:
# 指定别名设置的包为所有entity
type-aliases-package: com.bowen.entity
configuration:
map-underscore-to-camel-case: true # 驼峰命名规范
mapper-locations: # mapper映射文件位置
- classpath:mapper/*.xml
基本配置包括服务端口号、上下文、数据库配置（包括用户名、密码、数据库连接等），这里使用的连接池是 Spring Boot 自带的 hikari。
mybatis设置了，指定别名设置的包为所有entity，其中 map-underscore-to-camel-case: true， 用来开启驼峰命名规范，比如数据库中字段名为：user_name， 那么在实体类中可以定义属性为 userName （甚至可以写成 username，也能映射上），会自动匹配到驼峰属性，如果不这样配置的话，针对字段名和属性名不同的情况，会映射不到。
同时设置了mapper映射文件位置：- classpath:mapper/*.xml
2.3 映射扫描
映射扫描有两种配置方式：
-
一种方法是在 mapper 层对应的类上面添加
@Mapper注解，但是这种方法有个弊端，当我们有很多个 mapper 时，那么每一个类上面都得添加@Mapper注解。 -
另一种比较简便的方法是在 Spring Boot 启动类上添加
@MaperScan注解，来扫描一个包下的所有 mapper。如下：
@SpringBootApplication
@MapperScan("com.bowen.dao")
public class SrpingbootMybatisApplication {
public static void main(String[] args) {
SpringApplication.run(SrpingbootMybatisApplication.class, args);
}
}
这样的话，com.bowen.dao 包下的所有 mapper 都会被扫描到了。
3. 建表
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` BIGINT(11) NOT NULL AUTO_INCREMENT,
`user_name` varchar(100) CHARACTER SET utf8 NOT NULL,
`password` varchar(100) CHARACTER SET utf8 NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=latin1;
INSERT INTO `db_mybatis`.`user` (`id`, `user_name`, `password`) VALUES ('1', '猿码天地001', '123456');
INSERT INTO `db_mybatis`.`user` (`id`, `user_name`, `password`) VALUES ('2', '猿码天地002', '123456');
4. 基于 xml 的整合
使用原始的 xml 方式，需要新建 UserMapper.xml 文件，在上面的 application.yml 配置文件中，我们已经定义了 xml 文件的路径：classpath:mapper/*.xml，所以我们在 resources 目录下新建一个 mapper 文件夹，然后创建一个 UserMapper.xml 文件。
select * from user where user_name = #{username}
这和整合 Spring 一样的，namespace 中指定的是对应的 Mapper，
实体类如下：
public class User {
private Long id;
private String username;
private String password;
//省略get、set方法
}
UserMapper.java 文件中写一个接口即可：
public interface UserMapper {
User getUserByName(String username);
}
中间省略 service 的代码，我们写一个 Controller 来测试一下：
/**
* springboot-study
* 测试Controller
* @author : zhang.bw
* @date : 2020-07-17 21:37
**/
@RestController
@RequestMapping("/test")
public class TestController {
@Resource
private UserService userService;
@RequestMapping("/getUserByName/{name}")
public User getUserByName(@PathVariable String name) {
return userService.getUserByName(name);
}
}
启动项目，在浏览器中输入：http://localhost:8080/test/getUserByName/猿码天地001 即可查询到数据库表中用户名为 猿码天地001 的用户信息：
5. 基于注解的整合
基于注解的整合就不需要 xml 配置文件了，MyBatis 主要提供了 @Select， @Insert， @Update， Delete 四个注解。这四个注解是用的非常多的，也很简单，注解后面跟上对应的 sql 语句即可，我们举个例子：
@Select("select * from user where id = #{id} and user_name=#{name}")
User getUserByIdAndName(@Param("id") Long id, @Param("name") String username);
这跟 xml 文件中写 sql 语句是一样的，这样就不需要 xml 文件了。
可以看出，@Param 指定的参数应该要和 sql 中 #{} 取的参数名相同，不同则取不到。
有个问题需要注意一下，一般我们在设计表字段后，都会根据自动生成工具生成实体类，这样的话，基本上实体类是能和表字段对应上的，最起码也是驼峰对应的，由于在上面配置文件中开启了驼峰的配置，所以字段都是能对的上的。但是，万一有对不上的呢？我们也有解决办法，使用 @Results 注解来解决。
@Select("select * from user where id = #{id}")
@Results({
@Result(property = "username", column = "user_name"),
@Result(property = "password", column = "password")
})
User getUser(Long id);
@Results 中的 @Result 注解是用来指定每一个属性和字段的对应关系，这样的话就可以解决上面说的这个问题了。
当然了，我们也可以 xml 和注解相结合使用，目前我们实际的项目中也是采用混用的方式，因为有时候 xml 方便，有时候注解方便，比如就上面这个问题来说，如果我们定义了上面的这个 UserMapper.xml，那么我们完全可以使用 @ResultMap 注解来替代 @Results 注解，如下：
@Select("select * from user where id = #{id}")
@ResultMap("BaseResultMap")
User getUser(Long id);
@ResultMap 注解中的值从哪来呢？对应的是 UserMapper.xml 文件中定义的
这种 xml 和注解结合着使用的情况也很常见，而且也减少了大量的代码，因为 xml 文件可以使用自动生成工具去生成，也不需要人为手动敲，所以这种使用方式也很常见。
6. 验证
根据ID查询用户信息
@RequestMapping("/getUser/{id}")
public User getUser(@PathVariable Long id) {
return userService.getUser(id);
}
根据ID和用户名查询用户信息
@RequestMapping("/getUser/{id}/{name}")
public User getUser(@PathVariable Long id, @PathVariable String name) {
return userService.getUser(id, name);
}
查询所有用户信息
@RequestMapping("/getall")
public List getAll() {
return userService.getAll();
}
根据用户名查询用户信息
@RequestMapping("/getUserByName/{name}")
public User getUserByName(@PathVariable String name) {
return userService.getUserByName(name);
}
7. 总结
本节课主要系统的讲解了 Spring Boot 集成 MyBatis 的过程，包括MyBatis 介绍、MyBatis 配置（依赖导入、properties.yml配置、映射扫描）、建表等，同时分别基于 xml 形式和基于注解的形式讲解了如何使用mybatis，整个讲解过程非常详细，非常容易上手。
源码下载地址：关注公众号【猿码天地】并回复 springboot 获取
文章推荐
Java泛型详解，必须掌握
第004课：Spring Boot 项目属性配置
第005课：Spring Boot 中MVC支持
第003课：Spring Boot 快速体验 Web 开发
Maven 的这 7 个问题你思考过没有？
第001课：Spring Boot 课程概览
第002课：Spring Boot 开发环境搭建
50份Java优秀求职者简历
扫描二维码关注公众号 : 猿码天地
你多学一样本事，就少说一句求人的话，现在的努力，是为了以后的不求别人，实力是最强的底气。记住，活着不是靠泪水博得同情，而是靠汗水赢得掌声。
——《写给程序员朋友》
