歡迎訪問我的GitHub

這里分類和匯總了欣宸的全部原創(chuàng)(含配套源碼)：https://github.com/zq2599/blog_demos

本篇概覽

• Spring Cloud Gateway應(yīng)用中，處理請求時(shí)若發(fā)生異常未被捕獲行楞，請求方收到的響應(yīng)是系統(tǒng)默認(rèn)的內(nèi)容迁匠，無法滿足實(shí)際業(yè)務(wù)需求

• 因此橘蜜，從前一篇文章《Spring Cloud Gateway過濾器精確控制異常返回(分析篇)》開始，咱們深入分析了Spring Cloud Gateway的相關(guān)源碼垄分，了解到全局異常的處理細(xì)節(jié)宛篇，然后，通過前文《Spring Cloud Gateway過濾器精確控制異常返回(實(shí)戰(zhàn)薄湿，控制http返回碼和message字段)》的實(shí)戰(zhàn)叫倍，咱們已經(jīng)能隨意設(shè)置http返回碼偷卧，以及body中的message字段，也就是控制下圖兩個紅框中的內(nèi)容：

在這里插入圖片描述

• 正如上圖所示吆倦，異常發(fā)生時(shí)系統(tǒng)固定返回8個字段听诸，這就有些不夠靈活了，在一些對格式和內(nèi)容有嚴(yán)格要求的場景下蚕泽，咱們需要能夠完全控制返回碼和返回body的內(nèi)容蛇更，如下所示，只返回三個字段赛糟，每個字段都是完全為業(yè)務(wù)服務(wù)的：

{
    # 這是有具體業(yè)務(wù)含義的返回碼
    "code": "010020003",

    # 這是能精確描述錯誤原因的文本信息
    "message": "請確保請求參數(shù)中的user-id字段是有效的",
    
    # 這是常規(guī)的業(yè)務(wù)數(shù)據(jù)派任，發(fā)生異常時(shí)該字段為空
    "data": null
}

• 今天咱們的目標(biāo)就是通過編碼定制異常發(fā)生時(shí)的返回信息，具體內(nèi)容就是上述JSON數(shù)據(jù)：只有code璧南、message掌逛、data三個字段

源碼下載

• 本篇實(shí)戰(zhàn)中的完整源碼可在GitHub下載到，地址和鏈接信息如下表所示(https://github.com/zq2599/blog_demos)：

• 這個git項(xiàng)目中有多個文件夾，本篇的源碼在<font color="blue">spring-cloud-tutorials</font>文件夾下动知，如下圖紅框所示：

在這里插入圖片描述

• <font color="blue">spring-cloud-tutorials</font>文件夾下有多個子工程皿伺，本篇的代碼是<font color="red">gateway-change-body</font>，如下圖紅框所示：

在這里插入圖片描述

為何不用常規(guī)手段

• 提到全局異常處理盒粮，經(jīng)驗(yàn)豐富的您應(yīng)該想到了常用的ControllerAdvice和ExceptionHandler注解修飾的全局異常處理類鸵鸥，但是Spring Cloud Gateway是基于WebFlux的，咱們之前處理異常時(shí)用到的HttpServletRequest在Spring Cloud Gateway中并不適用丹皱，因此妒穴，不能用ControllerAdvice和ExceptionHandler的手段來處理全局異常

基本思路

• 在動手前做好充足的理論分析，寫出的代碼才能正常工作

• 打開DefaultErrorWebExceptionHandler.java摊崭，找到renderErrorResponse方法讼油，來看看Spring Cloud Gateway原本是如何構(gòu)造異常返回內(nèi)容的：

在這里插入圖片描述

• 此刻聰明的您應(yīng)該想到怎么做了：做個新的類繼承DefaultErrorWebExceptionHandler，覆蓋其renderErrorResponse方法呢簸，新的renderErrorResponse方法中矮台，按照實(shí)際業(yè)務(wù)需要來設(shè)置返回內(nèi)容，沒錯根时，這就是咱們的思路瘦赫，不過還要細(xì)化一下，最終具體的步驟如下：

1. 新增一個異常類<font color="blue">CustomizeInfoException.java</font>啸箫，該類有三個字段：http返回碼耸彪、業(yè)務(wù)返回碼、業(yè)務(wù)描述信息

2. 在返回異常的代碼位置忘苛，使用CustomizeInfoException類來拋出異常蝉娜，按照實(shí)際業(yè)務(wù)場景設(shè)置CustomizeInfoException實(shí)例的各個字段

3. 新增MyErrorWebExceptionHandler.java唱较，繼承自DefaultErrorWebExceptionHandler，重寫了renderErrorResponse方法召川，這里面檢查異常實(shí)例是否是CustomizeInfoException類型南缓，如果是，就從其中取出http返回碼荧呐、業(yè)務(wù)返回碼汉形、業(yè)務(wù)描述信息等字段，構(gòu)造返回body的內(nèi)容倍阐，異常實(shí)例若不是CustomizeInfoException類型概疆，就保持之前的處理邏輯不變；

4. 新增configuration類峰搪，用于將MyErrorWebExceptionHandler實(shí)例注冊到spring環(huán)境

• 分析完畢岔冀，開始編碼吧，為了簡單起見概耻，本篇不再新增maven子工程使套，而是基于前文創(chuàng)建的子工程<font color="red">gateway-change-body</font>，在這里面繼續(xù)寫代碼鞠柄；

編碼

• 新增異常類<font color="blue">CustomizeInfoException.java</font>：

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字段(業(yè)務(wù)返回碼)
     */
    private String code;

    /**
     * body中的message字段(業(yè)務(wù)返回信息)
     */
    private String message;
}

• 修改RequestBodyRewrite.java的apply方法侦高，這里面是在處理請求body，如果檢查到?jīng)]有<font color="blue">user-id</font>字段厌杜，就不將請求轉(zhuǎn)發(fā)到服務(wù)提供方<font color="blue">provider-hello</font>奉呛，而是返回錯誤，這里的錯誤就用CustomizeInfoException類來處理：

@Override
    public Publisher<String> apply(ServerWebExchange exchange, String body) {
        try {
            Map<String, Object> map = objectMapper.readValue(body, Map.class);

            // 如果請求參數(shù)中不含user-id期奔，就返回異常
            if (!map.containsKey("user-id")) {
                CustomizeInfoException customizeInfoException = new CustomizeInfoException();
                // 這里返回406侧馅，您可以按照業(yè)務(wù)需要自行調(diào)整
                customizeInfoException.setHttpStatus(HttpStatus.NOT_ACCEPTABLE);

                // 這里按照業(yè)務(wù)需要自行設(shè)置code
                customizeInfoException.setCode("010020003");

                // 這里按照業(yè)務(wù)需要自行設(shè)置返回的message
                customizeInfoException.setMessage("請確保請求參數(shù)中的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危尿，這里有一處需要<font color="red">重點(diǎn)關(guān)注的是：</font>下面的代碼僅是參考而已呐萌，您無需拘泥于CustomizeInfoException有關(guān)的邏輯，完全能按照業(yè)務(wù)需求自由設(shè)置返回的狀態(tài)碼和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來生成響應(yīng)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實(shí)例中獲取
            status = myGatewayException.getHttpStatus().value();
            responseBodyMap.put("code", myGatewayException.getCode());
            responseBodyMap.put("message", myGatewayException.getMessage());
            responseBodyMap.put("data", null);
        } else {
            // 如果不是咱們定制的異常，就維持和父類一樣的邏輯
            // 返回碼
            status = getHttpStatus(error);
            // body內(nèi)容
            responseBodyMap.putAll(error);
        }

        return ServerResponse
                // http返回碼
                .status(status)
                // 類型和以前一樣
                .contentType(MediaType.APPLICATION_JSON)
                // 響應(yīng)body的內(nèi)容
                .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;
    }
}

• 編碼完成法褥，該把程序運(yùn)行起來驗(yàn)證效果了茫叭；

驗(yàn)證

• 啟動應(yīng)用gateway-change-body

• 用postman發(fā)起POST請求，地址是<font color="blue">http://localhost:8081/hello/change</font>半等，如下圖揍愁，紅框2中的http返回碼是咱們代碼里設(shè)置的呐萨，紅框3顯示返回的內(nèi)容就是咱們定制的那三個字段：

在這里插入圖片描述

• 至此，控制Spring Cloud Gateway應(yīng)用異常返回的實(shí)戰(zhàn)已經(jīng)全部完成莽囤，從源碼分析結(jié)合實(shí)戰(zhàn)演練谬擦，希望欣宸的文章能陪伴您深入了解Spring Cloud Gateway，打造出更加強(qiáng)大的網(wǎng)關(guān)應(yīng)用朽缎；

你不孤單惨远，欣宸原創(chuàng)一路相伴

1. Java系列
2. Spring系列
3. Docker系列
4. kubernetes系列
5. 數(shù)據(jù)庫+中間件系列
6. DevOps系列

歡迎關(guān)注公眾號：程序員欣宸

微信搜索「程序員欣宸」，我是欣宸话肖，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos