Spring注解大全

在SpringMVC 中，控制器Controller 負責處理由DispatcherServlet 分發的請求，它把使用者請求的資料經過業務處理層處理之後封裝成一個Model ，然後再把該Model 傳回給對應的View 進行展示。在SpringMVC 中提供了一個非常簡便的定義Controller 的方法，你無需繼承特定的類或實作特定的接口，隻需使用@Controller 标記一個類是Controller ，然後使用@RequestMapping 和@RequestParam 等一些注解用以定義URL 請求和Controller 方法之間的映射，這樣的Controller 就能被外界通路到。此外Controller 不會直接依賴于HttpServletRequest 和HttpServletResponse 等HttpServlet 對象，它們可以通過Controller 的方法參數靈活的擷取到。

@Controller 用于标記在一個類上，使用它标記的類就是一個SpringMVC Controller 對象。分發處理器将會掃描使用了該注解的類的方法，并檢測該方法是否使用了@RequestMapping 注解。@Controller 隻是定義了一個控制器類，而使用@RequestMapping 注解的方法才是真正處理請求的處理器。單單使用@Controller 标記在一個類上還不能真正意義上的說它就是SpringMVC 的一個控制器類，因為這個時候Spring 還不認識它。那麼要如何做Spring 才能認識它呢？這個時候就需要我們把這個控制器類交給Spring 來管理。有兩種方式：

######（1）在SpringMVC 的配置檔案中定義MyController 的bean 對象。

######　（2）在SpringMVC 的配置檔案中告訴Spring 該到哪裡去找标記為@Controller 的Controller 控制器。

<bean class="com.host.app.web.controller.MyController"/> < context:component-scan base-package = "com.host.app.web" />//路徑寫到controller的上一層(掃描包詳解見下面淺析)

RequestMapping是一個用來處理請求位址映射的注解，可用于類或方法上。用于類上，表示類中的所有響應請求的方法都是以該位址作為父路徑。

RequestMapping注解有六個屬性，下面我們把她分成三類進行說明（下面有相應示例）。

1、 value， method；

value： 指定請求的實際位址，指定的位址可以是URI Template 模式（後面将會說明）；

method： 指定請求的method類型， GET、POST、PUT、DELETE等；

2、consumes，produces

consumes： 指定處理請求的送出内容類型（Content-Type），例如application/json, text/html;

produces: 指定傳回的内容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才傳回；

3、params，headers

params： 指定request中必須包含某些參數值是，才讓該方法處理。

headers： 指定request中必須包含某些指定的header值，才能讓該方法處理請求。

@Resource和@Autowired都是做bean的注入時使用，其實@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要導入，但是Spring支援該注解的注入。

1、共同點

兩者都可以寫在字段和setter方法上。兩者如果都寫在字段上，那麼就不需要再寫setter方法。

2、不同點

（1）@Autowired

@Autowired為Spring提供的注解，需要導入包org.springframework.beans.factory.annotation.Autowired;隻按照byType注入。

public class TestServiceImpl { // 下面兩種@Autowired隻要使用一種即可 @Autowired private UserDao userDao; // 用于字段上 public void setUserDao(UserDao userDao) { // 用于屬性的方法上 this.userDao = userDao; }

@Autowired注解是按照類型（byType）裝配依賴對象，預設情況下它要求依賴對象必須存在，如果允許null值，可以設定它的required屬性為false。如果我們想使用按照名稱（byName）來裝配，可以結合@Qualifier注解一起使用。如下：

@Qualifier("userDao") private UserDao userDao;

@Resource預設按照ByName自動注入，由J2EE提供，需要導入包javax.annotation.Resource。@Resource有兩個重要的屬性：name和type，而Spring将@Resource注解的name屬性解析為bean的名字，而type屬性則解析為bean的類型。是以，如果使用name屬性，則使用byName的自動注入政策，而使用type屬性時則使用byType自動注入政策。如果既不制定name也不制定type屬性，這時将通過反射機制使用byName自動注入政策。

// 下面兩種@Resource隻要使用一種即可 @Resource(name="userDao")

注：最好是将@Resource放在setter方法上，因為這樣更符合面向對象的思想，通過set、get去操作屬性，而不是直接去操作屬性。

@Resource裝配順序：

①如果同時指定了name和type，則從Spring上下文中找到唯一比對的bean進行裝配，找不到則抛出異常。

②如果指定了name，則從上下文中查找名稱（id）比對的bean進行裝配，找不到則抛出異常。

③如果指定了type，則從上下文中找到類似比對的唯一bean進行裝配，找不到或是找到多個，都會抛出異常。

④如果既沒有指定name，又沒有指定type，則自動按照byName方式進行裝配；如果沒有比對，則回退為一個原始類型進行比對，如果比對則自動裝配。

@Resource的作用相當于@Autowired，隻不過@Autowired按照byType自動注入。

代表的是：該Controller的所有方法在調用前，先執行此@ModelAttribute方法，可用于注解和方法參數中，可以把這個@ModelAttribute特性，應用在BaseController當中，所有的Controller繼承BaseController，即可實作在調用Controller時，先執行@ModelAttribute方法。

@SessionAttributes即将值放到session作用域中，寫在class上面。

具體示例參見下面：使用 @ModelAttribute 和 @SessionAttributes 傳遞和儲存資料

SpringMVC 支援使用 @ModelAttribute 和 @SessionAttributes 在不同的模型（model）和控制器之間共享資料。 @ModelAttribute 主要有兩種使用方式，一種是标注在方法上，一種是标注在 Controller 方法參數上。

當 @ModelAttribute 标記在方法上的時候，該方法将在處理器方法執行之前執行，然後把傳回的對象存放在 session 或模型屬性中，屬性名稱可以使用 @ModelAttribute(“attributeName”) 在标記方法的時候指定，若未指定，則使用傳回類型的類名稱（首字母小寫）作為屬性名稱。關于 @ModelAttribute 标記在方法上時對應的屬性是存放在 session 中還是存放在模型中，我們來做一個實驗，看下面一段代碼。

用于将請求URL中的模闆變量映射到功能處理方法的參數上，即取出uri模闆中的變量作為參數。如：

@Controller public class TestController { @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET) public String getLogin(@PathVariable("userId") String userId, @PathVariable("roleId") String roleId){ System.out.println("User Id : " + userId); System.out.println("Role Id : " + roleId); return "hello"; @RequestMapping(value="/product/{productId}",method = RequestMethod.GET) public String getProduct(@PathVariable("productId") String productId){ System.out.println("Product Id : " + productId); @RequestMapping(value="/javabeat/{regexp1:[a-z-]+}", method = RequestMethod.GET) public String getRegExp(@PathVariable("regexp1") String regexp1){ System.out.println("URI Part 1 : " + regexp1);

@requestParam主要用于在SpringMVC背景控制層擷取參數，類似一種是request.getParameter("name")，它有三個常用參數：defaultValue = "0", required = false, value = "isApp"；defaultValue 表示設定預設值，required 銅過boolean設定是否是必須要傳入的參數，value 值表示接受的傳入的參數類型。

作用： 該注解用于将Controller的方法傳回的對象，通過适當的HttpMessageConverter轉換為指定格式後，寫入到Response對象的body資料區。

使用時機：傳回的資料不是html标簽的頁面，而是其他某種格式的資料時（如json、xml等）使用；

相當于通用的注解，當不知道一些類歸到哪個層時使用，但是不建議。

用于注解dao層，在daoImpl類上面注解。