写在前面:使用mybatis-plus的优缺点
- 优点:mybatis-plus 作为 mybatis 的好拍档补充了它的短板,让 mybatis 兼具了 hibernate 的优点。
- 缺点:
- 增加了学习成本。mybatis功能已经足够强大,足以应付绝大多数的开发,再花费时间和精力去学习mybatis-plus,走取巧之路,有好的一面,肯定也有不好的一面。
- 增加了升级和维护成本。mybatis升级之后,mybatis-plus还能不能用呢?如果不能用或者出现bug,这就是一个风险。
- 额外增加系统负担,mybatis-plus运行原理是往mybatis的全局配置中增加MappedStatement,平均一张表对应20个MappedStatement对象,如果表很多的话,内存中会充斥着大量的MappedStatement对象。
个人建议:感觉没什么必要,使用mbg就足以应付crud局面了,插件方面mybatis本身已经支持的很好了。
简介
官网地址
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
愿景是成为 MyBatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍。
Mybatis-Plus同JPA、tk-mapper一样都是“偷懒”工具。

特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
- 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
- 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
- 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
- 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
- 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
- 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
- 分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
- 内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
- 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作
支持的数据库
- mysql 、mariadb 、oracle 、db2 、h2 、hsql 、sqlite 、postgresql 、sqlserver 、presto 、Gauss 、Firebird
- Phoenix 、clickhouse 、Sybase ASE 、 OceanBase 、达梦数据库 、虚谷数据库 、人大金仓数据库 、南大通用数据库
框架结构

代码托管
Gitee | Github
参与贡献
欢迎各路好汉一起来参与完善 MyBatis-Plus,我们期待你的 PR!
快速开始
数据准备
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
|
初始化工程
使用 Spring Initializer 快速初始化一个 Spring Boot 工程
添加依赖
引入 Spring Boot Starter 父工程:
1
2
3
4
5
6
|
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.5.RELEASE</version>
<relativePath/>
</parent>
|
引入 spring-boot-starter
、spring-boot-starter-test
、mybatis-plus-boot-starter
、lombok
、mysql-connector-java
依赖:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- mybatis-plus 是自己开发,并非官方的! -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
|
配置数据源
1
2
3
4
5
6
7
|
spring:
datasource:
# 数据源基本配置
username: root
password: 333
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/eden?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&allowMultiQueries=true
|
配置扫描包
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
package com.eh.mp;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("com.eh.mp.dao")
@SpringBootApplication
public class MybatisPlusDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusDemoApplication.class, args);
}
}
|
编写实体类
1
2
3
4
5
6
7
8
9
10
11
|
package com.eh.mp.entity;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
|
编写Mapper
1
2
3
4
5
6
7
|
package com.eh.mp.dao;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.eh.mp.entity.User;
public interface UserMapper extends BaseMapper<User> {
}
|
配置日志:
logback.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
<?xml version="1.0" encoding="UTF-8"?>
<configuration scanPeriod="60 seconds" debug="false">
<timestamp key="dt" datePattern="yyyyMMdd HH:mm:ss"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--高亮-->
<pattern>${dt} [%thread] %highlight(%-5level) %cyan(%logger{50}) - %msg%n</pattern>
</encoder>
<withJansi>true</withJansi>
</appender>
<logger name="com.eh.mp.dao" level="debug"/>
<logger name="org.mybatis" level="debug"/>
<root level="info">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
|
测试:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
package com.eh.mp;
import com.eh.mp.dao.UserMapper;
import com.eh.mp.entity.User;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
@ExtendWith(SpringExtension.class)
@SpringBootTest
class MybatisPlusDemoApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
userMapper.selectList(null).stream().forEach(System.out::println);
}
}
|
控制台输出
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
20201104 18:59:50 [main] DEBUG org.mybatis.spring.SqlSessionUtils - Creating a new SqlSession
20201104 18:59:50 [main] DEBUG org.mybatis.spring.SqlSessionUtils - SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4f966719] was not registered for synchronization because synchronization is not active
20201104 18:59:50 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Starting...
20201104 18:59:50 [main] INFO com.zaxxer.hikari.HikariDataSource - HikariPool-1 - Start completed.
20201104 18:59:50 [main] DEBUG o.m.spring.transaction.SpringManagedTransaction - JDBC Connection [HikariProxyConnection@1163664780 wrapping com.mysql.cj.jdbc.ConnectionImpl@a451491] will not be managed by Spring
20201104 18:59:50 [main] DEBUG com.eh.mp.dao.UserMapper.selectList - ==> Preparing: SELECT id,name,age,email FROM user
20201104 18:59:50 [main] DEBUG com.eh.mp.dao.UserMapper.selectList - ==> Parameters:
20201104 18:59:50 [main] DEBUG com.eh.mp.dao.UserMapper.selectList - <== Total: 5
20201104 18:59:50 [main] DEBUG org.mybatis.spring.SqlSessionUtils - Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4f966719]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)
|
小结
通过以上几个简单的步骤,我们就实现了 User 表的 CRUD 功能,甚至连 XML 文件都不用编写!
从以上步骤中,我们可以看到集成MyBatis-Plus
非常的简单,只需要引入 starter 工程,并配置 mapper 扫描路径即可。