Spring MVC常用的注解

spring mvc常用的注解：

個介紹。

@Controller

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

類名稱開頭字母小寫,你也可以自己指定，如下

方法一：

@Controller

public class TestController {}

方法二：           

@Controller("tmpController")

public class TestController {}

@RequestMapping

[email protected]用來定義通路的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中詳細說明。

[email protected] 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

[email protected]用于方法中的參數，表示方法參數綁定到位址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"; 

} 

[email protected]用于位址欄使用{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 擷取請求的頭部資訊