springmvc注解詳解

隨著Annotation的流行,一些主流框架都加入了對Annotation的支持。使用Annotation能夠簡化很多配置工作,能夠很大程度上提高程序開發的效率。本文將 Spring 2.5 新增的 Sping MVC 注解功能,介紹如何使用注解配置替換傳統的基于 XML 的 Spring MVC 配置。
棄用了struts,用spring mvc框架做了幾個項目,感覺都不錯,而且使用了注解方式,可以省掉一大堆配置文件。本文主要介紹使用注解方式配置的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之下。

  1. 將@RequestMapping用于整個類不是必須的,如果沒有配置,所有的方法的訪問路徑配置將是完全獨立的,沒有任何關聯。
  2. 完整的參數項為:@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
  3. value的配置還可以采用模版變量的形式,例如:
    @RequestMapping(value="/owners/{ownerId}",method=RequestMethod.GET)這點將在介紹@PathVariable中詳細說明。
  4. @RequestMapping params的補充說明,你可以通過設置參數條件來限制訪問地址,例如params="myParam=myValue"表達式,訪問地址中參數只有包含了該規定的值"myParam=myValue"才能匹配得上,類似"myParam"之類的表達式也是支持的,表示當前請求的地址必須有該參數(參數的值可以是任意),"!myParam"之類的表達式表明當前請求的地址不能包含具體指定的參數"myParam"。
  5. 有一點需要注意的,如果為類定義了訪問地址為.do,.html之類的,則在方法級的@RequestMapping,不能再定義value值,否則會報錯,例如:
@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的模板變量。
@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
public String findOwner( , Model model) {  
  Owner owner = ownerService.findOwner(ownerId);    
  model.addAttribute("owner", owner);    
  return "displayOwner";  
}  
  1. @PathVariable用于地址欄使用{xxx}模版變量時使用。如果@RequestMapping沒有定義類似"/{ownerId}" ,這種變量,則使用在方法中@PathVariable會報錯。
@ModelAttribute
  1. 應用于方法參數,參數可以在頁面直接獲取,相當于request.setAttribute(,)
  2. 應用于方法,將任何一個擁有返回值的方法標注上@ModelAttribute,使其返回值將會進入到模型對象的屬性列表中.
  3. 應用于方法參數時@ModelAttribute("xx"),須關聯到Object的數據類型,基本數據類型 如:int,String不起作用
@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

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 獲取請求的頭部信息
@ControllerAdvice 全局異常處理器 和@ExceptionHandler配合使用
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容