5分鐘弄懂Spring MVC常用註解，不信你來看

一、@RequestMapping註解

查看@RequestMapping註解的源碼，我們可以瞭解到該註解作用的範圍以及常用的屬性。

1、作用：用於建立請求 URL 和處理請求方法之間的對應關係。

2、出現的位置

• 類上：請求 URL 的第一級訪問目錄。此處不寫的話，就相當於應用的根目錄。
  它出現的目的是爲了使我們的 URL 可以按照模塊化管理。
  例如：在賬戶模塊上有如下請求：/account/add；/account/update；/account/delete；
  其中/account表示請求URL的第一級訪問目錄，這樣寫的好處可以方便的進行模塊化管理。
• 方法上：請求 URL 的第二級訪問目錄。上述中的/add；/update；/delete屬於第二級訪問目錄。

3、屬性

• value：用於指定請求的 URL。它和 path 屬性的作用是一樣的。

• method：用於指定請求的方式。（GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS, TRACE;）
  使用方式：RequestMethod.請求方式

• params：用於指定限制請求參數的條件。它支持簡單的表達式。要求請求參數的 key 和 value 必須和配置的一模一樣。
  例如：params = {“username=zhangsan”}，表示請求參數中必須有username並且值相同。
  如果username的值不一樣，將會出現如下的400請求錯誤。
  

• headers 發送的請求中必須包含的請求頭。

<a href="user/testRequestMapping?username=zhangsan">RequestMapping註解</a>

@Controller
@RequestMapping(path = "user")
public class HelloController {

    @RequestMapping(value = "/testRequestMapping", method = {RequestMethod.GET}, params = {"username=zhangsan"}, headers = {"Accept"})
    public String testRequestMapping() {
        System.out.println("testRequestMapping......");
        return "success";
    }
}

二、@RequestParam註解

1、作用：把請求中的指定名稱的參數傳遞給控制器中的形參賦值

2、屬性

• value：請求參數中的名稱。和name屬性作用相同。
• required：請求參數中是否必須提供此參數。默認值：true。表示必須提供，如果不提供將報錯。

<a href="anno/testRequestParam?username=chuzhuyong">@RequestParam註解</a>

	@RequestMapping(value = "/testRequestParam")
    public String testRequestParam(@RequestParam(name = "username") String name,@RequestParam(name = "age",required = false) Integer age) {
        System.out.println(name + "," + age);
        return "success";
    }

三、@RequestBody註解

1、作用

用於獲取請求體內容。直接使用得到是 key=value&key=value…結構的數據。
get 請求方式不適用。

2、屬性

required：是否必須有請求體。默認值是:true。當取值爲 true 時,get 請求方式會報錯。如果取值爲 false，get 請求得到是 null。

<form action="anno/testRequestBody" method="post">
        用戶名：<input type="text" name="name"><br>
        密碼：<input type="password" name="age"><br>
        <input type="submit" value="提交">
</form>

四、@PathVariable註解

1、 作用

用於綁定 url 中的佔位符。例如：請求 url 中 /delete/{id}，這個{id}就是 url 佔位符。
url 支持佔位符是 spring3.0 之後加入的。是 springmvc 支持 rest 風格 URL 的一個重要標誌。

2、屬性

value：用於指定 url 中佔位符名稱。
required：是否必須提供佔位符。

<a href="anno/testPathVariable/10">@PathVariable註解</a>

	@RequestMapping(value = "/testPathVariable/{uid}")
    public String testPathVariable(@PathVariable(name = "uid") String id) {
        System.out.println("執行了......");
        System.out.println(id);
        return "success";
    }

五、@RequestHeader註解

1、作用

用於獲取請求消息頭。

2、屬性：

value：提供消息頭名稱
required：是否必須有此消息頭

<a href="anno/testRequestHeader">@RequestHeader註解</a>

	@RequestMapping(value = "/testRequestHeader")
    public String testRequestHeader(@RequestHeader(name = "Accept") String header) {
        System.out.println("執行了......");
        System.out.println(header);
        return "success";
    }

六、@CookieValue註解

1、作用

用於把指定 cookie 名稱的值傳入控制器方法參數。

2、屬性

value：指定 cookie 的名稱。
required：是否必須有此 cookie。

<a href="anno/testCookieValue">@CookieValue註解</a>

	@RequestMapping(value = "/testCookieValue")
    public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) {
        System.out.println("執行了......");
        System.out.println(cookieValue);
        return "success";
    }

七、@ModelAttribute註解

1、作用

該註解是 SpringMVC4.3 版本以後新加入的。它可以用於修飾方法和參數。
出現在方法上，表示當前方法會在控制器的方法執行之前，先執行。它可以修飾沒有返回值的方法，也可以修飾有具體返回值的方法。
出現在參數上，獲取指定的數據給參數賦值。

2、屬性

• value：用於獲取數據的 key。key 可以是 POJO 的屬性名稱，也可以是 map 結構的 key。

3、應用場景

當表單提交數據不是完整的實體類數據時，保證沒有提交數據的字段使用數據庫對象原來的數據。
例如：
我們在編輯一個用戶時，用戶有一個創建信息字段，該字段的值是不允許被修改的。在提交表單數據是肯定沒有此字段的內容，一旦更新會把該字段內容置爲 null，此時就可以使用此註解解決問題。

<form action="anno/testModelAttribute" method="post">
        姓名：<input type="text" name="name"><br>
        年齡：<input type="password" name="age"><br>
        <input type="submit" value="提交">
</form>

	@RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user) {
        System.out.println("testModelAttribute()執行了......");
        System.out.println(user);
        return "success";
    }
    @ModelAttribute
    public void ModelAttribute(String name, Map<String,User> map) {
        System.out.println("ModelAttribute()方法執行了......");
        // 模擬查詢數據庫
        User user = new User();
        user.setName(name);
        user.setAge(22);
        user.setDate(new Date());
        map.put("abc",user);
    }

八、@SessionAttributes註解

1、作用

用於多次執行控制器方法間的參數共享。

2、屬性

value：用於指定存入的屬性名稱
type：用於指定存入的數據類型。

3、示例

<a href="anno/testSessionAttributes">@SessionAttributes註解</a><br>
<a href="anno/getSessionAttributes">getSessionAttributes</a><br>
<a href="anno/delSessionAttributes">delSessionAttributes</a>

@Controller
@RequestMapping(path = "anno")
@SessionAttributes(value = {"msg"})        // 把msg=成功存入到session域中
public class AnnoController {
/**
     * 向session中存入值
     */
    @RequestMapping(value = "/testSessionAttributes")
    public String testSessionAttributes(Model model) {
        System.out.println("testSessionAttributes執行了......");
        // 底層會存儲到request域對象中
        model.addAttribute("msg","成功");

        System.out.println(model);
        return "success";
    }

    /**
     * 從session域中獲取值
     */
    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap) {
        System.out.println("testSessionAttributes執行了......");
        String msg = (String) modelMap.get("msg");
        System.out.println(msg);
        return "success";
    }

    /**
     * 清除數據
     */
    @RequestMapping(value = "/delSessionAttributes")
    public String delSessionAttributes(SessionStatus status) {
        System.out.println("delSessionAttributes執行了......");
        status.setComplete();
        return "success";
    }

}

success.jsp

	<h1>歡迎你的到來！</h1>
    ${requestScope.msg}
    ${sessionScope}