mybatis-plus的插件
一.拦截器插件
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注入
（3）范例
二.分析sql插件
在MP中提供了对SQL执行的分析的插件，可用作阻断全表更新、删除的操作，注意：该插件仅适用于开发环境，不适用于生产环境。
1.代码块
@Bean //注入分析sql插件
public SqlExplainInterceptor sqlExplainInterceptor(){
SqlExplainInterceptor sqlExplainInterceptor = new SqlExplainInterceptor();
// 攻击 SQL 阻断解析器、加入解析链
List list = new ArrayList<>(); //创建一个解析器集合
list.add(new BlockAttackSqlParser()); //添加全表更新、删除的解析器
sqlExplainInterceptor.setSqlParserList(list); //存入sqlExplainInterceptor
return sqlExplainInterceptor;
}
2.范例
3.插件的作用
阻断一些sql语句的误操作。
三.性能分析插件
性能分析拦截器，用于输出每条 SQL 语句及其执行时间，可以设置最大执行时间，超过时间会抛出异常。 该插件只用于开发环境，不建议生产环境使用。
1.代码块
2.范例
3.异常解决
四.乐观锁插件
1.原理
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
2.代码块
（1）xml配置【二选一】
（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 findById(Long id);
}
（2）MyBaseMapper类
import cn.pojo.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import java.util.List;
/**
* 自定义sql注入器
* @param
*/
public interface MyBaseMapper extends BaseMapper {
List 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 getMethodList() {
ArrayList 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 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 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 {
//参数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 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
org.springframework.boot
spring-boot-starter-parent
2.1.4.RELEASE
org.example
demo05
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-test
test
com.baomidou
mybatis-plus-boot-starter
3.1.1
com.baomidou
mybatis-plus-generator
3.1.1
org.springframework.boot
spring-boot-starter-freemarker
mysql
mysql-connector-java
5.1.47
org.slf4j
slf4j-log4j12
org.springframework.boot
spring-boot-maven-plugin
（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;
/***
*
* mysql 代码生成器演示例子 *
*
*/
public class MysqlGenerator {
/*** * 读取控制台内容 *
*/
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 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