使用ResponseEntity處理API返回問題
最近在做Google AMP mail的時候遇到了一個問題，在調(diào)用/unsub（退訂）接口的時候需要向google client返回特定的ResponseHeader。
但是項目使用的是Springboot 2.x，通常使用@RestController修飾API層，無法做到動態(tài)的返回特殊的Header。那么如何對一些特殊的API做一些特別的返回值封裝呢？
Spring framework中的ResponseEntity類很好的解決了此問題。
眾所周知，我們的HTTP/HTTPS的響應由狀態(tài)碼、頭部信息以及響應體內(nèi)容三大塊組成，響應體內(nèi)容可以通過返回值進行一系列封裝回傳出結(jié)果，而狀態(tài)碼與頭部信息需要特別設置。
ResponseEntity的使用
先上源碼，看看ResponseEntity到底如何使用的。
1. ResponseEntity的第一種使用方式
public class ResponseEntity<T> extends HttpEntity<T> {
public ResponseEntity(HttpStatus status) {
this((Object)null, (MultiValueMap)null, (HttpStatus)status);
}
public ResponseEntity(@Nullable T body, HttpStatus status) {
this(body, (MultiValueMap)null, (HttpStatus)status);
}
public ResponseEntity(MultiValueMap<String, String> headers, HttpStatus status) {
this((Object)null, headers, (HttpStatus)status);
}
public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatus status) {
super(body, headers);
Assert.notNull(status, "HttpStatus must not be null");
this.status = status;
}
private ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, Object status) {
super(body, headers);
Assert.notNull(status, "HttpStatus must not be null");
this.status = status;
}
}可以看到這個類提供了五個構(gòu)造方法，返回的狀態(tài)碼是必傳的外，頭部信息以及響應體內(nèi)容都是可選擇的。
當我們需要使用的時候，直接new一個ResponseEntity對象作為API返回值即可，這就是它的第一種使用方式。
需要注意的是，在有headers作為參數(shù)的構(gòu)造方法中，需要傳入一個類型為MultiValueMap<String, String>的參數(shù)。
MultiValueMap繼承自Map這個抽象類，其中擁有一個叫做HttpHeaders的子類，我們可以當它為一個key和value都為String類型的HashMap使用。
HttpHeaders里面保存了一些常用的Header的key值，例如"Accept-Charset"。當然也可以自定義一些特殊的key。
HttpHeaders headers = new HttpHeaders();
headers.add("Access-Control-Expose-Headers", "AMP-Access-Control-Allow-Source-Origin");
return new ResponseEntity<>(resultBody, headers, HttpStatus.OK);2. ResponseEntity的第二種使用方式
繼續(xù)看源碼，發(fā)現(xiàn)了好多返回值為ResponseEntity.BodyBuilder的方法有木有
public static ResponseEntity.BodyBuilder status(HttpStatus status) {
Assert.notNull(status, "HttpStatus must not be null");
return new ResponseEntity.DefaultBuilder(status);
}
public static ResponseEntity.BodyBuilder status(int status) {
return new ResponseEntity.DefaultBuilder(status);
}
public static ResponseEntity.BodyBuilder ok() {
return status(HttpStatus.OK);
}
public static ResponseEntity.BodyBuilder created(URI location) {
ResponseEntity.BodyBuilder builder = status(HttpStatus.CREATED);
return (ResponseEntity.BodyBuilder)builder.location(location);
}
public static ResponseEntity.BodyBuilder accepted() {
return status(HttpStatus.ACCEPTED);
}
public static ResponseEntity.HeadersBuilder<?> noContent() {
return status(HttpStatus.NO_CONTENT);
}
public static ResponseEntity.BodyBuilder badRequest() {
return status(HttpStatus.BAD_REQUEST);
}
public static ResponseEntity.HeadersBuilder<?> notFound() {
return status(HttpStatus.NOT_FOUND);
}
public static ResponseEntity.BodyBuilder unprocessableEntity() {
return status(HttpStatus.UNPROCESSABLE_ENTITY);
}
.........事實證明，越是偉大的軟件工程師是越“懶惰”的，為了節(jié)約時間增加效率，我們可以用Builder的方式去生成ResponseEntity對象并返回：
Map<String, String> resultBody = new HashMap<>();
resultBody.put("name":"Lucas");
resultBody.put("school":"harvard university");
return ResponseEntity.status(HttpStatus.OK)
.body(resultBody);與其他方式對比
@RestController注解修飾controller層。
@RestController = @Controller + @ResponseBody
@ResponseBody是將controller的方法返回的對象通過適當?shù)霓D(zhuǎn)換器轉(zhuǎn)換為指定的格式之后，寫入到response對象的body區(qū)，通常用來返回JSON數(shù)據(jù)或者是XML數(shù)據(jù)。
注意：在使用此注解之后不會再走視圖處理器（ModelAndView），而是直接將數(shù)據(jù)寫入到輸入流中，他的效果等同于通過response對象輸出指定格式的數(shù)據(jù)。
@ResponseStatus
這個注解主要用在自定義的Exception 上，或者直接用在controller層的API方法上也可，當發(fā)生異常/方法執(zhí)行結(jié)束時，會返回相應的Http狀態(tài)碼和msg。
@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="不允許訪問")
注：
- ResponseEntity的優(yōu)先級高于@ResponseBody。
- 只有在返回值不為ResponseEntity的情況下才去檢查有沒有@ResponseBody注解；如果響應類型是ResponseEntity則會忽略@ResponseBody注解。
總結(jié)
ResponseEntity能夠非常方便的修改返回值的狀態(tài)碼，但最優(yōu)秀的用法仍然是能夠為不同API設置不同的返回響應頭。
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
常用校驗注解之@NotNull,@NotBlank,@NotEmpty的區(qū)別及說明
這篇文章主要介紹了常用校驗注解之@NotNull,@NotBlank,@NotEmpty的區(qū)別及說明,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
這篇文章主要介紹了springboot如何添加支付接口，幫助大家更好得理解和學習使用springboot框架，感興趣的朋友可以了解下2021-04-04
JRebel是一款JVM插件,它使得Java代碼修改后不用重啟系統(tǒng),立即生效,IDEA上原生是不支持熱部署的,一般更新了 Java 文件后要手動重啟 Tomcat 服務器,才能生效,浪費時間浪費生命,目前對于idea熱部署最好的解決方案就是安裝JRebel插件,本文分步驟介紹的非常詳細,一起看看吧2023-08-08
下面小編就為大家?guī)硪黄狫ava基礎(chǔ)的幾道練習題(分享)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧，希望可以幫到你2021-07-07
mybatis中insert主鍵ID獲取和多參數(shù)傳遞的示例代碼
這篇文章主要介紹了mybatis中insert主鍵ID獲取和多參數(shù)傳遞的示例代碼,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
Java使用wait和notify實現(xiàn)線程之間的通信
Java 線程通信是將多個獨立的線程個體進行關(guān)聯(lián)處理,使得線程與線程之間能進行相互通信,下面這篇文章主要給大家介紹了關(guān)于Java使用wait和notify實現(xiàn)線程之間通信的相關(guān)資料,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下2022-04-04
這篇文章主要為大家詳細介紹了Java集合繼承體系，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-11-11
mybatis如何使用Java8的日期LocalDate和LocalDateTime詳解
這篇文章主要給大家介紹了關(guān)于mybatis如何使用Java8的日期LocalDate和LocalDateTime的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧。2017-09-09
這篇文章主要介紹了Java實現(xiàn)郵件發(fā)送的過程及代碼詳解，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-07-07
下面小編就為大家?guī)硪黄猨ava隨機數(shù)生產(chǎn)算法實例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-10-10