MybatisPlus
简介
mybatisplus是什么?
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
mybatisplus特性:
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
-
搭建数据库
- 新建表
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) );
- 插入数据
DELETE FROM user; 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');
-
新建一个springboot工程,导入mybatisplus依赖
<dependencies> <!--mybatis-plus,可以先使用低版本的,可以体验原生态的一些功能--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency> <!--mysql--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </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>
-
配置yml文件(数据库)
spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver username: root password: 1227 url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
-
编写实体类
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private int age; private String email; }
-
编写mapper接口
//继承BaseMapper<User>,实体类为泛型 public interface UserMapper extends BaseMapper<User> { }
-
主启动类中开启扫描mapper接口包
@SpringBootApplication @MapperScan("com.ryan.mapper") public class MybatisPlusApplication { public static void main(String[] args) { SpringApplication.run(MybatisPlusApplication.class, args); } }
-
测试
@Test void contextLoads() { List<User> users = userMapper.selectList(null); for (User user : users) { System.out.println(user); } }
思考:
- 我们全程没配置mybatis,也没写sql语句,这些都是谁帮我们做了?
小结:
通过以上几个简单的步骤,我们就实现了 User 表的 CRUD 功能,甚至连 XML 文件都不用编写!
从以上步骤中,我们可以看到集成MyBatis-Plus
非常的简单,只需要引入 starter 工程,并配置 mapper 扫描路径即可。
但 MyBatis-Plus 的强大远不止这些功能,想要详细了解 MyBatis-Plus 的强大功能?那就继续往下看吧!
配置日志
我们所有的sql现在都是不可见的,我们希望知道他是怎么执行的,所以我们必须看日志
配置日志实现:这里使用系统的,如果使用其他的还要导入对应依赖
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 这里使用系统的日志实现
CRUD扩展
插入操作
测试数据插入
@Test
void test1() {
User user = new User();
user.setName("ryan");
user.setAge(3);
user.setEmail("123@124.com");
int result = userMapper.insert(user);
System.out.println(result);
//注意这里没有手动设置id,看看插入后的id是怎样的
}
主键生成策略
我们本身没有收到设置id的生成策略,但是我们插入没有id的数据时,发现最后还是生成了id,说明mybatis-plus帮我们做了这一点,他的生成策略是雪花算法
如果我们想要自定义id生成策略的话,可以在实体类中添加注解
@TableId(type = IdType.AUTO)
private Long id;
点进注解可以看到,有多种策略可以选择
public enum IdType {
AUTO(0),//自增,注意如果这里设置了自增,数据库也一定要设置,否则会报错
NONE(1),//未设置主键
INPUT(2),//手动输入
ID_WORKER(3),//默认的全局唯一id
UUID(4),//全局唯一id,uuid
ID_WORKER_STR(5);//ID_WORKER的字符串表示法
}
感兴趣的可以自己去测试一下,这里就不一一测试了
更新操作
@Test
void test2() {
User user = new User();
user.setId(1269856358531420162L);
user.setName("ryan");
user.setAge(25);
user.setEmail("635726567@qq.com");
int result = userMapper.updateById(user);//注意虽然方法名是byId,但是参数是一个对象
System.out.println(result);
}
从结果来看,mybatis-plus还可以我们拼接动态sql,这是一个非常强大的功能
自动填充
创建时间、修改时间,这些操作一般都是自动化完成的,我们不需要手动更新
阿里巴巴开发手册:所有的数据库表:gmt_create、gmt_modified几乎所有的表都要配置上
方式一:数据库级别(工作中不允许你修改数据库)
- 在表中添加字段create_time,update_time两个字段,默认值为CURRENT_TIMESTAMP
2. 在实体来添加对应的属性
//自动填充
private Date createTime;
private Date updateTime;
- 再次插入一条数据,查看结果
方式二:代码级别
-
删除数据库的默认值,更新操作
-
实体类字段添加注解
//自动填充 @TableField(fill = FieldFill.INSERT) private Date createTime; @TableField(fill = FieldFill.INSERT_UPDATE) private Date updateTime;
-
编写处理器来处理这个注解即可
@Component @Slf4j public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { log.info("start execute insert fill"); this.setFieldValByName("createTime",new Date(),metaObject); this.setFieldValByName("updateTime",new Date(),metaObject); } @Override public void updateFill(MetaObject metaObject) { log.info("start execute update fill"); this.setFieldValByName("updateTime",new Date(),metaObject); } }
-
再测试插入和更新操作,注意时间的变化
小结:
- mybatis-plus已经帮忙我们实现了自动填充功能,并且匹配时间格式
- 但是要注意,时区要设置东八区的时间:serverTimezone=GMT%2B8
乐观锁(保留)
查询操作
mybatis-plus中除了单个查询还可以多个查询,以及条件查询
//查询操作
@Test
void test3(){
User user = userMapper.selectById(1);
System.out.println(user);
}
@Test
void test4(){
//除了查询单个记录,还可以通过id查询多条记录
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
for (User user : users) {
System.out.println(user);
}
//结果三条记录都查出来了,牛逼
}
@Test
void test5(){
//还可以通过map进行我条件查询
Map<String, Object> map = new HashMap<>();
//自定义要查询
map.put("name","Tom");
map.put("age",28);
List<User> users = userMapper.selectByMap(map);
for (User user : users) {
System.out.println(user);
}
}
分页查询
以前大家都是用limit或者pagehelper分页插件
其实mybatisplus也内置了分页查询功能
mybatisplus分页使用步骤
springboot配置mybatisplus分页插件
@Configuration
@MapperScan("com.ryan.mapper")//扫描mapper的注解可从主启动类转移到配置类中
@EnableTransactionManagement
public class MybatisPlusConfig {
//配置分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
测试,直接调用selectPage方法即可
@Test
void test6(){
//参数为查询第几页,每页大小
IPage<User> page = new Page<>(2, 5);
userMapper.selectPage(page,null);
//从结果来看确实按照分页查询了,看sql语句,底层本质上还是使用了limit
}
删除操作
删除操作非常简单,和上面操作都差不多,也支持单个删除、批量删除和map删除
//删除操作
@Test
void test7(){
userMapper.deleteById(7L);
}
@Test
void test8(){
userMapper.deleteBatchIds(Arrays.asList(8,9));
}
@Test
void test9(){
Map<String, Object> map = new HashMap<>();
map.put("name","bb");
userMapper.deleteByMap(map);
}
逻辑删除
逻辑删除的本质是修改操作,所谓的逻辑删除其实并不是真正的删除,而是在表中将对应的是否删除标识(is_delete)或者说是状态字段(status)做修改操作。比如0是未删除,1是删除。在逻辑上数据是被删除的,但数据本身依然存在库中。
逻辑删除使用步骤
-
在数据库中添加字段is_delete,并且默认值为0
-
在实体类中添加对应的属性,并添加注解@TableLogic
//逻辑删除字段 @TableLogic private Integer isDelete;
-
配置类中添加逻辑删除组件
//逻辑删除组件 @Bean public ISqlInjector iSqlInjector(){ return new LogicSqlInjector(); }
-
yml配置文件中配置逻辑删除默认值
mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 这里使用系统的日志实现 global-config: db-config: logic-delete-value: 1 # 逻辑已删除值(默认为 1) logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
-
测试
//逻辑删除,类似回收站,注意逻辑删除本质上是更新操作,将deleted字段的值修改 @Test void test10(){ userMapper.deleteById(2L); }
从结果来看,本质上走更新操作,将is_delete的值更新为1
然后再看看是否还可以查询到,经测试发现查不到了,因为此时会自动添加过滤操作
性能分析插件
性能分析拦截器,用于输出每条 SQL 语句及其执行时间,便于将一些慢sql揪出来修改以提高性能
该插件 3.2.0
以上版本移除推荐使用第三方扩展
性能分析插件使用步骤
-
添加bean组件
//性能分析插件 @Bean @Profile({"dev","test"})// 设置 dev test 环境开启 public PerformanceInterceptor performanceInterceptor() { PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); performanceInterceptor.setMaxTime(100);//设置sql执行最大时间为100毫秒,超过这个时间就会报错 performanceInterceptor.setFormat(true);//是否格式话sql语句 return performanceInterceptor; }
-
配置yml,当前环境为dev或者test
profiles: active: dev #当前环境为开发环境
-
测试使用
注意!参数说明:
- 参数:maxTime SQL 执行最大时长,超过自动停止运行,有助于发现问题。
- 参数:format SQL SQL是否格式化,默认false。
- 该插件只用于开发环境,不建议生产环境使用。
条件构造器
通过wrapper构造查询条件,然后传到查询方法即可
@Test
void test1(){
//name和email不为空,且年龄小于等于24岁的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.le("age",24);
List<User> users = userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
//写了一个之后,你会发现其实跟map差不多
}
@Test
void test2(){
//查询年龄在21-28之间的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",21,28);
List<User> users = userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
}
@Test
void test3(){
//查询名字有a的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like("name","a");
List<User> users = userMapper.selectList(wrapper);
for (User user : users) {
System.out.println(user);
}
}
…就不一一测了
代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
代码生成器使用步骤
-
导入相关依赖
<!--mybatis-plus,可以先使用低版本的,可以体验原生态的一些功能--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency> <!--代码自动生成器--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.0.5</version> </dependency> <!--模板引擎(默认)--> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.2</version> </dependency> <!--mysql--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!--springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
-
编写代码自动生成类并配置
public class RyanCode { public static void main(String[] args) { //需要构建一个代码自动生成器对象 AutoGenerator mpg = new AutoGenerator(); //配置策略 //1.全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getProperty("user.dir");//获取当前项目的路径 gc.setOutputDir(projectPath + "/src/main/java"); gc.setAuthor("Ryan"); gc.setOpen(false); gc.setFileOverride(false);//是否覆盖 gc.setServiceName("%sService");//去Service的I前缀 gc.setIdType(IdType.ID_WORKER); gc.setDateType(DateType.ONLY_DATE); gc.setSwagger2(true); mpg.setGlobalConfig(gc); //2.设置数据源 DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8"); dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("123456"); dsc.setDbType(DbType.MYSQL); mpg.setDataSource(dsc); //3.包的配置 PackageConfig pc = new PackageConfig(); pc.setParent("com.ryan"); pc.setEntity("entity"); pc.setMapper("mapper"); pc.setService("service"); pc.setController("controller"); mpg.setPackageInfo(pc); //4.策略配置 StrategyConfig sc = new StrategyConfig(); sc.setInclude("user");//需要映射的表,可变长参数,可以同时映射多个表 sc.setNaming(NamingStrategy.underline_to_camel); sc.setColumnNaming(NamingStrategy.underline_to_camel); //sc.setSuperEntityClass("你自己的父类实体,没有就不用设置"); sc.setEntityLombokModel(true); //sc.setRestControllerStyle(true); sc.setLogicDeleteFieldName("is_delete"); //看到逻辑删除,需要想到自动填充策略 TableFill createTime = new TableFill("create_time", FieldFill.INSERT); TableFill updateTime = new TableFill("update_time",FieldFill.INSERT_UPDATE); List<TableFill> list = new ArrayList<>(); list.add(createTime); list.add(updateTime); sc.setTableFillList(list); //乐观锁;略 //还有关于controller的一些策略 sc.setRestControllerStyle(true); sc.setControllerMappingHyphenStyle(true);//例如localhost:8080/hello_id_2 mpg.setStrategy(sc); mpg.execute(); } }
-
启动测试,发现都很多包和代码都帮我们自动生成了,如果还需要生成其他的(映射的表),只需要修改sc.setInclude(“user”);就可以了,非常方便