当前位置 主页 > 网站技术 > 代码类 >

    springboot FeignClient注解及参数

    栏目:代码类 时间:2019-12-17 18:08

    一、FeignClient注解

    FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上

    @FeignClient(name = "github-client", url = "https://api.github.com", configuration = GitHubExampleConfig.class)
    public interface GitHubClient {
      @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
      String searchRepo(@RequestParam("q") String queryStr);
    }
    

    声明接口之后,在代码中通过@Resource注入之后即可使用。@FeignClient标签的常用属性如下:

    name:指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现 url: url一般用于调试,可以手动指定@FeignClient调用的地址 decode404:当发生http 404错误时,如果该字段位true,会调用decoder进行解码,否则抛出FeignException configuration: Feign配置类,可以自定义Feign的Encoder、Decoder、LogLevel、Contract fallback: 定义容错的处理类,当调用远程接口失败或超时时,会调用对应接口的容错逻辑,fallback指定的类必须实现@FeignClient标记的接口 fallbackFactory: 工厂类,用于生成fallback类示例,通过这个属性我们可以实现每个接口通用的容错逻辑,减少重复的代码 path: 定义当前FeignClient的统一前缀
    @FeignClient(name = "github-client",
        url = "https://api.github.com",
        configuration = GitHubExampleConfig.class,
        fallback = GitHubClient.DefaultFallback.class)
    public interface GitHubClient {
      @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
      String searchRepo(@RequestParam("q") String queryStr);
     
      /**
       * 容错处理类,当调用失败时,简单返回空字符串
       */
      @Component
      public class DefaultFallback implements GitHubClient {
        @Override
        public String searchRepo(@RequestParam("q") String queryStr) {
          return "";
        }
      }
    }
    

    在使用fallback属性时,需要使用@Component注解,保证fallback类被Spring容器扫描到,GitHubExampleConfig内容如下:

    @Configuration
    public class GitHubExampleConfig {
      @Bean
      Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
      }
    }
    

    在使用FeignClient时,Spring会按name创建不同的ApplicationContext,通过不同的Context来隔离FeignClient的配置信息,在使用配置类时,不能把配置类放到Spring App Component scan的路径下,否则,配置类会对所有FeignClient生效.

    二、Feign Client 和@RequestMapping

    当前工程中有和Feign Client中一样的Endpoint时,Feign Client的类上不能用@RequestMapping注解否则,当前工程该endpoint http请求且使用accpet时会报404
    Controller:

    @RestController
    @RequestMapping("/v1/card")
    public class IndexApi {
     
      @PostMapping("balance")
      @ResponseBody
      public Info index() {
        Info.Builder builder = new Info.Builder();
        builder.withDetail("x", 2);
        builder.withDetail("y", 2);
        return builder.build();
      }
    }
    

    Feign Client

    @FeignClient(
        name = "card",
        url = "http://localhost:7913",
        fallback = CardFeignClientFallback.class,
        configuration = FeignClientConfiguration.class
    )
    @RequestMapping(value = "/v1/card")
    public interface CardFeignClient {
     
      @RequestMapping(value = "/balance", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
      Info info();
     
    }