SpringMVC HttpMessageConverter報文信息轉換器

Posted on 2022-05-28 by WalkonNet

SpringMVC HttpMessageConverter報文信息轉換器

HttpMessageConverter 是報文信息轉換器，作用有 2 個：

將請求報文轉換為Java對象：請求報文是從瀏覽器發送到服務器，發送到服務器中就是 request 對象

將Java對象轉換為響應報文：響應報文是服務器響應給瀏覽器的，服務器中用的java，瀏覽器不能解析java，所以要轉換成響應報文給瀏覽器。

其中，HttpMessageConverter 提供瞭兩個註解：@RequestBody，@ResponseBody。還有兩個類型：RequestEntity，ResponseEntity。

最常用的還是用來將Java對象轉換為響應報文的兩個：@ResponseBody和ResponseEntity。

至於獲取請求參數，或者請求頭什麼的，前面已經有過好幾種方法瞭，沒必要再使用這裡的 @RequestBody 和 RequestEntity。

一、@RequestBody

@RequestBody可以獲取請求體，需要在控制器方法設置一個形參，使用@RequestBody進行標識，當前請求的請求體就會為當前註解所標識的形參賦值。

比如這有一個頁面表單，用來發送請求。

<form th:action="@{/testRequestBody}" method="post">
    用戶名：<input type="text" name="username">
    密碼：<input type="password" name="password">
    <input type="submit">
</form>

對應的有個控制器處理這個請求：

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody){
    System.out.println("requestBody:"+requestBody);
    return "success";
}

這裡要補充一個 success.html 以供跳轉。

然後我們在表單中輸入 username=admin，password=123456，提交後，查看控制臺的輸出：

requestBody:username=admin&password=123456

username=admin&password=123456這個就是請求體的內容瞭。

二、RequestEntity

RequestEntity是封裝請求報文的一種類型，包含瞭請求頭和請求體。

使用時，需要在控制器方法的形參中設置該類型的形參，當前請求的請求報文就會賦值給該形參。

接著，就可以通過getHeaders()獲取請求頭信息，通過getBody()獲取請求體信息。

復制一下上面的表單，請求地址換一下：

<form th:action="@{/testRequestEntity}" method="post">
    用戶名：<input type="text" name="username"><br>
    密碼：<input type="password" name="password"><br>
    <input type="submit">
</form>

然後補充一個控制器方法：

@RequestMapping("/testRequestEntity")
    public String testRequestEntity(RequestEntity<String> requestEntity){
        System.out.println("請求頭:"+requestEntity.getHeaders());
        System.out.println("請求體:"+requestEntity.getBody());
        return "success";
    }

輸入表單提交測試一下：

三、@ResponseBody

1.不使用 @ResponseBody

在不使用@ResponseBody這個註解的時候，使用servlet api 中 HttpServletResponse 也是可以響應給瀏覽器的。

比如：

@RequestMapping("/testResponse")
    public void testResponse(HttpServletResponse response) throws IOException {
        response.getWriter().print("hello, response");
    }

前端寫一個超鏈接測試一下：

<a th:href="@{/testResponse}" rel="external nofollow" >使用HttpServletResponse響應瀏覽器</a>

點擊超鏈接。

2.使用 @ResponseBody

使用@ResponseBody則可以標識一個控制器方法，可以將該方法的返回值直接作為響應報文的響應體響應到瀏覽器。

@RequestMapping("/testResponseBody")
    @ResponseBody
    public String testResponseBody(){
        return "success";
    }

這裡的控制器方法增加瞭@ResponseBody：

如果沒有這個註解，返回的 "success"，會匹配要跳轉的頁面。
加上之後， "success"則不再代表視圖名稱，而是直接返回給瀏覽器的響應體。

繼續增加超鏈接測試一下：

<a th:href="@{/testResponseBody}" rel="external nofollow" >使用 @testResponseBody 響應瀏覽器</a>

註意，為瞭區分效果，success.html 裡我修改下內容：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>這是 success.html 頁面</h1>
</body>
</html>

OK，現在點擊超鏈接，頁面顯示 success。

接著，我去掉控制器裡的 @ResponseBody，再重新部署點擊超鏈接試試。

跳轉到瞭 success.html 頁面。

所以，使用@ResponseBody還是很方便的，我們需要返回給瀏覽器什麼數據，直接在控制器方法裡 return 即可。

3. springMVC 處理 json

上面示例響應的是個字符串，對於瀏覽器來說就直接顯示瞭。如果我要響應一個對象呢？

比如，新建一個 User 類，設置好構造方法，set 和 get：

public class User {
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
... ...

編寫控制器：

@RequestMapping("/testResponseUser")
    @ResponseBody
    public User testResponseUser() {
        return new User(1001, "大周", "123456", 11, "男");
    }

直接返回一個 User 對象。

為瞭測試，繼續在前端頁面增加一個超鏈接：

<a th:href="@{/testResponseUser}" rel="external nofollow" >響應瀏覽器User對象</a>

重新部署，點擊測試，報錯瞭。

這裡還需要轉換的步驟，把 User 對象轉換成 json 格式的字符串。

在 pom.xml 中加入依賴 jackson：

<!--對象轉化json 響應給瀏覽器-->
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.12.1</version>
    </dependency>

另外，檢查一下 springMVC.xml 配置文件中的註解驅動是否開啟：

<!--開啟 mvc 的註解驅動-->
    <mvc:annotation-driven />

重新部署，點擊超鏈接。

響應正常。

4. springMVC 處理 ajax

使用ajax發送請求，跟上面點擊超鏈接發送請，也隻是發送請求方式不同而已，對於服務器來說，都是一樣處理。

ajax的優點就是頁面不刷新的情況下，可以與服務器進行交互。

繼續在前端頁面增加內容，新增一個超鏈接，綁定一個點擊事件@click：

<div id="app">
	<a th:href="@{/testAjax}" rel="external nofollow"  @click="testAjax">springMVC 處理ajax</a><br>
</div>

這裡需要用到靜態資源 vue.min.js 和 axios.min.js，下載後放到webapp\static\js下。

通過vue和axios處理點擊事件：

<!--引入-->
<script type="text/javascript" th:src="@{/static/js/vue.min.js}"></script>
<script type="text/javascript" th:src="@{/static/js/axios.min.js}"></script>
<script>
    new Vue({
        el: "#app",
        methods: {
            testAjax: function (event) {
                axios({
                    method: "post",
                    url: event.target.href,
                    params: {
                        username: "admin",
                        password: "123456"
                    }
                }).then(function (response) {
                //    請求處理成功後要執行的
                    alert(response.data)  // response.data 獲取到響應的數據
                });
                event.preventDefault();  // 取消超鏈接的默認行為
            }
        }
    });
</script>

增加對於的請求控制器：

@RequestMapping("/testAjax")
    @ResponseBody
    public String testAjax(String username, String password) {
        System.out.println("username:" + username + ",password:" + password);
        return "hello, Ajax";
    }

重新部署之前，記得maven 重新打包一下。

另外，springMVC 配置文件中記得放開靜態資源的訪問：

<!--放開靜態資源的訪問-->
    <mvc:default-servlet-handler />

重新部署，點擊超鏈接。

四、@RestController 註解

這是以後會經常用的註解。

@RestController註解是 springMVC 提供的一個復合註解。

標識在控制器的類上，就相當於為類添加瞭@Controller註解，並且為其中的每個方法添加瞭@ResponseBody註解。

五、ResponseEntity

ResponseEntity用於控制器方法的返回值類型。

該控制器方法的返回值就是響應到瀏覽器的響應報文，後面的下載上傳文件的示例中會使用到。

以上就是SpringMVC HttpMessageConverter報文信息轉換器的詳細內容，更多關於SpringMVC HttpMessageConverter的資料請關註WalkonNet其它相關文章！

SpringMVC HttpMessageConverter報文信息轉換器

目錄