为什么学MyBatisPlus?
为简化开发而生
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
愿景
我们的愿景是成为 MyBatis 最好的搭档,就像魂斗罗中的 1P、2P,基友搭配,效率翻倍
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
使用第三方组件
- 导入对应的依赖
- 研究依赖如何配置
- 代码如何编写
- 提高扩展技术能力!
步骤
-
创建数据库
mybatis_plus
CREATE DATABASE mybatis_plus
-
建表,插入数据
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');
-- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
- idea创建一个SpringBoot项目,添加web依赖
- 在pom.xml导入依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.17</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
Lombok偷懒必备=-= 学习经典的3.0.5版本
mybatis-plus是自己开发的部署官方的
导入mybatis-plus即可,尽量不要同时导入mybatis和mybatis-plus
- application.properties
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3307/mybatis_plus_study?useSSL=false&Unicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
pojo-dao-service-controller- 使用了mybatis-plus
- pojo
- mapper接口
- 使用
实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
Mapper接口继承BaseMapper,所有crud完成了
@Repository
public interface UserMapper extends BaseMapper<User> {
}
@MapperScan("com.bo.mybatis_plus_01_mapper")
@SpringBootApplication
public class MybatisPlus01Application {
public static void main(String[] args) {
SpringApplication.run(MybatisPlus01Application.class, args);
}
}
测试
@SpringBootTest
class MybatisPlus01ApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//参数是一个wrapper,条件构造器
//查询全部用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
主启动类要扫描mapper包下的所有接口
//扫描mapper包下所有的接口
@MapperScan("com.bo.mybatis_plus_01.mapper")
@SpringBootApplication
public class MybatisPlus01Application {
public static void main(String[] args) {
SpringApplication.run(MybatisPlus01Application.class, args);
}
}
配置日志
所有的SQL是不可见的,看日志可以知道怎么执行的
application.proprties
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
insert插入
@Test
//测试插入
public void testInsert() {
User user = new User();
user.setName("陈平安");
user.setAge(15);
user.setEmail("123@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
System.out.println(user);
}
id没设置,但id会自动回填
主键生成策略
uuid、自增id、雪花算法、redis、zookeeper
雪花算法
nowflake(雪花算法)是一个开源的分布式 ID 生成算法,结果是一个 long 型的 ID。snowflake 算法将 64bit 划分为多段,分开来标识机器、时间等信息。snowflake 算法的核心思想是使用 41bit 作为毫秒数,10bit 作为机器的 ID(比如其中 5 个 bit 可作为数据中心,5 个 bit 作为机器 ID),12bit 作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是 0。
默认 ID_WORKED 全局唯一id
@TableId(type=IdType.ID_WORKER)
主键自增
实体类字段
@TableId(type=IdType.AUTO)
数据库字段一定是自增的
测试插入
id自增
未设置主键
手动输入
默认的全局唯一id
全局唯一id
截取字符串
测试更新
所有的sql都是字段帮你动态配置的
@Test
public void testUpdate() {
User user = new User();
user.setId(3L);
user.setName("abc");
userMapper.updateById(user);
}
自动填充
创建时间、修改时间
gmt_create
gmt_modified
数据库级别
- 在表中新增字段create_time,update_time
数据库是下划线,实体类是驼峰命名
代码级别
数据库删除默认值
实体类增加注释
@TableField(fill= FieldFill.INSERT)
private Date createTime;
@TableField(fill= FieldFill.UPDATE)
private Date updateTime;
编写处理器来处理注解
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill");
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
测试插入
测试修改
乐观锁
乐观锁(Optimistic Lock), 顾名思义,就是很乐观,每次去拿数据的时候都认为别人
不会修改,所以不会上锁,但是在更新的时候会判断一下在此期间别人有没有去更新。
version、newversion
乐观锁实现方式:
- 取出记录时,获取当前 version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
乐观锁:1、先查询,获得版本号 version = 1
-- A
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
-- B 线程抢先完成,这个时候 version = 2,会导致 A 修改失败!
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
测试MyBatis-Plus乐观锁插件
- 数据库增加version字段(默认为1)
- 实体类加字段
@Version//乐观锁的Version注解
private Integer version;
- 注册组件
//配置类
@Configuration
//开启事务
@EnableTransactionManagement
//扫描mapper文件夹
@MapperScan("com.bo.mybatis_plus_01.mapper")
public class MyBatisPlusConfig {
//注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
- 测试
成功
@Test
public void testOptimisticLocker() {
//1. 查询用户信息
User user = userMapper.selectById(1L);
//2. 修改用户信息
user.setName("蛮吉");
//3. 更新
userMapper.updateById(user);
}
}
失败
@Test
public void testOptimisticLocker2() {
//线程1
//1. 查询用户信息
User user = userMapper.selectById(1L);
//2. 修改用户信息
user.setName("蛮吉1");
//另一个线程
User user2 = userMapper.selectById(1L);
user2.setName("魁拔");
userMapper.updateById(user2);
userMapper.updateById(user);
}
线程A的没有执行成功,因为version变成2了
悲观锁
悲观锁(Pessimistic Lock), 顾名思义,就是很悲观,每次去拿数据的时候都认为别人
会修改,所以每次在拿数据的时候都会上锁,这样别人想拿这个数据就会 block 直到它
拿到锁。
CRUD
查询
单个查询
@Test
public void testSelectById() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
多条查询
@Test
public void testselectBatchIds() {
List<User> user = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
user.forEach(System.out::println);
}
条件查询
//条件查询map
@Test
public void testSelectByBatchIds() {
HashMap<String, Object> map = new HashMap<>();
map.put("name","魁拔");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
- 原始的limit进行分页
- pageHelper第三方插件
- MyBatis-Plus内置了分页插件
使用
- 自定义配置类
//配置类
@Configuration
//开启事务
@EnableTransactionManagement
//扫描mapper文件夹
@MapperScan("com.bo.mybatis_plus_01.mapper")
public class MyBatisPlusConfig {
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
- 使用page对象
//分页测试
@Test
public void testPage() {
//当前页,页面大小
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
Wrapper是高级查询,在后面讲
删除
单个删除
//测试删除
@Test
public void testDeleteById() {
userMapper.deleteById(4L);
}
批量删除
//批量删除
@Test
public void testDeleteBatchId() {
userMapper.deleteBatchIds(Arrays.asList(2L, 3L));
}
条件删除
//map条件删除
@Test
public void testDeleteMap() {
HashMap<String, Object> map = new HashMap<>();
map.put("name", "蛮吉");
userMapper.deleteByMap(map);
}
逻辑删除
物理删除:数据库中删除
逻辑删除:通过一个变量让记录失效,deleted = 0 => deleted = 1
应用场景:管理员可以查看被删除的记录
测试
数据库增加字段
实体类增加
@TableLogic
private Integer deleted;
配置类
// 逻辑删除组件!
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
application.properties
删除了是1,未删除为0
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
@Test
public void testDeleteById() {
userMapper.deleteById(1L);
}
走的是更新语句
查询一下
@Test
public void testSelectById() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
会自动过滤逻辑删除的数据
性能分析插件
检测慢sql
作用:性能分析拦截器,用于输出每条 SQL 语句及其执行时间
MyBatis-Plus提供了性能分析插件,如果超过这个时间就停止运行
导入插件
配置类
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启,保证我们的效率
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new
PerformanceInterceptor();
performanceInterceptor.setMaxTime(10); // ms设置sql执行的最大时间,如果超过了则不执行
performanceInterceptor.setFormat(true); // 是否格式化代码
return performanceInterceptor;
}
application.properties
设置开发环境
spring.profiles.active=dev
条件构造器
写复杂的sql使用
测试1
@Test
void contextLoads() {
//查询name不为空,邮箱不为空,年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);
}
测试2
@Test
public void test2() {
//查询单条名字为魁拔的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "魁拔");
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
测试3
@Test
public void test3() {
//查询年龄在20-30之间的用户个数
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 20, 30);
Integer count = userMapper.selectCount(wrapper);
System.out.println(count);
}
测试4
@Test
public void test3() {
//查询年龄在20-30之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 20, 30);
List<User> count = userMapper.selectList(wrapper);
System.out.println(count);
}
测试5
@Test
public void test4() {
//模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
//左 %e
wrapper.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
测试6
@Test
public void test5() {
//子查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
//id在子查询中查出来
wrapper.inSql("id", "select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
测试7
@Test
public void test6() {
//排序
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
代码自动生成器
dao、pojo、service、controller都自己写
pom.xml导入依赖
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
public class AutoCode {
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("purplersky");
gc.setOpen(true);
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 dConfig = new DataSourceConfig();
dConfig.setUrl("jdbc:mysql://localhost:3307/subway?useSSL=false&Unicode=true&characterEncoding=utf-8");
dConfig.setDriverName("com.mysql.jdbc.Driver");
dConfig.setUsername("root");
dConfig.setPassword("123456");
dConfig.setDbType(DbType.MYSQL);
mpg.setDataSource(dConfig);
//3.配置包
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.bo.mybatis_plus_01");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//4. 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("bill"); // 设置要映射的表名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动lombok;
strategy.setLogicDeleteFieldName("deleted");
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);//驼峰命名
strategy.setControllerMappingHyphenStyle(true); //RestFul风格
mpg.setStrategy(strategy);
mpg.execute();//执行代码构造器
}
}