@RequestParam @RequestBody @PathVariable 等參數綁定註解詳解
簡介：
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}")
publicclass RelativePathUriTemplateController
{
@RequestMapping("/pets/{petId}")
publicvoid findPet(@PathVariable String
ownerId, @PathVariable String petId,
Model model) {
// implementation
omitted
}
}登入後複製
@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {
@RequestMapping("/pets/{petId}")
public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
// implementation omitted
}
}登入後複製
- 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
登入後複製
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")
publicvoid displayHeaderInfo(@RequestHeader("Accept-Encoding")
String encoding,
@RequestHeader("Keep-Alive") long keepAlive)
{
//...
}登入後複製
@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive) {
//...
}登入後複製
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值：
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
登入後複製登入後複製
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
登入後複製
登入後複製
参数绑定的代码：
@RequestMapping("/displayHeaderInfo.do")
publicvoid displayHeaderInfo(@CookieValue("JSESSIONID")
String cookie) {
//...
}登入後複製
@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")
publicclass 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";
}
// ...登入後複製
@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
示例代码：
@RequestMapping(value
= "/something", method = RequestMethod.PUT)
publicvoid handle(@RequestBody String
body, Writer writer) throws IOException
{
writer.write(body);
}登入後複製
@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")
publicclass EditPetForm
{
// ...
}登入後複製
@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的示例代码：
// 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);
}登入後複製
// 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);
}登入後複製
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；
用在参数上的@ModelAttribute示例代码：
@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit",
method = RequestMethod.POST)
public String
processSubmit(@ModelAttribute Pet pet)
{
}登入後複製
@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++;
}
elseif (RequestHeader.class.isInstance(paramAnn))
{
RequestHeader requestHeader = (RequestHeader) paramAnn;
headerName = requestHeader.value();
required = requestHeader.required();
defaultValue = parseDefaultValueAttribute(requestHeader.defaultValue());
annotationsFound++;
}
elseif (RequestBody.class.isInstance(paramAnn))
{
requestBodyFound = true;
annotationsFound++;
}
elseif (CookieValue.class.isInstance(paramAnn))
{
CookieValue cookieValue = (CookieValue) paramAnn;
cookieName = cookieValue.value();
required = cookieValue.required();
defaultValue = parseDefaultValueAttribute(cookieValue.defaultValue());
annotationsFound++;
}
elseif (PathVariable.class.isInstance(paramAnn))
{
PathVariable pathVar = (PathVariable) paramAnn;
pathVarName = pathVar.value();
annotationsFound++;
}
elseif (ModelAttribute.class.isInstance(paramAnn))
{
ModelAttribute attr = (ModelAttribute) paramAnn;
attrName = attr.value();
annotationsFound++;
}
elseif (Value.class.isInstance(paramAnn))
{
defaultValue = ((Value) paramAnn).value();
}
elseif (paramAnn.annotationType().getSimpleName().startsWith("Valid"))
{
validate = true;
Object value = AnnotationUtils.getValue(paramAnn);
validationHints = (value instanceof Object[]
? (Object[]) value : new Object[]
{value});
}
}
if (annotationsFound
> 1) {
thrownew 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;
}
elseif (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()))
{
thrownew 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;
}
elseif (SessionStatus.class.isAssignableFrom(paramType))
{
args[i] = this.sessionStatus;
}
elseif (HttpEntity.class.isAssignableFrom(paramType))
{
args[i] = resolveHttpEntityRequest(methodParam, webRequest);
}
elseif (Errors.class.isAssignableFrom(paramType))
{
thrownew IllegalStateException("Errors/BindingResult
argument declared " +
"without
preceding model attribute. Check your handler method signature!");
}
elseif (BeanUtils.isSimpleProperty(paramType))
{// 判断是否参数类型是否是简单类型，若是在使用@RequestParam方式来处理,否则使用@ModelAttribute方式处理
paramName = "";
}
else {
attrName = "";
}
}
}
if (paramName
!= null)
{
args[i] = resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);
}
elseif (headerName
!= null)
{
args[i] = resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);
}
elseif (requestBodyFound)
{
args[i] = resolveRequestBody(methodParam, webRequest, handler);
}
elseif (cookieName
!= null)
{
args[i] = resolveCookieValue(cookieName, required, defaultValue, methodParam, webRequest, handler);
}
elseif (pathVarName
!= null)
{
args[i] = resolvePathVariable(pathVarName, methodParam, webRequest, handler);
}
elseif (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;
}登入後複製
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;
}登入後複製
RequestMappingHandlerAdapter中使用的参数绑定，代码稍微有些不同，有兴趣的同仁可以分析下，最后处理的结果都是一样的。
示例：
@RequestMapping ({"/", "/home"})
public String
showHomePage(String key){
logger.debug("key="+key);
return"home";
}登入後複製
@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";
}登入後複製
@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来处理。
以上就是@RequestParam @RequestBody @PathVariable 等参数绑定注解详解的内容，更多相关内容请关注PHP中文网（www.php.cn）！
本網站聲明
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
熱AI工具
Undresser.AI Undress
人工智慧驅動的應用程序，用於創建逼真的裸體照片
AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。
Undress AI Tool
免費脫衣圖片
Clothoff.io
AI脫衣器
Video Face Swap
使用我們完全免費的人工智慧換臉工具，輕鬆在任何影片中換臉！
熱門文章
Windows 11 KB5054979中的新功能以及如何解決更新問題
3 週前
By DDD
如何修復KB5055523無法在Windows 11中安裝？
3 週前
By DDD
Inzoi：如何申請學校和大學
4 週前
By DDD
如何修復KB5055518無法在Windows 10中安裝？
3 週前
By DDD
在哪裡可以找到Atomfall中的站點辦公室鑰匙
4 週前
By DDD
熱工具
記事本++7.3.1
好用且免費的程式碼編輯器
SublimeText3漢化版
中文版，非常好用
禪工作室 13.0.1
強大的PHP整合開發環境
Dreamweaver CS6
視覺化網頁開發工具
SublimeText3 Mac版
神級程式碼編輯軟體(SublimeText3)
公司安全軟件導致應用無法運行？如何排查和解決？
Apr 19, 2025 pm 04:51 PM
公司安全軟件導致部分應用無法正常運行的排查與解決方法許多公司為了保障內部網絡安全，會部署安全軟件。 ...
如何使用MapStruct簡化系統對接中的字段映射問題？
Apr 19, 2025 pm 06:21 PM
系統對接中的字段映射處理在進行系統對接時，常常會遇到一個棘手的問題：如何將A系統的接口字段有效地映�...
如何優雅地獲取實體類變量名構建數據庫查詢條件？
Apr 19, 2025 pm 11:42 PM
在使用MyBatis-Plus或其他ORM框架進行數據庫操作時，經常需要根據實體類的屬性名構造查詢條件。如果每次都手動...
如何將姓名轉換為數字以實現排序並保持群組中的一致性？
Apr 19, 2025 pm 11:30 PM
將姓名轉換為數字以實現排序的解決方案在許多應用場景中，用戶可能需要在群組中進行排序，尤其是在一個用...
IntelliJ IDEA是如何在不輸出日誌的情況下識別Spring Boot項目的端口號的？
Apr 19, 2025 pm 11:45 PM
在使用IntelliJIDEAUltimate版本啟動Spring...
Java對像如何安全地轉換為數組？
Apr 19, 2025 pm 11:33 PM
Java對象與數組的轉換：深入探討強制類型轉換的風險與正確方法很多Java初學者會遇到將一個對象轉換成數組的�...
電商平台SKU和SPU數據庫設計：如何兼顧用戶自定義屬性和無屬性商品？
Apr 19, 2025 pm 11:27 PM
電商平台SKU和SPU表設計詳解本文將探討電商平台中SKU和SPU的數據庫設計問題，特別是如何處理用戶自定義銷售屬...
使用TKMyBatis進行數據庫查詢時，如何優雅地獲取實體類變量名構建查詢條件？
Apr 19, 2025 pm 09:51 PM
在使用TKMyBatis進行數據庫查詢時，如何優雅地獲取實體類變量名以構建查詢條件，是一個常見的難題。本文將針...
