Mybatis-Plus[狂]

Mybatis-Plus[狂]

写于2021.11.16

视频地址 狂神说Mybatis-Plus

原文地址

Mybatis-plus概述

需要的基础：SSM拿下

为什么学？→节省工作时间，大部分CRUD都可以自动完成

JPA tk-mapper MybatisPlus同类型插件

1. 简介

简介

是什么？Mybatis本身为了简化JDBC操作，Mybatis-Plus为了简化Mybatis

官网：

MyBatis-Plus

技术没有高低之分，人有高低之别

特性

使用第三方插件：

1. 导入对应的依赖
2. 研究依赖如何配置
3. 代码如何编写
4. 提高扩展技术能力

2. 快速入门

步骤

1. 创建数据库mybatis-plus
2. 创建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');

—真实开发中，会包含version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modifed

1. 编写项目，初始化项目，使用SpringBoot初始化
2. 导入依赖

<!--数据库驱动-->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.47</version>
		</dependency>
		<!--mybatis-plus-->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.0.5</version>
		</dependency>
		<!-- lombok -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.12</version>
		</dependency>

说明：我们使用mybatis-plus，可以节省大量代码，尽量不要同时导入mybatis和mybatis-plus，会导致一些错误

1. 连接数据库，和mybatis相同

#mysql
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&characterEncoding=utf8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

1. 使用mybatis-plus之前→pojo-dao（连接mybatis，配置mapper.xml文件）-service.controller
2. 使用mybatis-plus之后

• pojo

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private int id;
    private String name;
    private Integer age;
    private String email;
}

• mapper接口

package com.xu.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.xu.pojo.User;
import org.springframework.stereotype.Repository;

//在对应mapper上面实现基本的接口
@Repository //代表是dao层
public interface UserMapper extends BaseMapper<User>{
    //大部分crud编写完成
    //不需要以前的配置一堆文件
}

• 注意点：我们需要在主启动类上去扫描我们的mapper包下的所有接口@MapperScan(**"com.xu.mapper"**)
• 测试类中测试

package com.xu;

import com.xu.mapper.UserMapper;
import com.xu.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class MybatisPlusApplicationTests {

	//继承了basemapper的所有方法，所有方法来自父类，可以编写扩展方法
	@Autowired
	private UserMapper userMapper;

	@Test
	void contextLoads() {
		//查询全部用户
		//参数是wrapper，条件构造器，无条件就写null
		List<User> userList = userMapper.selectList(null);
		userList.forEach(System.out::println);
	}

}

• 使用

思考问题

1. SQL谁帮我们写的？Mybatis-Plus
2. 方法哪里来的？Mybatis-Plus

3. 配置日志

目前所有sql不可见，我们需要透明，配置日志

#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

配置完毕之后，后面的学习就需要注意自动生成的sql

4. CRUD扩展

Insert

@Test
	public void testInsert()
	{
		User user = new User();     //帮我们自动生成id
		user.setName("狂神说Java");
		user.setAge(3);
		user.setEmail("1");
		userMapper.insert(user);
	}

结果

💡 数据库插入的id：全局唯一默认值

主键生成策略

💡 默认***`ID_WORKER` 全局唯一id***

雪花算法：

SnowFlake 算法，是 Twitter 开源的分布式 id 生成算法。其核心思想就是：使用一个 64 bit 的 long 型的数字作为全局唯一 id。核心：41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心：北京，上海，西雅图，5个bit的机器id），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生4096个id），可以保证几乎全球唯一。

💡 主键自增

我们需要配置主键自增

1. 实体类字段上@TableId(type = IdType.***AUTO***)
2. 数据库字段上自增
3. 再次测试插入即可

💡 其余的源码解释

public enum IdType {
    AUTO(0),           //数据库id自增
    NONE(1),           //未设置主键
    INPUT(2),          //手动输入
    ID_WORKER(3),      //默认的全局唯一id
    UUID(4),           //全局唯一id uuid
    ID_WORKER_STR(5);  //ID_WORKER 字符串表表示法

update

@Test
	public void testUpdate()
	{
		User user = new User();
		user.setId(5);
		user.setName("老道");
		userMapper.updateById(user);
	}

@Test
	public void testUpdate()
	{
		User user = new User();
		user.setId(5);
		user.setAge(19);
		userMapper.updateById(user);
	}

大部分sql都自动生成

自动填充

创建/修改时间，这些操作都是自动化完成的，我们不希望手动更新

阿里巴巴开发手册：所有的数据库表：gmt_creat、gmt_modifyed几乎所有的表都要配置，而且需要自动化

1. 方式一：数据库级别

• 在表中新增字段create_time,update_time
• 再次测试插入方法

1. 代码级别

• 删除默认值，更新操作
• 实体类字段上增加注解

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

• 编写处理器处理注解

@Component //不要忘记将处理器加入ioc容器
@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);
    }
}

• 测试插入
• 测试更新，观察时间

乐观锁

在面试过程中，我们经常会被闻到乐观锁，悲观锁，其实很简单

乐观锁：顾名思义十分乐观，总认为不会出现问题，无论干什么都不会上锁，如果出了问题，再次更新值测试

悲观锁：顾名思义十分悲观，无论干什么都会上锁，再去操作

version，new version

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

乐观锁：1. 先查询版本号，获得版本号 version=1

--A线程
update user set name = "laodao",version=version+1
where id=2 and version=1

--B线程先一步完成，version=2，A线程就会更新失败
update user set name = "laodao",version=version+1
where id=2 and version=1

测试一下Mybatis-Plus乐观锁插件

1. 给数据库添加version字段
   

2. 实体类加对应的字段

@Version //乐观锁注解
    private int version;

1. 配置乐观锁

@MapperScan("com.xu.mapper")
@EnableTransactionManagement
@Configuration //强调此类为配置类
public class MybatisPlusConfig {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

1. 测试是否成功

查询操作

//测试查询
	@Test
	public void testSelectById()
	{
		User user = userMapper.selectById(1);
		System.out.println(user);
	}
	//测试批量查询
	@Test
	public void testSelectByBatchId()
	{
		List<User> userList = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
		userList.forEach(System.out::println);
	}
	//条件查询 map
	@Test
	public void testSelectByMap()
	{
		HashMap<String,Object> map = new HashMap<>();
		//自定义查询
		map.put("name", "laodao2");
		map.put("age", 4);
		List<User> userList = userMapper.selectByMap(map);
		userList.forEach(System.out::println);
	}

分页查询

分页在网站使用很多

1. 原始的limit分页
2. pageHelper第三方插件
3. mybatis-plus 有自带的分页插件

💡 如何使用

1. 配置拦截器组件即可

//分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return  new PaginationInterceptor();
    }

1. 直接使用page对象

//测试分页查询
	@Test
	public void testPage()
	{
		//参数一：当前页
		//参数二，页面大小
		//使用分页插件之后，现在就很简单了
		Page<User> page = new Page(2,5);
		userMapper.selectPage(page,null);

		page.getRecords().forEach(System.out::println);
		System.out.println(page.getTotal());

	}

删除操作

//测试删除
	@Test
	public void testDeleteByid()
	{
		userMapper.deleteById(4);
	}

	//通过集合删除
	@Test
	public void testDeleteBatchId()
	{
		userMapper.selectBatchIds(Arrays.asList(2,3));
	}

逻辑删除

💡 物理删除：从数据库中直接移除 逻辑删除：数据库中没有删除，而是通过一个变量让他失效 deleted = 0→deleted 1

管理员可以查看被删除记录，防止数据的丢失，类似回收站

测试一下：

1. 在表中增加一个deleted字段
2. 实体类中增加属性

@TableLogic //逻辑删除
private Integer deleted;

1. 配置

    @Bean //逻辑删除组件：高版本只需要实体类注解，不需要增加配置
    public ISqlInjector sqlInjector()
    {
        return new LogicSqlInjector();
    }

#配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

1. 测试删除

记录依然在，不过刚才的deleted值已经变化为1

1. 再次测试查询
   

这时语句已经拼接进deleted，实现回收站功能

5. 性能分析插件

平时我们的开发中，会遇到一些慢sql，测试/druid可以测试

MP也提供性能分析插件，如果超过时间就停止运行

1. 导入插件

@Bean
    @Profile({"dev","test"}) //设置在开发模式和测试模式启用
    public PerformanceInterceptor performanceInterceptor()
    {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); //设置最大查询时间
        performanceInterceptor.setFormat(true); //设置sql格式化
        return performanceInterceptor;
    }

注：要在SpringBoot中配置环境为dev或test环境

1. 测试使用

使用性能分析插件，可以分析sql，提高效率

6. 条件构造器

十分重要：Wrapper

写自定义语句的时候就需要这些

1. 测试一

@Test
    void test1()
    {
        //查询邮箱不为空，年龄有限制的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name")
               .ge("age", 12);
        userMapper.selectList(wrapper).forEach(System.out::println);
    }

1. 测试二

@Test
    void test2()
    {
        //查询名字为特定的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","laodao2");
        System.out.println(userMapper.selectOne(wrapper));;
    }

1. 测试三

@Test
    void test3()
    {
        //年龄在一定范围
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age", 20, 30);
        System.out.println(userMapper.selectOne(wrapper));;
    }

1. 测试四

//模糊查询
    @Test
    void test4()
    {
        //年龄在一定范围
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //左和右 %e 和 e%
        wrapper
                .notLike("name", "e")
                .likeRight("email", "t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

1. 测试五

@Test
    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. 代码生成器

dao、pojo、service、controller自动生成

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

测试：

public class Code {
    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("uKonw1mYourType");
        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);

        //2. 设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf8");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3. 包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.xu");
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4. 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user"); //!设置要映射的表名
        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> tableFiles = new ArrayList<>();
        tableFiles.add(gmtCreate);
        tableFiles.add(gmtModified);
        strategy.setTableFillList(tableFiles);
        //乐观锁
        strategy.setVersionFieldName("version");

        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);

        mpg.setStrategy(strategy);

        mpg.execute(); //执行命令
    }
}

注：需要自动生成代码时需要（老版本 目前3.0.5）

<!-- 模板引擎 -->
		<dependency>
			<groupId>org.apache.velocity</groupId>
			<artifactId>velocity-engine-core</artifactId>
			<version>2.0</version>
		</dependency>