一、概述

在利用Spring進行Web后臺開發時，經常會遇(yu)到枚舉類(lei)型(xing)綁定問題。一般情況下，如(ru)果Spring接收(shou)到的(de)參數(shu)值為字符(fu)串類(lei)型(xing)，Spring會根據(ju)枚舉的(de)值與傳(chuan)入的(de)字符(fu)串進行對應。假設如(ru)下枚舉

枚舉定義

public enum TestEnum {
    FIRST(1,"第一個"),
    SECOND(2,"第二個"),
    THIRD(3,"第三個");
}

那么客戶端請求時(shi),將(jiang)參數值(zhi)設(she)置(zhi)成FIRST或(huo)SECOND。但是如果設(she)置(zhi)的字符串(chuan)不是對應的就沒辦法完成映射(she)。

二、枚舉與Jackson結合

枚舉的全部定義

public enum TestEnum {
    FIRST(1,"第一個"),
    SECOND(2,"第二個"),
    THIRD(3,"第三個");
    private Integer code;
    private String desc;
    TestEnum(Integer code,String desc){
        this.code = code;
        this.desc = desc;
    }
    @Override
    @JsonValue
    public String toString() {
        return this.getCode().toString();
    }
}

通(tong)過(guo)重寫toString方(fang)法，即可在(zai)轉(zhuan)JSON的(de)(de)時(shi)候返(fan)(fan)回code的(de)(de)String值，而不(bu)是(shi)FIRST這種字符串。通(tong)過(guo)在(zai)toString方(fang)法上注解@JsonValue，可在(zai)JSON字符串轉(zhuan)對象時(shi)將(jiang)code的(de)(de)值轉(zhuan)成(cheng)枚(mei)舉，但是(shi)此方(fang)法只限于@RequestBody，返(fan)(fan)回值通(tong)過(guo)JSON格(ge)式返(fan)(fan)回時(shi)。如果是(shi)普通(tong)的(de)(de)@RequestParam將(jiang)達不(bu)到效果。

三、Spring轉化器實現

1、定義枚舉接口

public interface BaseEnum {
    Integer getCode();
}

2、定義ConverterFactory

public class CommonEnumConverterFactory implements ConverterFactory<String, BaseEnum> {
    private static final Map<Class,Converter> convertMap = new WeakHashMap<>();
    @Override
    public <T extends BaseEnum> Converter<String, T> getConverter(Class<T> targetType) {
        Converter result = convertMap.get(targetType);
        if(result == null){
            result = new IntegerStrToEnum<T>(targetType);
            convertMap.put(targetType,result);
        }
        return result;
    }
    class IntegerStrToEnum<T extends BaseEnum> implements Converter<String,T>{
        private final Class<T> enumType;
        private Map<String,T> enumMap = new HashMap<>();
        public IntegerStrToEnum(Class<T> enumType){
            this.enumType = enumType;
            T[] enums = enumType.getEnumConstants();
            for(T e : enums){
                enumMap.put(e.getCode() + "",e);
            }
        }
        @Override
        public T convert(String s) {
            T result = enumMap.get(s);
            if(result == null){
                throw new IllegalArgumentException("No element matches " + s);
            }
            return result;
        }
    }
}

3、將轉化器(qi)工廠注入到WebMvc

@Configuration
public class WebAppConfigurer implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(new CommonEnumConverterFactory());
    }
}

啟動項目(mu)后,不(bu)管是通(tong)(tong)過@RequestParam接收參數(shu)，還是通(tong)(tong)過對象包裹(guo)接收參數(shu),都可以通(tong)(tong)過枚舉(ju)中的(de)code值(zhi)映射。

@RequestMapping("/test-param")
public TestEnum testParam(@RequestParam("test")TestEnum testEnum){
}
@RequestMapping("/test-object")
public TestRequest testObject(TestRequest request){ 
}

但是還存在問題(ti),通過@RequestBody接(jie)收參數還是沒(mei)辦法做(zuo)到映射(she)，前端(duan)參數傳code不生效，默認(ren)用的(de)是枚(mei)舉的(de)original或者枚(mei)舉的(de)名稱做(zuo)映射(she)。這個時候就可以結合上(shang)面的(de)注解@JsonValue,即枚(mei)舉與(yu)JSON轉化時通過被注解的(de)方法返回的(de)值進行(xing)。

@Override
@JsonValue
public String toString() {
    return this.getCode().toString();
}

注(zhu)解了@JsonValue后，也將(jiang)枚(mei)舉類(lei)型(xing)的(de)返(fan)(fan)回(hui)值(zhi)統一成(cheng)code的(de)字(zi)符串(chuan)(chuan)。至此(ci)，不管使用什么方(fang)式進行傳參，或(huo)者將(jiang)枚(mei)舉類(lei)型(xing)返(fan)(fan)回(hui)，都是(shi)保持一致的(de)code字(zi)符串(chuan)(chuan)，從(cong)而(er)達(da)成(cheng)統一。