mybatis-plus是如何只做增强不做改变之通用枚举篇(更新版)

年前, Mybatis 官方已经发布了 3.5.0 ,从 Mybatis-Plus 的 commit 记录可看出,也在做了一些相关的适配工作,但迟迟未发布 3.0.8 的正式版,所以到现在只有静静的等待官方发布啦,不过我们可以通过源码打包自己优先体验.

废话不多说,直接进入正题,原来处理枚举需要必须通过 Mybatis-Plus 的扩展配置 typeEnumsPackage 来进行处理,但 3.0.8 发布之后,直接可以使用 Mybatis 的配置方式了,也就是设置 defaultEnumTypeHandler .

注意下, EnumAnnotationTypeHandler 已经过时了,所以在 3.0.8 以后,只需要使 EnumTypeHandler 即可处理 Mybatis-Plus 提供的两种枚举处理方案(实现 IEnum 接口或使用 @EnumValue 注解).

spring-boot

mybatis-plus:  
    configuration:    
        default-enum-type-handler: com.baomidou.mybatisplus.extension.handlers.EnumTypeHandler复制代码

springmvc

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">    
     <property name="configuration">        
        <bean class="com.baomidou.mybatisplus.core.MybatisConfiguration">           
             <property name="defaultEnumTypeHandler" value="com.baomidou.mybatisplus.extension.handlers.EnumTypeHandler"/>        
        </bean>    
     </property>
</bean>复制代码

到这里也许你会产生疑问了,使用这种方案和配置 typeEnumsPackage 的区别是什么?

//com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean 525行
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
classes.stream().filter(Class::isEnum) //是枚举          
//是IEnum实现类或使用@EnumValue注解      
.filter(cls -> IEnum.class.isAssignableFrom(cls) || EnumTypeHandler.dealEnumType(cls).isPresent())                 
//注册枚举转换器,注意下register方法,这里会反射调用EnumTypeHandler的默认构造方法                
.forEach(cls -> typeHandlerRegistry.register(cls, EnumTypeHandler.class));复制代码

看上面这代码是片段是配置 typeEnumsPackage 时进行的处理,然后再结合下面 EnumTypeHandler 的构造方法.

//com.baomidou.mybatisplus.extension.handlers.EnumTypeHandler
    public EnumTypeHandler(Class<E> type) {        
    if (type == null) {            
        throw new IllegalArgumentException("Type argument cannot be null");        
    }        
    this.type = type;        
    //是IEnum实现类
    if (IEnum.class.isAssignableFrom(type)) {           
        try {                
            //使用getValue方法获取值
            this.method = type.getMethod("getValue");
        } catch (NoSuchMethodException e) {                
            throw new IllegalArgumentException(String.format("NoSuchMethod getValue() in Class: %s.", type.getName()));            
        }        
    } else {            
            // 这里会缓存了枚举类对应的方法            
             this.method = TABLE_METHOD_OF_ENUM_TYPES.computeIfAbsent(type, k -> {                
            // 寻找标记@EnumValue字段               
             Field field = dealEnumType(this.type).orElseThrow(() -> new IllegalArgumentException(String.format("Could not find @EnumValue in Class: %s.", type.getName())));                
            // 获取标记@EnumValue字段的get方法                
            return ReflectionKit.getMethod(this.type, field);            
        });        
    }    
}复制代码

如果我们配置 typeEnumsPackage ,对使用注解的方式来说的话,就等同于预先初始化了缓存,但对于使用实现 IEnum 接口的方式来说,并无多大作用.

所以,如果你是使用注解的方式且不想懒加载,你可以配置 typeEnumsPackage 来初始化枚举缓存,其他的方式的话就直接设置 defaultEnumTypeHandler 即可.