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、 @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, ModelMap modelMap) {      

    }  

}

上面代码把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")
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, @ResonseBody

@RequestParam

• 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

• 用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

• 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

示例代码：

@RequestMapping(value = "/pet/setup", 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

@RequestBody将HTTP请求正文插入方法中,使用适合的HttpMessageConverter将请求体写入某个对象。

示例代码

function login() {//页面异步请求
    var mydata = '{"name":"' + $('#name').val() + '","id":"'  + $('#id').val() + '","status":"' + $('#status').val() + '"}';
    $.ajax({
        type : 'POST',
        contentType : 'application/json',
        url : "${pageContext.request.contextPath}/person/login",
        processData : false,
        dataType : 'json',
        data : mydata,
        success : function(data) {
            alert("id: " + data.id + "\nname: " + data.name + "\nstatus: "
                    + data.status);
        },
        error : function() {
            alert('出错了！');
        }
    });
};

Java

@RequestMapping(value = "person/login")
public Person login(@RequestBody Person person) {//将请求中的mydata写入Person对象中
    return person;//不会被解析为跳转路径，而是直接写入HTTP response body中
}

@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里，这种情况在某些特殊需求下使用，通常情况下在方法体中封装成一个json对象，然后在方法上使用该注释，在前台页面中获取就就是一个json对象，详情查看FormHttpMessageConverter api;

示例代码：

/**
 * 银行列表
 */
@RequestMapping(value = "pay/virtual/bank", method = RequestMethod.GET)
@ResponseBody
public JsonResult<List<BankListInfo>> virtualBankList() {
    JsonResult<List<BankListInfo>> jsonResult = new JsonResult<>();  # 封装json对象
    try {
    	BankService bankService = context.getBean("bestPayVirtualBankServiceImpl", BankService.class);
        List<BankListInfo> bankListInfos = bankService.getBankList(null);
        jsonResult.setDataObject(bankListInfos);
    } catch (Throwable throwable) {
	logger.error("get bank list error:", throwable);
	jsonResult.setCode("-1");
        jsonResult.setErrorDescription("查询银行列表出现异常");;
    }
    return jsonResult;
}

上面方法也可以使用String类型，返回一个json串

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。

该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

示例代码：关于@SessionAttributes的详解示例，不明白的请看下一篇文章：SpringMVC详解@SessionAttributes

import org.springframework.ui.ModelMap;  
import org.springframework.web.bind.annotation.SessionAttributes;  
  
@Controller  
@RequestMapping("/bbtForum")  
@SessionAttributes("currUser") // ①将ModelMap中属性名为currUser的属性放到Session属性列表中，以便这个属性可以跨请求访问
public class BbtForumController {  

    @RequestMapping(params = "method=listBoardTopic")  
    public String listBoardTopic(@RequestParam("id")int topicId, User user, ModelMap model) {  
        bbtForumService.getBoardTopics(topicId);
        System.out.println("topicId:" + topicId);
        System.out.println("user:" + user);
        model.addAttribute("currUser",user); //②向ModelMap中添加一个属性
        return "listTopic";  
    }  
  
}

@ModelAttribute

该注解有两个用法，一个是用于方法上，一个是用于参数上；

用于方法上时：  通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

• @SessionAttributes 启用的attribute 对象上；

• @ModelAttribute 用于方法上时指定的model对象；

• 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

用到方法上@ModelAttribute的示例代码：

@ModelAttribute  
public Account addAccount(@RequestParam String number) {
    return accountManager.findAccount(number);  
}

用在参数上的@ModelAttribute示例代码：

@RequestMapping(value = "/pay", method = RequestMethod.POST, params = "paymentCode=001")
public String goToPay(@ModelAttribute PayToBankModel model) {

}

上面代码绑定了一个PayToBankModel的JavaBean，所以在这个方法体中可以直接使用model里的值，这种场景一般用在对多参数增删改查使用

补充讲解：

问题： 在不给定注解的情况下，参数是怎样绑定的？

通过分析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);    //判断WebRquest是否可赋值给参数  
            if (argValue != WebArgumentResolver.UNRESOLVED) {  
                args[i] = argValue;  
            }  
            else if (defaultValue != null) {  
                args[i] = resolveDefaultValue(defaultValue);  
            }  
            else {  
                Class

附加

SpringMVC使用JSR-303进行校验@Valid和@Validated

未经允许请勿转载：程序喵 » @RequestParam、@RequestBody、@PathVariable等SpringMVC注解含义