第六章 註解式控制器詳解—SpringMVC強大的資料繫結(1)
到目前為止,請求已經能交給我們的處理器進行處理了,接下來的事情是要進行收集資料啦,接下來我們看看我們能從請求中收集到哪些資料,如圖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
public String requestOrResponse (
ServletRequest servletRequest, HttpServletRequest httpServletRequest,
ServletResponse servletResponse, HttpServletResponse httpServletResponse
)
Spring Web MVC框架會自動幫助我們把相應的Servlet請求/響應(Servlet API)作為引數傳遞過來。
二、InputStream/OutputStream 和 Reader/Writer
public void inputOrOutBody(InputStream requestBodyIn, OutputStream responseBodyOut)
throws IOException {
responseBodyOut.write("success".getBytes());
}
requestBodyIn:獲取請求的內容區位元組流,等價於request.getInputStream();
responseBodyOut:獲取相應的內容區位元組流,等價於response.getOutputStream()。
public void readerOrWriteBody(Reader reader, Writer writer)
throws IOException {
writer.write("hello");
}
reader:獲取請求的內容區字元流,等價於request.getReader();
writer:獲取相應的內容區字元流,等價於response.getWriter()。
InputStream/OutputStream 和 Reader/Writer兩組不能同時使用,只能使用其中的一組。
三、WebRequest/NativeWebRequest
WebRequest是Spring Web MVC提供的統一請求訪問介面,不僅僅可以訪問請求相關資料(如引數區資料、請求頭資料,但訪問不到Cookie區資料),還可以訪問會話和上下文中的資料;NativeWebRequest繼承了WebRequest,並提供訪問本地Servlet API的方法。
public String webRequest(WebRequest webRequest, NativeWebRequest nativeWebRequest) {
System.out.println(webRequest.getParameter("test"));//①得到請求引數test的值
webRequest.setAttribute("name", "value", WebRequest.SCOPE_REQUEST);//②
System.out.println(webRequest.getAttribute("name", WebRequest.SCOPE_REQUEST));
HttpServletRequest request =
nativeWebRequest.getNativeRequest(HttpServletRequest.class);//③
HttpServletResponse response =
nativeWebRequest.getNativeResponse(HttpServletResponse.class);
return "success";
}
① webRequest.getParameter:訪問請求引數區的資料,可以通過getHeader()訪問請求頭資料;
② webRequest.setAttribute/getAttribute:到指定的作用範圍內取/放屬性資料,Servlet定義的三個作用範圍分別使用如下常量代表:
SCOPE_REQUEST :代表請求作用範圍;
SCOPE_SESSION :代表會話作用範圍;
SCOPE_GLOBAL_SESSION :代表全域性會話作用範圍,即ServletContext上下文作用範圍。
③ nativeWebRequest.getNativeRequest/nativeWebRequest.getNativeResponse:得到本地的Servlet API。
四、HttpSession
<span style="color:#000000">public String session(HttpSession session) {
System.out.println(session);
return "success";
}
</span>
此處的session永遠不為null。
注意:session訪問不是執行緒安全的,如果需要執行緒安全,需要設定AnnotationMethodHandlerAdapter或RequestMappingHandlerAdapter的synchronizeOnSession屬性為true,即可執行緒安全的訪問session。
五、命令/表單物件
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中去。
六、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),但三者是同一個物件,如圖6-12所示:
圖6-11
AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter將使用BindingAwareModelMap作為模型物件的實現,即此處我們的形參(Model model, Map model2, ModelMap model3)都是同一個BindingAwareModelMap例項。
此處還有一點需要我們注意:
@RequestMapping(value = "/mergeModel")
public ModelAndView mergeModel(Model model) {
model.addAttribute("a", "a");//①新增模型資料
ModelAndView mv = new ModelAndView("success");
mv.addObject("a", "update");//②在檢視渲染之前更新③處同名模型資料
model.addAttribute("a", "new");//③修改①處同名模型資料
//檢視頁面的a將顯示為"update" 而不是"new"
return mv;
}
從程式碼中我們可以總結出功能處理方法的返回值中的模型資料(如ModelAndView)會 合併 功能處理方法形式引數中的模型資料(如Model),但如果兩者之間有同名的,返回值中的模型資料會覆蓋形式引數中的模型資料。
七、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)
以上程式碼都能獲取錯誤物件。
Spring3.1之前(使用AnnotationMethodHandlerAdapter)錯誤物件必須緊跟在命令物件/表單物件之後,如下定義是錯誤的:
@RequestMapping(value = "/error4")
public String error4(UserModel user, Model model, Errors errors)
}
如上程式碼從Spring3.1開始(使用RequestMappingHandlerAdapter)將能正常工作,但還是推薦“錯誤物件緊跟在命令物件/表單物件之後”,這樣是萬無一失的。
八、其他雜項
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)將在後續章節詳細講解。