Spring Cloud Feign 自定义配置(重试、拦截与错误码处理) 代码实践

下面是关于“Spring Cloud Feign 自定义配置(重试、拦截与错误码处理)”的完整攻略详情。

1. 什么是 Spring Cloud Feign

Spring Cloud Feign 是一个声明式 REST 客户端，它使通过 HTTP 通信的服务调用变得更加简单。

Feign 会通过定义接口的方式来注入需要访问的远程服务，这样就可以像调用本地方法一样调用远程接口，而无需考虑 REST 接口的 HTTP 细节。

2. Spring Cloud Feign 自定义配置

2.1 重试

Feign 默认并不支持重试机制。在使用 Feign 的过程中，可能会出现一些网络波动或者服务端故障等导致调用失败的情况，而且如果你在系统中定义的调用次数很多，那么肯定需要在调用失败之后重试几次。

Feign 集成了 Ribbon，因此可以使用 RibbonClient 中的策略来进行重试。

注：Ribbon 是 Netflix 公司开发的一个基于 HTTP 和 TCP 客户端的负载均衡器，Feign 可以通过它提供的负载均衡策略对指定服务进行调用。

具体代码实现：

@Configuration
public class Config {

    @Bean
    public Retryer feignRetryer() {
        // period - 重试的间隔时间，默认是 100ms
        // maxAttempts - 最多重试次数，默认是 5
        // maxPeriods - 最大的重试时间，默认是 1s
        return new Retryer.Default(100, TimeDuration.milliseconds(1000), 5);
    }

}

如果需要对指定的接口启用重试机制，可以在接口类或者接口方法上加上 @Retryable 注解，并指定重试的次数和延迟时间等参数。

@FeignClient(name = "xxx", configuration = Config.class)
public interface MyFeignClient {

    @Retryable(value = {FeignException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))
    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") long id);

}

2.2 拦截

Spring Cloud Feign 支持使用 Interceptor 对请求和响应进行拦截和处理。

Interceptor 可以给请求添加一些自定义的 header 信息、修改请求地址、记录日志等操作，对于一些需要做统一处理的场景非常有用。

具体代码实现：

定义一个拦截器：

public class MyFeignInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate requestTemplate) {
        // 在 header 中添加一个自定义的 Token
        requestTemplate.header("Token", "xxx");
        // 修改请求地址
        requestTemplate.uri("http://localhost:8080/users");
    }

}

在 Feign 接口类中加上 @FeignClient 和 @Configuration 注解，配置拦截器。

@FeignClient(name = "xxx", configuration = Config.class)
public interface MyFeignClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") long id);

}

@Configuration
public class Config {

    @Bean
    public MyFeignInterceptor feignInterceptor() {
        return new MyFeignInterceptor();
    }

}

2.3 错误码处理

在调用远程接口的过程中，常常会出现一些异常情况，比如 404 等异常状态码。Spring Cloud Feign 提供了 ErrorDecoder 接口来处理这些异常状态码。

具体代码实现：

自定义一个 ErrorDecoder 实现类：

public class MyErrorDecoder implements ErrorDecoder {

    @Override
    public Exception decode(String methodKey, Response response) {
        if (response.status() == 404) {
            return new NotFoundException("未找到资源");
        } else if (response.status() == 500) {
            return new InternalServerErrorException("服务器内部错误");
        }
        return new DecodeException("解码错误");
    }

}

在 Feign 接口类中加上 @FeignClient 和 @Configuration 注解，配置 ErrorDecoder。

@FeignClient(name = "xxx", configuration = Config.class)
public interface MyFeignClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") long id);

}

@Configuration
public class Config {

    @Bean
    public ErrorDecoder errorDecoder() {
        return new MyErrorDecoder();
    }

}

3. 示例

3.1 重试示例

定义一个 Feign 接口：

@FeignClient(name = "user-service", configuration = Config.class)
public interface UserFeignClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") long id);

}

自定义 retryer 的配置：

@Configuration
public class Config {

    @Bean
    public Retryer feignRetryer() {
        // period - 重试的间隔时间，默认是 100ms
        // maxAttempts - 最多重试次数，默认是 5
        // maxPeriods - 最大的重试时间，默认是 1s
        return new Retryer.Default(100, TimeDuration.milliseconds(1000), 5);
    }

}

通过接口调用远程方法，并捕获异常：

try {
    User user = userFeignClient.getUserById(1L);
    System.out.println(user);
} catch (Exception e) {
    e.printStackTrace();
}

3.2 拦截示例

定义一个 Feign 接口：

@FeignClient(name = "user-service", configuration = {Config.class})
public interface UserFeignClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") long id);

}

自定义拦截器：

public class MyFeignInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate requestTemplate) {
        // 在 header 中添加一个自定义的 Token
        requestTemplate.header("Token", "xxx");
        // 修改请求地址
        requestTemplate.uri("http://localhost:8080/users");
    }

}

在 Feign 接口类中配置拦截器：

@Configuration
public class Config {

    @Bean
    public MyFeignInterceptor feignInterceptor() {
        return new MyFeignInterceptor();
    }

}

通过接口调用远程方法：

User user = userFeignClient.getUserById(1L);
System.out.println(user);

以上就是关于“Spring Cloud Feign 自定义配置(重试、拦截与错误码处理) 代码实践”的完整攻略，希望对你有所帮助。