Spring Cloud Feign (四)

声明式服务调用 Spring Cloud Feign

对Spring Cloud Ribbon和Spring Cloud Hystrix在实践过程中,这两个框架的使用几乎是同时出现的,Spring Cloud Feign就是一个更高层次的封装来整合这两个基础工具以简化开发。它基于Netflix Feign实现,除了提供这两者的强大功能之外,它还提供了一种声明式的Web服务客户端定义的方式。Spring Cloud Feign在RestTemplate的封装基础上做了进一步封装,由它来帮助定义和实现依赖服务接口的定义,在Spring Cloud Feign的实现下,只需创建一个接口并用注解的方式来配置它,即可完成对服务提供方接口的绑定。Spring Cloud Feign具备可插拔的注解支持,包括Feign注解和JAX-RS注解,为了适应Spring用户,它在Netflix Feign基础上扩展了对Spring MVC注解的支持。

1. 快速集成 Spring Cloud Feign

基础服务搭建

  • eureka-server工程:服务注册中心

  • hello-service工程:服务提供者

  • Spring Cloud Feign Client服务搭建

    1. 创建Spring Boot 工程 feign-consumer

    2. 添加依赖: spring-cloud-starter-eureka-server, spring-cloud-starter-feign

    3. 配置指定服务注册中心,并定义自身服务名

    4. 使用@EnableFeignClients开启Spring Cloud Feign 的支持功能

    5. 定义HelloClient接口,使用@FeignClient注解指定服务名来绑定服务,使用SpringMVC注解绑定具体该服务提供的REST接口

      @FeignClient("hello-service")
      public interface HelloClient {
          
          @RequestMapping("/hello")
          String hello();
      }
      
    6. 在需要调用的地方使用@Autowired注入HelloClient实例,并调用该指定服务接口来向该服务发起/hello接口的调用

2. 参数绑定

  • 设置Request Header

    通过设置Feign拦截器统一设置token,需要实现Feign提供的一个接口 RequestInterceptor

    @Configuration
    public class FeignRequestInterceptor implements RequestInterceptor {
        
        @Override
        public void apply(RequestTemplate requestTemplate) {
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            if (null != attributes) {
                HttpServletRequest request = attributes.getRequest();
                if (null != request) {
                  //添加token
                    requestTemplate.header("Authorization", request.getHeader("Authorization"));
                }
            }
        }
    }
    

    自定义Feign配置覆盖默认配置

    @Configuration
    public class FeignConfiguration {
        
        @Bean
        public FeignRequestInterceptor feignRequestInterceptor() {
            return new FeignRequestInterceptor();
        }
        
        // 超时重试
        @Bean
        public Retryer feignRetryer() {
            return new Retryer.Default(100, 1000, 5);
        }
    }
    

    在定义各参数绑定时,@RequestParam, @PathVariable等可以指定参数名称的注解,value属性不能缺少,在Feign中绑定参数必须通过value属性指明具体的参数名,否则抛出 IllegalStateException异常。

  • 接收对象类型请求响应体

    接收对象必须有默认的构造函数即无参构造器,否则Spring Cloud Feign 根据 JSON 字符串转换对象时抛出异常。

3. 配置

3.1 Ribbon配置

Spring Cloud Feign客户端负载均衡通过Spring Cloud Ribbon实现,可以直接通过配置Ribbon客户端的方式自定义各个服务客户端的调用参数。

  • 全局配置

    使用 ribbon.<key>=<value>的方式设置ribbon的各项参数,如

    ribbon.ConnectTimeout=500
    ribbon.ReadTimeout=5000
    
  • 指定服务配置

    针对各个服务客户端进行个性化配置的方式与全局配置相似,使用<client>.ribbon.<key>=<value>的方式设置。client可以使用@FeignClient注解中的name或value属性值来设置对应的ribbon参数,如

    HELLO-SERVICE.ribbon.ConnectTiomeout=500
    HELLO-SERVICE.ribbon.ReadTimeout=5000
    HELLO-SERVICE.ribbon.OkToRetryOnAllOperations=true
    HELLO-SERVICE.ribbon.MaxAutoRetriesNextServer=2  // 尝试更换实例次数
    HELLO-SERVICE.ribbon.MaxAutoRetries=1  // 尝试访问首选实例次数
    
  • 重试机制

    Spring Cloud Feign中默认实现了请求的重试机制,上面对于HELLO-SERVICE客户端的配置就是对请求超时及重试机制配置的详情。

3.2 Hystrix配置

Spring Cloud Feign 还引入了服务保护与容错的工具Hystrix。默认情况Spring Cloud Feign会为所有Feign客户端的方法都封装到Hystrix命令中进行服务保护。

  • 全局配置

    使用hystrix.command.default.<key>=<value>的方式配置hystrix各项参数,如

    hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=5000
    
  • 禁用 Hystrix

    1. 全局禁用

      feign.hystrix.enabled=false
      
    2. 针对指定服务禁用Hystrix

      构建关闭Hystrix配置类

      @Configuration
      public class DisableHystrixConfiguration {
          
          @Bean
          @Scope("prototype")
          public Feign.Builder feignBuilder() {
              return Feign.builder();
          }
      }
      

      @FeignClient注解中通过configuration参数引入配置类

      @FeignClient(name = "HELLO-SERVICE", configuration = DisableHystrixConfiguration.class)
      public interface HelliClient {
      
  • 指定命令配置

    使用hystrix.command.<commandKey>作为前缀,<commandKey>默认情况下采用Feign客户端中的方法名作为标识。

    如配置/hello接口的熔断超时时间:

    hystrix.command.hello.execution.isolation.thread.timeoutInMilliseconds=5000
    
  • 服务降级配置

    1. 为Feign客户端的定义接口HelloService实现一个具体的实现类HelloServiceFallback

      @Component
      public class HelloServiceFallback implements HelloService {
      
    2. 在服务绑定接口中通过@FeignClient注解的fallback属性来指定对应的服务降级实现类

      @FeignClient(name="HELLO-SERVICE", fallback=HelloServiceFallback.class)
      public interface HelloService {
      
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354

推荐阅读更多精彩内容