RuoYi-Vue-Plus 阅读笔记 – 5 – MyBatis Plus 配置

本文最后更新于 229 天前，如有失效请评论区留言。

common-mybatis.yml 配置

# 内置配置 不允许修改 如需修改请在 nacos 上写相同配置覆盖
# MyBatisPlus配置
# https://baomidou.com/config/
mybatis-plus:
  # 启动时是否检查 MyBatis XML 文件的存在，默认不检查
  checkConfigLocation: false
  configuration:
    # 自动驼峰命名规则（camel case）映射
    mapUnderscoreToCamelCase: true
    # MyBatis 自动映射策略
    # NONE：不启用 PARTIAL：只对非嵌套 resultMap 自动映射 FULL：对所有 resultMap 自动映射
    autoMappingBehavior: FULL
    # MyBatis 自动映射时未知列或未知属性处理策
    # NONE：不做处理 WARNING：打印相关警告 FAILING：抛出异常和详细信息
    autoMappingUnknownColumnBehavior: NONE
    # 更详细的日志输出 会有性能损耗 org.apache.ibatis.logging.stdout.StdOutImpl
    # 关闭日志记录 (可单纯使用 p6spy 分析) org.apache.ibatis.logging.nologging.NoLoggingImpl
    # 默认日志输出 org.apache.ibatis.logging.slf4j.Slf4jImpl
    logImpl: org.apache.ibatis.logging.nologging.NoLoggingImpl
  global-config:
    # 是否打印 Logo banner
    banner: true
    dbConfig:
      # 主键类型
      # AUTO 自增 NONE 空 INPUT 用户输入 ASSIGN_ID 雪花 ASSIGN_UUID 唯一 UUID
      idType: ASSIGN_ID
      # 逻辑已删除值(框架表均使用此值 禁止随意修改)
      logicDeleteValue: 2
      # 逻辑未删除值
      logicNotDeleteValue: 0
      insertStrategy: NOT_NULL
      updateStrategy: NOT_NULL
      whereStrategy: NOT_NULL

Configuration

完整配置参考文档：https://baomidou.com/pages/56bac0/#configuration-2

dbConfig

完整配置参考文档： https://baomidou.com/pages/56bac0/#idtype

数据库 ID

idType = ASSIGN_ID，分配 ID(主键类型为 Number(Long、Integer) 或 String,使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)

逻辑删除

说明
只对自动注入的 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

配置

logicDeleteValue: 2，逻辑已删除值(默认为 1)
logicNotDeleteValue: 0 ，逻辑未删除值(默认为 0)

使用
在字段上添加注解 @TableLogic

/**
 * 删除标志（0代表存在 2代表删除）
 */
@TableLogic
private String delFlag;

insertStrategy

updateStrategy，whereStrategy 同 insertStrategy

字段验证策略，在 insert(update,select) 的时候的字段验证策略，默认 NOT_NULL

MybatisPlusConfig 配置类

定义mapper包扫描路径，指定配置文件路径

@EnableTransactionManagement(proxyTargetClass = true)
@AutoConfiguration(before = MybatisPlusAutoConfiguration.class)
@MapperScan("${mybatis-plus.mapperPackage}")
@PropertySource(value = "classpath:common-mybatis.yml", factory = YmlPropertySourceFactory.class)
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 数据权限处理
        interceptor.addInnerInterceptor(dataPermissionInterceptor());
        // 分页插件
        interceptor.addInnerInterceptor(paginationInnerInterceptor());
        // 乐观锁插件
        interceptor.addInnerInterceptor(optimisticLockerInnerInterceptor());
        return interceptor;
    }

    /**
     * 数据权限拦截器
     */
    public PlusDataPermissionInterceptor dataPermissionInterceptor() {
        return new PlusDataPermissionInterceptor();
    }

    /**
     * 分页插件，自动识别数据库类型
     */
    public PaginationInnerInterceptor paginationInnerInterceptor() {
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        paginationInnerInterceptor.setMaxLimit(-1L);
        // 分页合理化
        paginationInnerInterceptor.setOverflow(true);
        return paginationInnerInterceptor;
    }

    /**
     * 乐观锁插件
     */
    public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor() {
        return new OptimisticLockerInnerInterceptor();
    }

    /**
     * 元对象字段填充控制器
     */
    @Bean
    public MetaObjectHandler metaObjectHandler() {
        return new InjectionMetaObjectHandler();
    }

    /**
     * 使用网卡信息绑定雪花生成器
     * 防止集群雪花ID重复
     */
    @Bean
    public IdentifierGenerator idGenerator() {
        return new DefaultIdentifierGenerator(NetUtil.getLocalhost());
    }

    /**
     * PaginationInnerInterceptor 分页插件，自动识别数据库类型
     * https://baomidou.com/pages/97710a/
     * OptimisticLockerInnerInterceptor 乐观锁插件
     * https://baomidou.com/pages/0d93c0/
     * MetaObjectHandler 元对象字段填充控制器
     * https://baomidou.com/pages/4c6bcf/
     * ISqlInjector sql注入器
     * https://baomidou.com/pages/42ea4a/
     * BlockAttackInnerInterceptor 如果是对全表的删除或更新操作，就会终止该操作
     * https://baomidou.com/pages/f9a237/
     * IllegalSQLInnerInterceptor sql性能规范插件(垃圾SQL拦截)
     * IdentifierGenerator 自定义主键策略
     * https://baomidou.com/pages/568eb2/
     * TenantLineInnerInterceptor 多租户插件
     * https://baomidou.com/pages/aef2f2/
     * DynamicTableNameInnerInterceptor 动态表名插件
     * https://baomidou.com/pages/2a45ff/
     */

    @Bean
    public DdlApplicationRunner ddlApplicationRunner(@Autowired(required = false) List<IDdl> ddlList) {
        return new DdlApplicationRunner(ddlList);
    }

}

MybatisPlusInterceptor 插件

mybatis plus 提供了很多插件，目前已有的功能

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

关于插件部分放在后面章节单独说明

IdentifierGenerator 自定义 ID

IdentifierGenerator，也可以通过 GlobalConfig 配置 identifierGenerator
通过 Bean 注入

@Bean
public IdentifierGenerator idGenerator() {
    return new DefaultIdentifierGenerator(NetUtil.getLocalhost());
}

DefaultIdentifierGenerator 默认使用雪花算法，这里使用网卡信息绑定雪花生成器

metaObjectHandler 元对象字段填充控制器

也可以通过 GlobalConfig 配置 metaObjectHandler ，null

通过 Bean 注入

/**
 * 元对象字段填充控制器
 */
@Bean
public MetaObjectHandler metaObjectHandler() {
    return new InjectionMetaObjectHandler();
}

元对象字段填充控制器 InjectionMetaObjectHandler

@Slf4j
public class InjectionMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        try {
            if (ObjectUtil.isNotNull(metaObject) && metaObject.getOriginalObject() instanceof BaseEntity baseEntity) {
                Date current = ObjectUtil.isNotNull(baseEntity.getCreateTime())
                    ? baseEntity.getCreateTime() : new Date();
                baseEntity.setCreateTime(current);
                baseEntity.setUpdateTime(current);
                LoginUser loginUser = getLoginUser();
                if (ObjectUtil.isNotNull(loginUser)) {
                    Long userId = ObjectUtil.isNotNull(baseEntity.getCreateBy())
                        ? baseEntity.getCreateBy() : loginUser.getUserId();
                    // 当前已登录 且 创建人为空 则填充
                    baseEntity.setCreateBy(userId);
                    // 当前已登录 且 更新人为空 则填充
                    baseEntity.setUpdateBy(userId);
                    baseEntity.setCreateDept(ObjectUtil.isNotNull(baseEntity.getCreateDept())
                        ? baseEntity.getCreateDept() : loginUser.getDeptId());
                }
            }
        } catch (Exception e) {
            throw new ServiceException("自动注入异常 => " + e.getMessage(), HttpStatus.HTTP_UNAUTHORIZED);
        }
    }

    @Override  
    public void updateFill(MetaObject metaObject) {  
        try {  
            if (ObjectUtil.isNotNull(metaObject) && metaObject.getOriginalObject() instanceof BaseEntity baseEntity) {  
                Date current = new Date();  
                // 更新时间填充(不管为不为空)  
                baseEntity.setUpdateTime(current);  
                LoginUser loginUser = getLoginUser();  
                // 当前已登录 更新人填充(不管为不为空)  
                if (ObjectUtil.isNotNull(loginUser)) {  
                    baseEntity.setUpdateBy(loginUser.getUserId());  
                }  
            }  
        } catch (Exception e) {  
            throw new ServiceException("自动注入异常 => " + e.getMessage(), HttpStatus.HTTP_UNAUTHORIZED);  
        }  
    }
}

上述处理器配置了在用户已登录的情况下，插入和更新时自动填充创建人，创建时间、更新人、更新时间

标签云

最新文章

common-mybatis.yml 配置

Configuration

dbConfig

数据库 ID

逻辑删除

insertStrategy

MybatisPlusConfig 配置类

MybatisPlusInterceptor 插件

IdentifierGenerator 自定义 ID

metaObjectHandler 元对象字段填充控制器

发送评论编辑评论

标签云

最新文章

common-mybatis.yml 配置

Configuration

dbConfig

数据库 ID

逻辑删除

insertStrategy

MybatisPlusConfig 配置类

MybatisPlusInterceptor 插件

IdentifierGenerator 自定义 ID

metaObjectHandler 元对象字段填充控制器

发送评论 编辑评论

推荐文章

发送评论编辑评论