Spring MVC常用註解說明

2019獨角獸企業重金招聘Python工程師標準>>>

    使用Spring MVC的註解及其用法和其它相關知識來實現控制器功能。

02	之前在使用Struts2實現MVC的註解時，是藉助struts2-convention這個插件，如今我們使用Spring自帶的spring-webmvc組件來實現同樣的功能，而且比之以前更簡單。另外，還省掉了整合兩個框架帶來的不穩定因素。

03	對於Spring MVC框架，我主要講一下它的常用註解，再結合一些示例進行說明，方便大家能夠快速理解。

04	一、Spring MVC常用註解說明

05	@Controller

06	在類上面定義，表明該類爲控制器，返回字符串與redirect:xxx

07	@RequestMapping

08	在類或方法上面使用此註解，設置URL訪問地址。它有兩個屬性，value指定訪問路徑，method指定指定請求方式，請求方式在RequestMethod這個類中，全部以常量形式定義，它默認使用GET請求。

09	@RequestParam

10	指定Request請求參數，在方法參數中定義，相當於傳統的request.getParameter()。

11	@PathVariable

12	獲取URL訪問路徑變量，這是Spring MVC 3.0框架才加入的特性，基於RESTful風格的URL訪問路徑。

13	@ModelAttribute

14	全局式的方法，在一組URL訪問路徑中，每次都會執行，方法返回結果保存在module會話中。

15

@Service

16	在類上面定義，指定被註解的類是業務邏輯組件，如果不指定具體的Bean ID，則採用默認命名方式，即類名的首字母小寫。之前在SSH2中，大象曾對Dao組件使用@Repository，本例只有業務層，所以就只用@Service註解。

17	@Autowired

18	IoC自動注入功能，替換以前的set寫法，在SSH2中就已經開始使用了。

19	@Qualifier

20	對同一接口類有不同實現指定具體的實現類。

21	@ResponseBody

22	同樣定義在方法上，Ajax調用聲明，指定方法返回結果爲Ajax回調函數結果。這是Spring MVC3.0框架中增加的一個新特性。

23	@InitBinder

24	初始化數據綁定與類型轉換，將傳入的參數轉換爲自定義類型，或者對參數進行自定義處理。

25

二、示例

26

27	@RequestMapping在類名上面定義，相當於指定的URL是此控制器內的所有其它訪問路徑的父路徑。如果在某個方法上面定義@RequestMapping註解，則相對於父路徑來說，是其子路徑。如果不定義value值，那麼按父路徑訪問就會被默認執行。但請注意，默認的訪問方式只能有一個。

28

對於UserController的list方法REST訪問URL爲http://localhost:8080/ssm3/user，而且它同時接收GET和POST兩種請求。另外，Spring MVC 3.0有一個很靈活的特性，可以自定義方法參數。看看list方法，我設定了兩個參數，一個Model，一個User對象。Model是用來渲染數據，生成頁面用的。相當於request.setAttribute，你可以這樣理解，但不能就這樣認爲，Model以及另一個ModelMap，都是作爲視圖模型傳遞參數的，它們的作用域爲request。除此之外，你還可以定義HttpServletRequest、HttpServletResponse等等各種各樣的參數。

29	如果一個類還要定義其它資源訪問怎麼辦呢？請看下面的RoleController

30

31	在RoleController上定義了全局路徑/role，這樣一來，對於和角色相關的資源都會以/role開頭，比如創建角色/role/new；編輯角色/role/edit/{id}等等。

32	上圖edit方法中的{id}寫法，就是RESTful URL風格，與@PathVariable搭配來一起實現該功能。它表示所請求的URL中，可以將變量值作爲參數進行動態的傳遞。例如：http://localhost:8080/ssm3/role/edit/1，另外，除了可以用數字，還可以用字符串，還可以多定義幾個變量：/role/edit/{id}/{type}等等。

33	每個方法的返回值，其實都對應着一個結果頁面，這一點和struts2-convention這個插件很相像。本例使用FreeMarker模板引擎作爲展示層，頁面的後綴爲.html，頁面中除了標準的HTML之外，其餘的數據填充，條件判斷之類，都要用到FreeMarker指令。

34	對於save方法返回值寫法表示的是重定向，相當於執行http://localhost:8080/ssm3/role，而這個URL對應的其實就是RoleController這個類裏面list方法。如果要帶上參數之類的，一定要符合所定義的REST資源路徑纔可以。

35

36

37	@ResponseBody用來標識Ajax方法調用，在上面這個方法中，用到了@RequestParam註解，它的作用就和request.getParameter("name")一樣。Spring MVC框架支持好幾種返回格式，例如：String/JSON/XML等等。不過以這種格式的字符串值形式返回是最簡便的一種方式，而且利用JavaScript解析也十分方便。頁面調用的時候請用jQuery的$.ajax()這種原生方式來定義，這種寫法不會出問題，也很靈活，而且其它幾種方式最終也是調用它來完成請求。

38

39	對於擁有相同的一組訪問規則的URL，如果都需要獲得相同的數據，則使用@ModelAttribute註解。以RoleController爲例，上面這個註解與方法的含義，相當於是在它裏面所有的訪問路徑方法中都調用這個寫法：module.addAttribute(“allRoles”,roleService.getRoles())。也即，不管是訪問create還是edit，都會執行preperList，都會獲得allRoles這個List。

40

41	註冊自定義類型編輯器，在Spring MVC中，對於時間類型，框架不會自動幫你轉換綁定，需要你自己來定義屬性編輯器。除此之外，還可以對某些特殊字符進行轉義符處理，都可以放在@InitBinder註解的方法中進行。如果所有的Controller都需要註冊相同的屬性編輯器，則可以實現WebBindingInitializer接口，定義一個全局的屬性編輯器。

42	三、在web容器中部署

43	想要讓Spring MVC框架幫助我們完成工作，就需要在Web容器中配置好它。

44

45	DispatcherServlet是Spring MVC的核心，是處理一切請求轉發的核心控制器。大象曾在本系列的第二篇文章中就詳細描述了Spring MVC的流程結構，如果沒什麼印象的話請再去看看。

46	Spring MVC有一個默認規則，Web容器啓動之後，會自動查找/WEB-INF/<servlet-name>.xml這個Spring類型的配置文件。如果想自定義配置文件路徑，就按上面的寫法，指定contextConfiglocation這個屬性，大象採用maven構建項目，所以servlet-context.xml這個配置文件放在resource目錄下。

47

四、MVC配置

48	Spring MVC 3.0對使用和配置作了較大的改進，除了提供註解來簡化控制器的開發之外，在配置文件上面也進行了簡化。

49

50	基於Spring MVC註解的配置就是上面這兩行，還有一種更簡化的配置寫法是隻寫這一句：<mvc:annotation-driven />就可以了，Spring啓動的時候會自動註冊上面這兩個bean。爲什麼大象要在這裏顯示的註冊兩個bean呢？因爲，我們在真正使用的時候，一般來說，使用默認的方式滿足不了我們的系統或業務要求。比如攔截器，比如數據驗證，比如返回消息格式轉換等等一些自定義設置。他們都需要配置在這兩個bean裏面。因爲本例是用來作爲入門教程，所以這些東西都沒有加進來。

51	DefaultAnnotationHandlerMapping這個類是將所有標註了@RequestMapping註解的Controller類，都放到了一個HandlerMapping對象中，當有請求時，就在這個對象中進行查找是否有與之匹配的路徑，AnnotationMethodHandlerAdapter是管理所有@RequestMapping註解的方法。

轉載於:https://my.oschina.net/zhanghaiyang/blog/593775