Mybatis plus

1、概述

文档：Redirect

特性：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

2、快速入门

1、创建数据库

2、创建springboot项目，导入依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--连接数据库--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId></dependency><!--数据持久层框架--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.0.5</version></dependency>

3、连接数据库

spring.datasource.username=rootspring.datasource.password=20000211aspring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTCspring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

4、pojo-dao-service-controller

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {private Long id;private String name;private Integer age;private String email;}

//Mapper接口继承BaseMapper//所有的基本的CRUD就完成了@Repositorypublic interface UserMapper extends BaseMapper<User> {}

3、配置日志

配置日志只需要在application.properties文件中加上

mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

4、CRUD拓展

@Testvoid insert(){User user = new User();user.setName("徐翊皓");user.setAge(21);user.setEmail("1552485819@");userMapper.insert(user);}

主键生成策略

分布式系统唯一id生成：分布式系统唯一ID生成方案汇总 - nick hao - 博客园

1、默认ID_WORKER全局唯一id

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {//这个是默认的@TableId(type = IdType.ID_WORKER)private Long id;private String name;private Integer age;private String email;}

2、主键自增

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {@TableId(type = IdType.AUTO)private Long id;private String name;private Integer age;private String email;}

实体类字段上 @TableId(type = IdType.AUTO)

数据库字段也一定要设置为自动递增

3、其余的源码解释

public enum IdType {AUTO(0),//自动递增NONE(1),//未设置INPUT(2),//手动输入，设置为这种方式后需要自己输入，不然主键为nullID_WORKER(3),//默认的全局唯一idUUID(4),//全局唯一ID_WORKER_STR(5);//ID_WORKER的字符串表示法​private int key;​private IdType(int key) {this.key = key;}​public int getKey() {return this.key;}}

雪花算法

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看GitHub - twitter-archive/snowflake: Snowflake is a network service for generating unique ID numbers at high scale with some simple guarantees.。

自动填充

创建时间，更新时间！这些操作都应该是自动完成的，我们不希望去手动完成！

阿里巴巴开发手册：所有的数据库表都要配置上gmt_create、gmt_modifield，并且需要自动化！

方式一：数据库级别（在企业中，不允许去修改数据库）

1、在表中新增字段create_time，update_time

2、实体类中增加属性

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {@TableId(type = IdType.AUTO)private Long id;private String name;private Integer age;private String email;private Date createTime;private Date updateTime;}

3、测试

@Testvoid update(){User user = new User();user.setId(5L);user.setName("徐斌");user.setAge(50);user.setEmail("123456@");userMapper.updateById(user);}

方式二：代码级别

1、删除数据库中的默认值和更新操作

2、实体类的属性上需要增加注解

//插入数据库时时自动填充@TableField(fill = FieldFill.INSERT)private Date createTime;//插入或更新数据库时时自动填充@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;

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

@Slf4j@Componentpublic class MyMetaObjectHandler implements MetaObjectHandler {//插入时的填充策略@Overridepublic 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);}​//更新时的填充策略@Overridepublic void updateFill(MetaObject metaObject) {log.info("start update fill");//setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)this.setFieldValByName("updateTime",new Date(),metaObject);}}

乐观锁

在面试过程中，经常会被问到乐观锁，悲观锁！

乐观锁实现方式：

取出记录时，获取当前version

更新时带上这个version

set version = newVersion where version = oldVersion

如果version不对，就更新失败

乐观锁：1、先查询，获得版本号 version=1 2、执行更新时把version+1--Aupdate user set name = "徐翊皓",version = version + 1where id = 1 and version = 1--B 线程抢先完成，这个时候version为2，会导致A线程修改失败update user set name = "徐翊皓",version = version + 1where id = 1 and version = 1

1、数据库添加version字段

2、实体类中增加属性

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {@TableId(type = IdType.AUTO)private Long id;private String name;private Integer age;private String email;@TableField(fill = FieldFill.INSERT)private Date createTime;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;//乐观锁注解@Versionprivate Integer version;}

3、注册组件

spring xml方式：

<bean class="com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor" id="optimisticLockerInnerInterceptor"/>​<bean id="mybatisPlusInterceptor" class="com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor"><property name="interceptors"><list><ref bean="optimisticLockerInnerInterceptor"/></list></property></bean>

spring boot注解方式：

@MapperScan("com.xyh.mapper")@Configurationpublic class MyBatisPlusConfig {@Beanpublic OptimisticLockerInterceptor optimisticLockerInterceptor() {return new OptimisticLockerInterceptor();}}

4、测试成功

//测试乐观锁成功@Testvoid test1(){User user = userMapper.selectById(1L);user.setName("倪大红");user.setAge(80);userMapper.updateById(user);}

//测试乐观锁成功@Testvoid test1(){User user = userMapper.selectById(1L);user.setName("倪红");user.setAge(80);userMapper.updateById(user);}

5、测试失败

//测试乐观锁失败@Testvoid test2(){User user = userMapper.selectById(1L);user.setName("a");User user1 = userMapper.selectById(1L);user1.setName("b");userMapper.updateById(user);userMapper.updateById(user1);//如果没有使用乐观锁，b就会覆盖a}

分页插件

1、注册组件

@MapperScan("com.xyh.mapper")@Configurationpublic class MyBatisPlusConfig {//乐观锁@Beanpublic OptimisticLockerInterceptor optimisticLockerInterceptor() {return new OptimisticLockerInterceptor();}//分页插件@Beanpublic PaginationInterceptor paginationInterceptor(){return new PaginationInterceptor();}}

2、编写dao层代码

//Mapper接口继承BaseMapper//所有的基本的CRUD就完成了@Repositorypublic interface UserMapper extends BaseMapper<User> {IPage<User> selectByPage(Page<User> page,String name);}

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-////DTD Mapper 3.0//EN" "/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.xyh.mapper.UserMapper"><select id="selectByPage" resultType="com.xyh.pojo.User">select * from user where name like "%"#{name}"%"</select></mapper>

3、测试

//分页查询@Testvoid testPage(){String name="徐";//参数一：当前页//参数二：页面大小Page<User> page = new Page<>(1,1);IPage<User> userIPage = userMapper.selectByPage(page, name);System.out.println(userIPage.getTotal());for (User user:userIPage.getRecords()){System.out.println(user);}}

逻辑删除

物理删除：从数据库中直接移除

逻辑删除：在数据库中没有被移除，而是通过一个变量来让他失效！deleted=0==》deleted=1

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

1、数据库增加字段

2、实体类中增加属性

@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable {@TableId(type = IdType.AUTO)private Long id;private String name;private Integer age;private String email;@TableField(fill = FieldFill.INSERT)private Date createTime;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;//乐观锁注解@Versionprivate Integer version;//逻辑删除@TableLogicprivate Integer deleted;}

3、注册组件

@MapperScan("com.xyh.mapper")@Configurationpublic class MyBatisPlusConfig {//乐观锁@Beanpublic OptimisticLockerInterceptor optimisticLockerInterceptor() {return new OptimisticLockerInterceptor();}//分页插件@Beanpublic PaginationInterceptor paginationInterceptor(){return new PaginationInterceptor();}//逻辑删除@Beanpublic ISqlInjector sqlInjector(){return new LogicSqlInjector();}}

4、配置文件

# 逻辑已删除值(默认为 1)mybatis-plus.global-config.db-config.logic-delete-value=1 # 逻辑未删除值(默认为 0)mybatis-plus.global-config.db-config.logic-not-delete-value=0

5、测试

@Testvoid delete(){userMapper.deleteById(5L);System.out.println(userMapper.selectById(5L));}

5、性能分析插件

用于输出每条sql以及执行的时间

6、条件查询器（Wrapper）

还是要去看官方文档

@SpringBootTestpublic class WrapperTest {@Autowiredprivate UserMapper userMapper;@Testvoid test1(){userMapper.selectList(new QueryWrapper<User>().eq("name","徐翊皓").between("age",20,30));}}

7、代码生成器

1、导入依赖

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.0.5</version></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.3.1.tmp</version></dependency><!-模板引擎，我们这里选择的是默认的：velocity-><dependency><groupId>org.apache.velocity</groupId><artifactId>velocity-engine-core</artifactId><version>2.0</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency>

2、编写一个类

//代码自动生成public class GeneratorCode {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.AUTO);gc.setDateType(DateType.ONLY_DATE);gc.setSwagger2(false);mpg.setGlobalConfig(gc);//2、设置数据源DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("root");dsc.setPassword("20000211a");dsc.setDbType(DbType.MYSQL);mpg.setDataSource(dsc);//3、包的配置PackageConfig pc = new PackageConfig();pc.setParent("com.xyh");pc.setEntity("pojo");pc.setMapper("mapper");pc.setService("service");pc.setServiceImpl("service.impl");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 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);strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2mpg.setStrategy(strategy);mpg.execute(); //执行}}