芋道 Spring Boot MyBatis 入门
点击上方“芋道源码”，选择“设为星标”
做积极的人，而不是积极废人！
源码精品专栏
原创 | Java 2019 超神之路，很肝~
中文详细注释的开源项目
RPC 框架 Dubbo 源码解析
网络应用框架 Netty 源码解析
消息中间件 RocketMQ 源码解析
数据库中间件 Sharding-JDBC 和 MyCAT 源码解析
作业调度中间件 Elastic-Job 源码解析
分布式事务中间件 TCC-Transaction 源码解析
Eureka 和 Hystrix 源码解析
Java 并发源码
摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/MyBatis/ 「芋道源码」欢迎转载，保留摘要，谢谢！
1. 概述
2. MyBatis + XML
3. MyBatis + 注解
4. MyBatis-Plus
5. tkmybatis
666. 彩蛋
本文，我们基于 Spring Boot 2.X 版本。
1. 概述
在 DAL 数据访问层，目前会有三种方向的解决方案：
JDBC
MyBatis
JPA
艿艿自己在 知识星球 中，做过一个简单的调研，看看大家使用哪个为主。结果是 MyBatis > JPA > JDBC 。这个也符合在知乎上看到的两篇文章：
《MyBatis 为什么在国内相当流行?》
《为什么阿里巴巴的持久层采用 iBatis 框架,而不使用 hibernate 框架呢？感觉 hibernate 更厉害的样子？》
而每个团队使用 MyBatis 方式还有不同，主要是如下：
注意，几种方式可以组合使用。
MyBatis + XML
MyBatis + 注解
MyBatis-Plus
tkmybatis
艿艿的团队，最终我们使用 XML 的方式，因为 XML 便于可以看到每个表使用到的 SQL ，方便做优化和管理。 后来，考虑到提高开发效率，很多标准的数据库的 CRUD 操作，编写还是比较枯燥乏味浪费时间，所以使用 MyBatis-Plus 简化。当然，一些相对复杂的 SQL ，还是会考虑使用 XML 。
下面，我们上面列的四种方式，逐个来入门。
2. MyBatis + XML
示例代码对应仓库：mybatis-xml 。
本小节，我们会使用 mybatis-spring-boot-starter 自动化配置 MyBatis 主要配置。同时，在 XML 中编写相应的 SQL 操作。
2.1 引入依赖
在 pom.xml 文件中，引入相关依赖。
org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE
4.0.0
lab-12-mybatis
org.springframework.boot
spring-boot-starter-jdbc
mysql
mysql-connector-java
5.1.48
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.1
org.springframework.boot
spring-boot-starter-test
test
具体每个依赖的作用，胖友自己认真看下艿艿添加的所有注释噢。
2.2 Application
创建 Application.java 类，配置 @MapperScan 注解，扫描对应 Mapper 接口所在的包路径。代码如下：
// Application.java
@SpringBootApplication
@MapperScan(basePackages = "cn.iocoder.springboot.lab12.mybatis.mapper")
public class Application {
}
cn.iocoder.springboot.lab12.mybatis.mapper包路径下，就是我们 Mapper 接口所在的包路径。建议 1 ：因为这里是做示例。实际项目中，可以考虑创建一个 MyBatisConfig 配置类，将
@MapperScan注解添加到其上。
2.3 应用配置文件
在 resources 目录下，创建 application.yaml 配置文件。配置如下：
spring:
# datasource 数据源配置内容
datasource:
url: jdbc:mysql://47.112.193.81:3306/testb5f4?useSSL=false&useUnicode=true&characterEncoding=UTF-8
driver-class-name: com.mysql.jdbc.Driver
username: testb5f4
password: F4df4db0ed86@11
# mybatis 配置内容
mybatis:
config-location: classpath:mybatis-config.xml # 配置 MyBatis 配置文件路径
mapper-locations: classpath:mapper/*.xml # 配置 Mapper XML 地址
type-aliases-package: cn.iocoder.springboot.lab12.mybatis.dataobject # 配置数据库实体包路径
具体的每个配置项，胖友自己认真看下艿艿添加的所有注释噢。
2.4 MyBatis 配置文件
在 resources 目录下，创建 mybatis-config.xml 配置文件。配置如下：
因为在数据库中的表的字段，我们是使用下划线风格，而数据库实体的字段使用驼峰风格，所以通过 mapUnderscoreToCamelCase = true 来自动转换。
2.5 UserDO
在 cn.iocoder.springboot.lab12.mybatis.dataobject 包路径下，创建 UserDO.java 类，用户 DO 。代码如下：
// UserDO.java
public class UserDO {
/**
* 用户编号
*/
private Integer id;
/**
* 账号
*/
private String username;
/**
* 密码（明文）
*
* ps：生产环境下，千万不要明文噢
*/
private String password;
/**
* 创建时间
*/
private Date createTime;
// ... 省略 setting/getting 方法
}
对应的创建表的 SQL 如下：
CREATE TABLE `users` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户编号',
`username` varchar(64) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '账号',
`password` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '密码',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
PRIMARY KEY (`id`),
UNIQUE KEY `idx_username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
2.6 UserMapper
在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下，创建 UserMapper 接口。代码如下：
// UserMapper.java
@Repository
public interface UserMapper {
int insert(UserDO user);
int updateById(UserDO user);
int deleteById(@Param("id") Integer id); // 生产请使用标记删除，除非有点想不开，嘿嘿。
UserDO selectById(@Param("id") Integer id);
UserDO selectByUsername(@Param("username") String username);
List selectByIds(@Param("ids")Collection ids);
}
@Repository注解，用于标记是数据访问 Bean 对象。在 MyBatis 的接口，实际非必须，只是为了避免在 Service 中，@Autowired注入时无需报警。@Param注解，声明变量名。-
在方法为单参数时，非必须。
在方法为多参数时，必须。艿艿自己的编程习惯，禁止使用 Map 作为查询参数，因为无法通过方法的定义，很直观的看懂具体的用途。
细心的胖友，肯定会发现例如说
#selectByUsername(@Param("username") String username)等方法，是使用 By 字段结尾，这是为什么呢？一般情况下，在 SQL 中的WHERE条件字段，我们建议能够带在方法名后。原因无它，简单明了。如果是多个字段，可以使用 AND 分隔。当然，如果查询字段比较多，可能方法名会比较长。
在 resources/mapper 路径下，创建 UserMapper.xml 配置文件。代码如下：
id, username, password, create_time
INSERT INTO users (
username, password, create_time
) VALUES (
#{username}, #{password}, #{createTime}
)
UPDATE users
, username = #{username}
, password = #{password}
WHERE id = #{id}
DELETE FROM users
WHERE id = #{id}
建议 1 ：对于绝大多数查询，我们是返回统一字段，所以可以使用
建议 2 ：对于数据库的关键字，使用大写。例如说，
SELECT、WHERE等等。建议 3 ：基本是每“块”数据库关键字占用一行，胖友可以看看艿艿写的每一行示例。一定要排版干净，毕竟我们是有代码洁癖的男孩子。
2.7 简单测试
创建 UserMapperTest 测试类，我们来测试一下简单的 UserMapper 的每个操作。代码如下：
// UserMapperTest.java
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserMapperTest {
@Autowired
private UserMapper userMapper;
@Test
public void testInsert() {
UserDO user = new UserDO().setUsername(UUID.randomUUID().toString())
.setPassword("nicai").setCreateTime(new Date());
userMapper.insert(user);
}
@Test
public void testUpdateById() {
UserDO updateUser = new UserDO().setId(1)
.setPassword("wobucai");
userMapper.updateById(updateUser);
}
@Test
public void testDeleteById() {
userMapper.deleteById(2);
}
@Test
public void testSelectById() {
userMapper.selectById(1);
}
@Test
public void testSelectByUsername() {
userMapper.selectByUsername("yunai");
}
@Test
public void testSelectByIds() {
List users = userMapper.selectByIds(Arrays.asList(1, 3));
System.out.println("users：" + users.size());
}
}
具体的，胖友可以自己跑跑，妥妥的。
如果胖友嫌弃手写 MyBatis XML 很麻烦，可以看看 IDEA MyBatisCodeHelper-Pro 插件。在没有使用 MyBatis-Plus 插件之前，使用过蛮长一段时间，我以前的老大也在用。
当然，也可以考虑使用 MyBatis Generator (MBG) 。
3. MyBatis + 注解
大多数情况下，艿艿并不推荐使用注解的方式编写 SQL 。一方面，SQL 无法很好的排版。另一方面，会导致 Mapper 接口很长很乱。
并且，在 MyBatis 的官方文档中，对注解的评价如下：
FROM https://mybatis.org/mybatis-3/zh/java-api.html
因为最初设计时，MyBatis 是一个 XML 驱动的框架。配置信息是基于 XML 的，而且映射语句也是定义在 XML 中的。而到了 MyBatis 3，就有新选择了。MyBatis 3 构建在全面且强大的基于 Java 语言的配置 API 之上。这个配置 API 是基于 XML 的 MyBatis 配置的基础，也是新的基于注解配置的基础。注解提供了一种简单的方式来实现简单映射语句，而不会引入大量的开销。
**不幸的是，Java 注解的的表达力和灵活性十分有限。**尽管很多时间都花在调查、设计和试验上，最强大的 MyBatis 映射并不能用注解来构建——并不是在开玩笑，的确是这样。比方说，C#属性就没有这些限制，因此 MyBatis.NET 将会比 XML 有更丰富的选择。也就是说，基于 Java 注解的配置离不开它的特性。
间接表述不是很推荐使用 MyBatis 注解的方式。
同时，在艿艿的工作经历之间，和询问一些好朋友，没有发现使用注解的情况。
因此，真的不推荐使用 MyBatis + 注解。哈哈哈哈，不过这个章节，我还是想写一写。
示例代码对应仓库：lab-12-mybatis-annotation 。
3.1 差异部分
考虑到胖友已经看过 「2. MyBatis + XML」 小节的内容，我们在这个小节主要说下差异的地方。
1、application.yaml
在 application.yaml 配置文件中，我们可以删除 mapper-locations 配置项。
当然，如果胖友想 XML 和注解一起使用，可以保留该配置项。
2、UserMapper.xml
可以删除 UserMapper.xml 配置文件。不过需要在 UserMapper 接口上，通过注解声明 SQL 操作。具体见 「3.2 UserMapper」 。
3.2 UserMapper
在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下，创建 UserMapper 接口。代码如下：
// UserMapper.java
@Repository
public interface UserMapper {
@Insert("INSERT INTO users(username, password, create_time) VALUES(#{username}, #{password}, #{createTime})")
@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
int insert(UserDO user);
@Update(value = {
""
})
int updateById(UserDO user);
@Insert("DELETE FROM users WHERE id = #{id}")
int deleteById(@Param("id") Integer id); // 生产请使用标记删除，除非有点想不开，嘿嘿。
@Select("SELECT username, password, create_time FROM users WHERE id = #{id}")
UserDO selectById(@Param("id") Integer id);
@Select("SELECT username, password, create_time FROM users WHERE username = #{username}")
UserDO selectByUsername(@Param("username") String username);
@Select(value = {
""
})
List selectByIds(@Param("ids") Collection ids);
}
是不是发现整个 Mapper 接口看起来乱乱的，并且 SQL 的排版也不尽如人意。
对于使用 OGNL 编写动态 SQL ，也特别难受。具体怎么用，胖友可以看看 《MyBatis 在注解上使用动态 SQL》 文章。反正艿艿不是想写第二遍了。
3.3 简单测试
具体的测试，还是使用 UserMapperTest 测试类，直接运行每个测试方法即可。
4. MyBatis-Plus
关于 MyBatis-Plus 的介绍，直接到 https://mybatis.plus/ 官网，艿艿就不多哔哔，嘿嘿。
示例代码对应仓库：mybatis-plus 。
本小节，我们会使用 mybatis-plus-boot-starter 自动化配置 MyBatis-Plus 的配置。同时，演示如何使用 MyBatis-Plus 实现我们在 「2. MyBatis + XML」 演示的各种 CRUD 的操作。
4.1 引入依赖
在 pom.xml 文件中，引入相关依赖。
org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE
4.0.0
lab-12-mybatis-plus
org.springframework.boot
spring-boot-starter-jdbc
mysql
mysql-connector-java
5.1.48
com.baomidou
mybatis-plus-boot-starter
3.2.0
org.springframework.boot
spring-boot-starter-test
test
相比来说，将
mybatis-spring-boot-starter替换成mybatis-plus-boot-starter。
4.2 Application
创建 Application.java 类，配置 @MapperScan 注解，扫描对应 Mapper 接口所在的包路径。代码如下：
// Application.java
@SpringBootApplication
@MapperScan(basePackages = "cn.iocoder.springboot.lab12.mybatis.mapper")
public class Application {
}
和 「2.2 Application」 一致。
4.3 应用配置文件
在 resources 目录下，创建 application.yaml 配置文件。配置如下：
spring:
# datasource 数据源配置内容
datasource:
url: jdbc:mysql://47.112.193.81:3306/testb5f4?useSSL=false&useUnicode=true&characterEncoding=UTF-8
driver-class-name: com.mysql.jdbc.Driver
username: testb5f4
password: F4df4db0ed86@11
# mybatis-plus 配置内容
mybatis-plus:
configuration:
map-underscore-to-camel-case: true # 虽然默认为 true ，但是还是显示去指定下。
global-config:
db-config:
id-type: auto # ID 主键自增
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
mapper-locations: classpath*:mapper/*.xml
type-aliases-package: cn.iocoder.springboot.lab12.mybatis.dataobject
# logging
logging:
level:
# dao 开启 debug 模式 mybatis 输入 sql
cn:
iocoder:
springboot:
lab12:
mybatis:
mapper: debug
将
mybatis替换成mybatis-plus配置项目。实际上，如果老项目在用mybatis-spring-boot-starter的话，直接将mybatis修改成mybatis-plus即可。相比
mybatis配置项来说，mybatis-plus增加了更多配置项，也因此我们无需在配置mybatis-config.xml配置文件。更多的 MyBatis-Plus 配置项，可以看看 MyBatis-Plus 使用配置 。
配置
logging的原因是，方便我们看到 MyBatis-Plus 自动生成的 SQL 。生产环境下，记得关闭噢。
4.4 UserDO
在 cn.iocoder.springboot.lab12.mybatis.dataobject 包路径下，创建 UserDO.java 类，用户 DO 。代码如下：
// UserDO.java
@TableName(value = "users")
public class UserDO {
/**
* 用户编号
*/
private Integer id;
/**
* 账号
*/
private String username;
/**
* 密码（明文）
*
* ps：生产环境下，千万不要明文噢
*/
private String password;
/**
* 创建时间
*/
private Date createTime;
/**
* 是否删除
*/
@TableLogic
private Integer deleted;
// ... 省略 setting/getting 方法
}
相比 「2.5 UserDO」 来说，主要有两点差别。
增加了
@TableName注解，设置了 UserDO 对应的表名是users。毕竟，我们要使用 MyBatis-Plus 给咱自动生成 CRUD 操作。增加了
deleted字段，并添加了@TableLogic注解，设置该字段为逻辑删除的标记。-
在
application.yaml配置文件中，我们配置了删除（logic-delete-value = 1）和未删除（logic-not-delete-value = 0）。当然，也可以通过注解的value和delval来定义未删除和删除。具体关于 MyBatis-Plus 的逻辑删除功能，看下 逻辑删除 部分的文档。
对应的创建表的 SQL 如下：
CREATE TABLE `users` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户编号',
`username` varchar(64) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '账号',
`password` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '密码',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`deleted` bit(1) DEFAULT NULL COMMENT '是否删除。0-未删除；1-删除',
PRIMARY KEY (`id`),
UNIQUE KEY `idx_username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
4.5 UserMapper
在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下，创建 UserMapper 接口。代码如下：
// UserMapper.java
@Repository
public interface UserMapper extends BaseMapper {
default UserDO selectByUsername(@Param("username") String username) {
return selectOne(new QueryWrapper().eq("username", username));
}
List selectByIds(@Param("ids") Collection ids);
default IPage selectPageByCreateTime(IPage page, @Param("createTime") Date createTime) {
return selectPage(page,
new QueryWrapper().gt("create_time", createTime));
}
}
还是老样子，我们来比较下 「2.6 UserMapper」 接口。
继承了
com.baomidou.mybatisplus.core.mapper.BaseMapper接口，这样常规的 CRUD 操作，MyBatis-Plus 就可以替我们自动生成。一般来说，开发 CRUD 业务的时候，最枯燥的就是要写 CRUD 的常用 SQL ，完全跟不上艿艿的思绪哈。-
因为继承了 BaseMapper 接口，所以我们删除了
#insert(UserDO user)、#updateById(UserDO user)、#deleteById(@Param("id") Integer id)、#selectById(@Param("id") Integer id)四个 CRUD 方法。更多 BaseMapper 已经提供好的接口方法，可以看看 《MyBatis-Plus 文档 —— CRUD 接口》 。
对于
#selectByUsername(@Param("username") String username)方法，我们使用了com.baomidou.mybatisplus.core.conditions.query.QueryWrapper构造相对灵活的条件，这样一些动态 SQL 我们就无需在 XML 中编写。-
更多 QueryWrapper 已经提供好的拼接方法，可以看看 《MyBatis-Plus 文档 —— 条件构造器》 。
建议 1 ：不要在 Service 中，使用 QueryWrapper 拼接动态条件。因为 BaseMapper 提供了
#selectList(Wrapper等方法，促使我们能够在 Service 层的逻辑中，使用 QueryWrapper 拼接动态条件，这样会导致逻辑里遍布了各种查询，使我们无法对实际有哪些查询条件做统一的管理。碰到这种情况，建议封装到对应的 Mapper 中，这样会更加简洁干净可管理。queryWrapper) 建议 2 ：因为 QueryWrapper 暂时不支持一些类似
对于
#selectByIds(@Param("ids")方法，实际也可以使用 MyBatis-Plus 的 QueryWrapper 很方便的实现，这里仅仅是为了演示在 MyBatis-Plus 混合使用 XML 。对于
#selectPageByCreateTime(IPage方法，是我们额外添加的，用于演示 MyBatis-Plus 提供的分页插件。page, @Param("createTime") Date createTime) -
更多 IPage 的内容，可以看看 《MyBatis-Plus 文档 —— 分页插件》 。
在 resources/mapper 路径下，创建 UserMapper.xml 配置文件。代码如下：
id, username, password, create_time
是不是一下子，瘦了！
4.6 简单测试
创建 UserMapperTest 测试类，我们来测试一下简单的 UserMapper 的每个操作。代码如下：
// UserMapperTest.java
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserMapperTest {
@Autowired
private UserMapper userMapper;
@Test
public void testInsert() {
UserDO user = new UserDO().setUsername(UUID.randomUUID().toString())
.setPassword("nicai").setCreateTime(new Date())
.setDeleted(0); // 一般情况下，是否删除，可以全局枚举下。
userMapper.insert(user);
}
@Test
public void testUpdateById() {
UserDO updateUser = new UserDO().setId(1)
.setPassword("wobucai");
userMapper.updateById(updateUser);
}
@Test
public void testDeleteById() {
userMapper.deleteById(2);
}
@Test
public void testSelectById() {
userMapper.selectById(1);
}
@Test
public void testSelectByUsername() {
userMapper.selectByUsername("yunai");
}
@Test
public void testSelectByIds() {
List users = userMapper.selectByIds(Arrays.asList(1, 3));
System.out.println("users：" + users.size());
}
@Test
public void testSelectPageByCreateTime() {
IPage page = new Page<>(1, 10);
Date createTime = new Date(2018 - 1990, Calendar.FEBRUARY, 24); // 临时 Demo ，实际不建议这么写
page = userMapper.selectPageByCreateTime(page, createTime);
System.out.println("users：" + page.getRecords().size());
}
}
和 「2.7 简单测试」 差不多，只是多了一个分页的单元测试方法。
总的来说，MyBatis-Plus 给我们日常开发，还是提供了蛮多便利性的，胖友不烦尝试下。
5. tkmybatis
关于 tkmybatis 的介绍，直接到 http://www.mybatis.tk/ 官网，艿艿就不多哔哔，嘿嘿。
需要注意的是，tkmybatis 对自己的定位是 mybatis 的工具的意思，那么 tk 猜测是 toolkit 的缩写。也因此，tkmybatis 是多个开源项目组合起来的：
Mapper ：提供通用的 MyBatis Mapper 。
Mybatis-PageHelper ：提供 MyBatis 分页插件。
本小节，我们会使用 tkmybatis 实现我们在 「3. MyBatis-Plus」 的各种 CRUD 操作。
艿艿：说实在的，还是喜欢 MyBatis-Plus 。一站式，文档也更加齐全和易懂。
5.1 引入依赖
在 pom.xml 文件中，引入相关依赖。
org.springframework.boot
spring-boot-starter-parent
2.1.3.RELEASE
4.0.0
lab-12-mybatis-tk
org.springframework.boot
spring-boot-starter-jdbc
mysql
mysql-connector-java
5.1.48
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.1
tk.mybatis
mapper-spring-boot-starter
2.1.5
com.github.pagehelper
pagehelper-spring-boot-starter
1.2.5
org.mybatis.spring.boot
mybatis-spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
引入
mybatis-spring-boot-starter依赖，自动化配置 MyBatis 。引入
mapper-spring-boot-starter依赖，自动化配置 Mapper 。引入
pagehelper-spring-boot-starter依赖，自动化配置 PageHelper 。
5.2 Application
创建 Application.java 类，配置 @MapperScan 注解，扫描对应 Mapper 接口所在的包路径。代码如下：
// Application.java
@SpringBootApplication
@MapperScan(basePackages = "cn.iocoder.springboot.lab12.mybatis.mapper") // 注意，要换成 tk 提供的 @MapperScan 注解
public class Application {
}
注意，整列使用的是 tkmybatis 提供的
tk.mybatis.spring.annotation.@MapperScan注解。
5.3 应用配置文件
在 resources 目录下，创建 application.yaml 配置文件。配置如下：
spring:
# datasource 数据源配置内容
datasource:
url: jdbc:mysql://47.112.193.81:3306/testb5f4?useSSL=false&useUnicode=true&characterEncoding=UTF-8
driver-class-name: com.mysql.jdbc.Driver
username: testb5f4
password: F4df4db0ed86@11
# mybatis 配置内容
mybatis:
config-location: classpath:mybatis-config.xml # 配置 MyBatis 配置文件路径
mapper-locations: classpath:mapper/*.xml # 配置 Mapper XML 地址
type-aliases-package: cn.iocoder.springboot.lab12.mybatis.dataobject # 配置数据库实体包路径
# mapper 配置内容
mapper:
mappers: cn.iocoder.springboot.lab12.mybatis.util.BaseMapper # 设置基础 Mapper 接口
not-empty: true # 在 INSERT 和 UPDATE 操作时，是否会判断字段是否为空。即 一共有
mybatis、mapper、pagehelper三大块配置项。相比 MyBatis-Plus 略微复杂一些。具体每个配置项的作用，胖友看下注释。有一点要注意，
cn.iocoder.springboot.lab12.mybatis.util.BaseMapper接口，需要我们自己定义，去继承tk.mybatis.mapper.common.Mapper和tk.mybatis.mapper.common.MySqlMapper接口。
5.4 MyBatis 配置文件
在 resources 目录下，创建 mybatis-config.xml 配置文件。配置如下：
和 「2.3 MyBatis 配置文件」 一致。
5.5 UserDO
在 cn.iocoder.springboot.lab12.mybatis.dataobject 包路径下，创建 UserDO.java 类，用户 DO 。代码如下：
// UserDO.java
/**
* 用户 DO
*/
@Table(name = "users")
public class UserDO {
/**
* 用户编号
*/
@Id // 表示该字段为主键 ID
@GeneratedValue(strategy = GenerationType.IDENTITY, generator = "JDBC") // strategy 设置使用数据库主键自增策略；generator 设置插入完成后，查询最后生成的 ID 填充到该属性中。
private Integer id;
/**
* 账号
*/
private String username;
/**
* 密码（明文）
*
* ps：生产环境下，千万不要明文噢
*/
private String password;
/**
* 创建时间
*/
private Date createTime;
public Integer getId() {
return id;
}
public UserDO setId(Integer id) {
this.id = id;
return this;
}
public String getUsername() {
return username;
}
public UserDO setUsername(String username) {
this.username = username;
return this;
}
public String getPassword() {
return password;
}
public UserDO setPassword(String password) {
this.password = password;
return this;
}
public Date getCreateTime() {
return createTime;
}
public UserDO setCreateTime(Date createTime) {
this.createTime = createTime;
return this;
}
}
因为 Mapper 暂时不支持逻辑删除功能，所以这里我们去除了
deleted属性。Mapper 的开发者，倾向使用者，自己在业务逻辑中实现逻辑删除。@Table、@Id、@GeneratedValue注解，使用的是 JPA 提供的注解。如果不知道怎么引入这三个注解，胖友可以看看 UserDO.java 类。
对应的创建表的 SQL 如下：
CREATE TABLE `users` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户编号',
`username` varchar(64) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '账号',
`password` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '密码',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
PRIMARY KEY (`id`),
UNIQUE KEY `idx_username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
5.6 UserMapper
在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下，创建 UserMapper 接口。代码如下：
// UserMapper.java
@Repository
public interface UserMapper extends BaseMapper { // 继承的是，我们定义的 BaseMapper 接口
default UserDO selectByUsername(@Param("username") String username) {
Example example = new Example(UserDO.class);
// 创建 Criteria 对象，设置 username 查询条件
example.createCriteria().andEqualTo("username", username);
// 执行查询
return selectOneByExample(example);
}
List selectByIds(@Param("ids") Collection ids);
default List selectListByCreateTime(@Param("createTime") Date createTime) {
Example example = new Example(UserDO.class);
// 创建 Criteria 对象，设置 create_time 查询条件
example.createCriteria().andGreaterThan("createTime", createTime);
return selectByExample(example);
}
}
继承的接口，是我们自己定义的
cn.iocoder.springboot.lab12.mybatis.util.BaseMapper接口。在 MyBatis-Plus 中，我们使用 QueryWrapper 拼装动态 SQL 。而在 tkmybatis 中，通过使用它提供的 Example 和 Criteria 类。
关于分页，PageHelper 的使用方式，有点神奇，我们在 「5.6 简单测试」 来看。
在 resources/mapper 路径下，创建 UserMapper.xml 配置文件。代码如下：
id, username, password, create_time
这个没有差别哈。
5.7 简单测试
创建 UserMapperTest 测试类，我们来测试一下简单的 UserMapper 的每个操作。代码如下：
// UserMapperTest.java
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserMapperTest {
@Autowired
private UserMapper userMapper;
@Test
public void testInsert() {
UserDO user = new UserDO().setUsername(UUID.randomUUID().toString())
.setPassword("nicai").setCreateTime(new Date());
userMapper.insert(user);
System.out.println(user.getId());
}
@Test
public void testUpdateById() {
UserDO updateUser = new UserDO().setId(1)
.setPassword("wobucai");
userMapper.updateByPrimaryKey(updateUser);
}
@Test
public void testDeleteById() {
userMapper.deleteByPrimaryKey(2);
}
@Test
public void testSelectById() {
userMapper.selectByPrimaryKey(1);
}
@Test
public void testSelectByUsername() {
userMapper.selectByUsername("yunai");
}
@Test
public void testSelectByIds() {
List users = userMapper.selectByIds(Arrays.asList(1, 3));
System.out.println("users：" + users.size());
}
@Test // 更多使用，可以参考 https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md
public void testSelectPageByCreateTime() {
// 设置分页
PageHelper.startPage(1, 10);
Date createTime = new Date(2018 - 1990, Calendar.FEBRUARY, 24); // 临时 Demo ，实际不建议这么写
// 执行列表查询
// PageHelper 会自动发起分页的数量查询，设置到 PageHelper 中
List users = userMapper.selectListByCreateTime(createTime); // 实际返回的是 com.github.pagehelper.Page 代理对象
// 转换成 PageInfo 对象，并输出分页
PageInfo page = new PageInfo<>(users);
System.out.println(page.getTotal());
}
}
分页逻辑，在
#testSelectPageByCreateTime()方法中，我们已经进行实现。相比来说，个人不是很喜欢 PageHelper 这种方式。也和朋友聊了下，他们也倾向类似 MyBatis-Plus 提供的分页方式。
666. 彩蛋
总的来说，个人还是比较推荐在项目中使用 MyBatis-Plus 。也问了好些朋友，目前都处于要么在使用 MyBatis-Plus ，要么新项目考虑使用 MyBatis-Plus 。
在之前使用 Spring Data JPA 的过程中，还是比较喜欢可以通过方法名，自动生成对应的 CRUD 操作。所以，就琢磨有没可能 Spring Data JPA 底层实现，除了使用 Hibernate ，是否有可能使用 MyBatis 呢？于是乎，在 Github 上竟然搜到了 spring-data-jpa-mybatis 项目。有点神奇，感兴趣的胖友可以试试。当然，生产上不是很建议哈。
推荐阅读：
《性能测试 —— MySQL 基准测试》
《芋道 Spring Boot 多数据源（读写分离）入门》 对应 lab-17 。
《芋道 Spring Boot 分库分表入门》 对应 lab-18 。
欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：
已在知识星球更新源码解析如下：
最近更新《芋道 SpringBoot 2.X 入门》系列，已经 20 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。
提供近 3W 行代码的 SpringBoot 示例，以及超 4W 行代码的电商微服务项目。
获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。
如果你喜欢这篇文章，喜欢，转发。
生活很美好，明天见(｡･ω･｡)ﾉ♡