Spring 常用的註解整理
一、元件型註解:
- @Component 在類定義之前新增@Component註解,他會被spring容器識別,並轉為bean。
- @Repository 對Dao實現類進行註解 (特殊的@Component)
- @Service 用於對業務邏輯層進行註解, (特殊的@Component)
- @Controller 用於控制層註解 , (特殊的@Component)
以上四種註解都是註解在類上的,被註解的類將被spring初始話為一個bean,然後統一管理。
二、請求和引數型註解:
- @RequestMapping:用於處理請求地址對映,可以作用於類和方法上。
-
- value:定義request請求的對映地址
- method:定義地request址請求的方式,包括【GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.】預設接受get請求,如果請求方式和定義的方式不一樣則請求無法成功。
- params:定義request請求中必須包含的引數值。
- headers:定義request請求中必須包含某些指定的請求頭,如:RequestMapping(value = "/something", headers = "content-type=text/*")說明請求中必須要包含"text/html", "text/plain"這中型別的Content-type頭,才是一個匹配的請求。
- consumes:定義請求提交內容的型別。
- produces:指定返回的內容型別,僅當request請求頭中的(Accept)型別中包含該指定型別才返回
1 @RequestMapping(value="/requestTest.do",params = {"name=sdf"},headers = {"Accept-Encoding=gzip, deflate, br"},method = RequestMethod.GET) 2 public String getIndex(){ 3 System.out.println("請求成功"); 4 return "index"; 5 }
上面程式碼表示請求的方式為GET請求,請求引數必須包含name=sdf這一引數,然後請求頭中必須有 Accept-Encoding=gzip, deflate, br這個型別頭。
這樣通過註解就能對一個請求進行約束了。
[email protected]:用於獲取傳入引數的值
-
- value:引數的名稱
- required:定義該傳入引數是否必須,預設為true,(和@RequestMapping的params屬性有點類似)
1 @RequestMapping("/requestParams1.do")
2 public String requestParams1(@RequestParam(required = false) String name){
3 System.out.println("name = "+name);
4 return "index";
5 }
6 @RequestMapping("/requestParams2.do")
7 public String requestParams2(@RequestParam(value = "name",required = false) String names){
8 System.out.println("name = "+names);
9 return "index";
10 }
兩種請入參方式是一樣的,顯示宣告value的名稱時,入參引數名和value一樣,沒有顯示宣告的話,像第一種方式宣告的,入參引數名和函式引數變數名一樣。
[email protected]:用於定義路徑引數值
-
- value:引數的名稱
- required:定義傳入引數是否為必須值
@RequestMapping("/{myname}/pathVariable2.do")
public String pathVariable2(@PathVariable(value = "myname") String name){
System.out.println("myname = "+name);
return "index";
}
這個路徑聲明瞭{myname}作為路徑引數,那麼這一段路徑將為任意值,@PathVariable將可以根據value獲取路徑的值。
[email protected]:作用於方法上,可以將整個返回結果以某種格式返回,如json或xml格式。
1 @RequestMapping("/{myname}/pathVariable2.do")
2 @ResponseBody
3 public String pathVariable2(@PathVariable(value = "myname") String name){
4 System.out.println("myname = "+name);
5 return "index";
6 }
和上一段例子一樣,只是添加了@ResponseBody標籤,然後返回結果為:
它返回的不是一個頁面,而是把字串“index”直接在頁面打印出來了,這其實和如下程式碼時類似的。
1 PrintWriter out = resp.getWriter();
2 out.print("index");
3 out.flush();
- @CookieValue:用於獲取請求的Cookie值
1 @RequestMapping("/requestParams.do")
2 public String requestParams(@CookieValue("JSESSIONID") String cookie){
3 return "index";
4 }
[email protected]:用於把引數儲存到model中,可以註解方法或引數,註解在方法上的時候,該方法將在處理器方法執行之前執行,然後把返回的物件存放在 session(前提時要有@SessionAttributes註解) 或模型屬性中,@ModelAttribute(“attributeName”) 在標記方法的時候指定,若未指定,則使用返回型別的類名稱(首字母小寫)作為屬性名稱。
1 @ModelAttribute("user")
2 public UserEntity getUser(){
3 UserEntity userEntityr = new UserEntity();
4 userEntityr.setUsername("asdf");
5 return userEntityr;
6 }
7
8 @RequestMapping("/modelTest.do")
9 public String getUsers(@ModelAttribute("user") UserEntity user){
10 System.out.println(user.getUsername());
11 return "/index";
12 }
如上程式碼中,使用了@ModelAttribute("user")註解,在執行控制器前執行,然後將生成一個名稱為user的model資料,在控制器中我們通過註解在引數上的@ModelAttribute獲取引數,然後將model應用到控制器中,在jsp頁面中我們同樣可以使用它,
1 <body>
2 ${user.username}
3 </body>
預設情況下Spring MVC將模型中的資料儲存到request域中。當一個請求結束後,資料就失效了。如果要跨頁面使用。那麼需要使用到session。而@SessionAttributes註解就可以使得模型中的資料儲存一份到session域中。配合@ModelAttribute("user")使用的時候,會將對應的名稱的model值存到session中,
1 @Controller
2 @RequestMapping("/test")
3 @SessionAttributes(value = {"user","test1"})
4 public class LoginController{
5 @ModelAttribute("user")
6 public UserEntity getUser(){
7 UserEntity userEntityr = new UserEntity();
8 userEntityr.setUsername("asdf");
9 return userEntityr;
10 }
11
12 @RequestMapping("/modelTest.do")
13 public String getUsers(@ModelAttribute("user") UserEntity user ,HttpSession session){
14 System.out.println(user.getUsername());
15 System.out.println(session.getAttribute("user"));
16 return "/index";
17 }
18 }
結合上一個例子的程式碼,加了@SessionAttributes註解,然後請求了兩次,第一次session中不存在屬性名為user的值,第二次請求的時候發現session中又有了,這是因為,這是因為第一次請求時,model資料還未儲存到session中請求結束返回的時候才儲存,在第二次請求的時候已經可以獲取上一次的model了,