MybatisPlus快速入门02~~进阶篇(干货满满+超详细)

1. ActiveRecord

ActiveRecord （简称AR） 动态语言(PHP、Ruby等)的喜爱，而Java作为准静态语言，对于ActiveRecord往往只能感叹气优雅，所以我们也在AR道路上进行了一定的探索。

1.1 什么是ActiveRecord

​ ActiveRecord也属于ORM（对象关系映射）层，由Rails最早提出，遵循标准的ORM模型：表映射到记录，记
录映射到对象，字段映射到对象属性。配合遵循的命名和配置惯例，能够很大程度的快速实现模型的操作，而
且简洁易懂。
ActiveRecord的主要思想是：

• 每一个数据库表对应创建一个类，类的每一个对象实例对应于数据库中表的一行记录；通常表的每个字段
• 在类中都有相应的Field；
• ActiveRecord同时负责把自己持久化，在ActiveRecord中封装了对数据库的访问，即CURD;；
• ActiveRecord是一种领域模型(Domain Model)，封装了部分业务逻辑；

1.2 开启AR之旅

在MyBatisPlus 中，开启AR非常简单，只需要将实体对象继承Model即可

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
public class User extends Model<User> {

    @TableId(type = IdType.AUTO)        // 指定id类型为自增长
    private Long id;

    private String userName;
    private String password;
    private String name;
    private Integer age;
    private String email;

}

1.3 根据主键查询

	/**
     * 根据主键查询  通过setId 或 形参
     */
    @Test
    public void testSelectById(){
        User user = new User();
        //user.setId(2L);

        System.out.println(user.selectById(2L));
    }

1.4 新增数据

    /**
     * 新增数据
     */
    @Test
    public void testInsert(){
        User user = new User();
        user.setUserName("ziyuan");
        user.setPassword("123456");
        user.setName("梓源");
        user.setAge(23);
        user.setEmail("ziyuan710@163.com");

        // 执行新增操作
        System.out.println(user.insert());
    }

1.5 更新数据

    /**
     * 更新数据
     */
    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(1L);
        user.setAge(30);

        // 执行更新操作
        System.out.println(user.updateById());

    }

1.6 删除数据

 	/**
     * 删除数据
     */
    @Test
    public void testDelete(){
        User user = new User();
        System.out.println(user.deleteById(14L));
    }

1.7 根据条件查询

	/**
     * 根据条件查询
     */
    @Test
    public void testSelectByCheck(){

        User user = new User();
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.gt("age",20);

        for (User user1 : user.selectList(wrapper)) {
            System.out.println(user1);
        }
    }

2. 插件

官方文档: https://mp.baomidou.com/guide/interceptor.html

2.1 Mybatis的插件机制

​ MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，Mybatis允许使用插件来拦截的方法调用包括:

1. Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
2. ParameterHandler (getParameterObject, setParameters)
3. ResultSetHandler (handleResultSets, handleOutputParameters)
4. StatementHandler (prepare, parameterize, batch, update, query)

​ 我们看到了可以拦截Executor接口的部分方法，比如update，query，commit，rollback等方法，还有其他接口的
一些方法等。

总体概括为:

1. 拦截执行器的方法
2. 拦截参数的处理
3. 拦截结果集的处理
4. 拦截Sql语法构建的处理

拦截器示例

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import java.util.Properties;

@Intercepts({@Signature(
        type= Executor.class,
        method = "update",
        args = {MappedStatement.class, Object.class})})
public class MyInterceptor implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 拦截方法, 具体业务逻辑编写的位置
        return invocation.proceed();
    }
    @Override
    public Object plugin(Object target) {
        // 创建target对象的代理对象，目的是将当前拦截器加入到该对象中
        return Plugin.wrap(target,this);
    }
    @Override
    public void setProperties(Properties properties) {
        // 属性设置
    }
}

SpringBoot 配置

	/**
     * 自定义拦截器
     * @return
     */
    @Bean
    public MyInterceptor myInterceptor(){
        return new MyInterceptor();
    }

2.2 执行分析插件

在MP中提供了对SQL执行的分析的插件，可用作阻断全表更新、删除的操作，注意：该插件仅适用于开发环境，不
适用于生产环境。

springBoot配置

    @Bean
    public SqlExplainInterceptor sqlExplainInterceptor(){
        SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
        List<ISqlParser> sqlParserList = new ArrayList<>();
        // 攻击 SQL 阻断解析器、加入解析链
        sqlParserList.add(new BlockAttackSqlParser());
        sqlExplainInterceptor.setSqlParserList(sqlParserList);
        return sqlExplainInterceptor;
    }

测试

    @Test
    public void testUpdates(){
        User user = new User();
        user.setAge(20);
        int result = userDao.update(user, null);
        System.out.println("result = " + result);
    }

当执行全表更新时，会抛出异常，这样有效防止了一些误操作。

2.3 性能分析插件

性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常。

该插件只用于开发环境，不建议生产环境使用。

xml配置

    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        <plugins>
            <!-- SQL 执行性能分析，开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长 -->
            <plugin 
    interceptor="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor">
                <property name="maxTime" value="100" />
                <!--SQL是否格式化 默认false-->
                <property name="format" value="true" />
            </plugin>
        </plugins>
    </configuration>

SpringBoot配置 推荐

	/**
     * 性能分析插件
     */
    @Bean
    public PerformanceInterceptor performanceInterceptor(){

        PerformanceInterceptor per = new PerformanceInterceptor();

        per.setMaxTime(1000);
        per.setFormat(true);

        return  per;
    }

2.4 乐观锁插件

2.4.1 主要使用场景

当要更新一条记录的时候，希望这条记录没有被别人使用

乐观锁实现方式：

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

2.4.2 插件配置

@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
    return new OptimisticLockerInterceptor();
}

2.4.3 注解实体字段

需要为实体字段添加@Version注解。

第一步，为表添加version字段，并且设置初始值为1：

alter table `tb_user` add column `version`  int(10) null after `email`;
update `tb_user` set `version`='1';

第二步，为User实体对象添加version字段，并且添加@Version注解：

	@Version
    private Integer version;

2.4.4 测试

    /**
     * 更新数据
     */
    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(1L);
        user.setAge(30);
        user.setVersion(1); //获取到version为1

        // 执行更新操作
        System.out.println(user.updateById());
    }

更新的条件中有version条件，并且更新的version为2。
如果再次执行，更新则不成功。这样就避免了多人同时更新时导致数据的不一致。

2.4.5 特别说明

1. 支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
2. 整数类型下 newVersion = oldVersion + 1
3. newVersion 会回写到 entity 中
4. 仅支持 updateById(id) 与 update(entity, wrapper) 方法
5. 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

3. Sql注入器

官方文档: https://mp.baomidou.com/guide/sql-injector.html

自定义BaseMapper示例: https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-deluxe

3.1 MyBaseDao

package org.ziyuan.dao;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import java.util.List;

/**
 * 编写扩展方法
 * @param <T>
 */
public interface MyBatisDao<T> extends BaseMapper<T> {
    List<T> findAll();
}

其他的Mapper都可以继承该Mapper，这样实现了统一的扩展。

package org.ziyuan.dao;
import org.ziyuan.pojo.User;
public interface UserDao extends MyBatisDao<User> { }

3.2 编写FindAll

package org.ziyuan.sqlInjector;

import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;

public class FindAll extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        // 注册方法
        String sqlMethod = "findAll";
        // 编写SQL语句
        String sql = "select * from "+ tableInfo.getTableName();
        // 数据源
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return this.addSelectMappedStatement(mapperClass,sqlMethod,sqlSource,modelClass,tableInfo);
    }
}

3.3 编写MySqlInjector

如果直接继承AbstractSqlInjector的话，原有的BaseMapper中的方法将失效，所以我们选择继承DefaultSqlInjector
进行扩展。

package org.ziyuan.sqlInjector;


import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;

import java.util.List;

public class MySqlInjector extends DefaultSqlInjector {
    @Override
    public List<AbstractMethod> getMethodList() {

        //调用父级方法
        List<AbstractMethod> methodList = super.getMethodList();

        // 扩充自己的方法
        methodList.add(new FindAll());

        return methodList;
    }
}

3.4 注册到Spring容器

	/**
     * 自定义SQL注入器
     */
    @Bean
    public MySqlInjector mySqlInjector(){
        return new MySqlInjector();
    }

3.5 测试

  @Test
    public void testSelectFindAll(){
        for (User user : userDao.findAll()) {
            System.out.println(user);
        }
    }

测试结果

2021-08-30 18:05:09.882  INFO 22476 --- [           main] .z.SpringbootMybatisplusApplicationTests : Started SpringbootMybatisplusApplicationTests in 3.209 seconds (JVM running for 4.531)

 Time：27 ms - ID：org.ziyuan.dao.UserDao.findAll
Execute SQL：
    select
        * 
    from
        tb_user

User(id=1, userName=sunziyuan, password=123456, name=张三, age=30, email=test1@itcast.cn, version=2)
User(id=2, userName=lisi, password=123456, name=李四, age=20, email=test2@itcast.cn, version=1)
User(id=3, userName=wangwu, password=123456, name=王五, age=28, email=test3@itcast.cn, version=1)
User(id=4, userName=zhaoliu, password=123456, name=赵六, age=21, email=test4@itcast.cn, version=1)
User(id=5, userName=sunqi, password=123456, name=孙七, age=24, email=test5@itcast.cn, version=1)
User(id=11, userName=ziyuan, password=123456, name=孙梓源, age=0, email=ziyuan710@gmail.com, version=1)
User(id=12, userName=ziyuan, password=123456, name=孙梓源, age=0, email=ziyuan710@gmail.com, version=1)
User(id=13, userName=ziyuan, password=123456, name=孙梓源, age=0, email=ziyuan710@gmail.com, version=1)

4. 自动填充功能

官方地址：https://mp.baomidou.com/guide/auto-fill-metainfo.html

有些时候我们可能会有这样的需求，插入或者更新数据时，希望有些字段可以自动填充数据，比如密码、version
等。在MP中提供了这样的功能，可以实现自动填充。

4.1 添加@TableField注解

为password 添加自动填充功能，在新增数据时有效

	// 插入数据时进行填充
    @TableField(fill = FieldFill.INSERT)
    private String password;

FieldFill提供了多种模式选择

    public enum FieldFill {
        /**
         * 默认不处理
         */
        DEFAULT,
        /**
         * 插入时填充字段
         */
        INSERT,
        /**
         * 更新时填充字段
         */
        UPDATE,
        /**
         * 插入和更新时填充字段
         */
        INSERT_UPDATE
    }

4.2 编写MyMetaObjecthandler

package org.ziyuan.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.context.annotation.Configuration;


@Configuration
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入时
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        Object password = getFieldValByName("password", metaObject);
        if (null==password) {
            // 字段为空，可以进行填充
            setFieldValByName("password","123456",metaObject);
        }
    }

    /**
     * 更新时
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {

    }
}

4.3 测试

 	@Test
    public void testInserts(){
        User user = new User();
        user.setName("关羽");
        user.setUserName("guanyu");
        user.setAge(30);
        user.setEmail("guanyu@itast.cn");
        user.setVersion(1);
        int result = this.userDao.insert(user);
        System.out.println("result = " + result);
    }

5. 逻辑删除

官方地址: https://mp.baomidou.com/guide/logic-delete.html

开发系统时，有时候在实现功能时，删除操作需要实现逻辑删除，所谓逻辑删除就是将数据标记为删除，而并非真正
的物理删除（非DELETE操作），查询时需要携带状态条件，确保被标记的数据不被查询到。这样做的目的就是避免
数据被真正的删除。

5.1 修改表结构

为tb_user表增加deleted字段，用于表示数据是否被删除，1代表删除，0代表未删除。

alter table `tb_user`add column `deleted`  int(1) null default 0 comment '1代表删除，0代表未删除' after `version`;

同时，修改User实体类，增加Deleted属性并且添加@TableLogic注解:

@TableLogic
private Integer deleted;

5.2 配置

mybatis-plus:
    global-config:
        db-config:
            logic-delete-value: 1
            logic-not-delete-value: 0

5.3 测试

    @Test
    public void testDelete01(){
        int i = userDao.deleteById(4L);
        System.out.println("受影响行数："+i);
    }

5.4 允许结果

 Time：2 ms - ID：org.ziyuan.dao.UserDao.deleteById
Execute SQL：
    UPDATE
        tb_user 
    SET
        deleted=1 
    WHERE
        id=4 
        AND deleted=0

受影响行数：1

6. 通用枚举

官方地址: https://mp.baomidou.com/guide/enum.html

解决了繁琐的配置，让 mybatis 优雅的使用枚举属性！

6.1 修改表结构

alter table `tb_user` add column `sex`  int(1) null default 1 comment '1-男，2-女' after `deleted`;

6.2 定义枚举

package org.ziyuan.enums;

import com.baomidou.mybatisplus.core.enums.IEnum;

public enum  SexEnum implements IEnum<Integer> {
    MAN(1,"男"),
    WOMAN(2,"女");

    private int value;
    private String desc;

    SexEnum(int value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    @Override
    public Integer getValue() {
        return this.value;
    }

    @Override
    public String toString() {
        return this.desc;
    }
}

6.3 配置

# 枚举包扫描
mybatis-plus:
    type-enums-package: org.ziyuan.enums

6.4 修改实体

private SexEnum sex;

6.5 测试

	/**
     * 插入
     */
    @Test
    public void testInsert(){
        User user = new User();
        user.setUserName("ziyuan");
        user.setPassword("123456");
        user.setName("孙梓源");
        user.setAge(0);
        user.setEmail("ziyuan710@gmail.com");
        user.setSex(SexEnum.MAN);

        System.out.println(userDao.insert(user));
    }

7. 代码生成器

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

7.1 创建工程

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.4.RELEASE</version>
    </parent>
    <groupId>cn.itcast.mp</groupId>
    <artifactId>itcast-mp-generator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--mybatis-plus的springboot支持-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.1.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

7.2 代码

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
/**
 * <p>
 * mysql 代码生成器演示例子
 * </p>
 */
public class MysqlGenerator {
    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
                        if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }
    /**
     * RUN THIS
     */
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("itcast");
        gc.setOpen(false);
        mpg.setGlobalConfig(gc);
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);
        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("cn.itcast.mp.generator");
        mpg.setPackageInfo(pc);
        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输入文件名称
                return projectPath + "/itcast-mp-generator/src/main/resources/mapper/"+pc.getModuleName()
                     + "/" + tableInfo.getEntityName() + "Mapper" + 
StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null));
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//        
strategy.setSuperEntityClass("com.baomidou.mybatisplus.samples.generator.common.BaseE
ntity");
        strategy.setEntityLombokModel(true);
//        
strategy.setSuperControllerClass("com.baomidou.mybatisplus.samples.generator.common.B
aseController");
        strategy.setInclude(scanner("表名"));
        strategy.setSuperEntityColumns("id");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

8 MybatisX 快速开发

MybatisX 是一款基于 IDEA 的快速开发插件，为效率而生。
官方地址:https://mp.baomidou.com/guide/mybatisx-idea-plugin.html#%E5%8A%9F%E8%83%BD

XML跳转

生成代码(需先在idea配置Datebase配置数据源)