官网:mp.baomidou.com
参考教程:mp.baomidou.com/guide/
一、简介
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,
为简化开发、提高效率而生。
-
润物无声
- 只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑。
-
效率至上
- 只需简单配置,即可快速进行 CRUD 操作,从而节省大量时间。
-
丰富功能
- 热加载、代码生成、分页、性能分析等功能一应俱全。
二、创建并初始化数据库
1. 创建数据库
mybatis_plus
2. 创建 User 表
其对应的数据库 Schema 脚本如下:
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)
);
注意这里主键没有选择自增:这是为了方便后面Mybatis-plus实现各种各样的主键策略:
插入数据,其对应的数据库 Data 脚本如下:
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');
三、确认idea配置
1、 打开配置
2、 Java编译器
3、项目和文件的编码
4、Maven配置
四、创建项目
1、初始化工程
使用 Spring Initializr 快速初始化一个 Spring Boot 工程:
Group:com.atguigu
Artifact:mybatis_plus
版本:2.2.1.RELEASE。pring Initializr 快速初始化时是2.3.1.RELEASE,后面会修改。
要保证是2.2.X:这样才能保证兼容性。
2、引入依赖
注意:引入 MyBatis-Plus 之后请不要再次引入 MyBatis,以避免因版本差异导致的问题。
原有的:spring-boot-starter和spring-boot-starter-test就用它的
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<scope>test</scope>
</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>
<!--我们要添加的依赖:-->
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1</version>
</dependency>
<!--mysql运行时依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!--lombok用来简化实体类-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
2.1 依赖分析
1. mybatis-plus-boot-starter:mybatis-plus启动器
mybatis-plus-boot-starter里面已经包含了mybatis依赖,所以就不要再次的引入mybatis了。
避免自己引入的mybatis和mybatis-plus-boot-starter里面自带的mybatis发生冲突。
2. mysql-connect-java:mysql的运行依赖
我们没有给这个依赖指定版本,因为在springboot的parent里面已经为我们的mysql引入了和
当前springboot版本所匹配的mysql版本。
springboot parent中指定的mysql版本是8.0.18,兼容的Mysql版本是5.6,5.7,8.0(5.8)
3. 引入lombok依赖,所以安装lombok插件
3、idea中安装lombok插件
(1)idea2019版本
(2)idea2018版本
五、编写代码
1、配置
在 application.properties 配置文件中添加 MySQL 数据库的相关配置:
1. spring boot 2.0(内置jdbc5驱动)
#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus&characterEncoding=UTF-8&useSSL=false&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
2. spring boot 2.1及以上(内置jdbc8驱动)
注意:driver和url的变化
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 东8区,2B就是+ 这是URL的编码格式
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
注意:
1、 这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀,因为8.0版本的jdbc驱动需要添加这个后缀,
否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is
unrecognized or represents more
2、 这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ,在 jdbc 8 中 建议使用这个
驱动,否则运行测试用例的时候会有 WARN 信息。
2、 主类
在 Spring Boot 启动类中添加 @MapperScan 注解,扫描mapper包下的:mapper/dao接口
@MapperScan("com.atguigu.mybatis_plus.mapper") //扫描mapper包下的:mapper/dao接口
@SpringBootApplication
@MapperScan("com.atguigu.mybatis_plus.mapper")
public class MybatisPlusApplication {
......
}
3、 实体
1. 创建包 entity 编写实体类 User.java(此处使用了 Lombok 简化代码)
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
2. 查看编译结果:
在实体类上加了@Data这个注解后,相当于给我们实体类加了如下这些东西:
4、 mapper
创建包 mapper 编写Mapper 接口: UserMapper.java
继承了BaseMapper这个厉害的爹后有很多功能:
不用写实现类了
有增删改查,有复杂查询,有分页,有排序。
注意这个泛型:<User> ,因为这个User泛型,在自动生成sql时,操作的是User表。
@Repository //表示这是一个持久层:mapper层/dao层,为了使@Autowired不报错
public interface UserMapper extends BaseMapper<User> {
}
5、测试
0. 添加测试类,进行功能测试:
用SpringBoot给我们提供的默认的测试环境
1. 注意:private UserMapper userMapper;会报红
这不是编译错误,在编译阶段由于面向对象的多态,它只看接口,接口在这个编译就会通过。
运行阶段再看这个UserMapper有没有实现类,如果没有实现类,它的启动会失败,实例创建不出来。
这是IDEA新添加的一个注入校验的功能:
在依赖注入的过程中,IDEA会在Spring的上下文找当前我们源码环境当中有没有UserMapper的
一个具体的实现在。
如果有的话IDEA就会认为你的UserMapper在未来是可以被实例化出来的,这个userMapper对象是可以
被注入进来的,IDEA就会认为这句话编写的正确。
但是如果IDEA在当前上下文没有找到UserMapper的一个实现类,他就认为你的项目在未来的运行过程
中没法注入userMapper这个对象,所以就会报这个错:
Could not autowire. No beans of 'UserMapper' type found. Could not autowire.
No beans of 'UserMapper' type found.
Mybatis-plus的工作原理:
只要有一个接口,此处是UserMapper在。未来在运行时它会根据我们的反射机制动态的去根据接口
生成实现类,再动态的根据实现类生成对象。
所以在运行的过程中,Mybatis-plus它就会自动的在此处注入真正userMapper对象。而不用我们
在编码的时候在实现这个接口。
这是因为IDEA不知道这个过程,才会提示这样的错误。
那么怎么让IDEA不报这个错呢?
在接口处加上@Repository注解表示这是一个持久层的组件Component:mapper层/dao层。
凡是添加了这样的一个注解的一个类/接口,IDEA就会认为它就是未来要被注入的一个对象。
虽然它是一个接口,但是你可以“骗”IDEA,IDEA就会认为有UserMapper的一个实现类用来注入。
2. userMapper.selectList(null);分析
selectList的参数是查询条件,即where后接的sql条件。此处没有任何条件null,即生成的sql没有
任何where语句。
通过以上几个简单的步骤,我们就实现了 User 表的 CRUD 功能,甚至连 XML 文件都不用编写!
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void testSelectList() {
//UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
//所以不填写就是无任何条件
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
3. 启动报错:测试方法启动不起来
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-launcher</artifactId>
<scope>test</scope>
</dependency>
4. 查看控制台输出:
6、查看sql输出日志
1. 我们想查看执行的SQL语句:打印日志
#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
2. 再看控制台打印: