Spring Cloud Gateway過濾器精確控制異常返回(實戰，完全訂製返回body)
- 2021 年 12 月 1 日
- 筆記
歡迎訪問我的GitHub
這裡分類和匯總了欣宸的全部原創(含配套源碼)：//github.com/zq2599/blog_demos
本篇概覽
-
Spring Cloud Gateway應用中，處理請求時若發生異常未被捕獲，請求方收到的響應是系統默認的內容，無法滿足實際業務需求
-
因此，從前一篇文章《Spring Cloud Gateway過濾器精確控制異常返回(分析篇)》開始，咱們深入分析了Spring Cloud Gateway的相關源碼，了解到全局異常的處理細節，然後，通過前文《Spring Cloud Gateway過濾器精確控制異常返回(實戰，控制http返回碼和message欄位)》的實戰，咱們已經能隨意設置http返回碼，以及body中的message欄位，也就是控制下圖兩個紅框中的內容：
- 正如上圖所示，異常發生時系統固定返回8個欄位，這就有些不夠靈活了，在一些對格式和內容有嚴格要求的場景下，咱們需要能夠完全控制返回碼和返回body的內容，如下所示，只返回三個欄位，每個欄位都是完全為業務服務的：
{
# 這是有具體業務含義的返回碼
"code": "010020003",
# 這是能精確描述錯誤原因的文本資訊
"message": "請確保請求參數中的user-id欄位是有效的",
# 這是常規的業務數據，發生異常時該欄位為空
"data": null
}
- 今天咱們的目標就是通過編碼訂製異常發生時的返回資訊，具體內容就是上述JSON數據：只有code、message、data三個欄位
源碼下載
- 本篇實戰中的完整源碼可在GitHub下載到，地址和鏈接資訊如下表所示(//github.com/zq2599/blog_demos)：
| 名稱 | 鏈接 | 備註 |
|---|---|---|
| 項目主頁 | //github.com/zq2599/blog_demos | 該項目在GitHub上的主頁 |
| git倉庫地址(https) | //github.com/zq2599/blog_demos.git | 該項目源碼的倉庫地址，https協議 |
| git倉庫地址(ssh) | [email protected]:zq2599/blog_demos.git | 該項目源碼的倉庫地址，ssh協議 |
- 這個git項目中有多個文件夾，本篇的源碼在spring-cloud-tutorials文件夾下，如下圖紅框所示：
- spring-cloud-tutorials文件夾下有多個子工程，本篇的程式碼是gateway-change-body，如下圖紅框所示：
為何不用常規手段
- 提到全局異常處理，經驗豐富的您應該想到了常用的ControllerAdvice和ExceptionHandler註解修飾的全局異常處理類，但是Spring Cloud Gateway是基於WebFlux的，咱們之前處理異常時用到的HttpServletRequest在Spring Cloud Gateway中並不適用，因此，不能用ControllerAdvice和ExceptionHandler的手段來處理全局異常
基本思路
-
在動手前做好充足的理論分析，寫出的程式碼才能正常工作
-
打開DefaultErrorWebExceptionHandler.java，找到renderErrorResponse方法，來看看Spring Cloud Gateway原本是如何構造異常返回內容的：
- 此刻聰明的您應該想到怎麼做了：做個新的類繼承DefaultErrorWebExceptionHandler，覆蓋其renderErrorResponse方法，新的renderErrorResponse方法中，按照實際業務需要來設置返回內容，沒錯，這就是咱們的思路，不過還要細化一下，最終具體的步驟如下：
-
新增一個異常類CustomizeInfoException.java，該類有三個欄位：http返回碼、業務返回碼、業務描述資訊
-
在返回異常的程式碼位置，使用CustomizeInfoException類來拋出異常，按照實際業務場景設置CustomizeInfoException實例的各個欄位
-
新增MyErrorWebExceptionHandler.java，繼承自DefaultErrorWebExceptionHandler，重寫了renderErrorResponse方法，這裡面檢查異常實例是否是CustomizeInfoException類型，如果是，就從其中取出http返回碼、業務返回碼、業務描述資訊等欄位，構造返回body的內容，異常實例若不是CustomizeInfoException類型，就保持之前的處理邏輯不變；
-
新增configuration類，用於將MyErrorWebExceptionHandler實例註冊到spring環境
- 分析完畢，開始編碼吧，為了簡單起見，本篇不再新增maven子工程，而是基於前文創建的子工程gateway-change-body，在這裡面繼續寫程式碼；
編碼
- 新增異常類CustomizeInfoException.java：
package com.bolingcavalry.changebody.exception;
import lombok.Data;
import org.springframework.http.HttpStatus;
@Data
public class CustomizeInfoException extends Exception {
/**
* http返回碼
*/
private HttpStatus httpStatus;
/**
* body中的code欄位(業務返回碼)
*/
private String code;
/**
* body中的message欄位(業務返回資訊)
*/
private String message;
}
- 修改RequestBodyRewrite.java的apply方法，這裡面是在處理請求body，如果檢查到沒有user-id欄位，就不將請求轉發到服務提供方provider-hello，而是返回錯誤，這裡的錯誤就用CustomizeInfoException類來處理：
@Override
public Publisher<String> apply(ServerWebExchange exchange, String body) {
try {
Map<String, Object> map = objectMapper.readValue(body, Map.class);
// 如果請求參數中不含user-id，就返回異常
if (!map.containsKey("user-id")) {
CustomizeInfoException customizeInfoException = new CustomizeInfoException();
// 這裡返回406，您可以按照業務需要自行調整
customizeInfoException.setHttpStatus(HttpStatus.NOT_ACCEPTABLE);
// 這裡按照業務需要自行設置code
customizeInfoException.setCode("010020003");
// 這裡按照業務需要自行設置返回的message
customizeInfoException.setMessage("請確保請求參數中的user-id欄位是有效的");
return Mono.error(customizeInfoException);
}
// 取得id
int userId = (Integer)map.get("user-id");
// 得到nanme後寫入map
map.put("user-name", mockUserName(userId));
return Mono.just(objectMapper.writeValueAsString(map));
} catch (Exception ex) {
log.error("1. json process fail", ex);
return Mono.error(new Exception("1. json process fail", ex));
}
}
- 異常處理類MyErrorWebExceptionHandler.java，這裡有一處需要重點關注的是：下面的程式碼僅是參考而已，您無需拘泥於CustomizeInfoException有關的邏輯，完全能按照業務需求自由設置返回的狀態碼和body：
package com.bolingcavalry.changebody.handler;
import com.bolingcavalry.changebody.exception.CustomizeInfoException;
import org.springframework.boot.autoconfigure.web.ErrorProperties;
import org.springframework.boot.autoconfigure.web.WebProperties;
import org.springframework.boot.autoconfigure.web.reactive.error.DefaultErrorWebExceptionHandler;
import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.context.ApplicationContext;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;
import java.util.HashMap;
import java.util.Map;
public class MyErrorWebExceptionHandler extends DefaultErrorWebExceptionHandler {
public MyErrorWebExceptionHandler(ErrorAttributes errorAttributes, WebProperties.Resources resources, ErrorProperties errorProperties, ApplicationContext applicationContext) {
super(errorAttributes, resources, errorProperties, applicationContext);
}
@Override
protected Mono<ServerResponse> renderErrorResponse(ServerRequest request) {
// 返回碼
int status;
// 最終是用responseBodyMap來生成響應body的
Map<String, Object> responseBodyMap = new HashMap<>();
// 這裡和父類的做法一樣，取得DefaultErrorAttributes整理出來的所有異常資訊
Map<String, Object> error = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
// 原始的異常資訊可以用getError方法取得
Throwable throwable = getError(request);
// 如果異常類是咱們訂製的，就訂製
if (throwable instanceof CustomizeInfoException) {
CustomizeInfoException myGatewayException = (CustomizeInfoException) throwable;
// http返回碼、body的code欄位、body的message欄位，這三個資訊都從CustomizeInfoException實例中獲取
status = myGatewayException.getHttpStatus().value();
responseBodyMap.put("code", myGatewayException.getCode());
responseBodyMap.put("message", myGatewayException.getMessage());
responseBodyMap.put("data", null);
} else {
// 如果不是咱們訂製的異常，就維持和父類一樣的邏輯
// 返回碼
status = getHttpStatus(error);
// body內容
responseBodyMap.putAll(error);
}
return ServerResponse
// http返回碼
.status(status)
// 類型和以前一樣
.contentType(MediaType.APPLICATION_JSON)
// 響應body的內容
.body(BodyInserters.fromValue(responseBodyMap));
}
}
- 最後是配置類MyErrorWebFluxAutoConfiguration.java：
package com.bolingcavalry.changebody.config;
import com.bolingcavalry.changebody.handler.MyErrorWebExceptionHandler;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.boot.autoconfigure.web.WebProperties;
import org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.boot.web.reactive.error.ErrorWebExceptionHandler;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.http.codec.ServerCodecConfigurer;
import org.springframework.web.reactive.config.WebFluxConfigurer;
import org.springframework.web.reactive.result.view.ViewResolver;
import java.util.stream.Collectors;
@Configuration(proxyBeanMethods = false)
@AutoConfigureBefore(WebFluxAutoConfiguration.class)
public class MyErrorWebFluxAutoConfiguration {
private final ServerProperties serverProperties;
public MyErrorWebFluxAutoConfiguration(ServerProperties serverProperties) {
this.serverProperties = serverProperties;
}
@Bean
@Order(-1)
public ErrorWebExceptionHandler errorWebExceptionHandler(ErrorAttributes errorAttributes,
org.springframework.boot.autoconfigure.web.ResourceProperties resourceProperties,
WebProperties webProperties, ObjectProvider<ViewResolver> viewResolvers,
ServerCodecConfigurer serverCodecConfigurer, ApplicationContext applicationContext) {
MyErrorWebExceptionHandler exceptionHandler = new MyErrorWebExceptionHandler(errorAttributes,
resourceProperties.hasBeenCustomized() ? resourceProperties : webProperties.getResources(),
this.serverProperties.getError(), applicationContext);
exceptionHandler.setViewResolvers(viewResolvers.orderedStream().collect(Collectors.toList()));
exceptionHandler.setMessageWriters(serverCodecConfigurer.getWriters());
exceptionHandler.setMessageReaders(serverCodecConfigurer.getReaders());
return exceptionHandler;
}
}
- 編碼完成，該把程式運行起來驗證效果了；
驗證
-
啟動應用gateway-change-body
-
用postman發起POST請求，地址是//localhost:8081/hello/change，如下圖，紅框2中的http返回碼是咱們程式碼里設置的，紅框3顯示返回的內容就是咱們訂製的那三個欄位：
- 至此，控制Spring Cloud Gateway應用異常返回的實戰已經全部完成，從源碼分析結合實戰演練，希望欣宸的文章能陪伴您深入了解Spring Cloud Gateway，打造出更加強大的網關應用；
你不孤單，欣宸原創一路相伴
歡迎關注公眾號：程式設計師欣宸
微信搜索「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界…
//github.com/zq2599/blog_demos
