[TOC] # Spring中的18個注解 ***** ### **@Controller** > 標識一個該類是Spring MVC controller處理器，用來創建處理http請求的對象. ``` @Controller public class TestController { @RequestMapping("/test") public String test(Map<String,Object> map){ return "hello"; } } ``` ### **@RestController** >Spring4之后加入的注解，原來在@Controller中返回json需要@ResponseBody來配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，默認返回json格式。 ```java @RestController public class TestController { @RequestMapping("/test") public String test(Map<String,Object> map){ return "hello"; } } ``` ### **@Service** >用于標注業務層組件，說白了就是加入你有一個用注解的方式把這個類注入到spring配置中 ### **@Autowired** >用來裝配bean，都可以寫在字段上，或者方法上。 默認情況下必須要求依賴對象必須存在，如果要允許null值，可以設置它的required屬性為false，例如：@Autowired(required=false) ### **@RequestMapping** >類定義處: 提供初步的請求映射信息，相對于 WEB 應用的根目錄。 方法處: 提供進一步的細分映射信息，相對于類定義處的 URL。 用過RequestMapping的同學都知道，他有非常多的作用，因此詳細的用法 ### **@RequestParam** >用于將請求參數區數據映射到功能處理方法的參數上 例如 ~~~ public Resp test(@RequestParam Integer id){ return Resp.success(customerInfoService.fetch(id)); } ~~~ 這個id就是要接收從接口傳遞過來的參數id的值的，如果接口傳遞過來的參數名和你接收的不一致，也可以如下 ~~~ public Resp test(@RequestParam(value="course_id") Integer id){ return Resp.success(customerInfoService.fetch(id)); } ~~~ >其中course\_id就是接口傳遞的參數，id就是映射course\_id的參數名 ### **@ModelAttribute** 使用地方有三種： **1\. 標記在方法上。** > 標記在方法上，會在每一個@RequestMapping標注的方法前執行，如果有返回值，則自動將該返回值加入到ModelMap中。 **A.在有返回的方法上:** >當ModelAttribute設置了value，方法返回的值會以這個value為key，以參數接受到的值作為value，存入到Model中，如下面的方法執行之后，最終相當于 model.addAttribute("user\_name", name);假如 @ModelAttribute沒有自定義value，則相當于 model.addAttribute("name", name); ~~~ @ModelAttribute(value="user_name") public String before2(@RequestParam(required = false) String name, Model model) { System.out.println("進入了2：" + name); return name; } ~~~ **B.在沒返回的方法上：** >需要手動model.add方法 ~~~ @ModelAttribute public void before(@RequestParam(required = false) Integer age, Model model) { model.addAttribute("age", age); System.out.println("進入了1：" + age); } ~~~ 我們在當前類下建一個請求方法： ~~~ @RequestMapping(value="/mod") public Resp mod( @RequestParam(required = false) String name, @RequestParam(required = false) Integer age, Model model){ System.out.println("進入mod"); System.out.println("參數接受的數值{name="+name+";age="+age+"}"); System.out.println("model傳過來的值:"+model); return Resp.success("1"); } ~~~ 在瀏覽器中輸入訪問地址并且加上參數： http://localhost:8081/api/test/mod?name=我是小菜&age=12 最終輸出如下： ~~~ 進入了1：40 進入了2：我是小菜 進入mod 參數接受的數值{name=我是小菜;age=12} model傳過來的值:{age=40, user_name=我是小菜} ~~~ **2\. 標記在方法的參數上。** > 標記在方法的參數上，會將客戶端傳遞過來的參數按名稱注入到指定對象中，并且會將這個對象自動加入ModelMap中，便于View層使用.我們在上面的類中加入一個方法如下 ~~~ @RequestMapping(value="/mod2") public Resp mod2(@ModelAttribute("user_name") String user_name, @ModelAttribute("name") String name, @ModelAttribute("age") Integer age,Model model){ System.out.println("進入mod2"); System.out.println("user_name:"+user_name); System.out.println("name："+name); System.out.println("age:"+age); System.out.println("model:"+model); return Resp.success("1"); } ~~~ 在瀏覽器中輸入訪問地址并且加上參數： http://localhost:8081/api/test/mod2?name=我是小菜&age=12 最終輸出： ~~~ 進入了1：40 進入了2：我是小菜 進入mod2 user_name:我是小菜 name：我是小菜 age:40 model:{user_name=我是小菜, org.springframework.validation.BindingResult.user_name=org.springframework.validation.BeanPropertyBindingResult: 0 errors, name=我是小菜, org.springframework.validation.BindingResult.name=org.springframework.validation.BeanPropertyBindingResult: 0 errors, age=40, org.springframework.validation.BindingResult.age=org.springframework.validation.BeanPropertyBindingResult: 0 errors} ~~~ 從結果就能看出，用在方法參數中的@ModelAttribute注解，實際上是一種接受參數并且自動放入Model對象中，便于使用。 ### **@Cacheable** >用來標記緩存查詢。可用用于方法或者類中， > 當標記在一個方法上時表示該方法是支持緩存的，當標記在一個類上時則表示該類所有的方法都是支持緩存的。 **參數列表**  比如@Cacheable(value="UserCache") 標識的是當調用了標記了這個注解的方法時，邏輯默認加上從緩存中獲取結果的邏輯，如果緩存中沒有數據，則執行用戶編寫查詢邏輯，查詢成功之后，同時將結果放入緩存中。 但凡說到緩存，都是key-value的形式的，因此key就是方法中的參數（id），value就是查詢的結果，而命名空間UserCache是在spring\*.xml中定義. ~~~ @Cacheable(value="UserCache")// 使用了一個緩存名叫 accountCache public Account getUserAge(int id) { //這里不用寫緩存的邏輯，直接按正常業務邏輯走即可， //緩存通過切面自動切入 int age=getUser(id); return age; } ~~~ ### **@CacheEvict** 用來標記要清空緩存的方法，當這個方法被調用后，即會清空緩存。@CacheEvict(value=”UserCache”) **參數列表**  ### **@Resource** >@Resource的作用相當于@Autowired, 只不過@Autowired按byType自動注入， 而@Resource默認按 byName自動注入罷了。 @Resource有兩個屬性是比較重要的，分是name和type， Spring將@Resource注解的name屬性解析為bean的名字，而type屬性則解析為bean的類型。 所以如果使用name屬性，則使用byName的自動注入策略，而使用type屬性時則使用byType自動注入策略。如果既不指定name也不指定type屬性，這時將通過反射機制使用byName自動注入策略。 **@Resource裝配順序:** * 如果同時指定了name和type，則從Spring上下文中找到唯一匹配的bean進行裝配，找不到則拋出異常 * 如果指定了name，則從上下文中查找名稱（id）匹配的bean進行裝配，找不到則拋出異常 * 如果指定了type，則從上下文中找到類型匹配的唯一bean進行裝配，找不到或者找到多個，都會拋出異常 * 如果既沒有指定name，又沒有指定type，則自動按照byName方式進行裝配；如果沒有匹配，則回退為一個原始類型進行匹配，如果匹配則自動裝配； ### **@PostConstruct** >用來標記是在項目啟動的時候執行這個方法。用來修飾一個非靜態的void()方法 也就是spring容器啟動時就執行，多用于一些全局配置、數據字典之類的加載 被@PostConstruct修飾的方法會在服務器加載Servlet的時候運行，并且只會被服務器執行一次。PostConstruct在構造函數之后執行,init()方法之前執行。PreDestroy（）方法在destroy()方法執行執行之后執 ### **@PreDestroy** >被@PreDestroy修飾的方法會在服務器卸載Servlet的時候運行，并且只會被服務器調用一次，類似于Servlet的destroy()方法。被@PreDestroy修飾的方法會在destroy()方法之后運行，在Servlet被徹底卸載之前 ### **@Repository** >用于標注數據訪問組件，即DAO組件 ### **@Component** >泛指組件，當組件不好歸類的時候，我們可以使用這個注解進行標注 ### **@Scope** >用來配置 spring bean 的作用域，它標識 bean 的作用域。 默認值是單例 * singleton:單例模式,全局有且僅有一個實例 * prototype:原型模式,每次獲取Bean的時候會有一個新的實例 * request:request表示該針對每一次HTTP請求都會產生一個新的bean，同時該bean僅在當前HTTP request內有效 * session:session作用域表示該針對每一次HTTP請求都會產生一個新的bean，同時該bean僅在當前HTTP session內有效 * global session:只在portal應用中有用，給每一個 global http session 新建一個Bean實例。 ### **@SessionAttributes** >默認情況下Spring MVC將模型中的數據存儲到request域中。當一個請求結束后，數據就失效了。如果要跨頁面使用。那么需要使用到session。而@SessionAttributes注解就可以使得模型中的數據存儲一份到session域中 **參數：** 1. names：這是一個字符串數組。里面應寫需要存儲到session中數據的名稱。 2. types：根據指定參數的類型，將模型中對應類型的參數存儲到session中 3. value：和names是一樣的。 ~~~ @Controller @SessionAttributes(value={"names"},types={Integer.class}) public class ScopeService { @RequestMapping("/testSession") public String test(Map<String,Object> map){ map.put("names", Arrays.asList("a","b","c")); map.put("age", 12); return "hello"; } } ~~~ ### **@Required** 適用于bean屬性setter方法，并表示受影響的bean屬性必須在XML配置文件在配置時進行填充。否則，容器會拋出一個BeanInitializationException異常。 ### **@Qualifier** 當你創建多個具有相同類型的 bean 時，并且想要用一個屬性只為它們其中的一個進行裝配，在這種情況下，你可以使用 @Qualifier 注釋和 @Autowired 注釋通過指定哪一個真正的 bean 將會被裝配來消除混亂。