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

/**
 * @author axin
 * @suammry xx 客户端
 */
@FeignClient(value = "xxClient",url = "${xx.host:www.axin.com}")
public interface DemoClient {

  @PostMapping(value = "/xxx/url", headers = "Content-Type=application/json"})
  yourResponse requestHTTP(@RequestBody JSONObject param);

}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FeignClient {

	/**
	 * 指定FeignClient的名称，如果项目使用了Ribbon，name属性会作为微服务的名称，用于服务发现
	 */
	@AliasFor("name")
	String value() default "";
	@Deprecated
	String serviceId() default "";
	@AliasFor("value")
	String name() default "";
	
	/**
	 * Sets the <code>@Qualifier</code> value for the feign client.
	 * 这个bean在应用上下文中的名字为接口的全限定名，你也可以使用 @FeignClient 注解中的 qualifier 属性给bean指定一个别名
	 */
	String qualifier() default "";

	/**
	 * url地址
	 */
	String url() default "";

	/**
	 * 当发生404错误，如果该字段为true，会调用decoder进行解码，否则抛出FeignException
	 */
	boolean decode404() default false;

	/**
	 * 指定FeignClient 的配置类，优先级最高，默认的配置类为 FeignClientsConfiguration类
	 */
	Class<?>[] configuration() default {};

	/**
	 * 配置熔断器的处理类
	 */
	Class<?> fallback() default void.class;

	/**
	 * 工厂类，用于生产fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复代码
	 */
	Class<?> fallbackFactory() default void.class;

	/**
	 * 定义统一的路径前缀
	 */
	String path() default "";

	/**
	 * Whether to mark the feign proxy as a primary bean. Defaults to true.
	 */
	boolean primary() default true;
}

/**
 * @author axin
 * @suammry xx 客户端
 */
@FeignClient(value = "xxClient",url = "${xx.host:www.axin.com}",configuration = MyConfiguration.class)
public interface DemoClient {

  @PostMapping(value = "/xxx/url", headers = "Content-Type=application/json"})
  yourResponse requestHTTP(@RequestBody JSONObject param);
}

/**
 * @author axin
 * @summary fegin 客户端的自定义配置
 */
public class MyConfiguration {

  /**
   * 自定义重试机制
   * @return
   */
  @Bean
  public Retryer feignRetryer() {
    //fegin提供的默认实现，最大请求次数为5，初始间隔时间为100ms，下次间隔时间1.5倍递增，重试间最大间隔时间为1s，
    return new Retryer.Default();
  }
}

/**
 * @author axin
 * @summary fegin 客户端的自定义配置
 */
@Slf4j
public class MyConfiguration {

  /**
   * 自定义重试机制
   * @return
   */
  @Bean
  public Retryer feignRetryer() {
    //最大请求次数为5，初始间隔时间为100ms，下次间隔时间1.5倍递增，重试间最大间隔时间为1s，
    return new Retryer.Default();
  }

  @Bean
  public ErrorDecoder feignError() {
    return (key, response) -> {
      if (response.status() == 400) {
        log.error("请求xxx服务400参数错误,返回:{}", response.body());
      }

      if (response.status() == 409) {
        log.error("请求xxx服务409异常,返回:{}", response.body());
      }

      if (response.status() == 404) {
        log.error("请求xxx服务404异常,返回:{}", response.body());
      }

      // 其他异常交给Default去解码处理
      // 这里使用单例即可，Default不用每次都去new
      return new ErrorDecoder.Default().decode(key, response);
    };
  }

}

/**
 * @author axin
 * @summary fegin 客户端的自定义配置
 */
@Slf4j
public class MyConfiguration {

  /**
   * 自定义重试机制
   * @return
   */
  @Bean
  public Retryer feignRetryer() {
    //最大请求次数为5，初始间隔时间为100ms，下次间隔时间1.5倍递增，重试间最大间隔时间为1s，
    return new Retryer.Default();
  }

  @Bean
  public ErrorDecoder feignError() {
    return (key, response) -> {
      if (response.status() == 400) {
        log.error("请求xxx服务400参数错误,返回:{}", response.body());
      }

      if (response.status() == 409) {
        log.error("请求xxx服务409异常,返回:{}", response.body());
      }

      if (response.status() == 404) {
        log.error("请求xxx服务404异常,返回:{}", response.body());
      }

      // 其他异常交给Default去解码处理
      // 这里使用单例即可，Default不用每次都去new
      return new ErrorDecoder.Default().decode(key, response);
    };
  }

   /**
   * fegin 拦截器
   * @return
   */
  @Bean
  public RequestInterceptor cameraSign() {
    return template -> {

      // 如果是get请求
      if (template.method().equals(Request.HttpMethod.GET.name())) {
        //获取到get请求的参数
        Map<String, Collection<String>> queries = template.queries();
      }

      //如果是Post请求
      if (template.method().equals(Request.HttpMethod.POST.name())) {
        //获得请求body
        String body = template.requestBody().asString();
        JSONPObject request = JSON.parseObject(body, JSONPObject.class);
      }

      //Do what you want... 例如生成接口签名

      String sign = "根据请求参数生成的签名";
      //放入url？之后
      template.query("sign", sign);

      //放入请求body中
      String newBody = "原有body" + sign;
      template.body(Request.Body.encoded(newBody.getBytes(StandardCharsets.UTF_8), StandardCharsets.UTF_8));
    };
  }
}