快捷導(dǎo)航

SpringBoot 枚舉類型的自動(dòng)轉(zhuǎn)換的實(shí)現(xiàn)

更新時(shí)間：2022年03月24日 10:36:49 作者：rookie_only

一般我們?cè)跀?shù)據(jù)庫(kù)都會(huì)定義數(shù)值型的枚舉常量，不管是序列化還是反序列化都是需要我們手動(dòng)去轉(zhuǎn)換成枚舉類型的，本文主要介紹了Spring Boot 枚舉類型的自動(dòng)轉(zhuǎn)換，感興趣的可以了解一下

需求：一般我們?cè)跀?shù)據(jù)庫(kù)都會(huì)定義數(shù)值型的枚舉常量，不管是序列化還是反序列化都是需要我們手動(dòng)去轉(zhuǎn)換成枚舉類型的，既然這樣我們能不能讓它們自動(dòng)轉(zhuǎn)換呢？接下來(lái)我們就來(lái)嘗試一下：

首先解決如何接收枚舉類型。

枚舉父類

/**
 * @author rookie
 */
public interface IEnum<T extends Serializable> {

    /**
     * 獲取值
     * @return 值
     */
    T getValue();
}

1、請(qǐng)求頭接收參數(shù)

添加Convert

@Component
public class EnumConvertFactory implements ConverterFactory<String, IEnum<?>> {

    @Override
    public <T extends IEnum<?>> Converter<String, T> getConverter(Class<T> targetType) {
        return new StringToEnum<>(targetType);
    }


    public static class StringToEnum<T extends IEnum<?>> implements Converter<String, T> {

        private final Class<T> targetType;

        public StringToEnum(Class<T> targetType) {
            this.targetType = targetType;
        }

        @Override
        public T convert(String source) {
            if (!StringUtils.hasText(source)) {
                return null;
            }
            return (T) EnumConvertFactory.getEnum(this.targetType, source);
        }
    }

    public static <T extends IEnum<?>> T getEnum(Class<T> targetType, String source) {
        for (T constant : targetType.getEnumConstants()) {
            if (source.equals(String.valueOf(constant.getValue()))) {
                return constant;
            }
        }
        return null;
    }
}

注冊(cè)Convert

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private EnumConvertFactory enumConvertFactory;

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(enumConvertFactory);
    }
}

我們只要實(shí)現(xiàn) IEnum ，然后在我們的接收實(shí)體類中定義相應(yīng)的枚舉類型就能自動(dòng)轉(zhuǎn)換成枚舉類型了，比如這樣：

@Getter
@AllArgsConstructor
public enum TestEnum implements IEnum<String>{

    /**
     * 測(cè)試
     */
    TEST_ENUM("1","2");
    
    private final String value;

    private final String msg;

}

2、請(qǐng)求體接收

Jackson接收枚舉

如果我們接收的是 JSON 字符串類型，那么 Jackson 默認(rèn)是根據(jù)下標(biāo)進(jìn)行轉(zhuǎn)換的，和我們根據(jù)匹配值獲取相應(yīng)枚舉不符，所以進(jìn)行以下更改：

添加枚舉反序列化處理器

@Data
@EqualsAndHashCode(callSuper = true)
public class EnumDeserializer extends JsonDeserializer<Enum<?>> implements ContextualDeserializer {

    private Class<?> target;

    @SuppressWarnings("all")
    @Override
    public Enum<?> deserialize(JsonParser jsonParser, DeserializationContext ctx) throws IOException {
        if (!StringUtils.hasText(jsonParser.getText())) {
            return null;
        }
        if (IEnum.class.isAssignableFrom(target)) {
            return (Enum<?>) EnumConvertFactory.getEnum((Class) target, jsonParser.getText());
        }
        return null;
    }

    /**
     * @param ctx      ctx
     * @param property property
     * @return 1
     * @throws JsonMappingException
     */
    @Override
    public JsonDeserializer<?> createContextual(DeserializationContext ctx, BeanProperty property) throws JsonMappingException {
        Class<?> rawCls = ctx.getContextualType().getRawClass();
        EnumDeserializer enumDeserializer = new EnumDeserializer();
        enumDeserializer.setTarget(rawCls);
        return enumDeserializer;
    }

}

注冊(cè)處理器

@Component
public class JacksonConfig implements SmartInitializingSingleton {

    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public void afterSingletonsInstantiated() {
        SimpleModule simpleModule = new SimpleModule();
        simpleModule.addDeserializer(Enum.class, new EnumDeserializer());
        objectMapper.registerModule(simpleModule);
    }	
}

使用方法和上面一致。

3、添加自定義枚舉序列化

接下來(lái)我們就要解決如何將數(shù)據(jù)庫(kù)中的數(shù)值常量枚舉轉(zhuǎn)換成

jackson 序列化默認(rèn)是按照名稱序列化的，和我們想返回枚舉中的某個(gè)值不符，下面我們進(jìn)行一下小的改動(dòng)：

添加序列化處理器

public class IEnumSerializer extends JsonSerializer<IEnum> {
    @Override
    public void serialize(IEnum iEnum, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeString(iEnum.getName());
    }
}

注冊(cè)序列化處理器

@Component
public class BeanLoadProcess implements SmartInitializingSingleton {

    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public void afterSingletonsInstantiated() {
        SimpleModule simpleModule = new SimpleModule();
        simpleModule.addSerializer(IEnum.class,new IEnumSerializer());
        objectMapper.registerModule(simpleModule);
    }
}

因?yàn)槲覀兿纫徊绞亲寯?shù)據(jù)庫(kù)中的常量能轉(zhuǎn)換成枚舉類型，這里我們定義一下 Mybatis plus（我用的是plus）的枚舉處理器

mybatis-plus:
  configuration:
    default-enum-type-handler: org.apache.ibatis.type.EnumOrdinalTypeHandler

好了這樣就行了。

到此這篇關(guān)于Spring Boot 枚舉類型的自動(dòng)轉(zhuǎn)換的文章就介紹到這了,更多相關(guān)Spring Boot 枚舉類型的自動(dòng)轉(zhuǎn)換內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: