关于feign.codec.DecodeException异常的解决方案

当使用Spring Cloud Feign调用外部服务时，如果接口返回的数据不能按照指定的数据类型进行反序列化，就会抛出feign.codec.DecodeException异常。那么，在实际开发过程中，我们如何解决这个异常呢？

下面是几种解决方案。

方案一：自定义错误解码器

我们可以定义一个自己的错误解码器，当外部服务返回的数据无法按照指定数据类型反序列化时，我们可以捕获该异常并通过自己定义的错误解码器将异常处理掉，不会再抛出。

import feign.Response;
import feign.codec.DecodeException;
import feign.codec.Decoder;

import java.io.IOException;
import java.lang.reflect.Type;

public class CustomDecoder implements Decoder {

    private final Decoder delegate;

    public CustomDecoder(Decoder delegate) {
        this.delegate = delegate;
    }

    @Override
    public Object decode(Response response, Type type) throws IOException, DecodeException {
        try {
            return delegate.decode(response, type);
        } catch (DecodeException e) {
            // 自定义处理DecodeException异常
            return null;
        }
    }
}

然后在Feign.Builder中加入我们自定义的错误解码器：

CustomDecoder decoder = new CustomDecoder(new JacksonDecoder());

Feign.builder()
        .decoder(decoder)
        .target(Target<TestService.class>, "http://localhost:8080");

方案二：重写错误处理器

在Feign的ErrorDecoder中，提供了默认的错误处理器Default。默认的错误处理器会将Feign发生的错误和服务端返回的错误封装到一个FeignException`中进行抛出。

我们可以重写ErrorDecoder，自定义处理Feign发生的错误和服务端返回的错误，并自定义返回一个我们自己定义的异常。

import feign.Response;
import feign.codec.ErrorDecoder;

public class CustomErrorDecoder implements ErrorDecoder {

    private final ErrorDecoder delegate;

    public CustomErrorDecoder(ErrorDecoder delegate) {
        this.delegate = delegate;
    }

    @Override
    public Exception decode(String methodKey, Response response) {
        try {
            return delegate.decode(methodKey, response);
        } catch (Exception e) {
            // 自定义处理Feign发生的错误和服务端返回的错误
            return new CustomException("请求xxx服务发生了错误");
        }
    }

}

在Feign.Builder中同样要加入自定义的错误处理器：

CustomErrorDecoder errorDecoder = new CustomErrorDecoder(new ErrorDecoder.Default());

Feign.builder()
        .errorDecoder(errorDecoder)
        .target(Target<TestService.class>, "http://localhost:8080");

示例说明

假设我们有一个外部服务UserDetailsService，它提供一个查询用户信息的接口/user/{id}。

public interface UserDetailsService {

    @GetMapping("/user/{id}")
    User getUser(@PathVariable("id") Long id);

}

我们使用Spring Cloud Feign客户端调用该接口时，需要使用相应的声明式接口：

@FeignClient("user-details-service")
public interface UserDetailsServiceClient {

    @GetMapping("/user/{id}")
    User getUser(@PathVariable("id") Long id);

}

然后我们使用UserDetailsServiceClient进行调用时，如果外部服务无法按照我们指定的数据类型进行反序列化，则会抛出feign.codec.DecodeException异常。

try {
    User user = userDetailsServiceClient.getUser(1L);
} catch (DecodeException e) {
    // 处理DecodeException异常
}

以上我们就介绍了如何通过自定义错误解码器和自定义错误处理器来解决feign.codec.DecodeException异常。

在实际开发中，由于各种原因，外部服务返回的数据很可能与我们需要的数据结构不一致。通过这种方式处理的话，可以使我们的应用程序更加健壮和健康。