Mybatis-Plus个人学习总结笔记

为什么要学习它呢？MybatisPlus可以节省我们大量的工作时间，所有的CRUD代码它都可以自动化完成！
JPA、tk-mapper、MybatisPlus

一、简介

1.1MybatisPlus是什么？

MybatisPlus官网
MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

1.2特性[见官网]

使用第三方组件套路：
（一）导入对应的依赖；（二）研究依赖如何配置；（三）代码如何编写；（四）提高扩展技术能力；

2.1入门步骤

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');

2.2初始化工程

创建一个空的SpringBoot工程web
在SpringBoot默认依赖的基础上引入

 <!--数据库驱动-->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<!--lombok-->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
		</dependency>

		<!--mybatis_plus-->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.0.5</version>
		</dependency>

2.3开始配置（连接数据库-和mybatis一样）

# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同com.mysql.cj.jdbc.Driver、需要增加时区的配置 serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus?useSSL=false&userUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

2.4传统方式pojo-dao(连接mybatis、配置mapper.xml文件)-service-controller

2.4使用了mybatis-plus之后

（一）pojo

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private long id;
    private String  name;
    private Integer age;
    private String email;

}

（二）mapper

//在对应的Mapper上面继承基本的接口BaseMapper
@Repository
public interface UserMapper extends BaseMapper<User>{

    //所有的CRUD操作都已经编写完成了
    //你不需要像以前那样的配置一大堆的文件了
}

注意： 我们需要在主启动类上去扫描我们的mapper包下的所有接口@MapperScan("com.example.Mapper")
（三）测试类中测试

@SpringBootTest
class MybatisPlusApplicationTests {
	//继承了BaseMapper,所有的方法都来自自己的父亲
	//我们也可以编写自己的扩展方法
	@Autowired
	private UserMapper userMapper;

	@Test
	void contextLoads() {
		//参数wrapper 条件构造器 我们这查所有 用null
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

（四）成功截图

三、配置日志

我们所有的sql现在都是不可见的，我们希望知道它是如何执行的，所有我们需要看日志

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

配置完毕日志之后，后面的学习就需要注意到这个自动生成的的SQL。

四、CRUD扩展

4.1insert

    @Test
    public void testinsert(){
	    User user = new User();
		user.setName("赵亮亮");
		user.setAge(23);
		user.setEmail("1003989507@qq.com");

        int insert = userMapper.insert(user);//帮我们自动生成了id
        System.out.println(insert);//受影响的行数
        System.out.println(user);//发现 id会自动回填
    }

问题：可能出现id为0，第二次运行报错Duplicate entry ‘0’ for key ‘PRIMARY’
解决方案： User表中的id写成了long,改成Long即可

4.2主键生成策略

4.2.1默认ID_WORKER全局唯一id

链接: 分布式系统唯一id生成

雪花算法： snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0,可以保证全球唯一。

4.2.2主键自增

我们需要配置主键自增：
1、实体类字段上@TableId(type = IdType.AUTO)
2、数据库字段一定要是自增的！

问题：数据设置id自增的时候，保存出现ALTER TABLE causes auto_increment resequencing, resulting in duplicate entry ’1′ for key提示’
解决方案：

第1步：将主键字段值为0的那条记录值改为其他大于0且不重复的任意数
第2步：修改主键字段为auto_increment
第3步：把刚才修改过的那条记录的值还原

3、再次测试即可
4、其他的源码解析

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

4.3更新操作

所有的sql都是自动帮你动态配置的

/*
* 更新操作
* */
@Test
public void testUpdate(){
    User user = new User();
    //通过条件自动拼接动态sql
    user.setId(5L);
    user.setAge(33);
    //注意：updateById 但是参数是一个对象
    int i = userMapper.updateById(user);
    System.out.println(i);
}

4.4自动填充

比如 创建时间、修改时间、这些操作都是一遍都是自动化完成的，我们不希望手动更新
阿里巴巴开发手册：所有的数据表：gmt_creat、gmt_modified几乎所有表都要配置上！而且需要自动化

4.1方式一：数据库级别[工作做不建议使用]

1、在表中新增create_time、update_time

2、再次测试插入方法，我们需要先把实体类同步！

private Date createTime;
private Date updateTime;

3、再次查看更新结果

4.2方式二：代码级别

1、删除数据库的默认值、更新操作！
2、实体类字段属性上需要增加注解

//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3、编写处理器来处理这个注解即可

@Slf4j
@Component //一定不要忘记把处理器加入到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
    /*
    * 插入时的填充策略
    * */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill .....");
        //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        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);
    }
}

4、测试插入、测试更新、观察时间即可

4.5乐观锁

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

当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
    取出记录时，获取当前version
     更新时，带上这个version
     执行更新时， set version = newVersion where version = oldVersion
     如果version不对，就更新失败

乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "zhaoliangliang" ,version = version + 1
where id = 2 and version = 1

-- B 线程抢先完成，这个时候 version = 2 ，会导致 A 修改失败！
update user set name = "zhaoliangliang" ,version = version + 1
where id = 2 and version = 1

4.5.1测试一下乐观锁插件

1、首先数据库添加version
2、实体类加对应的字段

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

3、注册组件

//扫描我们的mapper文件夹
@MapperScan("com.example.Mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}

4、测试一下

4.6查询操作

	/*
    * 测试查询
    * */
    @Test
    public void testSelectById(){
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    /*
     * 测试多id查询
     * */
    @Test
    public void testSelectByBechId(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);

    }

    /*
    * 按条件查询之一使用 map操作
    * */
    @Test
    public void testSelectByBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        //自定义查询
        map.put("name","佑子");
        map.put("age",18);

        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

4.6分页查询

分页在网站上使用十分之多
1、原始的limit进行分页；2、pageHelper第三方插件；3、MP其实也内置了分页插件

4.6.1配置拦截器组件[根据版本导]

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

4.6.2直接使用

/*
* 测试分页插件
* */
@Test
public void testPage(){
    //参数一：当前页 参数二：页面大小
    Page<User> page = new Page<>(2,5);
    userMapper.selectPage(page,null);
    //
    page.getRecords().forEach(System.out::println);
}

4.7一般删除

/*
    * 删除操作
    * */
    @Test
    public void deleyte(){
        userMapper.deleteById(1370251770880638977L);
    }
    /*
     * 批量删除
     * */
    @Test
    public void deleyte2(){
        userMapper.deleteBatchIds(Arrays.asList(4L,5L));
    }
    /*
     * 通过map删除
     * */
    @Test
    public void deleyte3(){
        HashMap<String , Object> map = new HashMap<>();
        map.put("name","赵亮亮");
        userMapper.deleteByMap(map);
    }

4.8逻辑删除

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

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

1、数据库添加字段
2、实体类增加属性

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

3、配置

//3.1.1开始不在需要这一步
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

properties中：
# 逻辑逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

yml中:
mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

4、测试

数据库查看

去查询当前数据

4.9性能分析插件

作用：性能
我们在平时的开发中，会遇到一些慢查询sql,测试！druid…
MP也提供性能分析插件，如果超过这个时间就会停止运行！

4.9.1导入插件

/*
* SQL执行效率插件
* */
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//ms 设置sql执行的最大时间 如果超过了则不执行
    performanceInterceptor.setFormat(true);//设置格式化代码
    return new PerformanceInterceptor();
}

然后配置
spring.profiles.active=dev

4.10条件构造器Wrapper

4.10.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);
}

4.10.2案例二

@Test
void contextLoads1() {
    //查询name、邮箱不为空的,年龄大于等于12的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","赵梦媛");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

4.10.3案例三

@Test
void contextLoads2() {
    //查询年龄在10-20岁的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",10,20);
    Integer count = userMapper.selectCount(wrapper);
    System.out.println(count);
}

4.10.4案例四,记住查看输出的sql进行分析

/*
* 模糊查询
* */
@Test
void contextLoads3() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
            .notLike("name","m")
            .likeRight("email","t");

    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

4.10.5案例五

/*
 * 嵌套查询
 * */
@Test
void contextLoads4() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //在子查询中查
    wrapper.inSql("id","select id from user where id<3");
    List<Object> list = userMapper.selectObjs(wrapper);
    list.forEach(System.out::println);
}

/*
 * 排序
 * */
@Test
void contextLoads5() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("id");

    List<User> list = userMapper.selectList(wrapper);
    list.forEach(System.out::println);
}

4.11代码自动生成器

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

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;

//代码生成器
public class KuangCode {
    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("赵亮亮");
        gc.setOpen(false);
        gc.setFileOverride(false);//是否覆盖
        gc.setServiceName("%sService");//去service的I前缀
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
//        gc.getSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatisplus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.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.example");
        pc.setEntity("entity");
        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.setEntityBuilderModel(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);
        mpg.setStrategy(strategy);
        mpg.execute();//执行
    }
}