Spring MVC 中的基於註解的 Controller
阿新 • • 發佈:2019-01-28
終於來到了基於註解的 Spring MVC 了。之前我們所講到的 handler,需要根據 url 並通過 HandlerMapping 來映射出相應的 handler 並呼叫相應的方法以響應請求。實際上,ControllerClassNameHandlerMapping, MultiActionController 和選擇恰當的 methodNameResolver(如 InternalPathMethodNameResolver) 就已經可以在很大程度上幫助我們省去不少的 XML 配置,誰讓 ControllerClassNameHandlerMapping 極度的擁抱了 Convention Over Configuration 呢。
那為什麼還要用基於註解的 Controller 呢?Spring MVC 在 Spring 2.5 釋出中新添加了一種基於註解的 Controller 形式。藉助於與 Spring 2.5 一同釋出的容器內 <context:component-scan> 功能支援,基於註解的 Controller 幾乎可以達到 XML 零配置,進而極大地提高我們的開發效率。
和其它 Controller 一樣,基於註解的 Controller 同樣有相應的 HandlerMapping,那就是 DefaultAnnotationHandlerMapping。同樣,也有相應的 HandlerAdapter,那就是 AnnotationMethodHandlerAdapter。甚至,我們都可以不把 Controller 註冊到容器裡,那麼肯定需要一種機制來幫助我們完成這點,這就是 <context:component-scan>。開發基於註解的 Controller,我們需要做以下準備工作:
● <context:compnent-scan>
Xml程式碼
- <!-- 切記,這不是必需的!除非你把註解的 Controller 一個個的註冊到容器中。相信大家還是喜歡用 context:compnent-scan 吧。不要認為在 Spring MVC 中才提到 context:component-scan,就認為它只能掃描 @Controller。component-scan 預設掃描的註解型別是 @Component,不過,在 @Component 語義基礎上細化後的 @Repository, @Service 和 @Controller 也同樣可以獲得 component-scan 的青睞 -->
- <context:component-scanbase-package="org.zachary.spring3.anno.web"/>
● HandlerMapping
Xml程式碼
- <beanclass="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
- <description>
- 這點是必需的還是非必需的呢?
- 如果定義了 DefaultAnnotationHandlerMapping,它就可以將請求來的 url 和被註解了 @RequesMapping 的指進行匹配。當然,說這句話的前提是定義 DefaultAnnotationHandlerMapping 的優先順序比定義了其它的 HandlerMapping 的優先順序要高(如果定義了其它的話)。
- 如果沒有定義 DefaultAnnotationHandlerMapping,並不代表不能對映到相應的 handler 上。因為如果你定義了其它的 HandlerMapping,請求過來的 url 和註解了的 @RequestMapping 裡的值正好能匹配上,那麼沒有 DefaultAnnotationHandlerMapping,@Controller 一樣可以如魚得水的被捕獲到。
- 當然,如果你要使用基於註解的 @Controller,最好還是老老實實地註冊 DefaultAnnotationHandlerMapping。
- </description>
- </bean>
● HandlerAdaptor
Xml程式碼
- <beanclass="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
- <description>
- 和上面的 HandlerMapping 一樣,是必需的還是非必需的呢?
- Spring MVC 中,如果我們沒有註冊任何 HandlerAdaptor 到容器中,注意,我說的是任何。那麼 DispatcherServlet 將啟用後備的幾個預設使用的 HandlerAdaptor 實現,包括:
- org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
- org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter
- org.springframework.web.servlet.mvc.AnnotationMethodHandlerAdaptor
- 看見沒,如果我們沒有註冊任何的 HandlerAdaptor,框架會準備 AnnotationMethodHandlerAdaptor 的。可是由於某些原因,我們需要為某些 HandlerAdaptoer 進行一些定製化,即在容器中註冊了某個 HandlerAdaptor,那麼很抱歉,框架只會啟用你註冊的那個,而框架本身準備的不會被啟用。所以,你一旦為某個 HandlerMapping 進行了定製化,請別忘了把其它的 HandlerAdaptor 也註冊進來,即便這些不需要定製化。否則的話,後果你是可以想象的。當然,除非你確保你真的只需要那一個你註冊進容器的 HandlerAdaptor,否則,我再囉嗦一遍,別忘了把其它的 HandlerAdaptor 也註冊進來。
- </description>
- </bean>
好了,有了以上幾點準備工作,我們就可以開始基於註解的 Controller 之旅了。下面我們來一個一個註解的來講解。
● @Controller
Java程式碼
- /**
- * @Controller,類級別上的註解。我們定義的類可以只是一個 javabean,不需要實現任何介面。標註了
- * @Controller,藉助 <context:component-scan>,框架能自動識別到這就是一個 Controller
- */
- @Controller
- publicclass MyController {
- // ......
- }
● @RequestMapping
Java程式碼
- /**
- * @RequestMapping 可以出現在類級別上,也可以出現在方法上。如果出現在類級別上,那請求的 url 為 類級別
- * 上的 @RequestMapping + 方法級別上的 @RequestMapping,否則直接取方法級上的 @RequestMapping。
- * 類級別的 @RequestMapping 不是必需的。
- */
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * 由於類級別上定義了 @RequestMapping,那麼想匹配到這個方法來處理請求,url 必須為 /my/somelist。
- * 如果沒有定義類級別上的 @RequestMapping,url 為 /somelist 即可。同時,請求方法必須為 POST
- */
- @RequestMapping(value="/somelist", method=RequestMethod.POST);
- public String getSomeList() {...}
- /**
- * 在方法級別使用 @RequestMapping 來限定請求處理的時候,可以指定兩個屬性。除了我們在上面剛使用過的
- * method 屬性,還有一個 params 屬性。使用 params 屬性,可以達到與使用
- * ParameterMethodNameResolver 作為 MethodResolver的 MultiActionController 類似的功能。
- *
- * params 有兩種表達形式,這裡先說第一種:"parameterName=parameterValue"
- *
- * 請求方法為 GET 或 POST,且具有 hello 引數,且值為 world 的請求才能匹配到該方法,如:
- * /my?hello=world
- */
- @RequestMapping(params="hello=world", method={RequestMethod.GET, RequestMethod.POST})
- public String helloworld() {...}
- /**
- * 請求方法為 GET 或 POST,且具有 hello 引數,且值為 java 的請求才能匹配到該方法,如:
- * /my?hello=java
- */
- @RequestMapping(params="hello=java", method={RequestMethod.GET, RequestMethod.POST})
- public String hellojava() {...}
- /**
- * params 屬性的另外一種表達形式為:"parameter"
- *
- * 請求方法為 GET,且具有請求引數 java 即匹配此方法,而不管 java 引數的值是什麼,如:
- * /my?java=anything
- */
- @RequestMapping(params="java", method={RequestMethod.GET})
- public String java() {...}
- /**
- * 請求方法為 GET,且具有請求引數 cplusplus 即匹配此方法,而不管 cplusplus 引數的值是什麼,如:
- * /my?cplusplus=anything
- */
- @RequestMapping(params="cplusplus", method={RequestMethod.GET})
- public String cplusplus() {...}
- /**
- * @RequestMapping 還有一個引數化 headers,它和 params 非常相似,也有兩種表示式,只不過它是對
- * 請求頭做限制罷了。大家可以通過 telnet 或 http-client 來發類似的請求以檢驗。以 telnet 為例:
- *
- * telnet localhost 8080
- * POST /contextPath/my HTTP/1.1
- * Host: localhost
- * hello: world # 這個就是自定義請求頭,和標準的請求頭的寫法別無二致
- * 【回車】
- * 【回車】
- */
- @RequestMapping(headers="hello=world", method={RequestMethod.POST})
- public String cplusplus() {...}
- }
● @RequestParam(將請求引數繫結到方法引數)
Java程式碼
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * 注意,這裡的方法有一個引數。若請求 url 為 /my/test,會匹配此方法。這裡的方法的引數名為 userId,
- * 那麼請求引數中一定有名為 userId 的引數,且值為整數。這也是預設的繫結行為,它是根據名稱匹配原則進行
- * 的資料繫結。當請求中的引數名與方法名一致的時候,相應的引數值將被繫結到相應的方法引數上。
- *
- * 如果沒有傳遞 userId 引數,框架會傳入 null。可是這裡我們定義的是 primitive type,異常伺候!若
- * 要解決此問題,需要將 primitive type 定義成相應的 wrapper type 即可,這裡使用 Integer 就行了。
- *
- * 如果傳遞了 userId 引數,但值不是整數,你叫 test 怎麼辦呢?這種情況下,框架藉助 PropertyEditor
- * 資料型別轉換失敗,ExceptionResolver 會接手處理,請求是不會進入 test 方法的。
- *
- * 這種方式下,預設的繫結行為需要我們嚴格遵守命名一致性原則。如果我們對此不滿,想自定義繫結關係,可以求
- * 助於 @RequestParam。
- */
- @RequestMapping("/test")
- public String test(int userId) { ... }
- /**
- * 當我們不想使用 userId 作為方法的引數名,即不想使用預設的資料繫結方式。如果我們要使用 id 作為方法
- * 的引數,為了保證名稱為 userId 的請求引數可以繫結到新的名稱為 id 的方法引數上,我們就可以使用
- * @RequestParam 對這一引數進行標註。@RequestParam 只可以標註於方法引數上。
- *
- * 如果請求引數中有 age,和方法的引數名稱一致,故 age 引數不需要 @RequestParam 標註。如果沒有傳遞
- * age,我們又不想定義成 Integer,很顯然框架會注入 null 值,報錯是必然的。這是由於 @RequestParam
- * 的 required 屬性決定的,預設就是 true。如果我們定義成 false,
- * 即 @RequestParam(required=false) int age
- * 這個時候定義成 int 型的 age,即便請求引數沒有 age 引數,也是沒問題的。
- *
- * 同時,這裡還能繫結 Date 型別,User 物件型別等等。如 date=2011-01-01&userName=Tom&userAge=18
- * 這裡,User 類的屬性需要為 userName 和 userAge,以免和 age,name 混淆。所以,Spring MVC 對物件
- * 的資料繫結就沒有 Struts2 做的那麼好了,Strtus2 可以這樣:user.age=18&user.name=Tom
- */
- @RequestMapping("/test2")
- public String test2(@RequestParam("userId") int id, int age, Date date, User user) { ... }
- }
● @PathVariable(將 url template 裡的引數繫結到方法引數)
Java程式碼
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * @PathVariable 是 url 模板,需要和 @RequestMapping 配合起來使用,這是 Spring 3.0 之後引入的。
- *
- * 在這個例子中,請求的 url 必須滿足類似 /my/user/zhangsan/18 這樣的格式才能匹配方法。url 模板裡
- * 的引數名和方法引數名的繫結規則和 @RequestParam 類似,這裡就不再贅述了。
- *
- * @PathVariable 和 @RequestParam 的區別在於:
- * @PathVariable 的 url:/my//user/zhangsan/18
- * @RequestParam 的 url:/my//user?nickname=zhangsan&age=18
- */
- @RequestMapping("/user/{nickname}/{age}");
- public String getUserInfo(@PathVariable("nickname") String name, @PathVariableint age) {...}
- }
Java程式碼
- /**
- * 來看一個 http 請求:
- * (請求行) POST /my HTTP/1.1
- * (請求頭) Host: localhost
- * (請求頭) Content-Type: text/plain
- * (請求頭) Content-Length: 5
- *
- * (請求體) hello
- *
- * 這裡的 hello,就是請求體,也稱 request message。若有請求體,則必須提供請求體的型別和長度,這些信
- * 息是寫在請求頭裡的,即 Content-Type 和 Content-Length
- */
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * 我們定義的 body 的資料型別是 String,請求體嘛,肯定是 String。實際上,@RequestBody 是用於將請
- * 求體的內容繫結到方法引數上,資料型別不一定是 String。Spring MVC 是通過 HttpMessageConverter
- * 來完成這種轉換的。AnnotationMethodHandlerAdapter 預設註冊了一些 HttpMessageConverters:
- * ByteArrayHttpMessageConverter - converts byte arrays
- * StringHttpMessageConverter - converts strings
- * FormHttpMessageConverter - converts form data to/from MultiValueMap<String,String>
- * SourceHttpMessageConverter - convert to/from a javax.xml.transform.Source
- * MappingJacksonHttpMessageConverter - converts json
- * MarshallingHttpMessageConverter - convert to/from an object using the
- * org.springframework.oxm package.
- *
- * 正如上所述,HttpMessageConverter 用於從請求正文繫結到物件和把物件序列化成 String 予客戶端響應。
- * 即 HttpMessageConverter is responsible for converting from the HTTP request message to
- * an object and converting from an object to the HTTP response body
- *
- * 我們可以在 AnnotationMethodHandlerAdapter 定義任意多的 HttpMessageConverters。
- *
- * 既然 HttpMessageConverter 可以用於雙向 convert,這裡討論的是 @RequestBody,那這部分我們只講
- * converting from the HTTP request message to an object。
- *
- * 假設我們只向 AnnotationMethodHandlerAdapter 注入了 MappingJacksonHttpMessageConverter 和
- * MarshallingHttpMessageConverter。處理請求的方法有如下簽名:
- * public String test(@RequestBody User user) { ... }
- *
- * 不管請求正文的內容是什麼,對於客戶端和伺服器而言,它們只是用文字來互相通訊。把字串轉為 User 對
- * 象,該用哪個 HttpMessageConverter 來完成此項工作呢?
- *
- * 在定義 HttpMessageConverters 時,我們可以為其指定 supportedMediaTypes。對於將請求正文轉為物件
- * 這個方向的操作,HttpMessageConverters 會從請求頭得到 Content-Type 頭資訊,看其是否隸屬於其定義
- * 的 supportedMediaTypes。若沒有匹配上,則會使用下一個 HttpMessageConverter 做同樣的判斷。只要
- * 某個 HttpMessageConverter 支援請求頭中的 Content-Type,那麼就會應用此 HttpMessageConverter
- * 來將 String 轉為 Object。當然,若請求正文並沒有按照 Content-Type 所規定的格式來編寫,必然要收到
- * 500 的響應。同時請注意,請求頭中還必須提供 Content-Length,否則拿不到請求正文。
- *
- * 如果所有的 HttpMessageConverters 中定義的 supportedMediaTypes 均不能匹配上 Content-Type 請
- * 求頭中的型別,那麼就會收到 415 Unsupported Media Type 響應。
- */
- @RequestMapping("/user/body");
- public String getBody(@RequestBody String body) {
- // 這裡的 body 的內容就是 hello
- System.out.println(body);
- returnnull;
- }
- }
● @ResponseBody(將處理完請求後返回的物件繫結到響應正文)
Java程式碼
- /**
- * 上面的 @RequestBody 講了 HttpMessageConverter 從請求正文到物件轉換的方向,現在來講講另外一個方
- * 向,@ResponseBody,此時,HttpMessageConverter 用於將處理完請求後返回的物件序列化成字串,即
- * converting from an object to the HTTP response body.
- */
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * 該方法的返回型別是 User,並不符合含有 @RequestMapping 的註解所需的簽名方式。但它仍然是合法的,因
- * 為在返回型別前有 @ResponseBody 註解,此註解將告知框架,將 User 物件作為影響正文返回?什麼?物件
- * 作為響應正文!所以,HttpMessageConverter 在這裡就起到作用了。這裡討論的是 @ResponseBody,所以
- * 這裡我們只講 converting from an object to the HTTP response body。
- *
- * User 物件要轉成什麼樣的 String,或者說要轉成什麼格式的 String?這個時候需要從請求頭中獲得此資訊
- * 了,這裡,就是請求頭的 Accept 頭。Accept 頭可以使用逗號分隔定義多個型別,用以告知伺服器我只接受
- * 哪些型別的響應。AnnotationMethodHandlerAdapter 中同樣注入了多個 HttpMessageConverter,每個
- * HttpMessageConverter 都可以定義各自的 supportedMediaTypes。這個時候該用哪個
- * HttpMessageConverter 來完成物件到文字的序列化操作呢?
- *
- * 遍歷 Accept 頭中的每種媒體型別,在定義的多個 HttpMessageConverters 中依次去匹配,若匹配上,就使
- * 用該 HttpMessageConverter 來完成序列化操作,並且響應頭的 Content-Type 並不是請求頭 Accept 頭
- * 的諸多型別中第一個被匹配的型別,而是匹配到的 HttpMessageConverter 定義的 supportedMediaTypes
- * 中的第一個型別。
- *
- * 如果所有的 HttpMessageConverters 中定義的 supportedMediaTypes 均不能匹配上 Accept 請求頭中
- * 的諸多的型別,那麼就會收到 406 Not Acceptable 響應。
- */
- @RequestMapping("/user")
- public@ResponseBody User getUser() {
- returnnew User(18, "Jack", "計算機");
- }
- }
● @ModelAttribute
Java程式碼
- /**
- * @ModelAttribute 可以為檢視渲染提供更多的模型資料,而不需要在處理請求的方法裡新增 ModelMap 或
- * Model 型別的引數。
- *
- * @ModelAttribute 可以標註在方法(存資料)上,也可以標註在方法引數(取資料)上。
- */
- @Controller
- @RequestMapping("/my")
- publicclass MyController {
- /**
- * 在處理該請求時,方法的返回型別是 User,貌似不符合返回型別的規範。由於這裡使用了 @ModelAttribute
- * 註解,表示將返回的物件以 "user" 為 key 放入模型資料裡。這裡的 key 值預設值是返回的資料型別首字母
- * 小寫的結果。如果想自定義 key,可以寫成 @ModelAttribute("myAttribute"),那麼模型資料將會將
- * User 物件繫結到 key 為 "myAttribute" 上。
- *
- * jsp 裡可以這樣訪問模型裡的資料:
- * age: ${user.age}
- * name: ${user.name}
- * job: ${user.job}
- *
- * 當然,這裡只是提到了 @ModelAttribute 存資料的操作。
- */
- @RequestMapping("/user")
- @ModelAttribute
- public User getUser() {
- returnnew User(18, "Jack", "計算機");
- }
- /**
- * 這裡將 @ModelAttribute 標註在方法引數上,表示要從模型資料裡取 key 為 "user" 的物件,繫結在方法
- * 引數上。如果這樣做的話,其實你是得不到上面的那個請求放入的 User 物件,得到的是另外一個物件。其實
- * 也好理解,這是兩個互相獨立的請求,作用域不一樣。要想達到我們的目的,即能夠從模型資料裡取資料,需要
- * 求助於 @SessionAttributes
- */
- @RequestMapping("/user2")
- public String showUser(@ModelAttribute User user) {
- System.out.println(user);
- returnnull;
- }
- }
● @SessionAttributes
Java程式碼
- /**
- * @SessionAttributes 和 @ModelAttribute 類似,只不過 @SessionAttributes 是將資料存放於 session
- * 中或從 session 中取資料。
- *
- * @SessionAttributes 只能應用在型別宣告上。比如下面的類的宣告中,只有屬性名為 "the-attribute" 的數
- * 據才會納入到 session 的管理。
- *
- * @SessionAttributes 允許以屬性名名稱或者型別兩種方法,來表明將哪些資料通過 session 進行管理。這裡
- * 我們使用的是指定屬性名稱的方式,但通過型別來指定也是可行的,如:
- * @SessionAttributes(types=User.class)
- */
- @Controller
- @RequestMapping("/my")
- @SessionAttributes("the-attribute")
- publicclass MyController {
- @RequestMapping("/getUser")
- public String getUser(int userId, Model model) {
- /**
- * 注意,這裡將 User 物件新增到屬性名為 "the-attribute" 上,所以 User 物件將納入到 session 的
- * 管理。如果這裡新增的物件的屬性名不是 "the-attribute",那麼它只會作用於當前請求,而不會納入到
- * session 的管理中。
- */
- User user = userService.getUserById(userId);
- model.addAtrribute("the-attribute", user);
- return"userinfo";
- }
- /**
- * 將模型裡的 "the-attribute" 為 key 的物件繫結到 User 類上。由於在類級別上聲明瞭只有 "the-
- * attribute" 的屬性名才會納入到 session 的管理,所以就解決了在 @ModelAttribute 註解中講解中最
- * 後提到的問題。
- *
- * 另外,這個方法還有兩個引數,BindingResult 和 SessionStatus。由於這裡有繫結資料的動作,我們可以
- * 根據 BindingResult 物件獲得資料繫結結果以決定後繼流程該如何處理。SessionStatus 在這裡用於處理
- * 完請求後,清空 session 裡的資料。
- */
- @RequestMapping("/updateUser")
- public String updateUser(@ModelAttribute("the-attribute") User user,
- BindingResult result, SessionStatus status) {
- if (result.hasErrors) {
- return"error";
- }
- userService.updateUser(user);
- // 我們通過呼叫 status.setComplete() 方法,該 Controller 所有放在 session 級別的模型屬性資料
- // 將從 session 中清空
- status.setComplete();
- return"redirect:getUser?userId=" + user.getId();
- }
- }
Spring MVC 裡的大部分的註解,這裡基本上都講到了。日後隨著 Spring 的升級,我也會逐一補充新加的註解。其實,僅憑以上的註解,是可以構建一個足夠強大的 RESTFul Webservices 的了。
這裡,補充講下被標註了 @RequestMapping 註解的請求方法的簽名。使用 @RequestMapping 標註的 web 請求處理方法的簽名比較靈活,我們幾乎可以宣告並使用任何型別的方法引數。不過,以下幾種型別的方法引數將擁有更多語義,它們均來自框架內部(或者說 AnnotationMethodHandlerAdapter)所管理的物件引用:
- request/response/session
- org.springframework.web.context.request.WebRequest。當前處理方法中獲得可用的 WebRequest 例項。
- java.util.Locale。通過相應的 LocalResolver 所返回的對應當前 web 請求的 Locale。
- java.io.InputStream/java.io.Reader。相當於 request.getInputStream() 或 request.getReader() 所獲得的物件引用。
- java.io.OutputStream/java.io.Writer。相當於 response.getOutputStream() 或 response.getWriter() 所獲得的物件引用。
- java.util.Map/org.springframework.ui.ModelMap。你現在可用對模型資料為所欲為了。
- org.springframework.validation.Errors/org.springframework.validation.BindingResult。用於對 Command 物件進行資料驗證的 Errors 或者 BindingResult 物件。宣告這兩種型別的方法引數有一個限制,它們的宣告必須緊跟著 Command 物件的定義。其它型別的方法引數是沒有任何順序限制的。
- org.springframework.web.bind.supportt.SessionStatus。SessionStatus 主要用於管理請求處理之後 Session 的狀態,比如清除 Session 中的指定的資料。
基於註解的 Controller 的請求處理方法返回型別可以有如下 4 種形式(當然,前面提到的 @ResponseBody 和 @ModelAttribute 並沒下面所描述的返回型別,具體參見上面對各自注解的講解):
- org.springframework.web.servlet.ModelAndView。這個不用多說,檢視資訊和模型資訊都能通過它返回。
- java.lang.String。該型別返回值代表邏輯檢視名,模型資料需要以其它形式提供,比如為處理方法宣告一個 ModelMap 型別的引數。注意,如果返回 null,並不代表向客戶端輸出空頁面(定向思維惹的禍),這種情況下,框架會從請求路徑中提取檢視資訊。如果返回 null 就是要表示方法內部已處理完請求,也不需要通知頁面,就是想僅僅返回空白頁面,唉,我還沒有想出來咋整。。。反正 writer.write("") 這樣寫可以,還得宣告一個 Writer 型別的方法引數。
- org.springframework.ui.ModelMap。ModelMap 型別返回值只包含了模型資料資訊而沒有檢視資訊,框架將根據請求的路徑來提取檢視資訊。
- void。沒有任何返回值,檢視資訊將從請求路徑中提取,模型資料需要通過其它形式提供。
String 型別的返回值為 null, 還有返回型別為 ModelMap 和 void,從請求路徑中如何提取檢視資訊呢?框架將擷取請求路徑中的最後一個 / 後面的內容,並去掉字尾名,剩下來的內容就是檢視名。如請求路徑為 /spring3/user/welcome,那麼檢視名是 welcome,/spring3/user/welcome.action 的檢視名也是 welcome。
接下來來講最後一個部分,請求引數到方法引數的繫結。這個在 @RequestParam 中已經講過,不過,這裡要講的是繫結複雜的物件。在 @RequestParam 中,我們這樣請求,date=2011-01-01 其實是繫結不到 Date 物件的。因為不同的 Locale 處理日期的字串的表達方式不一樣。總之,這部分涉及到字串到物件的轉換,這很像 PropertyEditor,對吧?Spring MVC 中,可以為某個 Controller 定製資料繫結,即在被標註了 @InitBinder 的方法裡寫繫結邏輯,方法名可以隨意,如:
Java程式碼
- /**
- * 初始化方法不能有返回值,而且至少應該有一個型別為 org.springframework.web.bind.WebDataBinder 的
- * 方法引數。同時,一個典型的基於註解的 Controller 的處理方法可以使用的方法引數中,除了 Command 物件
- * 以及相關的 Errors/BindingResult 物件作為方法的引數外,都可以作為初始化方法的引數。
- *
- * 這裡,我們沒有必要為日期再定製自定義繫結規則,Spring 已經為我們提供了 CustomDateEditor,這裡只是演
- * 示如何提供自定義資料繫結規則。
- *
- * 這裡的 WebDataBinder,是不是很像 PropertyEditorRegistry?
- */
- @InitBinder
- publicvoid initBinder(WebDataBinder binder) {
- binder.registerCustomEditor(Date.class, new PropertyEditorSupport() {
- final SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd");
- @Override
- publicvoid setAsText(String text) throws IllegalArgumentException {
- try {
- Date date = sf.parse(text);
- setValue(date);
- } catch (ParseException e) {
- Date data = sf.parse(text);
- thrownew IllegalArgumentException(e);
- }
- }
- })
- }
在 Controller 裡使用 @InitBinder 標註的初始化方法只能對一個 Controller 對應的 WebBinder 做定製。如果想在整個應用中共享繫結規則,可以為 AnnotationMethodHandlerAdapter 指定一個自定義的 org.springframework.web.bind.support.WebBindingInitializer 例項,這樣可以避免在每個 Controller 中都重複定義幾乎相同邏輯的 @InitBinder 的初始化方法。
Java程式碼
- publicclass MyBindingInitializer implements WebBindingInitializer {
- publicvoid initBinder(WebBinder binder, WebRequest request) {
- binder.registerCustomEditor(SomeDataType.class, somePropertyEditor)
- // 如果需要,這裡可以繼續註冊更多的 propertyEditor
- // ......
- }
- }
Xml程式碼
- <beanclass=""org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter>
- <propertyname="webBindingInitializer">
- <beanclass="...MyBindingInitializer"/>
- </property>
- </bean>
結束該篇文章前,我們來看幾個容易混淆的用於簡化開發的配置: <mvc:annotation-driven />, <context:annotation-config/>, <context:component-scan />。
<mvc:annotation-driven /> 會做以下幾件事:
- 向 spring 容器中註冊 DefaultAnnotationHandlerMapping。
- 向 spring 容器中註冊 AnnotationMethodHandlerAdapter。
- 配置一些 messageconverter。
- 解決了 @Controller 註解的使用前提配置,即 HandlerMapping 能夠知道誰來處理請求。
- 向 spring 容器中註冊 AutowiredAnnotationBeanPostProcessor。
- 向 spring 容器中註冊 CommonAnnotationBeanPostProcessor。
- 向 spring 容器中註冊 PersistenceAnnotationBeanPostProcessor。
- 向 spring 容器中註冊 RequiredAnnotationBeanPostProcessor。
- 使用 <context:annotationconfig />之前,必須在 <beans> 元素中宣告 context 名稱空間 <context:component-scan />。<context:component-scan /> 對包進行掃描,實現註解驅動 Bean 定義。即,將 @Controller 標識的類的 bean 註冊到容器中。
<context:component-scan/>,不但啟用了對類包進行掃描以實施註解驅動 Bean 定義的功能,同時還啟用了註解驅動自動注入的功能(即還隱式地在內部註冊了 AutowiredAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor)。因此當使用 <context:component-scan /> 後,除非需要使用PersistenceAnnotationBeanPostProcessor 和 RequiredAnnotationBeanPostProcessor 兩個 Processor 的功能(例如 JPA 等),否則就可以將 <context:annotation-config /> 移除了。