SpringMVC參數綁定註解

来源:https://www.cnblogs.com/blogcpp/archive/2020/07/03/13232584.html
-Advertisement-
Play Games

轉載：https://blog.csdn.net/walkerJong/article/details/7946109 ...


引言：

接上一篇文章，對@RequestMapping進行地址映射講解之後，該篇主要講解request 數據到handler method 參數數據的綁定所用到的註解和什麼情形下使用；


簡介：

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註解綁定它傳過來的值到方法的參數上。

示例代碼：

  1. @Controller
  2. @RequestMapping("/owners/{ownerId}")
  3. public class RelativePathUriTemplateController {
  4.  
  5.   @RequestMapping("/pets/{petId}")
  6.   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {    
  7.     // implementation omitted
  8.   }
  9. }
上面代碼把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

  1. @RequestMapping("/displayHeaderInfo.do")
  2. public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
  3.                               @RequestHeader("Keep-Alive") long keepAlive)  {
  4.  
  5.   //...
  6.  
  7. }
上面的代碼，把request header部分的 Accept-Encoding的值，綁定到參數encoding上了， Keep-Alive header的值綁定到參數keepAlive上。


@CookieValue 可以把Request header中關於cookie的值綁定到方法的參數上。

例如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
參數綁定的代碼： 

  1. @RequestMapping("/displayHeaderInfo.do")
  2. public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {
  3.  
  4.   //...
  5.  
  6. }
即把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用來指示參數是否必須綁定；

示例代碼：

  1. @Controller
  2. @RequestMapping("/pets")
  3. @SessionAttributes("pet")
  4. public class EditPetForm {
  5.  
  6.     // ...
  7.  
  8.     @RequestMapping(method = RequestMethod.GET)
  9.     public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
  10.         Pet pet = this.clinic.loadPet(petId);
  11.         model.addAttribute("pet", pet);
  12.         return "petForm";
  13.     }
  14.  
  15.     // ...


@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;

示例代碼：

  1. @RequestMapping(value = "/something", method = RequestMethod.PUT)
  2. public void handle(@RequestBody String body, Writer writer) throws IOException {
  3.   writer.write(body);
  4. }

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

該註解用來綁定HttpSession中的attribute對象的值，便於在方法中的參數里使用。

該註解有value、types兩個屬性，可以通過名字和類型指定要使用的attribute 對象；

示例代碼：

  1. @Controller
  2. @RequestMapping("/editPet.do")
  3. @SessionAttributes("pet")
  4. public class EditPetForm {
  5.     // ...
  6. }


@ModelAttribute

該註解有兩個用法，一個是用於方法上，一個是用於參數上；

用於方法上時：  通常用來在處理@RequestMapping之前，為請求綁定需要從後臺查詢的model；

用於參數上時： 用來通過名稱對應，把相應名稱的值綁定到註解的參數bean上；要綁定的值來源於：

A） @SessionAttributes 啟用的attribute 對象上；

B） @ModelAttribute 用於方法上時指定的model對象；

C） 上述兩種情況都沒有時，new一個需要綁定的bean對象，然後把request中按名稱對應的方式把值綁定到bean中。


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

  1. // Add one attribute
  2. // The return value of the method is added to the model under the name "account"
  3. // You can customize the name via @ModelAttribute("myAccount")
  4.  
  5. @ModelAttribute
  6. public Account addAccount(@RequestParam String number) {
  7.     return accountManager.findAccount(number);
  8. }

這種方式實際的效果就是在調用@RequestMapping的方法之前，為request對象的model里put（“account”， Account）；


用在參數上的@ModelAttribute示例代碼：

  1. @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
  2. public String processSubmit(@ModelAttribute Pet pet) {
  3.    
  4. }
首先查詢 @SessionAttributes有無綁定的Pet對象，若沒有則查詢@ModelAttribute方法層面上是否綁定了Pet對象，若沒有則將URI template中的值按對應的名稱綁定到Pet對象的各屬性上。

補充講解：

問題： 在不給定註解的情況下，參數是怎樣綁定的？

通過分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代碼發現，方法的參數在不給定參數的情況下：

若要綁定的對象時簡單類型：  調用@RequestParam來處理的。 

若要綁定的對象時複雜類型：  調用@ModelAttribute來處理的。

這裡的簡單類型指java的原始類型(boolean, int 等)、原始類型對象（Boolean, Int等）、String、Date等ConversionService里可以直接String轉換成目標對象的類型；


下麵貼出AnnotationMethodHandlerAdapter中綁定參數的部分源代碼：

  1. private Object[] resolveHandlerArguments(Method handlerMethod, Object handler,
  2. 			NativeWebRequest webRequest, ExtendedModelMap implicitModel) throws Exception {
  3.  
  4. 		Class[] paramTypes = handlerMethod.getParameterTypes();
  5. 		Object[] args = new Object[paramTypes.length];
  6.  
  7. 		for (int i = 0; i < args.length; i++) {
  8. 			MethodParameter methodParam = new MethodParameter(handlerMethod, i);
  9. 			methodParam.initParameterNameDiscovery(this.parameterNameDiscoverer);
  10. 			GenericTypeResolver.resolveParameterType(methodParam, handler.getClass());
  11. 			String paramName = null;
  12. 			String headerName = null;
  13. 			boolean requestBodyFound = false;
  14. 			String cookieName = null;
  15. 			String pathVarName = null;
  16. 			String attrName = null;
  17. 			boolean required = false;
  18. 			String defaultValue = null;
  19. 			boolean validate = false;
  20. 			Object[] validationHints = null;
  21. 			int annotationsFound = 0;
  22. 			Annotation[] paramAnns = methodParam.getParameterAnnotations();
  23.  
  24. 			for (Annotation paramAnn : paramAnns) {
  25. 				if (RequestParam.class.isInstance(paramAnn)) {
  26. 					RequestParam requestParam = (RequestParam) paramAnn;
  27. 					paramName = requestParam.value();
  28. 					required = requestParam.required();
  29. 					defaultValue = parseDefaultValueAttribute(requestParam.defaultValue());
  30. 					annotationsFound++;
  31. 				}
  32. 				else if (RequestHeader.class.isInstance(paramAnn)) {
  33. 					RequestHeader requestHeader = (RequestHeader) paramAnn;
  34. 					headerName = requestHeader.value();
  35. 					required = requestHeader.required();
  36. 					defaultValue = parseDefaultValueAttribute(requestHeader.defaultValue());
  37. 					annotationsFound++;
  38. 				}
  39. 				else if (RequestBody.class.isInstance(paramAnn)) {
  40. 					requestBodyFound = true;
  41. 					annotationsFound++;
  42. 				}
  43. 				else if (CookieValue.class.isInstance(paramAnn)) {
  44. 					CookieValue cookieValue = (CookieValue) paramAnn;
  45. 					cookieName = cookieValue.value();
  46. 					required = cookieValue.required();
  47. 					defaultValue = parseDefaultValueAttribute(cookieValue.defaultValue());
  48. 					annotationsFound++;
  49. 				}
  50. 				else if (PathVariable.class.isInstance(paramAnn)) {
  51. 					PathVariable pathVar = (PathVariable) paramAnn;
  52. 					pathVarName = pathVar.value();
  53. 					annotationsFound++;
  54. 				}
  55. 				else if (ModelAttribute.class.isInstance(paramAnn)) {
  56. 					ModelAttribute attr = (ModelAttribute) paramAnn;
  57. 					attrName = attr.value();
  58. 					annotationsFound++;
  59. 				}
  60. 				else if (Value.class.isInstance(paramAnn)) {
  61. 					defaultValue = ((Value) paramAnn).value();
  62. 				}
  63. 				else if (paramAnn.annotationType().getSimpleName().startsWith("Valid")) {
  64. 					validate = true;
  65. 					Object value = AnnotationUtils.getValue(paramAnn);
  66. 					validationHints = (value instanceof Object[] ? (Object[]) value : new Object[] {value});
  67. 				}
  68. 			}
  69.  
  70. 			if (annotationsFound > 1) {
  71. 				throw new IllegalStateException("Handler parameter annotations are exclusive choices - " +
  72. 						"do not specify more than one such annotation on the same parameter: " + handlerMethod);
  73. 			}
  74.  
  75. 			if (annotationsFound == 0) {// 若沒有發現註解
  76. 				Object argValue = resolveCommonArgument(methodParam, webRequest);    //判斷WebRquest是否可賦值給參數
  77. 				if (argValue != WebArgumentResolver.UNRESOLVED) {
  78. 					args[i] = argValue;
  79. 				}
  80. 				else if (defaultValue != null) {
  81. 					args[i] = resolveDefaultValue(defaultValue);
  82. 				}
  83. 				else {
  84. 					Class<?> paramType = methodParam.getParameterType();
  85. 					if (Model.class.isAssignableFrom(paramType) || Map.class.isAssignableFrom(paramType)) {
  86. 						if (!paramType.isAssignableFrom(implicitModel.getClass())) {
  87. 							throw new IllegalStateException("Argument [" + paramType.getSimpleName() + "] is of type " +
  88. 									"Model or Map but is not assignable from the actual model. You may need to switch " +
  89. 									"newer MVC infrastructure classes to use this argument.");
  90. 						}
  91. 						args[i] = implicitModel;
  92. 					}
  93. 					else if (SessionStatus.class.isAssignableFrom(paramType)) {
  94. 						args[i] = this.sessionStatus;
  95. 					}
  96. 					else if (HttpEntity.class.isAssignableFrom(paramType)) {
  97. 						args[i] = resolveHttpEntityRequest(methodParam, webRequest);
  98. 					}
  99. 					else if (Errors.class.isAssignableFrom(paramType)) {
  100. 						throw new IllegalStateException("Errors/BindingResult argument declared " +
  101. 								"without preceding model attribute. Check your handler method signature!");
  102. 					}
  103. 					else if (BeanUtils.isSimpleProperty(paramType)) {// 判斷是否參數類型是否是簡單類型，若是在使用@RequestParam方式來處理,否則使用@ModelAttribute方式處理
  104. 						paramName = "";
  105. 					}
  106. 					else {
  107. 						attrName = "";
  108. 					}
  109. 				}
  110. 			}
  111.  
  112. 			if (paramName != null) {
  113. 				args[i] = resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);
  114. 			}
  115. 			else if (headerName != null) {
  116. 				args[i] = resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);
  117. 			}
  118. 			else if (requestBodyFound) {
  119. 				args[i] = resolveRequestBody(methodParam, webRequest, handler);
  120. 			}
  121. 			else if (cookieName != null) {
  122. 				args[i] = resolveCookieValue(cookieName, required, defaultValue, methodParam, webRequest, handler);
  123. 			}
  124. 			else if (pathVarName != null) {
  125. 				args[i] = resolvePathVariable(pathVarName, methodParam, webRequest, handler);
  126. 			}
  127. 			else if (attrName != null) {
  128. 				WebDataBinder binder =
  129. 						resolveModelAttribute(attrName, methodParam, implicitModel, webRequest, handler);
  130. 				boolean assignBindingResult = (args.length > i + 1 && Errors.class.isAssignableFrom(paramTypes[i + 1]));
  131. 				if (binder.getTarget() != null) {
  132. 					doBind(binder, webRequest, validate, validationHints, !assignBindingResult);
  133. 				}
  134. 				args[i] = binder.getTarget();
  135. 				if (assignBindingResult) {
  136. 					args[i + 1] = binder.getBindingResult();
  137. 					i++;
  138. 				}
  139. 				implicitModel.putAll(binder.getBindingResult().getModel());
  140. 			}
  141. 		}
  142.  
  143. 		return args;
  144. 	}

RequestMappingHandlerAdapter中使用的參數綁定，代碼稍微有些不同，有興趣的同仁可以分析下，最後處理的結果都是一樣的。


示例：

  1. @RequestMapping ({"/", "/home"})
  2. 	public String showHomePage(String key){
  3. 		
  4. 		logger.debug("key="+key);
  5. 		
  6. 		return "home";
  7. 	}
這種情況下，就調用預設的@RequestParam來處理。 


  1. 	@RequestMapping (method = RequestMethod.POST)
  2. 	public String doRegister(User user){
  3. 		if(logger.isDebugEnabled()){
  4. 			logger.debug("process url[/user], method[post] in "+getClass());
  5. 			logger.debug(user);
  6. 		}
  7.  
  8. 		return "user";
  9. 	}

這種情況下，就調用@ModelAttribute來處理。


參考文檔：

1、 Spring Web Doc： 

spring-3.1.0/docs/spring-framework-reference/html/mvc.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python必須知道的異常處理
    異常處理 把可能會發生的錯誤，提前在代碼里進行捕捉(監測) try : code except Exception: 出錯後要執行的代碼 下麵是常見的異常： attributeError 試圖訪問一個對象沒有的屬性 Nameerror 訪問一個沒有變數 Valueerror 值類型不匹配 impor ...
  • c++ 標準庫文檔
    學習時常常忘記某個容器怎麼用。別怕，只要用時會查。太多也記不過來。 微軟的c++文檔：https://docs.microsoft.com/zh-cn/cpp/standard-library/vector-class?view=vs-2019 又發現一個網上查文檔的網站了，感覺還不錯。鏈接：htt ...
  • 面試：說說Java中的 volatile 關鍵詞？
    volatile 這個關鍵字可能很多朋友都聽說過，或許也都用過。在 Java 5 之前，它是一個備受爭議的關鍵字，因為在程式中使用它往往會導致出人意料的結果。在 Java 5之後，volatile 關鍵字才得以重獲生機。 ...
  • 點擊提交form
    <form action="/search" id="search_form"> <input type="text" name="keywords" value="" placeholder="Furniture Handles" class="jhser" /> <span class="ser ...
  • Java生鮮電商平臺-微服務電商優惠券的架構設計(小程式/APP)
    Java生鮮電商平臺-微服務電商優惠券的架構設計(小程式/APP) 說明：Java生鮮電商平臺的優惠券屬於電子優惠券，不過我們要先看看線下紙質優惠券： 商家決定做促銷，印製了10000張50元代金券； 其中1000張代金券分別發給1000個用戶； 到某一個時刻，這1000個用戶有300個適用了代金券 ...
  • Java語言概述
    一、Java基礎知識 二、軟體 1. 軟體是什麼? 軟體=數據+指令[命令]+文檔 2. 軟體開髮指什麼? 軟體開發是根據用戶的需求創建出相應的軟體系統. 軟體開發是一個過程,包含需求的提取,需求分析,軟體的編寫,軟體測試. 三、人與電腦做交互 圖形化界面 vs 命令行方式 dir md rd c ...
  • 若感染病毒的是你，你又該如何？
    前言 剛回到家，又被公司群里的消息轟炸了。讓統計每個人最近是否去過石景山萬達廣場。 這基本上已經是每日必備了，只要有任何風吹草動，就需要我們填各種信息。 我們都知道，北京最近的疫情很不樂觀，從每天的數據就能看出來了。 也許很多小伙伴不在北京，是切實感受不到的。 就拿我自己舉例吧，在去公司的每一天，我 ...
  • 從別人的代碼中學習golang系列--02
    這篇博客還是整理從https://github.com/LyricTian/gin-admin 這個項目中學習的golang相關知識 作者在項目中使用了https://github.com/google/wire 做依賴註入，這個庫我之前沒有使用過，看了作者代碼中的使用，至少剛開始是看著優點懵，不知 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類