@RequestParam @RequestBody @PathVariable 等参数绑定注解详解(转)

最新推荐文章于 2024-02-08 08:15:00 发布

weixin_30839881

最新推荐文章于 2024-02-08 08:15:00 发布

阅读量208

点赞数

原文链接：http://www.cnblogs.com/jiangbs/p/9118273.html

版权

<div id="post_detail">
<div class="post">
<div class="postTitle">
<h1><a id="cb_post_title_url" class="postTitle2" href="https://www.cnblogs.com/qq78292959/p/3760702.html">@RequestParam @RequestBody @PathVariable 等参数绑定注解详解(转)</a></h1>
</div>
<div id="cnblogs_post_body" class="blogpost-body"><h2>引言：</h2>
接上一篇文章，对@RequestMapping进行地址映射讲解之后，该篇主要讲解request 数据到handler method 参数数据的绑定所用到的注解和什么情形下使用；
 
<h2><a name="t1"></a>简介：</h2>
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;
 
<h3><a name="t2"></a>1、 @PathVariable </h3>
当使用@RequestMapping URI template 样式映射时，即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
示例代码：
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

@RequestMapping("/pets/{petId}")
public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
// implementation omitted
 }
}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。 
 
<h3><a name="t3"></a>2、 @RequestHeader、@CookieValue</h3>
@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。
示例代码：
这是一个Request 的header部分：
<div class="cnblogs_code">
<pre>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</pre>
</div>
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive) {

//...

}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。
 
 
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值：
<div class="cnblogs_code">
<pre>JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84</pre>
</div>
参数绑定的代码：
<div class="cnblogs_code">
<pre>@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) {

//...

}</pre>
</div>
即把JSESSIONID的值绑定到参数cookie上。
 
 
<h3><a name="t4"></a>3、@RequestParam, @RequestBody</h3>
@RequestParam 
A）常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；
B）用来处理Content-Type: 为 <code class="literal">application/x-www-form-urlencoded</code>编码的内容，提交方式GET、POST；
C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；
示例代码：
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>@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";
}

// ...</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
@RequestBody
该注解常用来处理Content-Type: 不是<code class="literal">application/x-www-form-urlencoded</code>编码的内容，例如application/json, application/xml等；
它是通过使用HandlerAdapter 配置的<code class="interfacename">HttpMessageConverters</code>来解析post data body，然后绑定到相应的bean上的。
因为配置有FormHttpMessageConverter，所以也可以用来处理 <code class="literal">application/x-www-form-urlencoded</code>的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;
示例代码：
<div class="cnblogs_code">
<pre>@RequestMapping(value = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException {
writer.write(body);
}</pre>
</div>
<h3>4、@SessionAttributes, @ModelAttribute</h3>
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。
该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；
示例代码：
<div class="cnblogs_code">
<pre>@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("pet")
public class EditPetForm {
// ...
}</pre>
</div>
@ModelAttribute
该注解有两个用法，一个是用于方法上，一个是用于参数上；
用于方法上时：  通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
用于参数上时：用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：
A） @SessionAttributes 启用的attribute 对象上；
B） @ModelAttribute 用于方法上时指定的model对象；
C）上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。
 
用到方法上@ModelAttribute的示例代码：
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")

@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；
 
 
用在参数上的@ModelAttribute示例代码：
<div class="cnblogs_code">
<pre>@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {

}</pre>
</div>
首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。 
 
<h2><a name="t6"></a>补充讲解：</h2>
<h3><a name="t7"></a>问题：在不给定注解的情况下，参数是怎样绑定的？</h3>
通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现，方法的参数在不给定参数的情况下：
若要绑定的对象时简单类型：  调用@RequestParam来处理的。  
若要绑定的对象时复杂类型：  调用@ModelAttribute来处理的。
这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；
 
下面贴出AnnotationMethodHandlerAdapter中绑定参数的部分源代码：
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>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<?> 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)) {// 判断是否参数类型是否是简单类型，若是在使用@RequestParam方式来处理,否则使用@ModelAttribute方式处理
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;
}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
RequestMappingHandlerAdapter中使用的参数绑定，代码稍微有些不同，有兴趣的同仁可以分析下，最后处理的结果都是一样的。
 
示例：
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre>@RequestMapping ({"/", "/home"})
public String showHomePage(String key){

logger.debug("key="+key);

return "home";
}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
这种情况下，就调用默认的@RequestParam来处理。
<div class="cnblogs_code"><div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div>
<pre> @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";
}</pre>
<div class="cnblogs_code_toolbar"><a href="javascript:void(0);" οnclick="copyCnblogsCode(this)" title="复制代码"><img src="//common.cnblogs.com/images/copycode.gif" alt="复制代码"></a></div></div>
这种情况下，就调用@ModelAttribute来处理。
 
 
<h2><a name="t8"></a>参考文档：</h2>
1、 Spring Web Doc： 
<pre>spring-3.1.0/docs/spring-framework-reference/html/mvc.html</pre></div><div id="MySignature"></div>
<div class="clear"></div>
<div id="blog_post_info_block">
<div id="BlogPostCategory">分类: <a href="http://www.cnblogs.com/qq78292959/category/577528.html" target="_blank">Spring</a></div>
<div id="EntryTag"></div>
<div id="blog_post_info"><div id="green_channel">
<a href="javascript:void(0);" id="green_channel_digg" οnclick="DiggIt(3760702,cb_blogId,1);green_channel_success(this,'谢谢推荐！');">好文要顶</a>
<a id="green_channel_follow" οnclick="follow('3ab20756-6392-e011-a53f-842b2b196315');" href="javascript:void(0);">关注我</a>
<a id="green_channel_favorite" οnclick="AddToWz(cb_entryId);return false;" href="javascript:void(0);">收藏该文</a>
<a id="green_channel_weibo" href="javascript:void(0);" title="分享至新浪微博" οnclick="ShareToTsina()"><img src="//common.cnblogs.com/images/icon_weibo_24.png" alt=""></a>
<a id="green_channel_wechat" href="javascript:void(0);" title="分享至微信" οnclick="shareOnWechat()"><img src="//common.cnblogs.com/images/wechat.png" alt=""></a>
</div>
<div id="author_profile">
<div id="author_profile_info" class="author_profile_info">
<a href="http://home.cnblogs.com/u/qq78292959/" target="_blank"><img src="//pic.cnblogs.com/face/sample_face.gif" class="author_avatar" alt=""></a>
<div id="author_profile_detail" class="author_profile_info">
<a href="http://home.cnblogs.com/u/qq78292959/">一个人的天空@</a> 
<a href="http://home.cnblogs.com/u/qq78292959/followees">关注 - 2</a> 
<a href="http://home.cnblogs.com/u/qq78292959/followers">粉丝 - 643</a>
</div>
</div>
<div class="clear"></div>
<div id="author_profile_honor"></div>
<div id="author_profile_follow">
<a href="javascript:void(0);" οnclick="follow('3ab20756-6392-e011-a53f-842b2b196315');return false;">+加关注</a>
</div>
</div>
<div id="div_digg">
<div class="diggit" οnclick="votePost(3760702,'Digg')">
5
</div>
<div class="buryit" οnclick="votePost(3760702,'Bury')">
0
</div>
<div class="clear"></div>
<div class="diggword" id="digg_tips">
</div>
</div>
<script type="text/javascript">
currentDiggType = 0;
</script></div>
<div class="clear"></div>
<div id="post_next_prev"><a href="http://www.cnblogs.com/qq78292959/p/3760651.html" class="p_n_p_prefix">« </a> 上一篇：<a href="http://www.cnblogs.com/qq78292959/p/3760651.html" title="发布于2014-05-30 10:48">@RequestBody, @ResponseBody 注解详解(转)</a> <a href="http://www.cnblogs.com/qq78292959/p/3761090.html" class="p_n_p_prefix">» </a> 下一篇：<a href="http://www.cnblogs.com/qq78292959/p/3761090.html" title="发布于2014-05-30 14:49">Spring 注解学习手札（七）补遗——@ResponseBody，@RequestBody，@PathVariable(转)</a> </div>
</div>

<div class="postDesc">posted on 2014-05-30 11:08 <a href="http://www.cnblogs.com/qq78292959/">一个人的天空@</a> 阅读(42861) 评论(2) <a href="https://i.cnblogs.com/EditPosts.aspx?postid=3760702" rel="nofollow">编辑</a> <a href="#" οnclick="AddToWz(3760702);return false;">收藏</a></div>
</div>
<script type="text/javascript">var allowComments=true,cb_blogId=90670,cb_entryId=3760702,cb_blogApp=currentBlogApp,cb_blogUserGuid='3ab20756-6392-e011-a53f-842b2b196315',cb_entryCreatedDate='2014/5/30 11:08:00';loadViewCount(cb_entryId);var cb_postType=1;</script>

</div>

转载于:https://www.cnblogs.com/jiangbs/p/9118273.html

weixin_30839881

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
@RequestParam @RequestBody @PathVariable 等参数绑定注解详解(转)

<div id="post_detail"><div class="post"> <div class="postTitle"> <h1><a id="cb_post_title_url" class="postTitle2" href="https://www.cnblogs.com/qq78292959/p/3760702.html"&g...
复制链接

扫一扫