Spring MVC常用的註解

Mr_Alexander發表於2016-06-02
SpringMVC
spring mvc常用的註解：

個介紹。 
@Controller 
@Controller 負責註冊一個bean 到spring 上下文中，bean 的ID 預設為

類名稱開頭字母小寫,你也可以自己指定，如下 
方法一： 
@Controller 
public class TestController {} 
 
方法二：            
@Controller("tmpController") 
public class TestController {} 
 
@RequestMapping 
 
1.@RequestMapping用來定義訪問的URL，你可以為整個類定義一個

@RequestMapping，或者為每個方法指定一個。 
把@RequestMapping放在類級別上，這可令它與方法級別上的

@RequestMapping註解協同工作，取得縮小選擇範圍的效果。 
例如： 
@RequestMapping("/test") 
public class TestController {} 
則，該類下的所有訪問路徑都在/test之下。 
 
2.將@RequestMapping用於整個類不是必須的，如果沒有配置，所有的方法

的訪問路徑配置將是完全獨立的，沒有任何關聯。 
 
3.完整的引數項為：@RequestMapping(value="",method =

{"",""},headers={},params={"",""})，各引數說明如下：
value :String[] 設定訪問地址 
method: RequestMethod[]設定訪問方式，字元陣列，檢視RequestMethod

類，包括GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE,常用

RequestMethod.GET，RequestMethod.POST 
headers:String[] headers一般結合method = RequestMethod.POST使用 
params: String[] 訪問引數設定，字元陣列 例如：userId=id 
 
4.value的配置還可以採用模版變數的形式 ，例如：@RequestMapping

(value="/owners/{ownerId}", method=RequestMethod.GET)，這點將在介

紹@PathVariable中詳細說明。 
 
5.@RequestMapping params的補充說明，你可以通過設定引數條件來限制

訪問地址，例如params="myParam=myValue"表示式，訪問地址中引數只有

包含了該規定的值"myParam=myValue"才能匹配得上，類似"myParam"之類

的表示式也是支援的，表示當前請求的地址必須有該引數(引數的值可以是

任意)，"!myParam"之類的表示式表明當前請求的地址不能包含具體指定的

引數"myParam"。 
 
6.有一點需要注意的，如果為類定義了訪問地址為*.do,*.html之類的，則

在方法級的@RequestMapping，不能再定義value值，否則會報錯，例如 
Java程式碼  
@RequestMapping("/bbs.do")  
public class BbsController {  
    @RequestMapping(params = "method=getList")  
    public String getList() {  
     return "list";  
    }  
@RequestMapping(value= "/spList")  
public String getSpecialList() {  
     return "splist";  
    }  
}  
 
如上例：/bbs.do?method=getList 可以訪問到方法getList() ；而訪

問/bbs.do/spList則會報錯. 
 
@PathVariable 
1.@PathVariable用於方法中的引數，表示方法引數繫結到地址URL的模板

變數。 
例如： 
Java程式碼  
@RequestMapping(value="/owners/{ownerId}", 

method=RequestMethod.GET)  
public String findOwner(@PathVariable String ownerId, Model 

model) {  
  Owner owner = ownerService.findOwner(ownerId);    
  model.addAttribute("owner", owner);    
  return "displayOwner";  
}  
 
2.@PathVariable用於位址列使用{xxx}模版變數時使用。 
如果@RequestMapping沒有定義類似"/{ownerId}" ，這種變數，則使用在

方法中@PathVariable會報錯。 
 
 
@ModelAttribute 
1.應用於方法引數,引數可以在頁面直接獲取，相當於

request.setAttribute(,) 
2.應用於方法,將任何一個擁有返回值的方法標註上 @ModelAttribute，使

其返回值將會進入到模型物件的屬性列表中. 
3.應用於方法引數時@ModelAttribute("xx"),須關聯到Object的資料型別

，基本資料型別 如：int,String不起作用 
例如： 
Java程式碼  
@ModelAttribute("items")//<——①向模型物件中新增一個名為items的

屬性  
public List<String> populateItems() {  
        List<String> lists = new ArrayList<String>();  
        lists.add("item1");  
        lists.add("item2");  
        return lists;  
}  
@RequestMapping(params = "method=listAllBoard")  
public String listAllBoard(@ModelAttribute("currUser")User user, 

ModelMap model) {  
        bbtForumService.getAllBoard();  
        //<——②在此訪問模型中的items屬性  
        System.out.println("model.items:" + ((List<String>)

model.get("items")).size());  
        return "listBoard";  
}  
 
在 ① 處，通過使用 @ModelAttribute 註解，populateItem() 方法將在

任何請求處理方法執行前呼叫，Spring MVC 會將該方法返回值以“items

”為名放入到隱含的模型物件屬性列表中。 
所以在 ② 處，我們就可以通過 ModelMap 入參訪問到 items 屬性，當執

行 listAllBoard() 請求處理方法時，② 處將在控制檯列印

出“model.items:2”的資訊。當然我們也可以在請求的檢視中訪問到模型

物件中的 items 屬性。 
 
 
@ResponseBody 
這個註解可以直接放在方法上，表示返回型別將會直接作為HTTP響應位元組

流輸出(不被放置在Model，也不被攔截為檢視頁面名稱)。可以用於ajax。 
 
@RequestParam 
@RequestParam是一個可選引數，例如：@RequestParam("id") 註解，所以

它將和URL所帶引數 id進行繫結 
如果入參是基本資料型別（如 int、long、float 等），URL 請求引數中

一定要有對應的引數，否則將丟擲 

org.springframework.web.util.NestedServletException 異常，提示無

法將 null 轉換為基本資料型別. 
 
@RequestParam包含3個配置 @RequestParam(required = ,value="", 

defaultValue = "") 
required :引數是否必須，boolean型別,可選項，預設為true 
value: 傳遞的引數名稱，String型別,可選項，如果有值，對應到設定方

法的引數 
defaultValue:String型別,引數沒有傳遞時為引數預設指定的值 
 
@SessionAttributes session管理 
Spring 允許我們有選擇地指定 ModelMap 中的哪些屬性需要轉存到 

session 中，以便下一個請求屬對應的 ModelMap 的屬性列表中還能訪問

到這些屬性。這一功能是通過類定義處標註 @SessionAttributes 註解來

實現的。@SessionAttributes 只能宣告在類上，而不能宣告在方法上。 
 
例如 
 
@SessionAttributes("currUser") // 將ModelMap 中屬性名為currUser 的屬性 


@SessionAttributes({"attr1","attr2"}) 
@SessionAttributes(types = User.class) 
@SessionAttributes(types = {User.class,Dept.class}) 
@SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"}) 

 
@CookieValue 獲取cookie資訊 
@RequestHeader 獲取請求的頭部資訊

相關文章