Spring MVC學習(六)-------註解式控制器詳解4

到目前爲止，請求已經能交給我們的處理器進行處理了，接下來的事情是要進行收集數據啦，接下來我們看看我們能從請求中收集到哪些數據，如圖6-11：

 圖6-11

1、@RequestParam綁定單個請求參數值；

2、@PathVariable綁定URI模板變量值；

3、@CookieValue綁定Cookie數據值

4、@RequestHeader綁定請求頭數據；

5、@ModelValue綁定參數到命令對象；

6、@SessionAttributes綁定命令對象到session；

7、@RequestBody綁定請求的內容區數據並能進行自動類型轉換等。

8、@RequestPart綁定“multipart/data”數據，除了能綁定@RequestParam能做到的請求參數外，還能綁定上傳的文件等。

 

除了上邊提到的註解，我們還可以通過如HttpServletRequest等API得到請求數據，但推薦使用註解方式，因爲使用起來更簡單。

 

接下來先看一下功能處理方法支持的參數類型吧。

6.6.1、功能處理方法支持的參數類型

在繼續學習之前，我們需要首先看看功能處理方法支持哪些類型的形式參數，以及他們的具體含義。

 一、ServletRequest/HttpServletRequest 和 ServletResponse/HttpServletResponse

Java代碼  

1. public String requestOrResponse (  
2.         ServletRequest servletRequest, HttpServletRequest httpServletRequest,  
3.         ServletResponse servletResponse, HttpServletResponse httpServletResponse  
4.     )  

 Spring Web MVC框架會自動幫助我們把相應的Servlet請求/響應（Servlet API）作爲參數傳遞過來。

 

二、InputStream/OutputStream 和 Reader/Writer

Java代碼  

1. public void inputOrOutBody(InputStream requestBodyIn, OutputStream responseBodyOut)  
2.         throws IOException {  
3. responseBodyOut.write("success".getBytes());  
4. }  

requestBodyIn：獲取請求的內容區字節流，等價於request.getInputStream();

responseBodyOut：獲取相應的內容區字節流，等價於response.getOutputStream()。

 

Java代碼  

1. public void readerOrWriteBody(Reader reader, Writer writer)  
2.         throws IOException {  
3.     writer.write("hello");  
4. }  

 reader：獲取請求的內容區字符流，等價於request.getReader();

writer：獲取相應的內容區字符流，等價於response.getWriter()。

 

InputStream/OutputStream 和 Reader/Writer兩組不能同時使用，只能使用其中的一組。

 

三、WebRequest/NativeWebRequest

WebRequest是Spring Web MVC提供的統一請求訪問接口，不僅僅可以訪問請求相關數據（如參數區數據、請求頭數據，但訪問不到Cookie區數據），還可以訪問會話和上下文中的數據；NativeWebRequest繼承了WebRequest，並提供訪問本地Servlet API的方法。

Java代碼  

1. public String webRequest(WebRequest webRequest, NativeWebRequest nativeWebRequest) {  
2.     System.out.println(webRequest.getParameter("test"));//①得到請求參數test的值  
3.     webRequest.setAttribute("name", "value", WebRequest.SCOPE_REQUEST);//②  
4.     System.out.println(webRequest.getAttribute("name", WebRequest.SCOPE_REQUEST));  
5.     HttpServletRequest request =   
6.         nativeWebRequest.getNativeRequest(HttpServletRequest.class);//③  
7.     HttpServletResponse response =   
8.         nativeWebRequest.getNativeResponse(HttpServletResponse.class);  
9.         return "success";  
10.     }  

 ① webRequest.getParameter：訪問請求參數區的數據，可以通過getHeader()訪問請求頭數據；

② webRequest.setAttribute/getAttribute：到指定的作用範圍內取/放屬性數據，Servlet定義的三個作用範圍分別使用如下常量代表：

            SCOPE_REQUEST ：代表請求作用範圍；

           SCOPE_SESSION ：代表會話作用範圍；

           SCOPE_GLOBAL_SESSION ：代表全局會話作用範圍，即ServletContext上下文作用範圍。 

③ nativeWebRequest.getNativeRequest/nativeWebRequest.getNativeResponse：得到本地的Servlet API。

 

四、HttpSession

Java代碼  

1. public String session(HttpSession session) {  
2.     System.out.println(session);  
3.     return "success";  
4. }  

 此處的session永遠不爲null。

 

注意：session訪問不是線程安全的，如果需要線程安全，需要設置AnnotationMethodHandlerAdapter或RequestMappingHandlerAdapter的synchronizeOnSession屬性爲true，即可線程安全的訪問session。

 

五、命令/表單對象

Spring Web MVC能夠自動將請求參數綁定到功能處理方法的命令/表單對象上。

Java代碼  

1. @RequestMapping(value = "/commandObject", method = RequestMethod.GET)  
2. public String toCreateUser(HttpServletRequest request, UserModel user) {  
3.     return "customer/create";  
4. }  
5. @RequestMapping(value = "/commandObject", method = RequestMethod.POST)  
6. public String createUser(HttpServletRequest request, UserModel user) {  
7.     System.out.println(user);  
8.     return "success";  
9. }  

 如果提交的表單（包含username和password文本域），將自動將請求參數綁定到命令對象user中去。

 

六、Model、Map、ModelMap

Spring Web MVC 提供Model、Map或ModelMap讓我們能去暴露渲染視圖需要的模型數據。

Java代碼  

1. @RequestMapping(value = "/model")  
2. public String createUser(Model model, Map model2, ModelMap model3) {  
3.     model.addAttribute("a", "a");  
4.     model2.put("b", "b");  
5.     model3.put("c", "c");  
6.     System.out.println(model == model2);  
7.     System.out.println(model2 == model3);  
8.     return "success";}  

 雖然此處注入的是三個不同的類型（Model model, Map model2, ModelMap model3），但三者是同一個對象，如圖6-12所示：

圖6-11

AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter將使用BindingAwareModelMap作爲模型對象的實現，即此處我們的形參（Model model, Map model2, ModelMap model3）都是同一個BindingAwareModelMap實例。

 

此處還有一點需要我們注意：

Java代碼  

1. @RequestMapping(value = "/mergeModel")  
2. public ModelAndView mergeModel(Model model) {  
3.     model.addAttribute("a", "a");//①添加模型數據  
4.     ModelAndView mv = new ModelAndView("success");  
5.     mv.addObject("a", "update");//②在視圖渲染之前更新③處同名模型數據  
6.     model.addAttribute("a", "new");//③修改①處同名模型數據  
7.     //視圖頁面的a將顯示爲"update" 而不是"new"  
8.     return mv;  
9. }  

 從代碼中我們可以總結出功能處理方法的返回值中的模型數據（如ModelAndView）會 合併 功能處理方法形式參數中的模型數據（如Model），但如果兩者之間有同名的，返回值中的模型數據會覆蓋形式參數中的模型數據。

 

七、Errors/BindingResult

Java代碼  

1. @RequestMapping(value = "/error1")  
2. public String error1(UserModel user, BindingResult result)  

 

Java代碼  

1. @RequestMapping(value = "/error2")  
2. public String error2(UserModel user, BindingResult result, Model model) {  
3.       

 

Java代碼  

1. @RequestMapping(value = "/error3")  
2. public String error3(UserModel user, Errors errors)   

 

以上代碼都能獲取錯誤對象。

 

Spring3.1之前（使用AnnotationMethodHandlerAdapter）錯誤對象必須緊跟在命令對象/表單對象之後，如下定義是錯誤的：

Java代碼  

1. @RequestMapping(value = "/error4")  
2. public String error4(UserModel user, Model model, Errors errors)  
3.     }  

如上代碼從Spring3.1開始（使用RequestMappingHandlerAdapter）將能正常工作，但還是推薦“錯誤對象緊跟在命令對象/表單對象之後”，這樣是萬無一失的。

 

Errors及BindingResult的詳細使用請參考4.16.2數據驗證。

 

八、其他雜項

Java代碼  

1. public String other(Locale locale, Principal principal)  

 java.util.Locale：得到當前請求的本地化信息，默認等價於ServletRequest.getLocale()，如果配置LocaleResolver解析器則由它決定Locale，後續介紹；

java.security.Principal：該主體對象包含了驗證通過的用戶信息，等價於HttpServletRequest.getUserPrincipal()。

 

以上測試在cn.javass.chapter6.web.controller.paramtype.MethodParamTypeController中。

 

其他功能處理方法的形式參數類型（如HttpEntity、UriComponentsBuilder、SessionStatus、RedirectAttributes）將在後續章節詳細講解。

 

第二部分會介紹註解方式的數據綁定。