MyBatisPlus个人学习
(ps:学习自官方和狂神说视频)
概述
- MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。(MyBatis-Puls的官网)
特性
(PS:特性来自官网)
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
快速入门
1、创建数据库
- 创建user表
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');
2、创建项目
- 使用IDEA新建一个SpringBoot项目
3、导入pom依赖
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-puls依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</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>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
4、连接数据库
- 在resources目录下创建application.properties文件
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/user?userSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
5、测试
- 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private long id;
private String name;
private Integer age;
private String email;
}
- 创建接口
@Repository
public interface UserMapper extends BaseMapper<User> {
}
- 添加注解
@MapperScan("com.example.demo.mapper")
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
- 测试
@SpringBootTest
class DemoApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询所有用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
CRUD及扩展
1、增加操作
- 测试插入
//测试插入
@Test
public void testInsert(){
User user = new User();
/*user.setId(1);*/
user.setName("hdd9");
user.setAge(3);
user.setEmail("1205360515@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
System.out.println(user);
}
2、乐观锁
- 数据库中添加字段version,int类型,默认值为1;
- 实体类中添加version字段
@Version//乐观锁的注解
private Integer version;
- 创建配置类MyBatisPlusConfig
@Configuration//配置类
public class MyBatisPlusConfig {
//注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
- 测试乐观锁
//测试乐观锁成功案例
@Test
public void testOptimisticLocker(){
//查询用户信息
User user = userMapper.selectById(1);
//修改用户信息
user.setName("hdd");
userMapper.updateById(user);
}
//测试乐观锁失败案例
@Test
public void testOptimisticLocker2(){
//线程1
User user = userMapper.selectById(6);
//修改用户信息
user.setName("hdd1");
//模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(6);
//修改用户信息
user2.setName("hdd2");
userMapper.updateById(user2);
userMapper.updateById(user);//如果没有乐观锁,会覆盖另外一个线程的值
}
3、更新操作
//测试更新
@Test
public void testUpdate(){
User user = new User();
//可以根据条件自动拼接动态SQL
user.setId(7);
user.setName("hdd6");
user.setAge(24);
//虽然updataById是ById但是参数是对象
int i = userMapper.updateById(user);
System.out.println(i);
}
4 、主键生成策略
- 在实体类主键字段上有个注解@TableId
/**
* 数据库ID自增
* AUTO(0),
* 该类型为未设置主键类型
* NONE(1),
* 用户输入ID
* 该类型可以通过自己注册自动填充插件进行填充
* INPUT(2),
* 以下3种类型、只有当插入对象ID为空,才自动填充。
* 全局唯一ID (idWorker)
* ID_WORKER(3),
* 全局唯一ID (UUID)
* UUID(4),
* 字符串全局唯一ID (idWorker 的字符串表示)
* ID_WORKER_STR(5);*/
@TableId(type = IdType.INPUT)
private long id;
6、查询操作
- 在MyBatisPlusConfig中配置分页插件
//配置分页插件
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
- 测试各种查操作
//测试查询操作
@Test
public void testSelectById(){
User user = userMapper.selectById(1);
System.out.println(user);
}
//测试查询多个用户操作
@Test
public void testSelectByBatchIds(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
//条件查询-使用map操作
@Test
public void testSelectByMap(){
HashMap<String, Object> hashMap = new HashMap<>();
//自定义要查询的条件
/*hashMap.put("name","侯典栋");*/
hashMap.put("age",5);
List<User> users = userMapper.selectByMap(hashMap);
users.forEach(System.out::println);
}
//分页查询
@Test
public void testPage(){
//参数一:current-当前页
//参数一:size-页面大小
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
//查询总记录数
System.out.println(page.getTotal());
}
7、删除操作
//测试删除
@Test
public void testDeleteById(){
userMapper.deleteById(6L);
}
//测试批量删除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(10L,9L));
}
//测试条件删除
@Test
public void testDeleteMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("id","8");
userMapper.deleteByMap(map);
}
8、逻辑删除
- 逻辑删除意思是,在数据库表中添加字段deleted,默认值为0,删除操作的时候删除完成后值改为1,再查询操作的时候就查询不到了,数据库中数据其实还没有丢失。
- application.properties配置文件中添加逻辑删除
#配置逻辑删除
mybatis-puls.global-config.db-cofing.logic-delete-value=1
mybatis-puls.global-config.db-cofing.logic-not-delete-value=0
- 数据库中添加字段deleted,默认值为0
- MyBatisPlusConfig类中添加组件
//逻辑删除组件
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
- 测试逻辑删除
//测试逻辑删除
@Test
public void testDeleteById01(){
userMapper.deleteById(1L);
}
9、性能分析插件
- application.properties中配置开发环境
#设置开发环境
spring.profiles.active=dev
- MyBatisPlusConfig中配置性能分析插件
//性能分析插件
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100);//设置sql执行的最大时间,如果超过了不执行,默认单位毫秒
performanceInterceptor.setFormat(true);//是否格式化
return performanceInterceptor;
}
- 效果
10、条件构造器
- 创建UserMapper和UserMapper.xml
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hdd.mapper.UserMapper">
</mapper>
- 在test中创建新的测试类WrapperTest
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
}
- 测试各种构造器
@Test
void contextLoads() {
//查询name,email不为空的用户,并且年龄大于等于6;
QueryWrapper<User> wrapper = new QueryWrapper<>();
//wrapper跟map不同,wrapper中有很多方法
wrapper.isNotNull("name").isNotNull("email").ge("age",6);
userMapper.selectList(wrapper).forEach(System.out::println);
}
@Test
void test02(){
//查询单条数据
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","侯典栋2");
User user = userMapper.selectOne(wrapper);//查询一个数据,出现多个会报错
System.out.println(user);
}
@Test
void test03(){
//查询age在1-10岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",1,10);//区间
Integer count = userMapper.selectCount(wrapper);//查询结果数
System.out.println(count);
}
//模糊查询
@Test
void test04(){
//查询名字中不包含2的
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name","2");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
@Test
void test05(){
//id 在子查询中查询出来
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id<4");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
@Test
void test06(){
//通过ID进行排序
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
11、代码自动生成器
- 创建新的测试类HddCode
public class HddCode {
public static void main(String[] args) {
//构建一个代码自动生成器对象
AutoGenerator mpg = new AutoGenerator();
//配置策略
//全局配置
GlobalConfig gc = new GlobalConfig();
String propertyPath = System.getProperty("user.dir");//获取系统当前目录
gc.setOutputDir(propertyPath+"/src/main/java");//生成路径
gc.setAuthor("hdd");//作者姓名
gc.setOpen(false);//是否打开资源管理器
gc.setFileOverride(false);//是否覆盖原来生成
gc.setServiceName("%sService");//去掉Service的I前缀
gc.setIdType(IdType.ID_WORKER );//默认是初始算法
gc.setDateType(DateType.ONLY_DATE);//日期类型
gc.setSwagger2(true);//是否配置Swagger文档
mpg.setGlobalConfig(gc);
//设置数据源的配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/user?userSSL=false&useUnicode=true&characterEncoding=utf-8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//配置包
PackageConfig pc = new PackageConfig();
pc.setModuleName("obm");
pc.setParent("com.hdd");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user");//要映射的表名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);//自动生成lombok
strategy.setLogicDeleteFieldName("deleted");//自动配置逻辑删除
//自动填充配置
TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
//乐观锁的配置
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);//localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute();//执行
}
}