handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类：（主要讲解常用类型）
A、处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable;
B、处理request header部分的注解： @RequestHeader, @CookieValue;
C、处理request body部分的注解：@RequestParam, @RequestBody;
D、处理attribute类型是注解： @SessionAttributes, @ModelAttribute;
在写正文之前，先铺垫一下基础，当你读到下面的文章的时候就基本不会再去百度该方面的内容了哈：
补充基础1：{
在Form元素的语法中，EncType表明提交数据的格式 用 Enctype 属性指定将数据回发到服务器时浏览器使用的编码类型。 下边是说明： application/x-www-form-urlencoded： 窗体数据被编码为名称/值对。这是标准的编码格式。 multipart/form-data： 窗体数据被编码为一条消息，页上的每个控件对应消息中的一个部分。 text/plain： 窗体数据以纯文本形式进行编码，其中不含任何控件或格式字符。
补充
form的enctype属性为编码方式，常用有两种：application/x-www-form-urlencoded和multipart/form-data，默认为application/x-www-form-urlencoded。 当action为get时候，浏览器用x-www-form-urlencoded的编码方式把form数据转换成一个字串（name1=value1&name2=value2...），然后把这个字串append到url后面，用?分割，加载这个新的url。 当action为post时候，浏览器把form数据封装到http body中，然后发送到server。 如果没有type=file的控件，用默认的application/x-www-form-urlencoded就可以了。 但是如果有type=file的话，就要用到multipart/form-data了。浏览器会把整个表单以控件为单位分割，并为每个部分加上Content-Disposition(form-data或者file),Content-Type(默认为text/plain),name(控件name)等信息，并加上分割符(boundary)。
}
1、 @PathVariable
当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
示例代码：
- @Controller
- @RequestMapping("/owners/{ownerId}")
- public class RelativePathUriTemplateController {
-
- @RequestMapping("/pets/{petId}")
- public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
-
- }
- }
上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。
2、 @RequestHeader、@CookieValue
@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。
示例代码：
这是一个Request 的header部分：
- Host localhost:8080
- Accept text/html,application/xhtml+xml,application/xml;q=0.9
- Accept-Language fr,en-gb;q=0.7,en;q=0.3
- Accept-Encoding gzip,deflate
- Accept-Charset ISO-8859-1,utf-8;q=0.7,*;q=0.7
- Keep-Alive 300
- @RequestMapping("/displayHeaderInfo.do")
- public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
- @RequestHeader("Keep-Alive") long keepAlive) {
-
-
-
- }
上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值：
- JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
参数绑定的代码：
- @RequestMapping("/displayHeaderInfo.do")
- public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) {
-
-
-
- }
即把JSESSIONID的值绑定到参数cookie上。
3、@RequestParam, @RequestBody
@RequestParam
A） 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；
B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；
C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；
示例代码：
- @Controller
- @RequestMapping("/pets")
- @SessionAttributes("pet")
- public class EditPetForm {
-
-
-
- @RequestMapping(method = RequestMethod.GET)
- public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
- Pet pet = this.clinic.loadPet(petId);
- model.addAttribute("pet", pet);
- return "petForm";
- }
-
-
@RequestBody
该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；
它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。
因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;
示例代码：
- @RequestMapping(value = "/something", method = RequestMethod.PUT)
- public void handle(@RequestBody String body, Writer writer) throws IOException {
- writer.write(body);
- }
4、@SessionAttributes, @ModelAttribute
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。
该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；
示例代码：
- @Controller
- @RequestMapping("/editPet.do")
- @SessionAttributes("pet")
- public class EditPetForm {
-
- }
@ModelAttribute
该注解有两个用法，一个是用于方法上，一个是用于参数上；
用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：
A） @SessionAttributes 启用的attribute 对象上；
B） @ModelAttribute 用于方法上时指定的model对象；
C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。
用到方法上@ModelAttribute的示例代码：
-
-
-
-
- @ModelAttribute
- public Account addAccount(@RequestParam String number) {
- return accountManager.findAccount(number);
- }
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；
用在参数上的@ModelAttribute示例代码：
- @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
- public String processSubmit(@ModelAttribute Pet pet) {
-
- }
首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。
补充讲解：
问题： 在不给定注解的情况下，参数是怎样绑定的？
通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现，方法的参数在不给定参数的情况下：
若要绑定的对象时简单类型： 调用@RequestParam来处理的。
若要绑定的对象时复杂类型： 调用@ModelAttribute来处理的。
这里的简单类型指Java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；
下面贴出AnnotationMethodHandlerAdapter中绑定参数的部分源代码：
- private Object[] resolveHandlerArguments(Method handlerMethod, Object handler,
- NativeWebRequest webRequest, ExtendedModelMap implicitModel) throws Exception {
-
- Class[] paramTypes = handlerMethod.getParameterTypes();
- Object[] args = new Object[paramTypes.length];
-
- for (int i = 0; i < args.length; i++) {
- MethodParameter methodParam = new MethodParameter(handlerMethod, i);
- methodParam.initParameterNameDiscovery(this.parameterNameDiscoverer);
- GenericTypeResolver.resolveParameterType(methodParam, handler.getClass());
- String paramName = null;
- String headerName = null;
- boolean requestBodyFound = false;
- String cookieName = null;
- String pathVarName = null;
- String attrName = null;
- boolean required = false;
- String defaultValue = null;
- boolean validate = false;
- Object[] validationHints = null;
- int annotationsFound = 0;
- Annotation[] paramAnns = methodParam.getParameterAnnotations();
-
- for (Annotation paramAnn : paramAnns) {
- if (RequestParam.class.isInstance(paramAnn)) {
- RequestParam requestParam = (RequestParam) paramAnn;
- paramName = requestParam.value();
- required = requestParam.required();
- defaultValue = parseDefaultValueAttribute(requestParam.defaultValue());
- annotationsFound++;
- }
- else if (RequestHeader.class.isInstance(paramAnn)) {
- RequestHeader requestHeader = (RequestHeader) paramAnn;
- headerName = requestHeader.value();
- required = requestHeader.required();
- defaultValue = parseDefaultValueAttribute(requestHeader.defaultValue());
- annotationsFound++;
- }
- else if (RequestBody.class.isInstance(paramAnn)) {
- requestBodyFound = true;
- annotationsFound++;
- }
- else if (CookieValue.class.isInstance(paramAnn)) {
- CookieValue cookieValue = (CookieValue) paramAnn;
- cookieName = cookieValue.value();
- required = cookieValue.required();
- defaultValue = parseDefaultValueAttribute(cookieValue.defaultValue());
- annotationsFound++;
- }
- else if (PathVariable.class.isInstance(paramAnn)) {
- PathVariable pathVar = (PathVariable) paramAnn;
- pathVarName = pathVar.value();
- annotationsFound++;
- }
- else if (ModelAttribute.class.isInstance(paramAnn)) {
- ModelAttribute attr = (ModelAttribute) paramAnn;
- attrName = attr.value();
- annotationsFound++;
- }
- else if (Value.class.isInstance(paramAnn)) {
- defaultValue = ((Value) paramAnn).value();
- }
- else if (paramAnn.annotationType().getSimpleName().startsWith("Valid")) {
- validate = true;
- Object value = AnnotationUtils.getValue(paramAnn);
- validationHints = (value instanceof Object[] ? (Object[]) value : new Object[] {value});
- }
- }
-
- if (annotationsFound > 1) {
- throw new IllegalStateException("Handler parameter annotations are exclusive choices - " +
- "do not specify more than one such annotation on the same parameter: " + handlerMethod);
- }
-
- if (annotationsFound == 0) {
- Object argValue = resolveCommonArgument(methodParam, webRequest);
- if (argValue != WebArgumentResolver.UNRESOLVED) {
- args[i] = argValue;
- }
- else if (defaultValue != null) {
- args[i] = resolveDefaultValue(defaultValue);
- }
- else {
- Class<?> paramType = methodParam.getParameterType();
- if (Model.class.isAssignableFrom(paramType) || Map.class.isAssignableFrom(paramType)) {
- if (!paramType.isAssignableFrom(implicitModel.getClass())) {
- throw new IllegalStateException("Argument [" + paramType.getSimpleName() + "] is of type " +
- "Model or Map but is not assignable from the actual model. You may need to switch " +
- "newer MVC infrastructure classes to use this argument.");
- }
- args[i] = implicitModel;
- }
- else if (SessionStatus.class.isAssignableFrom(paramType)) {
- args[i] = this.sessionStatus;
- }
- else if (HttpEntity.class.isAssignableFrom(paramType)) {
- args[i] = resolveHttpEntityRequest(methodParam, webRequest);
- }
- else if (Errors.class.isAssignableFrom(paramType)) {
- throw new IllegalStateException("Errors/BindingResult argument declared " +
- "without preceding model attribute. Check your handler method signature!");
- }
- else if (BeanUtils.isSimpleProperty(paramType)) {
- paramName = "";
- }
- else {
- attrName = "";
- }
- }
- }
-
- if (paramName != null) {
- args[i] = resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);
- }
- else if (headerName != null) {
- args[i] = resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);
- }
- else if (requestBodyFound) {
- args[i] = resolveRequestBody(methodParam, webRequest, handler);
- }
- else if (cookieName != null) {
- args[i] = resolveCookieValue(cookieName, required, defaultValue, methodParam, webRequest, handler);
- }
- else if (pathVarName != null) {
- args[i] = resolvePathVariable(pathVarName, methodParam, webRequest, handler);
- }
- else if (attrName != null) {
- WebDataBinder binder =
- resolveModelAttribute(attrName, methodParam, implicitModel, webRequest, handler);
- boolean assignBindingResult = (args.length > i + 1 && Errors.class.isAssignableFrom(paramTypes[i + 1]));
- if (binder.getTarget() != null) {
- doBind(binder, webRequest, validate, validationHints, !assignBindingResult);
- }
- args[i] = binder.getTarget();
- if (assignBindingResult) {
- args[i + 1] = binder.getBindingResult();
- i++;
- }
- implicitModel.putAll(binder.getBindingResult().getModel());
- }
- }
-
- return args;
- }
RequestMappingHandlerAdapter中使用的参数绑定，代码稍微有些不同，有兴趣的同仁可以分析下，最后处理的结果都是一样的。
示例：
- @RequestMapping ({"/", "/home"})
- public String showHomePage(String key){
-
- logger.debug("key="+key);
-
- return "home";
- }
这种情况下，就调用默认的@RequestParam来处理。
- @RequestMapping (method = RequestMethod.POST)
- public String doRegister(User user){
- if(logger.isDebugEnabled()){
- logger.debug("process url[/user], method[post] in "+getClass());
- logger.debug(user);
- }
-
- return "user";
- }
这种情况下，就调用@ModelAttribute来处理。
Ajax中content-type设置：
引言： 在Http请求中，我们每天都在使用Content-type来指定不同格式的请求信息，但是却很少有人去全面了解content-type中允许的值有多少，这里将讲解Content-Type的可用值，以及在Spring MVC中如何使用它们来映射请求信息。
1. Content-Type
MediaType，即是Internet Media Type，互联网媒体类型；也叫做MIME类型，在Http协议消息头中，使用Content-Type来表示具体请求中的媒体类型信息。
- 类型格式：type/subtype(;parameter)? type
- 主类型，任意的字符串，如text，如果是*号代表所有；
- subtype 子类型，任意的字符串，如html，如果是*号代表所有；
- parameter 可选，一些参数，如Accept请求头的q参数， Content-Type的 charset参数。
例如： Content-Type: text/html;charset:utf-8;
常见的媒体格式类型如下：
- text/html ： HTML格式
- text/plain ：纯文本格式
- text/xml ： XML格式
- image/gif ：gif图片格式
- image/jpeg ：jpg图片格式
- image/png：png图片格式
以application开头的媒体格式类型：
- application/xhtml+xml ：XHTML格式
- application/xml ： XML数据格式
- application/atom+xml ：Atom XML聚合格式
- application/json ： JSON数据格式
- application/pdf ：pdf格式
- application/msword ： Word文档格式
- application/octet-stream ： 二进制流数据（如常见的文件下载）
- application/x-www-form-urlencoded ： <form encType=””>中默认的encType，form表单数据被编码为key/value格式发送到服务器（表单默认的提交数据的格式）
另外一种常见的媒体格式是上传文件之时使用的：
- multipart/form-data ： 需要在表单中进行文件上传时，就需要使用该格式
以上就是我们在日常的开发中，经常会用到的若干content-type的内容格式。
2. Spring MVC中关于关于Content-Type类型信息的使用
首先我们来看看RequestMapping中的Class定义：
- @Target({ElementType.METHOD, ElementType.TYPE})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- @Mapping
- public @interface RequestMapping {
- String[] value() default {};
- RequestMethod[] method() default {};
- String[] params() default {};
- String[] headers() default {};
- String[] consumes() default {};
- String[] produces() default {};
- }
value: 指定请求的实际地址， 比如 /action/info之类。
method： 指定请求的method类型， GET、POST、PUT、DELETE等
consumes： 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回
params： 指定request中必须包含某些参数值是，才让该方法处理
headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求
其中，consumes， produces使用content-typ信息进行过滤信息；headers中可以使用content-type进行过滤和判断。
3. 使用示例
3.1 headers
- @RequestMapping(value = "/test", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")
- public void testHeaders(@PathVariable String ownerId, @PathVariable String petId) {
- // implementation omitted
- }
这里的Headers里面可以匹配所有Header里面可以出现的信息，不局限在Referer信息。
示例2
- @RequestMapping(value = "/response/ContentType", headers = "Accept=application/json")
- public void response2(HttpServletResponse response) throws IOException {
- //表示响应的内容区数据的媒体类型为json格式，且编码为utf-8(客户端应该以utf-8解码)
- response.setContentType("application/json;charset=utf-8");
- //写出响应体内容
- String jsonData = "{\"username\":\"zhang\", \"password\":\"123\"}";
- response.getWriter().write(jsonData);
- }
服务器根据请求头“Accept=application/json”生产json数据。
当你有如下Accept头，将遵守如下规则进行应用：
①Accept：text/html,application/xml,application/json
将按照如下顺序进行produces的匹配 ①text/html ②application/xml ③application/json
②Accept：application/xml;q=0.5,application/json;q=0.9,text/html
将按照如下顺序进行produces的匹配 ①text/html ②application/json ③application/xml
参数为媒体类型的质量因子，越大则优先权越高(从0到1)
③Accept：*/*,text/*,text/html
将按照如下顺序进行produces的匹配 ①text/html ②text/* ③*/*
即匹配规则为：最明确的优先匹配。
本文详细介绍了Spring MVC中参数绑定的原理与实践，包括不同类型的注解如何处理各种请求内容，如路径变量、请求头、Cookie值、请求体等。
扫一扫
6082
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
