2.5万字长文简单总结SpringMVC请求参数接收

这是公众号《Throwable文摘》发布的第22篇原创文章,暂时收录于专辑《架构与实战》。暂定下一篇发布的长文是《图文分析JUC同步器框架》,下一篇发布的短文是《SpringBoot2.x入门:引入jdbc模块与JdbcTemplate简单使用》。

前提

在日常使用SpringMVC进行开发的时候,有可能遇到前端各种类型的请求参数,这里做一次相对全面的总结。SpringMVC中处理控制器参数的接口是HandlerMethodArgumentResolver,此接口有众多子类,分别处理不同(注解类型)的参数,下面只列举几个子类:

RequestParamMethodArgumentResolver:解析处理使用了@RequestParam注解的参数、MultipartFile类型参数和Simple类型(如long、int等类型)参数。

RequestResponseBodyMethodProcessor:解析处理@RequestBody注解的参数。

PathVariableMapMethodArgumentResolver:解析处理@PathVariable注解的参数。

实际上,一般在解析一个控制器的请求参数的时候,用到的是HandlerMethodArgumentResolverComposite,里面装载了所有启用的HandlerMethodArgumentResolver子类。而HandlerMethodArgumentResolver子类在解析参数的时候使用到HttpMessageConverter(实际上也是一个列表,进行遍历匹配解析)子类进行匹配解析,常见的如MappingJackson2HttpMessageConverter(使用Jackson进行序列化和反序列化)。

spmvc-p-14

而HandlerMethodArgumentResolver子类到底依赖什么HttpMessageConverter实例实际上是由请求头中的Content-Type(在SpringMVC中统一命名为MediaType,见org.springframework.http.MediaType)决定的,因此我们在处理控制器的请求参数之前必须要明确外部请求的Content-Type到底是什么。上面的逻辑可以直接看源码AbstractMessageConverterMethodArgumentResolver#readWithMessageConverters,思路是比较清晰的。在@RequestMapping注解中,produces和consumes属性就是和请求的Accept或者响应的Content-Type相关的:

consumes属性:指定处理请求的提交内容类型(Content-Type),例如application/json、text/html等等,只有命中了对应的Content-Type的值才会接受该请求。

produces属性:指定返回的内容类型,仅当某个请求的请求头中的(Accept)类型中包含该指定类型才返回,如果返回的是JSON数据一般考虑使用application/json;charset=UTF-8。

另外提一点,SpringMVC中默认使用Jackson作为JSON的工具包,如果不是完全理解透整套源码的运作,一般不是十分建议修改默认使用的MappingJackson2HttpMessageConverter(例如有些人喜欢使用FastJson,实现HttpMessageConverter引入FastJson做HTTP消息转换器,其实这种做法并不推荐)。

SpringMVC请求参数接收

其实一般的表单或者JSON数据的请求都是相对简单的,一些复杂的处理主要包括URL路径参数、文件上传、数组或者列表类型数据等。另外,关于参数类型中存在日期类型属性(例如java.util.Date、java.sql.Date、java.time.LocalDate、java.time.LocalDateTime、java.time.ZonedDateTime等等),解析的时候一般需要自定义实现的逻辑实现String-->日期类型的转换。其实道理很简单,日期相关的类型对于每个国家、每个时区甚至每个使用者来说认知都不一定相同,所以SpringMVC并没有对于日期时间类型的解析提供一个通用的解决方案。在演示一些例子可能用到下面的模特类:

@Data public class User { private String name; private Integer age; private List<Contact> contacts; } @Data public class Contact { private String name; private String phone; }

下面主要以HTTP的GET方法和POST方法提交在SpringMVC体系中正确处理参数的例子进行分析,还会花精力整理SpringMVC体系中独有的URL路径参数处理的一些技巧以及最常见的日期参数处理的合理实践(对于GET方法和POST方法提交的参数处理,基本囊括了其他如DELETE、PUT等方法的参数处理,随机应变即可)。

GET方法请求参数处理

HTTP(s)协议使用GET方法进行请求的时候,提交的参数位于URL模式的Query部分,也就是URL的?标识符之后的参数,格式是key1=value1&key2=value2。GET方法请求参数可以有多种方法获取:

使用@RequestParam注解处理。

使用对象接收,注意对象的属性名称要和Query中的参数名称一致。

使用HttpServletRequest实例提供的方法(不推荐,存在硬编码)。

假设请求的URL为:8080/get?name=doge&age=26,那么控制器如下:

@Slf4j @RestController public class SampleController { @GetMapping(path = "/get1") public void get1(@RequestParam(name = "name") String name, @RequestParam(name = "age") Integer age) { log.info("name:{},age:{}", name, age); } @GetMapping(path = "/get2") public void get2(UserVo vo) { log.info("name:{},age:{}", vo.getName(), vo.getAge()); } @GetMapping(path = "/get3") public void get3(HttpServletRequest request) { String name = request.getParameter("name"); String age = request.getParameter("age"); log.info("name:{},age:{}", name, age); } @Data public static class UserVo { private String name; private Integer age; } } 表单参数

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zywxzx.html