mybatis-plus

mybatisPlus学习

简介

官网地址：https://mp.baomidou.com/
特性：

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

案例代码展示

案例代码查看：springboot整合mybatisPlus

核心功能

代码生成器

官网案例

说明：MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖
依赖

<!-- mybatis-plus-generator -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-generator</artifactId>
			<version>3.3.2</version>
		</dependency>
		<dependency>
			<groupId>org.apache.velocity</groupId>
			<artifactId>velocity-engine-core</artifactId>
			<version>2.3</version>
		</dependency>

注:由于官网的3.5.0版本下载失败 不知道是不是网络原因还是其他原因，本次采用3.3.2代替，由于本次使用的mybatis-plus版本为3.4.2导致 两个版本冲突，因此最好重新创建一个工程实现代码自动生成

案例代码：

public class autoGeneratorConfig {
	public static void main(String[] args) {
		autoGeneratorConfig generatorConfig = new autoGeneratorConfig();
		generatorConfig.demo();
	}

	public void demo() {
		//=============配置数据源================
		String url = "jdbc:mysql://127.0.0.1/conformity?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8";
		DataSourceConfig dataSourceConfig = new DataSourceConfig();
		dataSourceConfig.setUrl(url);
		dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
		dataSourceConfig.setUsername("root");
		dataSourceConfig.setPassword("root");
		dataSourceConfig.setDbType(DbType.MYSQL);

		//============配置策略================
		StrategyConfig strategyConfig = new StrategyConfig();
		//是否大写命名
		strategyConfig.setCapitalMode(true);
		//是否跳过视图
		strategyConfig.setSkipView(true);
		//数据库表映射到实体的命名策略
		strategyConfig.setNaming(NamingStrategy.underline_to_camel);
		//数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
		strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
		//表前缀
		strategyConfig.setTablePrefix("crbt_");
		//字段前缀
		strategyConfig.setFieldPrefix("");
		//【实体】是否为链式模型（默认 false）
		strategyConfig.setChainModel(true);
		//【实体】是否为lombok模型（默认 false）
		strategyConfig.setEntityLombokModel(true);
		//Boolean类型字段是否移除is前缀（默认 false）
		strategyConfig.setEntityBooleanColumnRemoveIsPrefix(false);
		//生成 @RestController 控制器
		strategyConfig.setRestControllerStyle(true);
		//是否生成实体时，生成字段注解
		strategyConfig.setEntityTableFieldAnnotationEnable(true);
		//乐观锁属性名称
		strategyConfig.setVersionFieldName("version");
		//逻辑删除属性名称
		strategyConfig.setLogicDeleteFieldName("is_delete");
		//表填充字段
		List<TableFill> fillList = new ArrayList<>();
		fillList.add(new TableFill("create_time", FieldFill.INSERT));
		fillList.add(new TableFill("update_time", FieldFill.INSERT_UPDATE));
		strategyConfig.setTableFillList(fillList);
		/**	默认激活进行sql模糊表名匹配
			关闭之后likeTable与notLikeTable将失效，include和exclude将使用内存过滤
			如果有sql语法兼容性问题的话，请手动设置为false
		 */
		strategyConfig.setEnableSqlFilter(true);

		//需要包含的表名，当enableSqlFilter为false时，允许正则表达式（与exclude二选一配置）
		//strategyConfig.setInclude(include);
		//需要排除的表名，当enableSqlFilter为false时，允许正则表达式
		//strategyConfig.setExclude(exclude);

		//自3.3.0起，模糊匹配表名（与notLikeTable二选一配置）
		strategyConfig.setLikeTable(new LikeTable("crbt_", SqlLike.RIGHT));
		//自3.3.0起，模糊排除表名
		//strategyConfig.setNotLikeTable(notLikeTable);

		//自定义继承的类全称
		strategyConfig.setSuperEntityClass(BaseEntity.class);
		strategyConfig.setSuperMapperClass("com.conformity.base.MyBaseMapper");
		strategyConfig.setSuperServiceClass(MyBaseService.class);
		strategyConfig.setSuperServiceImplClass(MyBaseServiceImpl.class);


		//=========包名配置==============
		PackageConfig packageConfig = new PackageConfig();
		//父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
		packageConfig.setParent("com.conformity");
		//父包模块名
		packageConfig.setModuleName("general");
		packageConfig.setController("controller");
		packageConfig.setEntity("entity");
		packageConfig.setMapper("mapper");
		packageConfig.setService("service");
		packageConfig.setServiceImpl("service.impl");
		packageConfig.setXml("dao");

		//=========模板配置，可自定义代码生成的模板，实现个性化操作=================
		TemplateConfig templateConfig = new TemplateConfig();
//		String temPath = "generator"+File.separator+"template"+File.separator;
//		templateConfig.setController(temPath+"Controller.java");
//		templateConfig.setService(temPath+"Service.java");
//		templateConfig.setServiceImpl(temPath+"ServiceImpl.java");
//		templateConfig.setMapper(temPath+"mapper.java");
//		templateConfig.setXml(temPath+"mapper.xml");

		//================全局策略配置===============
		GlobalConfig globalConfig = new GlobalConfig();
		//生成文件的输出目录
		String path = "src"+File.separator+"main"+File.separator+"java";
		globalConfig.setOutputDir(path);
		//是否覆盖已有文件
		globalConfig.setFileOverride(true);
		//是否打开输出目录
		globalConfig.setOpen(false);
		//开发人员
		globalConfig.setAuthor("lsx");
		//开启 swagger2 模式
		globalConfig.setSwagger2(true);
		//时间类型对应策略
		globalConfig.setDateType(DateType.ONLY_DATE);
		//开启 baseColumnList  
		globalConfig.setBaseColumnList(true);
		//开启 BaseResultMap
		globalConfig.setBaseResultMap(true);
		//实体命名方式---%sEntity 生成 UserEntity
		globalConfig.setEntityName("%sEntity");
		globalConfig.setMapperName("%sMapper");
		globalConfig.setXmlName("%sMapper");
		globalConfig.setServiceName("%sService");
		globalConfig.setServiceImplName("%sServiceImpl");
		globalConfig.setControllerName("%sController");
		globalConfig.setIdType(IdType.AUTO);

		//代码生成器
		AutoGenerator mpg = new AutoGenerator();
		mpg.setGlobalConfig(globalConfig);
		mpg.setDataSource(dataSourceConfig);
		mpg.setPackageInfo(packageConfig);
		mpg.setTemplate(templateConfig);
		mpg.setStrategy(strategyConfig);
		//设置模板引擎 默认Velocity
//		mpg.setTemplateEngine(new FreemarkerTemplateEngine());
		mpg.execute();

	}
}

自定义代码模板

下载的jar包包含有代码模板，需要自定义时根据上面编辑

CRUD接口

接口相对简单不做过多阐述，详细信息查看官网即可

条件构造器

官网阐述：
说明:

• 以下出现的第一个入参boolean condition表示该条件是否加入最后生成的sql中，例如：query.like(StringUtils.isNotBlank(name), Entity::getName, name) .eq(age!=null && age >= 0, Entity::getAge, age)
• 以下代码块内的多个方法均为从上往下补全个别boolean类型的入参,默认为true
• 以下出现的泛型Param均为Wrapper的子类实例(均具有AbstractWrapper的所有方法)
• 以下方法在入参中出现的R为泛型,在普通wrapper中是String,在LambdaWrapper中是函数(例:Entity::getId,Entity为实体类,getId为字段id的getMethod)
• 以下方法入参中的R column均表示数据库字段,当R具体类型为String时则为数据库字段名(字段名是数据库关键字的自己用转义符包裹!)!而不是实体类数据字段名!!!,另当R具体类型为SFunction时项目runtime不支持eclipse自家的编译器!!!
• 以下举例均为使用普通wrapper,入参为Map和List的均以json形式表现!
• 使用中如果入参的Map或者List为空,则不会加入最后生成的sql中!!!
• 有任何疑问就点开源码看,看不懂函数的点击我学习新知识

警告:

不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输

1. wrapper 很重
2. 传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
3. 正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
4. 我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr

AbstractWrapper

说明:

AbstractWrapper 是QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类
用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为

条件类型：

QueryWrapper

说明:

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件
及 LambdaQueryWrapper, 可以通过 new QueryWrapper().lambda() 方法获取

条件类型：
select

select(String... sqlSelect)
select(Predicate<TableFieldInfo> predicate)
select(Class<T> entityClass, Predicate<TableFieldInfo> predicate)

UpdateWrapper

说明

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件
及 LambdaUpdateWrapper, 可以通过 new UpdateWrapper().lambda() 方法获取!

条件类型：
set

set(String column, Object val)
set(boolean condition, String column, Object val)

setSql

setSql(String sql)

使用

各个api含义，例子建议查看官网，使用方式大同小异
通常使用的案例：

@Override
	public void demo() {
		QueryWrapper<MybatisTestUser> query = new QueryWrapper<>();
		//QueryWrapper select接口
		query.select("id,name,age,email,version,create_time,update_time,deleted");
		//AbstractWrapper接口  模糊查询   %值%   likeRight 值%  likeLeft    %值
		query.like("name", "aa");
		query.orderByDesc("create_time");
		query.last("limit 5");
		list(query);
	}

返回sql：

==>  Preparing: SELECT id,name,age,email,version,create_time,update_time,deleted FROM mybatistestuser WHERE deleted=0 AND (name LIKE ?) ORDER BY create_time DESC limit 5
==> Parameters: %sx%(String)
<==    Columns: id, name, age, email, version, create_time, update_time, deleted
<==        Row: 202103171103996848, lsx, 100, fdfds, 0, 2021-03-17 03:03:14, 2021-03-17 03:54:12, 0
<==        Row: 202103171054972868, lsx, 15, fdfds, 0, 2021-03-17 02:54:19, 2021-03-17 03:54:12, 0
<==        Row: 202103160942136630, lsx, 18, 522, 0, 2021-03-16 01:42:09, 2021-03-17 03:54:12, 0
<==        Row: 202103160935256898, lsx, 18, 522, 0, 2021-03-16 01:35:46, 2021-03-17 03:54:12, 0
<==        Row: 5, lsx, 24, test5@baomidou.com, 0, null, 2021-03-17 03:54:12, 0
<==      Total: 5

默认通过and方法进行拼接 上述代码相当于

query.().and().query.()
//如果需要用or表示 则通过query.or()拼接
query.like("name", "sx");
query.or();
query.eq("age", 18);

返回sql

==>  Preparing: SELECT id,name,age,email,version,create_time,update_time,deleted FROM mybatistestuser WHERE deleted=0 AND (name LIKE ? OR age = ?) ORDER BY create_time DESC limit 5
==> Parameters: %sx%(String), 18(Integer)
<==    Columns: id, name, age, email, version, create_time, update_time, deleted
<==        Row: 202103171103996848, lsx, 100, fdfds, 0, 2021-03-17 03:03:14, 2021-03-17 03:54:12, 0
<==        Row: 202103171054972868, lsx, 15, fdfds, 0, 2021-03-17 02:54:19, 2021-03-17 03:54:12, 0
<==        Row: 202103160942136630, lsx, 18, 522, 0, 2021-03-16 01:42:09, 2021-03-17 03:54:12, 0
<==        Row: 202103160935256898, lsx, 18, 522, 0, 2021-03-16 01:35:46, 2021-03-17 03:54:12, 0
<==        Row: 5, lsx, 24, test5@baomidou.com, 0, null, 2021-03-17 03:54:12, 0
<==      Total: 5

注： WHERE deleted=0 是配置的逻辑删除条件，查询时自动过滤逻辑删除(0 表示未删除)的数据

分页插件

	//3.4 之前
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }
/*
	 * 添加插件(since 3.4.0)  3.4后插件通过该方式注入
	 * 目前已有的功能:
		多租户: TenantLineInnerInterceptor
		动态表名: DynamicTableNameInnerInterceptor
		自动分页: PaginationInnerInterceptor
		乐观锁: OptimisticLockerInnerInterceptor
		sql性能规范: IllegalSQLInnerInterceptor
		防止全表更新与删除: BlockAttackInnerInterceptor
		
		使用多个功能需要注意顺序关系,建议使用如下顺序
		多租户,动态表名,分页,乐观锁,sql性能规范,防止全表更新与删除
	**/
	@Bean("optimisticLockerInnerInterceptor")
	public MybatisPlusInterceptor optimisticLockerInnerInterceptor(){
		MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
		interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//自动分页
		interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());//乐观锁
//		interceptor.addInnerInterceptor(new IllegalSQLInnerInterceptor());//sql性能规范
		interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());//防止全表更新删除
		
		return interceptor;

	}

使用

//controller
@RequestMapping("/selectBypage")
@ApiOperation("mybatisPlus测试---分页查询 ")
@ApiOperationSupport(author = "lsx",order = 3)
@ApiImplicitParams({   
       @ApiImplicitParam(name = "age", value = "年龄", required = false, paramType = "query"),           
       @ApiImplicitParam(name = "name", value = "姓名", required = false, paramType = "query"),           
       @ApiImplicitParam(name = "email", value = "邮箱", required = false, paramType = "query"),          
})
public IPage<MybatisTestUser> selectBypage(PageEntity pb,@ApiIgnore MybatisTestUser user){
	//IPage--mybatisPlus自带的分页  PageEntity 自定义的分页实体类
	IPage<MybatisTestUser> page = new Page<>();
	if (StringUtils.isNotBlank(pb.getCurrent())) {
		page.setCurrent(Long.valueOf(pb.getCurrent()));
	}
	if (StringUtils.isNotBlank(pb.getSize())) {
		page.setSize(Long.valueOf(pb.getSize()));
	}
	IPage<MybatisTestUser> selectBypage = testService.selectBypage(page, user);
	return selectBypage;
}

//serviceImpl
@Override
	public IPage<MybatisTestUser> selectBypage(IPage<MybatisTestUser> page,MybatisTestUser user) {
		QueryWrapper<MybatisTestUser> query= new QueryWrapper<>();
		IPage<MybatisTestUser> iPage = userTestMapper.selectPage(page, query);
		int total = iPage.getRecords().size();
		iPage.setTotal(total);
		return iPage;
	}

Sequence主键

个人不常用，没研究，忽略

自定义ID生成器

说明：

自3.3.0开始,默认使用雪花算法+UUID(不含中划线)

实体类中配置id的生成类型

//分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),
//	使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
//	@TableId(type = IdType.ASSIGN_ID)
	@TableId
	private String id;

@TableId 源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface TableId {

    /**
     * 字段名（该值可无）
     */
    String value() default "";

    /**
     * 主键类型
     * {@link IdType}
     */
    IdType type() default IdType.NONE;
}

IdType 源码：

/**
 * 生成ID类型枚举类
 *
 * @author hubin
 * @since 2015-11-10
 */
@Getter
public enum IdType {
    /**
     * 数据库ID自增
     * <p>该类型请确保数据库设置了 ID自增 否则无效</p>
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
     */
    NONE(1),
    /**
     * 用户输入ID
     * <p>该类型可以通过自己注册自动填充插件进行填充</p>
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 分配ID (主键类型为number或string）,
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
     *
     * @since 3.3.0
     */
    ASSIGN_ID(3),
    /**
     * 分配UUID (主键类型为 string)
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
     */
    ASSIGN_UUID(4),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_ID}
     */
    @Deprecated
    ID_WORKER(3),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_ID}
     */
    @Deprecated
    ID_WORKER_STR(3),
    /**
     * @deprecated 3.3.0 please use {@link #ASSIGN_UUID}
     */
    @Deprecated
    UUID(4);

    private final int key;

    IdType(int key) {
        this.key = key;
    }
}

通过IdType 源码可以看出自定义生成id选择 NONE(1),即@TableId(type = IdType.NONE)，由于@TableId 的源码默认为 IdType type() default IdType.NONE 所以只需要在主键上标注@TableId注解即可
自定义id配置
创建类实现IdentifierGenerator 接口 重写nextId 方法

/** 自定义id生成  本次案例以时间戳加上随机六位数 生成id
 * @author Admin
 *
 */
public class MyIdentifierGenerator implements IdentifierGenerator{
	private static SimpleDateFormat sf;
	static {
		sf = new SimpleDateFormat("yyyyMMddHHmm");
	}
	@Override
	public Number nextId(Object entity) {
		StringBuilder sb = new StringBuilder();
		for(int i = 0;i<6;i++) {
			int a = new Random().nextInt(10);
			sb.append(a+"");
		}
		String date = sf.format(new Date()).toString();
		Long id = Long.parseLong(date+sb.toString().trim());
		return id;
	}

}

将该配置加入到config配置类中

//配置自定义主键生成
	@Bean
	public IdentifierGenerator myIdentifierGenerator() {
		return new MyIdentifierGenerator();
	}

扩展

主要选取 逻辑删除、自动填充功能、sql注入器使用

逻辑删除

说明：

只对自动注入的sql起效:

• 插入: 不作限制
• 查找: 追加where条件过滤掉已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
• 更新: 追加where条件防止更新到已删除数据,且使用 wrapper.entity 生成的where条件会忽略该字段
• 删除: 转变为 更新
  例如:
• 删除: update user set deleted=1 where id = 1 and deleted=0
• 查找: select id,name,deleted from user where deleted=0

YML配置

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

实体类添加注解

//since 3.3.0,配置后可以忽略不配置@TableLogic
@TableLogic 
private Integer deleted;

在数据库中设置deleted的字段默认值为0 默认未删除 或者 在save前通过set方法给deleted赋值 或者 通过自动注入方式给该字段赋值，少了这一步逻辑删除不生效

自动填充功能

我们常用的字段create_time，update_time和逻辑删除的字段deleted 不需要每次save的时候赋值，通过自动注入进行实现赋值
实体类配置

@TableField(fill = FieldFill.INSERT)
private Integer deleted;

@TableField(fill = FieldFill.INSERT)
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

FieldFill源码

/**
 * 字段填充策略枚举类
 *
 * <p>
 * 判断注入的 insert 和 update 的 sql 脚本是否在对应情况下忽略掉字段的 if 标签生成
 * <if test="...">......</if>
 * 判断优先级比 {@link FieldStrategy} 高
 * </p>
 *
 * @author hubin
 * @since 2017-06-27
 */
public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入时填充字段
     */
    INSERT,
    /**
     * 更新时填充字段
     */
    UPDATE,
    /**
     * 插入和更新时填充字段
     */
    INSERT_UPDATE
}

创建类实现MetaObjectHandler 实现 MetaObjectHandler 重写insertFill 和 updateFill 方法

/** mybatisplus 自动注入
 * @author Admin
 *
 */
public class MyMetaObjectHandler implements MetaObjectHandler{

	@Override
	public void insertFill(MetaObject metaObject) {
		//第一个参数：需要填充的字段   第二个参数：填充的值   第三个参数：metaObject
		this.setFieldValByName("createTime", new Date(), metaObject);
		this.setFieldValByName("updateTime", new Date(), metaObject);
		this.setFieldValByName("deleted", 0, metaObject);
	}

	@Override
	public void updateFill(MetaObject metaObject) {
		this.setFieldValByName("updateTime", new Date(), metaObject);
	}

}

将该配置配置到config当中

//配置自动填充
@Bean
public MetaObjectHandler myMetaObjectHandler() {
	return new MyMetaObjectHandler();
}

Sql 注入器

上面配置了逻辑删除，那么mybatisPlus物理删除就不会生效需要手写sql，每个service都手写一次比较麻烦，因此通过sql注入器，配置全局通用物理删除sql，避免手写删除sql。

官网案例：https://gitee.com/baomidou/mybatis-plus-samples/tree/master/mybatis-plus-sample-deluxe/src/main/java/com/baomidou/mybatisplus/samples/deluxe/methods
可以参照官网上的案例进行自定义全局sql

1. 自定义全局sql
   创建类继承AbstractMethod , AbstractMethod 是一个抽象类，重写injectMappedStatement 方法

/** 自定义物理删除方法
 * @author Admin
 *
 */
@SuppressWarnings("serial")
public class MyCustom extends AbstractMethod{

	@Override
	public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
		//tableInfo 表的信息
		String sqlInit = "delete from "+tableInfo.getTableName()+" where %s = %s";
		//获取表的主键
		String idKey = tableInfo.getKeyColumn();
		//拼接主键参数的值
		String value ="#{"+idKey+"}";
		//拼接成完整的接口
		String sql = String.format(sqlInit,idKey, value);
		System.out.println(sql);
		SqlSource sqlSource = languageDriver.createSqlSource(
				configuration, 
				sql,
				modelClass
				);
		//添加到抽象方法AbstractMethod中 第二个参数为定义的物理删除方法的名称		
		return this.addDeleteMappedStatement(mapperClass, "physicalDel", sqlSource);
		
	}

}

通过给System.out.println(sql); 打上断点 ，输出出的sql为

2. 自定义的sql注册到mybatisplus注入器中
   创建类继承DefaultSqlInjector 重写getMethodList方法

/** 将自定义的sql注册到mybatisplus全局中
 * @author Admin
 *
 */
public class MyLogicSqlInjector extends DefaultSqlInjector{
	
	/**
     * 如果只需增加方法，保留MP自带方法
     * 可以super.getMethodList() 再add
     * @return
     */
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        methodList.add(new MyCustom());
        return methodList;
    }
	
}

3. 将该注入器配置到config配置类中

/**
	 * 自定义 SqlInjector
	 * 里面包含自定义的全局方法
	 */
	@Bean
	public MyLogicSqlInjector myLogicSqlInjector() {
		return new MyLogicSqlInjector();
	}

4. 自定义mapper继承BaseMapper

/** 基础的mapper
 * @author Admin
 *
 * @param <T>
 */
public interface MyBaseMapper<T> extends BaseMapper<T>{
	//该方法名要和MyCustom 定义的方法名相同
	boolean physicalDel(String id);
}

插件

说明：

MybatisPlusInterceptor 该插件是核心插件,目前代理了 Executor#query 和 Executor#update 和 StatementHandler#prepare 方法
属性: private List interceptors = new ArrayList<>();
InnerInterceptor:我们提供的插件都将基于此接口来实现功能
目前已有的功能:

• 自动分页: PaginationInnerInterceptor
• 多租户: TenantLineInnerInterceptor
• 动态表名: DynamicTableNameInnerInterceptor
• 乐观锁: OptimisticLockerInnerInterceptor
• sql性能规范: IllegalSQLInnerInterceptor
• 防止全表更新与删除: BlockAttackInnerInterceptor

主要使用乐观锁、分页
分页在上面已经阐述

乐观锁

OptimisticLockerInnerInterceptor
说明:

当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：

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

乐观锁配置需要两步
配置插件

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
    return interceptor;
}

在实体类的字段上加上@Version注解
说明:

支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime

• 整数类型下 newVersion = oldVersion + 1
• newVersion 会回写到 entity 中
• 仅支持 updateById(id) 与 update(entity, wrapper) 方法
• 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

@Version
private Integer version;