一.攔截器插件

MyBatis 允許你在已映射語句執行過程中的某一點進行攔截調用。默認情況下，MyBatis 允許使用插件來攔截的方法調用包括：

Executor (update, query, flflushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)

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

總體概括爲：

攔截執行器的方法
攔截參數的處理
攔截結果集的處理
攔截Sql語法構建的處理

1.自定義攔截器

（1）代碼塊

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) {
        //屬性設置
    }
}

（2）範例

2.spring的攔截器依賴注入

（1）bean註解注入

@Bean  //注入自定義的攔截器
public MyInterceptor myInterceptor(){
    return new MyInterceptor();
}

（2）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> 
<plugin interceptor="cn.itcast.mp.plugins.MyInterceptor"></plugin> 
</plugins> 
</configuration>

（3）範例

二.分析sql插件

在MP中提供了對SQL執行的分析的插件，可用作阻斷全表更新、刪除的操作，注意：該插件僅適用於開發環境，不適用於生產環境。

1.代碼塊

@Bean   //注入分析sql插件
public SqlExplainInterceptor sqlExplainInterceptor(){
    SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
    // 攻擊 SQL 阻斷解析器、加入解析鏈
    List<ISqlParser> list = new ArrayList<>();  //創建一個解析器集合
    list.add(new BlockAttackSqlParser());   //添加全表更新、刪除的解析器
    sqlExplainInterceptor.setSqlParserList(list);   //存入sqlExplainInterceptor
    return sqlExplainInterceptor;
}

2.範例

3.插件的作用

阻斷一些sql語句的誤操作。

三.性能分析插件

性能分析攔截器，用於輸出每條 SQL 語句及其執行時間，可以設置最大執行時間，超過時間會拋出異常。 該插件只用於開發環境，不建議生產環境使用。

1.代碼塊

<!-- 配置性能分析插件 -->
<plugin interceptor="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor">
    <!-- 設置每條sql語句執行的最大時間，單位爲毫秒 -->
    <property name="maxTime" value="100"/>
    <!--SQL是否格式化 默認false-->
    <property name="format" value="true"/>
</plugin>

2.範例

3.異常解決

四.樂觀鎖插件

1.原理

樂觀鎖實現方式：

取出記錄時，獲取當前version
更新時，帶上這個version
執行更新時， set version = newVersion where version = oldVersion
如果version不對，就更新失敗

2.代碼塊

（1）xml配置【二選一】

<bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/>

（2）springboot的bean註解配置【二選一】

@Bean   //配置樂觀鎖插件
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
    return new OptimisticLockerInterceptor();
}

（3）實體類

3.範例

（1）bean註解

（2）實體類

（3）測試類

4.特別說明【重點】

支持的數據類型只有**:int,Integer,long,Long,Date,Timestamp,LocalDateTime **
整數類型下 newVersion = oldVersion + 1
newVersion 會回寫到 entity 中
僅支持 updateById(id) 與 update(entity, wrapper) 方法
在** update(entity, wrapper) 方法下, wrapper 不能複用!!!**

五.sql自定義注入器

配置自定義sql注入器，作用是通用mapper。

1.圖解

2.代碼塊

（1）usermapper類

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import cn.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;
import java.util.List;
/**
 * mybatisPlus整合spring
 */
@Mapper
@Repository
public interface UserMapper extends MyBaseMapper<User> {
    User findById(Long id);
}

（2）MyBaseMapper類

import cn.pojo.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import java.util.List;
/**
 * 自定義sql注入器
 * @param <T>
 */
public interface MyBaseMapper<T> extends BaseMapper<T> {
    List<T> findAll();
    //設置通用方法
}

（3）MySqlInjector類

import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.AbstractSqlInjector;
import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
import java.util.ArrayList;
import java.util.List;
/**
 * sql注入器配置
 */
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() {
        ArrayList<AbstractMethod> list = new ArrayList<>();
        //獲取父類的方法【baseMapper父類的方法】
        list.addAll(super.getMethodList()); //存到集合中
        // 再擴充自定義的方法
       list.add(new FindAll());
        return list;
    }
}

（4）FindAll類

import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import org.apache.ibatis.executor.keygen.NoKeyGenerator;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.mapping.SqlSource;
/**
 * 定義sql語句實現
 */
public class FindAll extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        //定義sql方法名
        String sqlMethod = "findAll";
        //定義sql語句
        String sql = "select * from " + tableInfo.getTableName();
        //定義sqlSource
        SqlSource sqlSource = languageDriver.createSqlSource(
                configuration,
                sql,    //添加sql語句
                modelClass
        );
        return this.addSelectMappedStatement(
                mapperClass,
                sqlMethod,      //方法名
                sqlSource,          //方法配置
                modelClass,
                tableInfo
        );
    }
}

3.範例

（1）usermapper類

（2）MyBaseMapper類

（3）MySqlInjector類

（4）FindAll類

六.自動填充功能【重點】

我們可能會有這樣的需求，插入或者更新數據時，希望有些字段可以自動填充數據，比如密碼、version 等。在MP中提供了這樣的功能，可以實現自動填充。

1.代碼塊

（1）對象類

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import static com.baomidou.mybatisplus.annotation.IdType.AUTO;
@Data
@NoArgsConstructor  //空參構造方法
@AllArgsConstructor //全參構造方法
@TableName("tb_user") //測試全局表名前綴
//@KeySequence(value = "SEQ_USER",clazz = Long.class)  //配置oracle序列的註解
////value是聲明序列表的表名，clazz是聲明主鍵的數據類型
public class User extends Model<User> implements Serializable {
    @TableId(type=IdType.AUTO)  //聲明主鍵自增長
    private Long id;
    private String userName;
    @TableField(fill = FieldFill.INSERT)    //插入數據時自動填充字段
    private String password;
    @TableField(select = false)    //查詢時，則不返回該字段的值
    private String name;
    private Integer age;
    @TableField(value = "email")    //通過tableField進行字段不一致的映射
    //數據庫字段是email，而實體類對應的是mail
    private String mail;
    @TableField(exist = false)  //設置該字段在數據庫表中不存在
    private String msg; //數據庫中不存在該字段
    @Version    //配置樂觀鎖
    private Integer version;
}

（2）配置類

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
@Component  //聲明配置類
public class MyMetaObjectHandle implements MetaObjectHandler {
    @Override
    //插入數據時填充數據
    public void insertFill(MetaObject metaObject) {
        //先獲取password的值，
        //判斷是否爲空，如果爲空，則進行填充
        //如果不爲空,則不做處理
        Object password = getFieldValByName("password",metaObject);//通過字段名獲取字段值
        if(null == password){
            //參數一：字段名，參數二：字段值，參數三：metaObject
            setFieldValByName("password","123456",metaObject);
        }
    }
    @Override
    //更新數據時填充數據
    public void updateFill(MetaObject metaObject) {
    }
}

2.範例

（1）對象類

（2）配置類

（3）測試類

七.邏輯刪除

1.代碼塊

（1）對象類

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import static com.baomidou.mybatisplus.annotation.IdType.AUTO;
@Data
@NoArgsConstructor  //空參構造方法
@AllArgsConstructor //全參構造方法
@TableName("tb_user") //測試全局表名前綴
//@KeySequence(value = "SEQ_USER",clazz = Long.class)  //配置oracle序列的註解
////value是聲明序列表的表名，clazz是聲明主鍵的數據類型
public class User extends Model<User> implements Serializable {
    @TableId(type=IdType.AUTO)  //聲明主鍵自增長
    private Long id;
    private String userName;
    @TableField(fill = FieldFill.INSERT)    //插入數據時自動填充字段
    private String password;
    @TableField(select = false)    //查詢時，則不返回該字段的值
    private String name;
    private Integer age;
    @TableField(value = "email")    //通過tableField進行字段不一致的映射
    //數據庫字段是email，而實體類對應的是mail
    private String mail;
    @TableField(exist = false)  //設置該字段在數據庫表中不存在
    private String msg; //數據庫中不存在該字段
    @Version    //配置樂觀鎖
    private Integer version;
    @TableLogic //邏輯刪除的註解，0是未刪除,1是刪除
    private Integer deleted; //判斷是否被刪除【不會將真實數據刪除，而是標記刪除】
}

（2）yml配置文件

spring:
  #數據庫連接配置
  datasource:
    #配置oracle
#    driver-class-name: oracle.jdbc.driver.OracleDriver
#    url: jdbc:oracle:thin:@192.168.223.129:1521:orcl
#    username: root
#    password: root
      # mysql配置
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/db2?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
    username: root
    password: root

#mybatis的相關配置
#mybatis:
#  #mapper配置文件
#  mapper-locations: classpath*:mapper/*.xml
#  type-aliases-package: cn.pojo
#  #開啓駝峯命名
#  configuration:
#    map-underscore-to-camel-case: true
#mybatisplus的相關配置
mybatis-plus:
  #指定全局配置文件【二選一】
  config-location: classpath:mybatis-config.xml
  #mapper配置文件
  mapper-locations: classpath*:mapper/*.xml
  #開啓實體類包路徑掃描
  type-aliases-package: cn.pojo
#  configuration: #【二選一】
#    #開啓駝峯命名：默認開啓，
#    map-underscore-to-camel-case: true
#    #開啓二級緩存，默認開啓
#    cache-enabled: true
  global-config:
    db-config:
#      id-type: input
    # 全局主鍵自增長模式
      id-type: auto
#      # 全局的數據庫表名的前綴配置【不推薦】
#      table-prefix: tb_
      #邏輯刪除時，刪除的狀態值爲1
      logic-delete-value: 1
      #邏輯刪除時，未刪除的狀態值爲0
      logic-not-delete-value: 0

2.範例

（1）對象類

（2）yml配置文件

（3）測試類【重點細節】

八.通用枚舉

解決了繁瑣的配置，讓 mybatis 優雅的使用枚舉屬性！

1.代碼塊

（1）枚舉類

import com.baomidou.mybatisplus.core.enums.IEnum;
/**
 * 定義一個枚舉類
 */
public enum  SexEnum implements IEnum<Integer> {
    //參數1是value,參數2是desc
    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;
    }
}

（2）yml配置文件

# 枚舉包掃描 
mybatis-plus.type-enums-package=cn.itcast.mp.enums

（3）對象類

import cn.enums.SexEnum;
import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import static com.baomidou.mybatisplus.annotation.IdType.AUTO;
@Data
@NoArgsConstructor  //空參構造方法
@AllArgsConstructor //全參構造方法
@TableName("tb_user") //測試全局表名前綴
//@KeySequence(value = "SEQ_USER",clazz = Long.class)  //配置oracle序列的註解
////value是聲明序列表的表名，clazz是聲明主鍵的數據類型
public class User extends Model<User> implements Serializable {
    @TableId(type=IdType.AUTO)  //聲明主鍵自增長
    private Long id;
    private String userName;
    @TableField(fill = FieldFill.INSERT)    //插入數據時自動填充字段
    private String password;
    @TableField(select = false)    //查詢時，則不返回該字段的值
    private String name;
    private Integer age;
    @TableField(value = "email")    //通過tableField進行字段不一致的映射
    //數據庫字段是email，而實體類對應的是mail
    private String mail;
    @TableField(exist = false)  //設置該字段在數據庫表中不存在
    private String msg; //數據庫中不存在該字段
    @Version    //配置樂觀鎖
    private Integer version;
    @TableLogic //邏輯刪除的註解，0是未刪除,1是刪除
    private Integer deleted; //判斷是否被刪除【不會將真實數據刪除，而是標記刪除】
    private SexEnum sex;    //數據類型爲通用枚舉
}

2.範例

（1）對象類

（2）yml配置文件

（3）枚舉類

九.代碼生成器

AutoGenerator 是 MyBatis-Plus 的代碼生成器，通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼，極大的提升了開發效率。

1.代碼塊

（1）pom.xml

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.4.RELEASE</version>
</parent>
<groupId>org.example</groupId>
<artifactId>demo05</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>

（2）代碼生成類

import java.util.ArrayList;
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/db2? 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();
    }
}

2.演示

十.mybatisX插件【idea專有】

（1）作用

Java 與 XML 調回跳轉

Mapper 方法自動生成 XML

（2）演示

十一.源碼

鏈接：https://pan.baidu.com/s/1gzJ2WEUm2pF-_Y9PFCiCwQ

提取碼：q8tr

mybatis-plus的插件

一.攔截器插件

1.自定義攔截器

（1）代碼塊

（2）範例

2.spring的攔截器依賴注入

（1）bean註解注入

（2）xml注入

（3）範例

二.分析sql插件

1.代碼塊

2.範例

3.插件的作用

三.性能分析插件

1.代碼塊

2.範例

3.異常解決

四.樂觀鎖插件

1.原理

2.代碼塊

（1）xml配置【二選一】

（2）springboot的bean註解配置【二選一】

（3）實體類

3.範例

（1）bean註解

（2）實體類

（3）測試類

4.特別說明【重點】

五.sql自定義注入器

1.圖解

2.代碼塊

（1）usermapper類

（2）MyBaseMapper類

（3）MySqlInjector類

（4）FindAll類

3.範例

（1）usermapper類

（2）MyBaseMapper類

（3）MySqlInjector類

（4）FindAll類

六.自動填充功能【重點】

1.代碼塊

（1）對象類

（2）配置類

2.範例

（1）對象類

（2）配置類

（3）測試類

七.邏輯刪除

1.代碼塊

（1）對象類

（2）yml配置文件

2.範例

（1）對象類

（2）yml配置文件

（3）測試類【重點細節】

八.通用枚舉

1.代碼塊

（1）枚舉類

（2）yml配置文件

（3）對象類

2.範例

（1）對象類

（2）yml配置文件

（3）枚舉類

九.代碼生成器

1.代碼塊

（1）pom.xml

（2）代碼生成類

2.演示

十.mybatisX插件【idea專有】

（1）作用

（2）演示

十一.源碼