springboot枚舉類型傳遞

在本週寫項目時，須要將枚舉類型做爲參數進行傳遞。

測試

首先先創建一個枚舉類:

public enum ScoreType  {
    TOTAL_SCORE("總評成績"),
    MIDDLE_SCORE("期中成績"),
    FINAL_SCORE("期末成績");
    String des; // 描述
    ScoreType(String des) {
        this.des = des;
    }
    public String getDes() {
        return des;
    } 
}

再創建一個枚舉api接口:

@RestController
@RequestMapping("/Klass")
public class KlassController {
    @GetMapping("testEnum")
    public String testEnum(@RequestParam ScoreType scoreType) {
        return "枚舉序號:" + scoreType.ordinal() + ",枚舉名:" + scoreType.name();
    }
}

進行測試，使用枚舉名發送數據:

使用枚舉序號發送數據:

因而可知，在springboot默認請求參數映射中，枚舉類型只能經過枚舉名來進行參數映射，但有時候咱們須要用序號來作映射。

Converter

顧明思議Converter就是轉換的意思，咱們能夠經過定義的Converter來肯定參數到枚舉類型之間的轉換:

public class BaseEnumConverter<T extends Enum> implements Converter<String, T> {
    private Map<String, T> enumMap = new HashMap<>();
    public BaseEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        for (T e : enums) {
            enumMap.put(String.valueOf(e.ordinal()), e);
            enumMap.put(e.name(), e);
        }
    }
    @Override
    public T convert(String source) {
        T t1 = enumMap.get(source.toLowerCase());
        T t2 = enumMap.get(source.toUpperCase());
        if (t1 == null && t2 == null) {
            throw new IllegalArgumentException("沒法匹配對應的枚舉類型");
        }
        return t1 == null ? t2 : t1;
    }
}

分析代碼，根據運行時具體枚舉類的參數，獲取全部枚舉值，並將各個枚舉值序列和枚舉值名與枚舉值之間作映射(保存在Map中)，如上述枚舉類型，將會生成如下Map:

0 => ScoreType.TOTAL_SCORE
TOTAL_SCORE => ScoreType.TOTAL_SCORE
1 => ScoreType.MIDDLE_SCORE
MIDDLE_SCORE => ScoreType.MIDDLE_SCORE
2 => ScoreType.FINAL_SCORE
FINAL_SCORE => ScoreType.FINAL_SCORE

經過此Converter,就能夠實現前臺傳序號和枚舉名，都能成功映射到枚舉類型，將此Converter經過工廠模式提供到springboot中:

public class BaseEnumConverterFactory implements ConverterFactory<String, Enum> {
    private static final Map<Class, Converter> CONVERTERS = new HashMap<>();
    @Override
    public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
        // 每個類型建立一個轉換器
        Converter<String, T> converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new BaseEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverterFactory(new BaseEnumConverterFactory());
    }
}

進行測試,使用枚舉名發送數據:

使用枚舉序號發送數據:

靈活化

爲了保證靈活性，每一個枚舉類型能夠自定義轉換的方式，創建一個接口，對接口進行類型轉換，創建一個BaseEnum接口:

public interface BaseEnum {
    String[] getKeys(); //返回的keys可轉換爲BaseEnum
}

枚舉類實現此接口，並定義映射方式

public enum ScoreType implements BaseEnum {
    TOTAL_SCORE("總評成績"),
    MIDDLE_SCORE("期中成績"),
    FINAL_SCORE("期末成績");
    String des; // 描述
    ScoreType(String des) {
        this.des = des;
    }
    public String getDes() {
        return des;
    }
    @Override
    public String[] getKeys() {
        String[] s = {String.valueOf(this.ordinal()), this.name()}; // 次序和名字均可轉爲枚舉，如0和total_score => ScoreType.TOTAL_SCORE
    return s;
    }
}

轉換器統一對BaseEnum進行轉換:

public class BaseEnumConverter<T extends BaseEnum> implements Converter<String, T> {
    private Map<String, T> enumMap = new HashMap<>();
    public BaseEnumConverter(Class<T> enumType) {
        T[] enums = enumType.getEnumConstants();
        // 根據keys創建轉換
        for (T e : enums) {
            for (String key : e.getKeys()) {
                enumMap.put(key, e);
            }
        }
    }
    @Override
    public T convert(String source) {
        T t1 = enumMap.get(source.toLowerCase());
        T t2 = enumMap.get(source.toUpperCase());
        if (t1 == null && t2 == null) {
            throw new IllegalArgumentException("沒法匹配對應的枚舉類型");
        }
        return t1 == null ? t2 : t1;
    }
}

對於每一個枚舉類型，可經過返回的keys來自定義轉換的方式。