【feign】重写OpenFeign的ErrorDecoder获取服务提供方抛出的原始异常信息

最新推荐文章于 2024-05-24 16:07:16 发布

hkk666123

最新推荐文章于 2024-05-24 16:07:16 发布

阅读量5k

点赞数 1

分类专栏： Feign SpringCloud 文章标签： OpenFeign统一异常处理 OpenFeign获取原始异常 feign服务提供方原始异常

本文链接：https://blog.csdn.net/hkk666123/article/details/115290796

版权

Feign 同时被 2 个专栏收录

13 篇文章 2 订阅

订阅专栏

SpringCloud

10 篇文章 0 订阅

订阅专栏

文章目录

概述

在构建微服务的过程中, 我们时常会需要借助 Spring Cloud Open Feign 组件调用第三方依赖服务. 当服务提供方响应为非 2xx 状态码时, feign调用将会抛出FeignException. 由于其异常message经过了Feint的封装, 所以不再是服务提供方的原始异常信息. 若想展示原始信息则需要重写ErrorDecoder来实现, 下面介绍重写的两种方式:

重写ErrorDecoder
重写ErrorDecoder.Default

源码分析

通过对AsyncResponseHandler#handleResponse()及feign.FeignException#errorStatus(java.lang.String, feign.Response)可以得知: feingClient.method方法返回值类型不是feign.Response, 响应状态码为非 2xx(配置了404状态解码时需排除404)时, 将会抛出FeignException. 由于其对服务调用方的原始信息做了加工, 所以需要重写ErrorDecoder才能得到抛出的原始异常信息.

void handleResponse(CompletableFuture<Object> resultFuture,
                      String configKey,
                      Response response,
                      Type returnType,
                      long elapsedTime) {
    // copied fairly liberally from SynchronousMethodHandler
    boolean shouldClose = true;

    try {
      if (logLevel != Level.NONE) {
        response = logger.logAndRebufferResponse(configKey, logLevel, response,
            elapsedTime);
      }
      if (Response.class == returnType) {
        if (response.body() == null) {
          resultFuture.complete(response);
        } else if (response.body().length() == null
            || response.body().length() > MAX_RESPONSE_BUFFER_SIZE) {
          shouldClose = false;
          resultFuture.complete(response);
        } else {
          // Ensure the response body is disconnected
          final byte[] bodyData = Util.toByteArray(response.body().asInputStream());
          resultFuture.complete(response.toBuilder().body(bodyData).build());
        }
      } else if (response.status() >= 200 && response.status() < 300) {
        if (isVoidType(returnType)) {
          resultFuture.complete(null);
        } else {
          final Object result = decode(response, returnType);
          shouldClose = closeAfterDecode;
          resultFuture.complete(result);
        }
      } else if (decode404 && response.status() == 404 && !isVoidType(returnType)) {
        final Object result = decode(response, returnType);
        shouldClose = closeAfterDecode;
        resultFuture.complete(result);
      } else {
        resultFuture.completeExceptionally(errorDecoder.decode(configKey, response));
      }
    } catch (final IOException e) {
      if (logLevel != Level.NONE) {
        logger.logIOException(configKey, logLevel, e, elapsedTime);
      }
      resultFuture.completeExceptionally(errorReading(response.request(), response, e));
    } catch (final Exception e) {
      resultFuture.completeExceptionally(e);
    } finally {
      if (shouldClose) {
        ensureClosed(response.body());
      }
    }

  }

保留服务提供方抛出的原始异常信息

OpenFeign自定义配置

@Configuration
public class KeepErrMsgConfiguration {
    @Bean
    public ErrorDecoder errorDecoder() {
        return new RawErrorDecoder();
    }
}

重写`ErrorDecoder`

public class RawErrorDecoder implements ErrorDecoder {
    @Override
    public Exception decode(String methodKey, Response response) {
        String message = null;
        try {
            if (response.body() != null) {
                message = Util.toString(response.body().asReader(Util.UTF_8));
                JSONObject json = JSONObject.parseObject(message);
                return new RuntimeException(json.getString("message"));
            }
        } catch (Exception ignored) {
        }
        return new RuntimeException(message);
    }
}

重写`ErrorDecoder.Default`

public class RawErrorDecoder extends ErrorDecoder.Default {
    @Override
    public Exception decode(String methodKey, Response response) {
        Exception exception = super.decode(methodKey, response);
        if (exception instanceof RetryableException) {
            return exception;
        }
        try {
            if (response.body() != null) {
                String message = Util.toString(response.body().asReader(Util.UTF_8));
                return new RuntimeException(message);
            }
        } catch (IOException ignored) {
        }
        return exception;
    }
}