HttpMessageConverter報文信息轉換器的深入講解

Posted on by

前言

HttpMessageConverter，報文信息轉換器，將請求報文轉換為Java對象，或將Java對象轉換為響應報文。

HttpMessageConverter提供瞭兩個註解和兩個類型：@RequestBody，@ResponseBody，RequestEntity，ResponseEntity。

HttpMessageConverter 介紹

org.springframework.http.converter.HttpMessageConverter 是一個策略接口，接口說明如下：

Strategy interface that specifies a converter that can convert from and to HTTP requests and responses. 簡單說就是 HTTP request (請求)和response (響應)的轉換器。該接口有隻有5個方法，簡單來說就是獲取支持的 MediaType（application/json之類），接收到請求時判斷是否能讀（canRead），能讀則讀（read）；返回結果時判斷是否能寫（canWrite），能寫則寫（write）。這幾個方法先有個印象即可：

boolean canRead(Class<?> clazz, MediaType mediaType);
boolean canWrite(Class<?> clazz, MediaType mediaType);
List<MediaType> getSupportedMediaTypes();
T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
void write(T t, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

一、@RequestBody 請求體註解

@RequestBody可以獲取請求體，需要在控制器方法設置一個形參。

使用@RequestBody進行標識，當前請求的請求體就會為當前註解所標識的形參賦值。

1.1、表單提交模擬

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

1.2、控制器方法示例

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

輸出結果：

requestBody:username=admin&password=123456

二、RequestEntity 請求封裝對象

RequestEntity 封裝請求報文的一種類型，需要在控制器方法的形參中設置該類型的形參，當前請求的請求報文就會賦值給該形參。

  • 通過getHeaders()獲取請求頭信息
  • 通過getBody()獲取請求體信息

2.1、控制器方式示例

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

2.2、輸出結果

requestHeader:[host:"localhost:8080", connection:"keep-alive", content-length:"27", cache-control:"max-age=0", sec-ch-ua:"" Not A;Brand";v="99", "Chromium";v="90", "Google Chrome";v="90"", sec-ch-ua-mobile:"?0", upgrade-insecure-requests:"1", origin:"http://localhost:8080", user-agent:"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36"] requestBody:username=admin&password=123

三、@ResponseBody 響應體註解

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

3.1、控制器方式示例

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

結果：瀏覽器頁面顯示 success

3.2、SpringMVC 添加Json格式轉換器

首先：導入jackson的依賴

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.1</version>
</dependency>

然後：在SpringMVC的核心配置文件中開啟mvc的註解驅動。

此時在HandlerAdaptor中會自動裝配一個消息轉換器：MappingJackson2HttpMessageConverter，可以將響應到瀏覽器的Java對象轉換為Json格式的字符串。

<mvc:annotation-driven />

3.3、控制器使用 Json 格式轉換器示例

在處理器方法上使用 @ResponseBody 註解進行標識。

將Java對象直接作為控制器方法的返回值返回，就會自動轉換為Json格式的字符串

@RequestMapping("/testResponseUser")
@ResponseBody
public User testResponseUser(){
    return new User(1001,"admin","123456",23,"男");
}

瀏覽器的頁面中展示的結果：

{"id":1001,"username":"admin","password":"123456","age":23,"sex":"男"}

3.4、@RestController註解

@RestController註解是springMVC提供的一個復合註解，標識在控制器的類上。

相當於為類添加瞭@Controller註解，並且為其中的每個方法添加瞭@ResponseBody註解。

四、ResponseEntity 響應封裝對象

ResponseEntity 用於控制器方法的返回值類型，該控制器方法的返回值就是響應到瀏覽器的響應報文。

總結

到此這篇關於HttpMessageConverter報文信息轉換器的文章就介紹到這瞭,更多相關HttpMessageConverter報文信息轉換器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：