自定义 springmvc 参数值接收
今天一朋友问我,能不能想办法把 RequestBody 接收的实体类里面的某几个字段,像 RequestParam 一样写到方法参数里,挨个接收。大概就是这种样子
把下面这种
class Dto {
private String name;
private Integer age;
}
@PostMapping("/test")
public Object test(@RequestBody Dto dto);
变成下面这种情况
@PostMapping("/test")
public Object test(String name, Integer age);
给出结果总是很简单,但是要知道为什么其实也不容易。
这就得先简单提一下 springmvc 是如果处理参数的了。当然只是简单提一下。
如果你看过或者准备看 springmvc 源码,那就可以从 org.springframework.web.servlet.DispatcherServlet 类的 doDispatch() 方法的 ha.handle 这一行一步一步执行。
最后应该会执行到 org.springframework.web.method.support.InvocableHandlerMethod 类的 getMethodArgumentValues 方法这里来。
这就是 springmvc 获取参数具体值的方法
150行的 Parameters 就是我们在Controller方法里定义的注解和形参。
举个例子:
@PostMapping("/demo")
public String demo(@RequestParam(value = "name") String name, @RequestParam(value = "age") Integer age)
如果如上定义,那 Parameters 长度就为2 。然后构建两个长度的Object数组,也就是最终的参数值的数组。最后绑定到 name 和 age 字段上。
核心是163行和167行,点进方法里会看到实际执行这两个方法的是,org.springframework.web.method.support.HandlerMethodArgumentResolver 这个接口所对应的具体实现
这里是这个接口的两个方法,上面的是检查当前 HandlerMethodArgumentResolver 是否支持处理此参数,下面是具体的处理方法。
它有很多我们常用的实现,只是可能从来没见过。
比如我随便圈的两个实现,就是处理 @RequestParam 和 @RequestBody 的实现。
举个例子: 对于 @RequestBody 来说,第一个方法 supportsParameter() 就是判断此参数上,是否有 @RequestBody 注解,第二个方法 resolveArgument() 就是具体的处理,获取request的输入流,拿到json 按类型反序列化等等等。
下面简单截个图:
supportsParameter() 方法:
resolveArgument() 方法:
所以如果看完上面的具体实现,就可以知道,@RequestParam 、@RequestBody 都是不可以实现刚才的需求的,@RequestParam 不能处理 content-type : application/json 。@RequestBody 不能多次绑定。不多细讲。
好,回到开始的问题中来,既然明白了 springmvc 获取参数值的逻辑,那其实完全可以自己拓展实现方法。
说说我自己的想法:
基于需求,我完全可以自己定义一个注解,重写上面的 HandlerMethodArgumentResolver 接口里的方法。
1、supportsParameter() 方法的实现:就是判断参数里是否有我自定义的注解。
2、resolveArgument() 方法的实现:我可以像 @RequestBody 的实现一样,获取整个 json,然后反序列化成一个Map,再与注解里的字段名属性匹配,获取值,第二次一样,也获取整个 json 反序列化再取值,这样反复多次绑定。
尝试了一下,发现忽略了一点,@RequestBody 的实现,获取body中的 json 是读取 request 的输入流,第一次读取完了,第二次就读不到了,所以改进方法2。
plus 2、还是先像 @RequestBody 的实现一样,获取整个 json ,然后反序列化成一个Map,然后把获取到的Map里面的键值对放到 Request 的 ParameterMap中,那第二次、第三次…就直接从 ParameterMap 中取就行了
下面具体实现:
1、新建项目,定义注解
2、自定义 HandlerMethodArgumentResolver
2.1 、supportsParameter() 方法的实现和部分依赖引入
这里注入了 RequestMappingHandlerAdapter ,为的是将自己定义的 HandlerMethodArgumentResolver 放到框架 Resolver集合的第一个,前面提到过,这里的resolver就是 诸如 @RequestParam 、@RequestBody 等框架提供的注解的具体处理实现类,之所以要把自定义的放到第一个也很容易想到,因为框架不认识我定义的注解,但是它也有默认实现
2.2、resolveArgument() 的实现
具体实现就和前面是描述一样,获取整个 json ,然后反序列化成一个Map,然后把获取到的Map里面的键值对放到 Request 的 ParameterMap中,第二次、第三次…就直接从 ParameterMap 取。
最后跑起项目测试一下
请求:
controller:
执行结果: