1/💤背景

很多大厂都要求了代码里面避免魔法值,如阿里巴巴开发规范 阿里巴巴Java开发手册1.4.0 ,那么使用枚举就是比较好避免的一个办法,比如 性别 0-未知 1-男 2-女

【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。
反例:String key = “Id#taobao_” + tradeId;
cache.put(key, value);

1、Controller参数能否用枚举接收?
2、区分大小写?
3、传枚举的什么值?code 能自动识别么?

2/💫测试

为了比较全面的测试,我用三个枚举类进行了测试(实践出真知 )

public class TestEnum {
    public enum gender {
        man,
        woman
    }

    public enum club {
        A(1, "A"),
        B(2, "B");

        Integer number;
        String name;

        club(Integer number, String name) {
            this.number = number;
            this.name = name;
        }
    }

    public enum person {
        A(1, "qq", 23),
        B(2, "aa", 18);

        Integer number;
        String name;
        Integer age;

        person(Integer number, String name, Integer age) {
            this.number = number;
            this.name = name;
            this.age = age;
        }
    }
}

测试非常简单,写一个接口三个枚举参数或三个接口三个枚举参数

@GetMapping("/gender")
    @ResponseBody
    public String admin(@RequestParam(required = false) TestEnum.gender name) {
        System.out.println(name);
        return "hello word!!!";
    }
    
     @GetMapping("/club")
    @ResponseBody
    public String admin(@RequestParam(required = false) TestEnum.club name) {
        System.out.println(name);
        return "hello word!!!";
    }
    
    @GetMapping("/person")
    @ResponseBody
    public String admin(@RequestParam(required = false) TestEnum.person name) {
        System.out.println(name);
        return "hello word!!!";
    }

然后手动调用接口,改变参数值,观察返回值和后台日志,打印出名称则表示获取到了对应的枚举,反之则未获取成功。

3/💦结果

测试比较简单,可以自己尝试一下,简单来说: 只能识别name

默认spring的接口对枚举类型的接收处理逻辑比较简单,就是直接匹配name,

所以有下面几点需要注意:

1、参数未传的时候,获取到的枚举是null,也就是默认值是空的

2、如果传不匹配的值(枚举中没有的值),会报转化类型错误 Failed to convert value of type 'xxx' to required type

3、只能匹配name 也就是枚举本身的名称,比如person枚举,想匹配A(1, "qq", 23),,只能匹配 A 这个参数, 接口请求person/?name=A,而与其他的值无关,比如 1qq23

4、区分大小写 ,传 a 得到的也是转化类型错误

当前我们可以自定义 spring 的ConverterConverterFactory来实现 自定义转化逻辑,那么你想怎么处理参数就是你自己的事情了,可以做兼容处理,识别里面的值来转化成枚举而不限定name。

不过本次测试的是默认的springboot对枚举的处理逻辑,讨论未做额外处理的情况下,spring接口使用枚举的效果和问题。如果后面的人想使用枚举来接收参数,那么就不会完全没有思路。