1. 程式人生 > >Spring 中的註解彙總

Spring 中的註解彙總

@Controller
@RestController:
@Service
@Autowired
@RequestMapping
@RequestParam
@ModelAttribute
@Cacheable
@CacheEvict
@Resource
@PostConstruct
@PreDestroy
@Repository
@Component 
@Scope
@SessionAttributes
@Required
@Qualifier

@PathVariable 

 

1. @Controller

標識一個該類是Spring MVC controller處理器,用來建立處理http請求的物件.

@Controller
public class TestController {
        @RequestMapping("/test")
        public String test(Map<String,Object> map){

            return "hello";
        }
}

2. @RestController

Spring4之後加入的註解,原來在@Controller中返回json需要@ResponseBody來配合,如果直接用@RestController替代@Controller就不需要再配置@ResponseBody,預設返回json格式。

@RestController
public class TestController {
        @RequestMapping("/test")
        public String test(Map<String,Object> map){

            return "hello";
        }
}

3. @Service

用來裝配bean,主要用於標註業務層元件,通過註解的方式將該類加入到spring 中進行管理。

4. @Autowired

用來裝配bean,可以寫在欄位上,也可以寫在方法上。
預設情況下必須要求依賴物件必須存在,如果要允許null值,可以設定它的required屬性為false,例如:@Autowired(required=false)

5. @RequestMapping

類定義處:提供初步的請求對映資訊,相對於 WEB 應用的根目錄。
方法處:提供進一步的細分對映資訊,相對於類定義處的 URL。

6. @RequestParam

用於將請求引數區資料對映到功能處理方法的引數上
例如

public Resp test(@RequestParam Integer id){
        return Resp.success(customerInfoService.fetch(id));
}

 這個id就是要接收從介面傳遞過來的引數id的值的,如果介面傳遞過來的引數名和你接收的不一致,也可以如下

public Resp test(@RequestParam(value="userId") Integer id){
    return Resp.success(customerInfoService.fetch(id));
}

其中userId就是介面傳遞的引數,id就是對映userId的引數名。

7. @ModelAttribute

使用地方有三種:

1. 標記在方法上。

標記在方法上,會在每一個@RequestMapping標註的方法前執行,如果有返回值,則自動>將該返回值加入到ModelMap中。

A.在有返回的方法上:
當ModelAttribute設定了value,方法返回的值會以這個value為key,以引數接受到的值作為value,存入到Model中,如下面的方法執行之後,最終相當於 model.addAttribute("user_name", name);假如 @ModelAttribute沒有自定義value,則相當於
model.addAttribute("name", name);

[email protected](value="user_name")
2    public String before2(@RequestParam(required = false) String name, Model model) {
3        System.out.println("進入了2:" + name);
4        return name;
5    }

B.在沒返回的方法上:
需要手動model.add方法

1    @ModelAttribute
2    public void before(@RequestParam(required = false) Integer age, Model model) {
3        model.addAttribute("age", age);
4        System.out.println("進入了1:" + age);
5    }

我們在當前類下建一個請求方法:

 [email protected](value="/mod")
 2    public Resp mod(
 3            @RequestParam(required = false) String name,
 4            @RequestParam(required = false) Integer age, 
 5            Model model){
 6        System.out.println("進入mod");
 7        System.out.println("引數接受的數值{name="+name+";age="+age+"}");
 8        System.out.println("model傳過來的值:"+model);
 9        return Resp.success("1");
10    }

在瀏覽器中輸入訪問地址並且加上引數:
http://localhost:8081/api/test/mod?name=我是小菜&age=12

最終輸出如下:

1進入了1:40
2進入了2:我是小菜
3進入mod
4引數接受的數值{name=我是小菜;age=12}
5model傳過來的值:{age=40, user_name=我是小菜}

2. 標記在方法的引數上。

標記在方法的引數上,會將客戶端傳遞過來的引數按名稱注入到指定物件中,並且會將這個物件自動加入ModelMap中,便於View層使用.
我們在上面的類中加入一個方法如下

 [email protected](value="/mod2")
 2    public Resp mod2(@ModelAttribute("user_name") String user_name, 
 3            @ModelAttribute("name") String name,
 4            @ModelAttribute("age") Integer age,Model model){
 5        System.out.println("進入mod2");
 6        System.out.println("user_name:"+user_name);
 7        System.out.println("name:"+name);
 8        System.out.println("age:"+age);
 9        System.out.println("model:"+model);
10        return Resp.success("1");
11    }

在瀏覽器中輸入訪問地址並且加上引數:
http://localhost:8081/api/test/mod2?name=我是小菜&age=12
最終輸出:

1進入了1:40
2進入了2:我是小菜
3進入mod2
4user_name:我是小菜
5name:我是小菜
6age:40
7model:{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物件中,便於使用。

8. @Cacheable

用來標記快取查詢。可用用於方法或者類中,

當標記在一個方法上時表示該方法是支援快取的,
當標記在一個類上時則表示該類所有的方法都是支援快取的。

引數列表

引數 解釋 例子
value 名稱 @Cacheable(value={”c1”,”c2”}
key key @Cacheable(value=”c1”,key=”#id”)
condition 條件 @Cacheable(value=”c1”,condition=”#id=1”)比如@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;   
} 

 

9. @CacheEvict

用來標記要清空快取的方法,當這個方法被呼叫後,即會清空快取。 @CacheEvict(value=”UserCache”)

引數列表

引數 解釋 例子
value 名稱 @CachEvict(value={”c1”,”c2”}
key key @CachEvict(value=”c1”,key=”#id”)
condition 快取的條件,可以為空
allEntries 是否清空所有快取內容 @CachEvict(value=”c1”,allEntries=true)
beforeInvocation 是否在方法執行前就清空 @CachEvict(value=”c1”,beforeInvocation=true)

10. @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方式進行裝配;如果沒有匹配,則回退為一個原始型別進行匹配,如果匹配則自動裝配;

11. @PostConstruct

用來標記是在專案啟動的時候執行這個方法。用來修飾一個非靜態的void()方法
也就是spring容器啟動時就執行,多用於一些全域性配置、資料字典之類的載入

被@PostConstruct修飾的方法會在伺服器載入Servlet的時候執行,並且只會被伺服器執行一次。PostConstruct在建構函式之後執行,init()方法之前執行。PreDestroy()方法在destroy()方法執行執行之後執

12. @PreDestroy

被@PreDestroy修飾的方法會在伺服器解除安裝Servlet的時候執行,並且只會被伺服器呼叫一次,類似於Servlet的destroy()方法。被@PreDestroy修飾的方法會在destroy()方法之後執行,在Servlet被徹底解除安裝之前

13. @Repository

用於標註資料訪問元件,即DAO元件

14. @Component

泛指元件,當元件不好歸類的時候,我們可以使用這個註解進行標註

15. @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例項。

16. @SessionAttributes

預設情況下Spring MVC將模型中的資料儲存到request域中。當一個請求結束後,資料就失效了。如果要跨頁面使用。那麼需要使用到session。而@SessionAttributes註解就可以使得模型中的資料儲存一份到session域中

引數:

names:這是一個字串陣列。裡面應寫需要儲存到session中資料的名稱。
types:根據指定引數的型別,將模型中對應型別的引數儲存到session中
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";
         }
}

 

17. @Required

適用於bean屬性setter方法,並表示受影響的bean屬性必須在XML配置檔案在配置時進行填充。否則,容器會丟擲一個BeanInitializationException異常。

18. @Qualifier

當你建立多個具有相同型別的 bean 時,並且想要用一個屬性只為它們其中的一個進行裝配,在這種情況下,你可以使用 @Qualifier 註釋和 @Autowired 註釋通過指定哪一個真正的 bean 將會被裝配來消除混亂。

[email protected] 

@PathVariable可以用來對映URL中的佔位符到目標方法的引數中

@RequestMapping("/testPathVariable/{id}")
public String testPathVariable(@PathVariable("id") Integer id){
    System.out.println("testPathVariable:"+id);
    return SUCCESS;
}

本文轉至:《jaybrilhttps://segmentfault.com/a/1190000016600443