feat: 添加网关全局异常处理器

Author: cadecode

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/enums/FrameErrorEnum.java

@@ -58,9 +58,18 @@ public int getStatus() {
     UPLOAD_FILE_FAIL(2002, "上传文件失败"),
     FILE_NOT_FOUND(2003, "文件未找到"),
 
-    // rpc
-    RPC_UNKNOWN_ERROR(3001, "RPC UNKNOWN 异常"),
-    RPC_UNWRAP_FAIL(3002, "RPC UNWRAP 失败"),
+    // cloud
+    RPC_UNKNOWN_ERROR(3001, "[RPC]UNKNOWN 异常"),
+    RPC_UNWRAP_FAIL(3002, "[RPC]UNWRAP 失败"),
+    GW_SVC_NOT_FOUND(3003, "[GW]服务未找到") {
+        @Override
+        public int getStatus() {
+            return ApiStatus.SERVER_UNAVAILABLE;
+        }
+    },
+    GW_RES_STATUS_ERROR(3004, "[GW]响应状态错误"),
+    GW_SVC_INTERNAL_ERROR(3005, "[GW]服务内部错误"),
+
     ;
 
     private final String code;

framework/framework_base/src/main/java/com/github/cadecode/uniboot/framework/base/feign/FeignErrorDecoder.java

@@ -48,7 +48,7 @@ public Exception decode(String methodKey, Response response) {
         // 构造 ApiErrorCode
         ApiErrorCode errorCode = getErrorCode(result, error);
         // 构造 moreInfo
-        String moreInfo = getMoreInfo(error);
+        String moreInfo = markMoreInfo(error);
         return ApiException.of(errorCode, moreInfo);
     }
 
@@ -75,9 +75,9 @@ public int getStatus() {
     }
 
     /**
-     * 根据 ErrorMessage 获取 moreInfo 字符串
+     * 获取 moreInfo 字符串，在前面加上 RPC 标记
      */
-    private String getMoreInfo(ErrorMessage error) {
+    private String markMoreInfo(ErrorMessage error) {
         String moreInfo = error.getMoreInfo();
         // 在 moreInfo 前段追加 RPC 标记
         if (!StrUtil.startWith(moreInfo, "[RPC]")) {

gateway/pom.xml

@@ -78,10 +78,6 @@
             <groupId>com.github.cadecode</groupId>
             <artifactId>uni-boot-framework-api</artifactId>
             <exclusions>
-                <exclusion>
-                    <groupId>com.github.cadecode</groupId>
-                    <artifactId>uni-boot-common-core</artifactId>
-                </exclusion>
                 <exclusion>
                     <groupId>com.github.cadecode</groupId>
                     <artifactId>uni-boot-common-plugin-cache</artifactId>
@@ -90,6 +86,10 @@
                     <groupId>com.github.cadecode</groupId>
                     <artifactId>uni-boot-common-plugin-log</artifactId>
                 </exclusion>
+                <exclusion>
+                    <groupId>org.springframework.boot</groupId>
+                    <artifactId>spring-boot-starter-web</artifactId>
+                </exclusion>
             </exclusions>
         </dependency>
         <dependency>

gateway/src/main/java/com/github/cadecode/uniboot/gateway/UniGatewayApplication.java

@@ -1,16 +1,19 @@
 package com.github.cadecode.uniboot.gateway;
 
+import com.github.cadecode.uniboot.common.core.extension.strategy.StrategyService;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.builder.SpringApplicationBuilder;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 import org.springframework.cloud.openfeign.EnableFeignClients;
 import org.springframework.context.annotation.EnableAspectJAutoProxy;
+import org.springframework.plugin.core.config.EnablePluginRegistries;
 
 /**
  * 启动类
  */
+@EnablePluginRegistries({StrategyService.class})
 @EnableFeignClients("com.github.cadecode")
 @EnableDiscoveryClient
 @EnableAspectJAutoProxy(exposeProxy = true)

gateway/src/main/java/com/github/cadecode/uniboot/gateway/handler/GlobalExceptionHandler.java

@@ -0,0 +1,70 @@
+package com.github.cadecode.uniboot.gateway.handler;
+
+import cn.hutool.core.util.ObjectUtil;
+import com.github.cadecode.uniboot.common.core.enums.ApiErrorCode;
+import com.github.cadecode.uniboot.common.core.util.JacksonUtil;
+import com.github.cadecode.uniboot.common.core.web.response.ApiResult;
+import com.github.cadecode.uniboot.framework.api.enums.FrameErrorEnum;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.web.reactive.error.ErrorWebExceptionHandler;
+import org.springframework.cloud.gateway.support.NotFoundException;
+import org.springframework.core.annotation.Order;
+import org.springframework.core.io.buffer.DataBuffer;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.server.reactive.ServerHttpResponse;
+import org.springframework.stereotype.Component;
+import org.springframework.web.server.ResponseStatusException;
+import org.springframework.web.server.ServerWebExchange;
+import reactor.core.publisher.Mono;
+
+/**
+ * 网关全局异常处理
+ *
+ * @author Cade Li
+ * @since 2023/8/11
+ */
+@Slf4j
+@Order(-1)
+@Component
+public class GlobalExceptionHandler implements ErrorWebExceptionHandler {
+
+    @Override
+    public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
+        ServerHttpResponse response = exchange.getResponse();
+        if (exchange.getResponse().isCommitted()) {
+            return Mono.error(ex);
+        }
+        ApiResult<Object> result = getApiResultFromEx(exchange, ex);
+        log.error("[GW]Exception handler=> status:{}, path:{}, msg:{},", result.getStatus(), result.getError().getPath(), result.getError().getMessage(), ex);
+        response.setStatusCode(HttpStatus.resolve(result.getStatus()));
+        response.getHeaders().add(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);
+        DataBuffer dataBuffer = response.bufferFactory().wrap(JacksonUtil.toJson(result).getBytes());
+        return response.writeWith(Mono.just(dataBuffer));
+    }
+
+    private ApiResult<Object> getApiResultFromEx(ServerWebExchange exchange, Throwable ex) {
+        String moreInfo = ex.getMessage();
+        String path = exchange.getRequest().getPath().toString();
+        Integer status = null;
+        ApiErrorCode errorCode;
+        // 服务未找到 503
+        if (ex instanceof NotFoundException) {
+            errorCode = FrameErrorEnum.GW_SVC_NOT_FOUND;
+        } else if (ex instanceof ResponseStatusException) {
+            // 响应状态异常
+            errorCode = FrameErrorEnum.GW_RES_STATUS_ERROR;
+            ResponseStatusException e = (ResponseStatusException) ex;
+            status = e.getStatus().value();
+        } else {
+            // 其他异常
+            errorCode = FrameErrorEnum.GW_SVC_INTERNAL_ERROR;
+        }
+        ApiResult<Object> result = ApiResult.error(errorCode).moreInfo(moreInfo).path(path);
+        if (ObjectUtil.isNotNull(status)) {
+            result.status(status);
+        }
+        return result;
+    }
+}