SpringMVC引數繫結註解
以下文章轉自“開濤的部落格”
在SpringMVC 的控制器中提供了很多請求資料繫結的註解,以及功能處理方法支援的引數型別:
請求引數繫結註解:
- @RequestParam繫結單個請求引數值;
- @PathVariable繫結URI模板變數值;
- @CookieValue繫結Cookie資料值
- @RequestHeader繫結請求頭資料;
- @ModelValue繫結引數到命令物件;
- @SessionAttributes繫結命令物件到session;
- @RequestBody繫結請求的內容區資料並能進行自動型別轉換等。
- @RequestPart繫結“multipart/data”資料,除了能繫結@RequestParam
1、@RequestParam繫結單個請求引數值
@RequestParam用於將請求引數區資料對映到功能處理方法的引數上。
public String requestparam1(@RequestParam String username)
請求中包含username引數(如/requestparam1?username=zhang),則自動傳入。
public String requestparam2(@RequestParam("username") String username)
即通過@RequestParam("username")明確告訴Spring Web MVC
@RequestParam註解主要引數:
value:引數名字
required:是否必須,預設是true
defaultValue:預設值
多個同名引數接收方式:
public String requestparam7(@RequestParam(value="role") String[] roleList)
public String requestparam8(@RequestParam(value="list") List<String> list)
2、@PathVariable繫結URI模板變數值
@PathVariable用於將請求URL中的模板變數對映到功能處理方法的引數上。
@RequestMapping(value="/users/{userId}/topics/{topicId}")
public String test(@PathVariable(value="userId") int userId, @PathVariable(value="topicId") int topicId)
如請求的URL為“控制器URL/users/123/topics/456”,則自動將URL中模板變數{userId}和{topicId}繫結到通過@PathVariable註解的同名引數上,即入參後userId=123、topicId=456。
3、@CookieValue繫結Cookie資料值
@CookieValue用於將請求的Cookie資料對映到功能處理方法的引數上。
public String test(@CookieValue(value="JSESSIONID", defaultValue="") String sessionId)
public String test2(@CookieValue(value="JSESSIONID", defaultValue="") Cookie sessionId)
4、@RequestHeader繫結請求頭資料
@RequestHeader用於將請求的頭資訊區資料對映到功能處理方法的引數上。
@RequestMapping(value="/header")
public String test(@RequestHeader("User-Agent") String userAgent, @RequestHeader(value="Accept") String[] accepts)
5、@ModelAttribute繫結請求引數到命令物件
①繫結請求引數到命令物件:放在功能處理方法的入參上時,用於將多個請求引數繫結到一個命令物件,從而簡化繫結流程,而且自動暴露為模型資料用於檢視頁面展示時使用;
②暴露表單引用物件為模型資料:放在處理器的一般方法(非功能處理方法)上時,是為表單準備要展示的表單引用物件,如註冊時需要選擇的所在城市等,而且在執行功能處理方法(@RequestMapping註解的方法)之前,自動新增到模型物件中,用於檢視頁面展示時使用;
③暴露@RequestMapping方法返回值為模型資料:放在功能處理方法的返回值上時,是暴露功能處理方法的返回值為模型資料,用於檢視頁面展示時使用。
6、@SessionAttributes繫結命令物件到session
有時候我們需要在多次請求之間保持資料,一般情況需要我們明確的呼叫HttpSession的API來存取會話資料,如多步驟提交的表單。Spring Web MVC提供了@SessionAttributes進行請求間透明的存取會話資料。
7、@Value繫結SpEL表示式
@Value用於將一個SpEL表示式結果對映到到功能處理方法的引數上。
public String test(@Value("#{systemProperties['java.vm.version']}") String jvmVersio
功能處理方法支援的引數型別:
1、ServletRequest/HttpServletRequest和 ServletResponse/HttpServletResponse
public String requestOrResponse (ServletRequest servletRequest, HttpServletRequest httpServletRequest, ServletResponse servletResponse, HttpServletResponse httpServletResponse)
Spring Web MVC框架會自動幫助我們把相應的Servlet請求/響應(Servlet API)作為引數傳遞過來。
2、InputStream/OutputStream和 Reader/Writer
public void inputOrOutBody(InputStream requestBodyIn, OutputStream responseBodyOut)
requestBodyIn:獲取請求的內容區位元組流,等價於request.getInputStream();
responseBodyOut:獲取相應的內容區位元組流,等價於response.getOutputStream()。
public void readerOrWriteBody(Reader reader, Writer writer)
reader:獲取請求的內容區字元流,等價於request.getReader();
writer:獲取相應的內容區字元流,等價於response.getWriter()。
3、WebRequest/NativeWebRequest
public String webRequest(WebRequest webRequest, NativeWebRequest nativeWebRequest)
① webRequest.getParameter:訪問請求引數區的資料,可以通過getHeader()訪問請求頭資料;
② webRequest.setAttribute/getAttribute:到指定的作用範圍內取/放屬性資料,Servlet定義的三個作用範圍分別使用如下常量代表:
SCOPE_REQUEST :代表請求作用範圍;
SCOPE_SESSION :代表會話作用範圍;
SCOPE_GLOBAL_SESSION :代表全域性會話作用範圍,即ServletContext上下文作用範圍。
③ nativeWebRequest.getNativeRequest/nativeWebRequest.getNativeResponse:得到本地的Servlet API。
4、HttpSession
public String session(HttpSession session)
5、命令/表單物件
Spring Web MVC能夠自動將請求引數繫結到功能處理方法的命令/表單物件上。
@RequestMapping(value = "/commandObject", method = RequestMethod.GET)
public String toCreateUser(HttpServletRequest request, UserModel user) {
return "customer/create";}
@RequestMapping(value = "/commandObject", method = RequestMethod.POST)
public String createUser(HttpServletRequest request, UserModel user) {
System.out.println(user);
return "success";}
如果提交的表單(包含username和password文字域),將自動將請求引數繫結到命令物件user中去。
6、Model、Map、ModelMap
Spring Web MVC 提供Model、Map或ModelMap讓我們能去暴露渲染檢視需要的模型資料。
@RequestMapping(value = "/model")
public String createUser(Model model, Map model2, ModelMap model3) {
model.addAttribute("a", "a");
model2.put("b", "b");
model3.put("c", "c");
System.out.println(model == model2);
System.out.println(model2 == model3);
return "success";}
雖然此處注入的是三個不同的型別(Model model, Map model2, ModelMap model3),但三者是同一個物件。
7、Errors/BindingResult
@RequestMapping(value = "/error1")
public String error1(UserModel user, BindingResult result)
@RequestMapping(value = "/error2")
public String error2(UserModel user, BindingResult result, Model model)
@RequestMapping(value = "/error3")
public String error3(UserModel user, Errors errors)