1. 介绍mybatis-plus
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。 但是对于联表操作还必须使用mybatis.
2. 特性
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错 JDK1.
支持主键自动生成:支持多达 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
3. 如何使用
(1) 创建一个springboot工程并加入mybatis-plus的依赖
<!--引入mybatis-plus的依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
(2) 修改配置文件
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/user?serverTimezone=Asia/Shanghai
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
logging.level.com.yyk.mybatisplus.demo.mapper=debug
(3) 实体类
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
这里实体类使用的是lombok插件,可以不用写getter,setter等方法。
(4) 接口mapper
//创建一个接口并继承BaseMapper
public interface UserMapper extends BaseMapper<User> {
}
(5) 在主启动类上mapper的扫描
@SpringBootApplication
@MapperScan(basePackages = {"com.yyk.mybatisplus.demo.mapper"})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
(6) 测试
@SpringBootTest
class MybatisPlusApplicationTests {
@Resource
private UserMapper userMapper;
@Test
void contextLoads() {
//根据id查询用户信息
User user = userMapper.selectById(1);
System.out.println(user);
}
}
我们创建Mapper类,继承BaseMapper,BaseMapper中定义了一些通用的CRUD方法,我们甚至可以不用写实体类的映射文件就可以完成一些简单的CRUD操作。
4.CRUD
(1)增加insert
① 实体类:
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO) //必须数据库也是递增
private Long id;
//如果列名和属性名不同
@TableField(value = "u_name")
private String name;
private Integer age;
private String email;
}
② 测试:
/**
* 如果不想使用雪花算法产生的id,可以自己指定主键的生成策略
*/
@Test
public void testinsert(){
User user=new User(null,"wew",17,"232@qq.com",0);
int row=userMapper.insert(user);
System.out.println(row);
}
(2) 删除 delete
逻辑删除
说明:
只对自动注入的sql起效:
插入: 不作限制
查找: 追加where条件过滤掉已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
更新: 追加where条件防止更新到已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
删除: 转变为 更新
① 在表中增加一个逻辑字段
@TableLogic
private Integer deleted;
② 测试:
/**
* 逻辑删除:
*/
@Test
public void testDelete(){
int i = userMapper.deleteById(2);
System.out.println(i);
}
(3)修改update(自动填充)
① 在相应的属性字段上添加如下注解
@TableField(fill = FieldFill.INSERT)//只要在添加时该字段会自动填充
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
② 创建一个自动配置类
@Configuration //表示该类为配置类
public class MyConfig implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
/**
* 为哪个字段做自动填充
*/
this.strictInsertFill(metaObject, "createTime", Date.class, new Date()); // 起始版本 3.3.0(推荐使用)
this.strictInsertFill(metaObject, "updateTime", Date.class, new Date()); // 起始版本 3.3.0(推荐使用)
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date()); // 起始版本 3.3.0(推荐)
}
}
③ 测试
@Test
public void testInsert(){
User user=new User(null,"李斯",17,"233242362@qq.com",0);
//1406790199747428353:雪花算法针对的分布式id生成策略
int row = userMapper.insert(user);
System.out.println(row);
}
/**
* 自动填充:修改时会自动填充修改时间
* 添加时会自动填充添加时间和修改时间
*/
@Test
public void testUpdate(){
User user=new User(3L,"王武",19,"2243453250@qq.com",0);
int i = userMapper.updateById(user);
}
(4)查询---条件查询
/**
* 条件查询
*Wrapper: 条件的包装类。-QueryWrapper UpdateWrapper LambdaQueryWrapper
* LambdaUpdateWrapper
*/
@Test
public void testSelectByCondication(){
QueryWrapper<User> wrapper=new QueryWrapper<>();
wrapper.between("age",12,18);
wrapper.or();
wrapper.like("u_name","王");
wrapper.orderByDesc("age");
wrapper.select("count(*)");
wrapper.groupBy("u_name");
List<User> users = userMapper.selectList(wrapper);
System.out.println(users);
}
(5)分页查询
① 引入分页的插件
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
② 使用分页方法
//分页查询, 而且必须配置分页插件
@Test
public void testSelectByPage(){
/**
* Page:当前页码 每页显示的条数
*/
Page<User> page=new Page<>(2,4);
Page<User> page1 = userMapper.selectPage(page, null);
System.out.println("当前的总页码:"+page1.getPages());
System.out.println("总条数:"+page1.getTotal());
System.out.println("当前页的记录:"+page1.getRecords());
}