之前用过服务消费者调用服务提供者的时候使用RestTemplate技术,存在几个不便之处:

  1. 拼接url
  2. restTemplate.getForObJect

这两处代码都比较模板化,能不能不写这种模板化的东⻄
另外来说,拼接url显得很low,拼接字符串,拼接参数,很low还容易出错

Feign简介

Feign是Netflix开发的一个轻量级RESTful的HTTP服务客户端(用它来发起请求,远程调用的),是以Java接口注解的方式调用Http请求,而不用像Java中通过封装HTTP请求报文的方式直接调用,Feign被广泛应用在Spring Cloud 的解决方案中。
类似于Dubbo,服务消费者拿到服务提供者的接口,然后像调用本地接口方法一样去调用,实际发出的是远程的请求。

  • Feign可帮助我们更加便捷,优雅的调用HTTP API(不需要我们去拼接url然后调用restTemplate的api),在SpringCloud中,使用Feign非常简单,创建一个接口(在消费者--服务调用方这一端),并在接口上添加一些注解,代码就完成了。
  • SpringCloud对Feign进行了增强,使Feign支持了SpringMVC注解(OpenFeign)

本质:封装了Http调用流程,更符合面向接口化的编程习惯,类似于Dubbo的服务调用(Dubbo的调用方式其实就是很好的面向接口编程)

Feign配置应用

在服务调用者工程(消费者)创建接口(添加注解)
效果:Feign = RestTemplate + Ribbon + Hystrix

  • 服务消费者工程中引入Feign依赖(或者父类工程)

    <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
  • 服务消费者工程启动类使用注解@EnableFeignClients添加Feign支持
    注意: 此时去掉Hystrix熔断的支持注解@EnableCircuitBreaker以及引入的Hystrix依赖,因为Feign会自动引入
  • 创建Feign接口

    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    
    // name:调用的服务名称,和服务提供者yml文件中spring.application.name保持一致
    @FeignClient(name = "cloud-eureka-server")
    public interface OrderFeignClient {
    // 调用的请求路径
    @RequestMapping(value = "/shop/order/{userId}", method = RequestMethod.GET)
    public Integer findOrder(@PathVariable(value = "userId") Long userId);
    }

    注意:

  • @FeignClient注解的name属性用于指定要调用的服务提供者名称,和服务提供者yml文件中spring.application.name保持一致
  • 接口中的接口方法,就好比是远程服务提供者Controller中的Hander方法(只不过如同本地调用了),那么在进行参数绑定的时,可以使用@PathVariable、@RequestParam、@RequestHeader等,这也是OpenFeign对SpringMVC注解的支持,但是需要注意value必须设置,否则会抛出异常
  • 使用接口中方法完成远程调用(注入接口即可,实际注入的是接口的实现)

    @Autowired
    private OrderFeignClient OrderFeignClient;
    
    @Test
    public void testFeignClient(){
    Integer order = OrderFeignClient.findOrder(1545132l);
    System.out.println("=======>>> order:" + order);
    }

    Feign对负载均衡的支持

    Feign 本身已经集成了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,可以通过 ribbon.xx 来进行全局配置,也可以通过 服务名.ribbon.xx 来对指定服务进行细节配置配置(参考之前,此处略)
    Feign默认的请求处理超时时⻓1s,有时候业务确实执行的需要一定时间,那么这个时候,就需要调整请求处理超时时⻓,Feign自己有超时设置,如果配置Ribbon的超时,则会以Ribbon的为准

Ribbon设置

# 针对的被调用方微服务名称,不加就是全局生效
cloud-eureka-server:
  ribbon:
    # 请求连接超时时间
    ConnectTimeout: 2000
    # 请求处理超时时间
    ReadTimeout: 5000
    # 对所有操作都进行重试
    OkToRetryOnAllOperations: true
    # 根据如上配置,当访问到故障请求的时候,它会再尝试访问一次当前实例(次数由MaxAutoRetries配置),
    # 如果不行,就换一个实例进行访问,如果还不行,再换一次实例访问(更换次数由MaxAutoRetriesNextServer配置),
    # 如果依然不行,返回失败信息。

    # 对当前选中实例重试次数,不包括第一次调用
    MaxAutoRetries: 0 
    # 切换实例的重试次数
    MaxAutoRetriesNextServer: 0 
    # 负载策略调整
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule 

这些配置对Feign生效,对RestTemplate是不生效的。

Feign对熔断器的支持

  1. 在Feign客户端(服务消费端)工程配置文件(application.yml)中开启Feign对熔断器的支持

    # 开启Feign的熔断功能
    feign:
      hystrix:
     enabled: true

    Feign的超时时⻓设置,其实就上面Ribbon的超时时⻓设置
    Hystrix超时设置(按照之前Hystrix设置的方式设置)
    注意:

  2. 开启Hystrix之后,Feign中的方法都会被管理,一旦出现问题就进入对应的回退逻辑处理
    注意:针对超时这一点,当前有两个超时时间设置(Feign/hystrix),熔断的时候是根据这两个时间的最小值来进行的,即处理时⻓超过最短的那个超时时间,就熔断进入回退降级逻辑

    hystrix:
      command:
     default:
       execution:
         isolation:
           thread:
             # Hystrix的超时时⻓设置
             timeoutInMilliseconds: 15000
  3. 自定义FallBack处理类(需要实现FeignClient接口)

    package com.cloud.controller.service;
    
    import org.springframework.stereotype.Component;
    
    /*
     * 降级回退逻辑需要定义一个类,实现FeignClient接口,实现接口中的方法
     */
    // 别忘了这个注解,还应该被扫描到
    @Component
    public class OrderFallback implements OrderFeignClient {
      @Override
      public Integer findOrder(Long userId) {
     return -6;
      }
    }
  4. 在@FeignClient注解中关联第2步中自定义的处理类

    // 使用fallback的时候,类上的@RequestMapping的url前缀限定,改成配置在@FeignClient的path属性中
    @FeignClient(value = "cloud-eureka-server", fallback = OrderFallback.class, path = "/shop") 
    //@RequestMapping("/shop")
    public interface OrderFeignClient {
    
    }

    Feign对请求压缩和响应压缩的支持

    Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗,但是全部压缩会极度占用cpu资源。通过下面的参数,即可开启请求与响应的压缩功能:

    feign:
      compression:
     request:
       # 开启请求压缩
       enabled: true 
       # 设置压缩的数据类型,此处也是默认值
       mime-types: text/html,application/xml,application/json 
       # 设置触发压缩的大小下限,此处也是默认值
       min-request-size: 2048 
     response:
       # 开启响应压缩
       enabled: true 

    Feign的日志级别配置

    Feign是http请求客户端,类似于咱们的浏览器,它在请求和接收响应的时候,可以打印出比较详细的一些日志信息(响应头,状态码等等)。
    如果我们想看到Feign请求时的日志,我们可以进行配置,默认情况下Feign的日志没有开启。

  5. 开启Feign日志功能及级别

    // Feign的日志级别(Feign请求过程信息)
    // NONE:默认的,不显示任何日志----性能最好
    // BASIC:仅记录请求方法、URL、响应状态码以及执行时间----生产问题追踪
    // HEADERS:在BASIC级别的基础上,记录请求和响应的header
    // FULL:记录请求和响应的header、body和元数据----适用于开发及测试环境定位问题
    @Configuration
    public class FeignConfig {
      @Bean
      Logger.Level feignLevel() {
     return Logger.Level.FULL;
      }
    }
  6. 配置log日志级别为debug

    logging:
      level:
     # Feign日志只会对日志级别为debug的做出响应(FeignClient的全限定类名)
     com.cloud.controller.service.ResumeServiceFeignClient: debug

    Feign核心源码剖析

    只定义了接口,添加上@FeignClient,真的没有实现的话,是不能完成远程请求的,那么它很有可能是做了代理了。

  7. 先在findOrder方法内打个断点,发现OrderFeignClient确实是代理对象。并且它的增强是FeignInvocationHandler。
    image.png
    image.png
  8. 从@EnableFeignClients正向切入
    image.png
    image.png
    image.png
    image.png
    image.png
    接下来,我们主要追踪下另外一行主要的代码registerFeignClients(metadata, registry);
    image.png
    图片
    注册客户端,给每一个客户端生成代理对象
    image.png
    下一步,关注FeignClientFactoryBean这个工厂Bean的getObject方法,这个方法会返回我们的代理对象(FeignClientFactoryBean.getObject)
    image.png
    image.png
    image.png
    org.springframework.cloud.openfeign.HystrixTargeter#target
    image.png
    图片
    image.png
  9. 请求进来时候,是进入增强逻辑的,所以接下来我们要关注增强逻辑部分,FeignInvocationHandler
    image.png
    SynchronousMethodHandler#invoke
    image.png
    image.png
    image.png
    AbstractLoadBalancerAwareClient#executeWithLoadBalancer()
    image.png
    进入submit方法,我们进一步就会发现使用Ribbon在做负载均衡了
    image.png
    image.png
    image.png
    最终请求的发起使用的是HttpURLConnection
    image.png

标签: Feign, Spring Cloud

评论已关闭