MyBatis-Plus入门教程 MyBatis-Plus 扩展-通用枚举

解决了繁琐的配置，让 mybatis 优雅的使用枚举属性！

自3.1.0开始，如果你无需使用原生枚举，可配置默认枚举来省略扫描通用枚举配置

• 升级说明:

3.1.0 以下版本改变了原生默认行为,升级时请将默认枚举设置为​EnumOrdinalTypeHandler ​

• 影响用户:

实体中使用原生枚举

• 其他说明:

配置枚举包扫描的时候能提前注册使用注解枚举的缓存

1、声明通用枚举属性

• 方式一： 使用 ​@EnumValue​ 注解枚举属性

public enum GradeEnum {
    PRIMARY(1, "小学"),  SECONDORY(2, "中学"),  HIGH(3, "高中");
    GradeEnum(int code, String descp) {
        this.code = code;
        this.descp = descp;
    }
    @EnumValue//标记数据库存的值是code
    private final int code;
    //。。。
}

• 方式二： 枚举属性，实现 ​IEnum接口如下：

public enum AgeEnum implements IEnum<Integer> {
    ONE(1, "一岁"),
    TWO(2, "二岁"),
    THREE(3, "三岁");
    private int value;
    private String desc;
    @Override
    public Integer getValue() {
        return this.value;
    }
}

• 实体属性使用枚举类型

public class User {
    /**
     * 名字
     * 数据库字段: name varchar(20)
     */
    private String name;
    /**
     * 年龄，IEnum接口的枚举处理
     * 数据库字段：age INT(3)
     */
    private AgeEnum age;
    /**
     * 年级，原生枚举（带{@link com.baomidou.mybatisplus.annotation.EnumValue}):
     * 数据库字段：grade INT(2)
     */
    private GradeEnum grade;
}

2、配置扫描通用枚举

• 配置文件 ​resources/application.yml​

mybatis-plus:
    # 支持统配符 * 或者 ; 分割
    typeEnumsPackage: com.baomidou.springboot.entity.enums
  ....

• 自定义配置类 ​MybatisPlusAutoConfiguration​

@Configuration
public class MybatisPlusAutoConfiguration {
    @Bean
    public MybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer() {
        return properties -> {
            GlobalConfig globalConfig = properties.getGlobalConfig();
            globalConfig.setBanner(false);
            MybatisConfiguration configuration = new MybatisConfiguration();
            configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);
            properties.setConfiguration(configuration);
        };
    }
}

如何序列化枚举值为数据库存储值？

Jackson

• 重写 ​toString ​方法

springboot：

@Bean
    public Jackson2ObjectMapperBuilderCustomizer customizer(){
        return builder -> builder.featuresToEnable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
    }

jackson：

ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.configure(SerializationFeature.WRITE_ENUMS_USING_TO_STRING, true);

以上两种方式任选其一,然后在枚举中复写 ​toString方法即可。

• 注解处理

public enum GradeEnum {
    PRIMARY(1, "小学"),  SECONDORY(2, "中学"),  HIGH(3, "高中");
    GradeEnum(int code, String descp) {
        this.code = code;
        this.descp = descp;
    }
    @EnumValue
  	@JsonValue	//标记响应json值
    private final int code;
}

Fastjson

• 重写 ​toString方法

全局处理方式

FastJsonConfig config = new FastJsonConfig();
    config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString);

局部处理方式

@JSONField(serialzeFeatures= SerializerFeature.WriteEnumUsingToString)
    private UserStatus status;

以上两种方式任选其一,然后在枚举中复写 ​toString方法即可。