Spring Boot 前端请求参数自动映射到枚举，后端响应JSON数据自动解析枚举

一、 场景

1. 前端提交表单数据，其中有一个type字段自动映射到后端的一个Type枚举类
2. 后端向前端响应JSON数据，将Type枚举对象解析成JSON数据

二、 方案

1. 定义一个公共的枚举接口，如果有以上场景1需求的，就可以在枚举类上实现这个枚举接口

public interface BaseEnum {
    /**
     * 获取枚举编码
     */
    String getCode();
}

2. 实现枚举类

@Getter  // 没有引入lombok依赖包的，可以自己实现get方法
@JsonFormat(shape = JsonFormat.Shape.OBJECT)  // 实现场景2，只需要加上这个注解
public enum Type implements BaseEnum {

    TYPE_1("1", "类型1"),
    TYPE_2("2", "类型2");

    @EnumValue // 这个注解只是为了实现Mybatis Plus自动将数据库数据映射成对应的枚举对象，是另一种场景需求，和本文无关。
    private String code;
    private String desc;

    Type(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }
}

3. 自定义Converter类

**
 * 枚举编码 -> 枚举 转化器
 * 实现org.springframework.core.convert.converter.Converter类
 */
public class StringToEnumConverter implements Converter {
    private Map enumMap = Maps.newHashMap();

    public StringToEnumConverter(Class enumType) {
        T[] enums = enumType.getEnumConstants();
        for (T e : enums) {
            enumMap.put(e.getCode().toString(), e);
        }
    }

    @Override
    public T convert(String source) {
        T t = enumMap.get(source);
        if (Objects.isNull(t)) {
            throw new IllegalArgumentException("无法匹配对应的枚举类型");
        }
        return t;
    }
}

4. 自定义 ConverterFactory 工厂类

/**
 * 编码 -> 枚举 转化器工厂类
 */
public class StringCodeToEnumConverterFactory implements ConverterFactory {
    private static final Map CONVERTERS = Maps.newHashMap();

    /**
     * 获取一个从 String 转化为 T 的转换器，T 是一个泛型，有多个实现
     *
     * @param targetType 转换后的类型
     * @return 返回一个转化器
     */
    @Override
    public  Converter getConverter(Class targetType) {
        Converter converter = CONVERTERS.get(targetType);
        if (converter == null) {
            converter = new StringToEnumConverter<>(targetType);
            CONVERTERS.put(targetType, converter);
        }
        return converter;
    }
}

5. 将转化器工厂添加进 Spring Boot 配置

/**
 * MVC通用配置
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    /**
     * 枚举类的转换器工厂 addConverterFactory
     */
    @Override
    public void addFormatters(FormatterRegistry registry) {
        // 枚举 转化器工厂类 添加进 Spring Boot 配置
        registry.addConverterFactory(new StringCodeToEnumConverterFactory());
    }
}

三、 演示

@Controller("frontTestController")
@RequestMapping("/test")
public class TestController extends BaseController {

    @GetMapping("/form")
    @ResponseBody
    public List form(Test test) {
        System.out.println(JSONObject.toJSONString(test));
        return getList();
    }

    @PostMapping("/json")
    @ResponseBody
    public List json(@RequestBody Test test) {
        System.out.println(JSONObject.toJSONString(test));
        return getList();
    }

    public List getList() {
        List list = Lists.newArrayList();
        list.add(new Test(1, "test01", Type.TYPE_1));
        return list;
    }
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Test {
    private Integer testId;
    private String testName;
    private Type type;
}

1. 表单请求方式
请求URL：http://xxx.xxx.com/form?type=1
方法form()接收到请求参数为Type[code="1", desc="类型1"]枚举对象
响应数据：{"testId": 1,"testName": "test1","type": {"code": "1","desc": "类型1"}}

2.JSON请求方式
请求URL：http://xxx.xxx.com/json
请求参数：{"type":"TYPE_1"}
方法json()接收到请求参数为Type[code="1", desc="类型1"]枚举对象
响应数据：{"testId": 1,"testName": "test1","type": {"code": "1","desc": "类型1"}}

注意：这种比较特殊，没有特殊配置，参数值需要是枚举名称，如果参数值是1，会根据枚举类的ordinal属性来关联，原因应该是解析json用的是jackson，用不到spring的Formatter和Converter之类的机制。
有解决方案的朋友欢迎留言~~ (❤ ω ❤)