上一篇：SpringMVC架構的請求參數

下一篇：SpringMVC架構的傳回值及響應資料

文章目錄

1、RequestParam
2、RequestBody
3、PathVaribale
4、RequestHeader
5、CookieValue
6、ModelAttribute
7、SessionAttributes

1、RequestParam

RequestParam 注解的作用就是把請求中指定名稱的參數給控制器中的形參指派。

屬性	描述
value	請求參數中的名稱
required	請求參數中是否必須提供此參數，預設值是true，必須提供

示範如下：

/**
     * RequestParam注解的使用
     */
    @RequestMapping(value = "/testRequestParam")
    public String testRequestParam(@RequestParam(name = "username") String name,
                                   @RequestParam(name = "password", required = false) String pwd) {
        System.out.println("username:" + name);
        System.out.println("password:" + pwd);
        return "success";
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

2、RequestBody

RequestBody 注解的作用就是用于擷取請求體内容。直接使用得到是

key=value&key=value...

結構的資料。get 請求方式不适用，因為 get 請求是沒有請求體的，它把請求的參數都放入位址欄中了。

此注解常用來接收異步請求的參數，例如 JSON 。

屬性	描述
required	是否必須有請求體，預設值是true。為 true 時，get 請求方式會報錯。為 false，get 請求得到是 null

示範如下：

/**
     * RequestBody注解的使用
     */
    @RequestMapping(value = "/testRequestBody")
    public String testRequestBody(@RequestBody(required = false) String body) {
        System.out.println(body);
        return "success";
    }

<form action="anno/testRequestBody" method="post">
        username：<input type="text" name="username" /><br>
        password：<input type="text" name="password" /><br>
        <input type="submit" value="submit">
    </form>
    <a href="anno/testRequestBody?body=Atlantis">testRequestBody注解get請求</a>

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

3、PathVaribale

PathVaribale 注解的作用就是用于綁定 URL 中的占位符。例如：請求 URL 中

/delete/{id}

，這個

{id}

就是 URL 占位符。

URL 支援占位符是 Spring3.0 之後加入的。是 SpringMVC 支援 REST 風格 URL 的一個重要标志。

Restful 風格的 URL 指請求路徑一樣，但可以根據不同的請求方式去執行背景的不同方法。

屬性	描述
value	用于指定 url 中占位符名稱，同 name 屬性作用一緻
required	是否必須提供占位符

示範如下：

/**
     * PathVaribale注解的使用
     */
    @RequestMapping(value = "/testPathVaribale/{uid}")
    public String testPathVaribale(@PathVariable(value = "uid") String id) {
        System.out.println("id:" + id);
        return "success";
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

什麼是 REST?

REST（Representational State Transfer，簡稱 REST）描述了一個架構樣式的網絡系統，比如 web 應用程式。它首次出現在 2000 年 Roy Fielding 的博士論文中，他是 HTTP 規範的主要編寫者之一。在目前主流的三種 Web 服務互動方案中，REST 相比于 SOAP（Simple Object Access protocol，簡單對象通路協定）以及 XML-RPC 更加簡單明了，無論是對 URL 的處理還是對 Payload 的編碼，REST 都傾向于用更加簡單輕量的方法設計和實作。值得注意的是 REST 并沒有一個明确的标準，而更像是一種設計的風格。

它本身并沒有什麼實用性，其核心價值在于如何設計出符合 REST 風格的網絡接口。

restful 的優點

結構清晰、符合标準、易于了解、擴充友善，是以正得到越來越多網站的采用。

restful 的特性

①資源（ Resources）：網絡上的一個實體，或者說是網絡上的一個具體資訊。

它可以是一段文本、一張圖檔、一首歌曲、一種服務，總之就是一個具體的存在。可以用一個 URI（統一資源定位符）指向它，每種資源對應一個特定的 URI 。要擷取這個資源，通路它的 URI 就可以，是以 URI 即為每一個資源的獨一無二的識别符。

②表現層（ Representation）：把資源具體呈現出來的形式，叫做它的表現層（ Representation）。

比如，文本可以用 txt 格式表現，也可以用 HTML 格式、XML 格式、JSON 格式表現，甚至可以采用二進制格式。

③狀态轉化（ State Transfer）：每發出一個請求，就代表了用戶端和伺服器的一次互動過程。

HTTP 協定，是一個無狀态協定，即所有的狀态都儲存在伺服器端。是以，如果用戶端想要操作伺服器，必須通過某種手段，讓伺服器端發生 “狀态轉化 ”（ State Tran sfer）。而這種轉化是建立在表現層之上的，是以就是 “表現層狀态轉化 ”。

具體說，就是 HTTP 協定裡面，四個表示操作方式的動詞： GET、 POST、 PUT、DELETE。它們分别對應四種基本操作： GET 用來擷取資源， POST 用來建立資源， PUT 用來更新資源， DELETE 用來删除資源。

restful 的示例

/account/1 HTTP GET ：得到 id = 1 的 account

/account/1 HTTP DELETE：删除 id = 1 的 account

/account/1 HTTP PUT：更新 id = 1 的 account

/account HTTP POST：新增 account

基于 HiddentHttpMethodFilter 的示例（了解即可）

由于浏覽器 form 表單隻支援 GET 與 POST 請求，而 DELETE、PUT 等 method 并不支援，Spring3.0 添加了一個 HiddentHttpMethodFilter 過濾器，可以将浏覽器請求改為指定的請求方式，發送給我們的控制器方法，使得支援 GET、POST、PUT 與 DELETE 請求。

如何使用 HiddentHttpMethodFilter 過濾器？

第一步，在 web.xml 中配置該過濾器。

第二步，請求方式必須使用 post 請求。

第三步，按照要求提供_method 請求參數，該參數的取值就是我們需要的請求方式。

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

4、RequestHeader

RequestHeader注解的作用就是用于擷取請求消息頭。（在實際開發中一般不怎麼用）

屬性	描述
value	提供消息頭名稱
required	是否必須有此消息頭

示範如下：

/**
     * RequestHeader注解的使用
     */
    @RequestMapping(value = "/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value = "Accept") String header) {
        System.out.println("header:" + header);
        return "success";
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

5、CookieValue

CookieValue 注解的作用就是用于把指定 cookie 名稱的值傳入控制器方法參數。

屬性	描述
value	指定 cookie 的名稱
required	是否必須有此 cookie

示範如下：

/**
     * CookieValue注解的使用
     */
    @RequestMapping(value = "/testCookieValue")
    public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) {
        System.out.println("JSESSIONID:" + cookieValue);
        return "success";
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

6、ModelAttribute

ModelAttribute 注解是 SpringMVC4.3 版本以後新加入的，它可以用于修飾方法和參數。

出現在方法上，表示目前方法會在控制器的方法執行之前，先執行。它可以修飾沒有傳回值的方法，也可以修飾有具體傳回值的方法。

出現在參數上，擷取指定的資料給參數指派。

屬性	描述
value	用于擷取資料的 key。key 可以是 POJO 的屬性名稱，也可以是 map 結構的 key

應用場景：

當表單送出資料不是完整的實體類資料時，要保證沒有送出資料的字段使用資料庫對象原來的資料。簡單來說，我們在編輯一個使用者時，使用者有一個建立資訊字段，該字段的值是不允許被修改的。在送出表單資料是肯定沒有此字段的内容，一旦更新會把該字段内容置為 null，此時就可以使用此注解解決問題。

示範如下：

// JavaBean
public class User implements Serializable {
    private String username;
    private String password;
    private Integer age;
    private Date date;

	// 省略get、set和toString方法
}

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute() {
        System.out.println("testModelAttribute...");
        return "success";
    }

    /**
     * 被ModelAttribute修飾的方法，先被執行
     */
    @ModelAttribute
    public void showUser() {
        System.out.println("showUser...");
    }

<form action="anno/testModelAttribute" method="post">
        username：<input type="text" name="username" /><br>
        password：<input type="text" name="password" /><br>
        <input type="submit" value="submit">
    </form>

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

（1）ModelAttribute 修飾方法帶傳回值

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(User user) {
        System.out.println(user.toString());
        return "success";
    }

    /**
     * 被ModelAttribute修飾的方法，先被執行
     */
    @ModelAttribute
    public User showUser(String username,String password) {
        // 通過使用者名查詢資料庫（模拟）
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        user.setAge(23);
        user.setDate(new Date());
        return user;
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

（2）ModelAttribute 修飾方法不帶傳回值

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(@ModelAttribute(value = "newUser") User user) {
        System.out.println(user.toString());
        return "success";
    }

    /**
     * 被ModelAttribute修飾的方法，先被執行
     */
    @ModelAttribute
    public void showUser(String username, String password, Map<String, User> map) {
        // 通過使用者名查詢資料庫（模拟）
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        user.setAge(21);
        user.setDate(new Date());
        map.put("newUser", user);
    }

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

7、SessionAttributes

SessionAttributes 注解的作用就是用于多次執行控制器方法間的參數共享。

屬性	描述
value	用于指定存入的屬性名稱
type	用于指定存入的資料類型

示範如下：

@Controller
@RequestMapping(value = "/anno")
@SessionAttributes(value = {"user"}) //把user存入Session域中
public class AnnoController {
    /**
     * SessionAttributes注解的使用
     */
    @RequestMapping(value = "/setSessionAttributes")
    public String setSessionAttributes(Model model) {
        // model底層會把資料存儲到request域對象中
        model.addAttribute("user", "Atlantis");
        return "success";
    }

    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap) {
        String user = (String) modelMap.get("user");
        System.out.println("getSession:" + user);
        return "success";
    }

    @RequestMapping(value = "/delSessionAttributes")
    public String delSessionAttributes(SessionStatus status) {
        status.setComplete();
        return "success";
    }

<a href="anno/setSessionAttributes">設定Session</a>
    <a href="anno/getSessionAttributes">擷取Session</a>
    <a href="anno/delSessionAttributes">删除Session</a>

Request：${requestScope.user}<br>
    Session：${sessionScope.user}

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

SpringMVC架構的常用注解1、RequestParam2、RequestBody3、PathVaribale4、RequestHeader5、CookieValue6、ModelAttribute7、SessionAttributes

文章目錄

1、RequestParam

2、RequestBody

3、PathVaribale

4、RequestHeader

5、CookieValue

6、ModelAttribute

7、SessionAttributes

繼續閱讀

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

SpringMVC常見注釋的簡述

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法