Spring Cloud-04-OpenFeign服务接口调用

文章目录

Feign简介
OpenFeign配置应用
Feign对负载均衡的支持
Feign对熔断器的支持
Feign对请求压缩和响应压缩的支持
Feign的日志级别配置
Feign核心源码学习

服务消费者调⽤服务提供者的时候使⽤RestTemplate技术

存在不便之处

拼接url
restTmplate.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的调⽤⽅式其实就是很好的⾯向接口编程

OpenFeign配置应用

在服务调⽤者⼯程（消费）创建接⼝（添加注解）
（效果）Feign = RestTemplate+Ribbon+Hystrix
在上一篇文章的工程基础上进行修改

服务消费者⼯程中引⼊Feign依赖（或者⽗类⼯程）

创建子工程cloud-service-autodeliver-8092
修改pom文件

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

主启动类
注意：此时去掉Hystrix熔断的⽀持注解@EnableCircuitBreaker即可包括引⼊的依赖，因为Feign会⾃动引⼊

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class AutoDeliverApplication8092 {
   
    public static void main(String[] args) {
   
        SpringApplication.run(AutoDeliverApplication8092.class, args);
    }
}

改yaml

server:
  port: 8092
spring:
  application:
    name: cloud-service-autodeliver

eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true。
    register-with-eureka: true
    #是否从EurekaServer抓取已有的注册信息，默认为true。单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
    fetchRegistry: true
    service-url:
      # 单机版
      #defaultZone: http://localhost:8761/eureka # 入驻的服务注册中心地址
      # 集群版
      defaultZone: http://eureka8762.com:8762/eureka/,http://eureka8761.com:8761/eureka/ # 入驻的服务注册中心地址
  instance:
    #使⽤ip注册，否则会使⽤主机名注册了（此处考虑到对⽼版本的兼容，新版本经过实验都是ip）
    prefer-ip-address: true
    #⾃定义实例显示格式，加上版本号，便于多版本管理，注意是ip-address，早期版本是ipAddress
    instance-id: ${
   spring.cloud.client.ipaddress}:${
   spring.application.name}:${
   server.port}:@project.version@
    metadata-map:
      cluster: cl1
      region: rn1

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always

创建Feign接口

// 原来：http://cloud-service-resume/resume/openstate/ + userId;
// @FeignClient表明当前类是一个Feign客户端，value指定该客户端要请求的服务名称（登记到注册中心上的服务提供者的服务名称）
@FeignClient(value = "cloud-service-resume")
@RequestMapping("/resume")
public interface ResumeServiceFeignClient {
   

    // Feign要做的事情就是，拼装url发起请求
    // 调用该方法就是调用本地接口方法，那么实际上做的是远程请求
    @RequestMapping("/openstate/{userId}")
    public Integer findResumeStateById(@PathVariable("userId") Long userId);

}

controller

@RestController
@RequestMapping("/autodeliver")
public class AutoDeliverController {
   

    @Autowired
    private ResumeServiceFeignClient resumeServiceFeignClient;

    @RequestMapping("/checkState/{userId}")
    public Integer findResumeStateById(@PathVariable Long userId){
   
        return resumeServiceFeignClient.findResumeStateById(userId);
    }

}

注意：

@FeignClient注解的name属性⽤于指定要调⽤的服务提供者名称，和服务提供者yml⽂件中spring.application.name保持⼀致
接⼝中的接⼝⽅法，就好⽐是远程服务提供者Controller中的Hander⽅法（只不过如同本地调⽤了），那么在进⾏参数绑定的时，可以使⽤@PathVariable、@RequestParam、@RequestHeader等，这也是OpenFeign对SpringMVC注解的⽀持，但是需要注意value必须设置，否则会抛出异常

测试

Feign对负载均衡的支持

Feign 本身已经集成了Ribbon依赖和⾃动配置，因此我们不需要额外引⼊依赖，可以通过 ribbon.xx 来进⾏全局配置,也可以通过服务名.ribbon.xx 来对指定服务进⾏细节配置配置（参考之前，此处略）

Feign默认的请求处理超时时⻓1s，有时候我们的业务确实执⾏的需要⼀定时间，那么这个时候，我们就需要调整请求处理超时时⻓，Feign⾃⼰有超时设置，如果配置Ribbon的超时，则会以Ribbon的为准

#针对的被调⽤⽅微服务名称,不加就是全局⽣效
cloud-service-resume:
  ribbon:
    #请求连接超时时间
    ConnectTimeout: 2000
    #请求处理超时时间
    ReadTimeout: 5000
    #对所有操作都进⾏重试
    OkToRetryOnAllOperations: true
    ####根据如上配置，当访问到故障请求的时候，它会再尝试访问⼀次当前实例（次数由MaxAutoRetries配置），
    ####如果不⾏，就换⼀个实例进⾏访问，如果还不⾏，再换⼀次实例访问（更换次数由MaxAutoRetriesNextServer配置），
    ####如果依然不⾏，返回失败信息。
    MaxAutoRetries: 0 #对当前选中实例重试次数，不包括第⼀次调⽤
    MaxAutoRetriesNextServer: 0 #切换实例的重试次数
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule #负载策略调整

Feign对熔断器的支持

在Feign客户端⼯程配置⽂件（application.yml）中开启Feign对熔断器的⽀持

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

Feign的超时时⻓设置那其实就上⾯Ribbon的超时时⻓设置

Hystrix超时设置（就按照之前Hystrix设置的⽅式就OK了）

注意：

开启Hystrix之后，Feign中的⽅法都会被进⾏⼀个管理了，⼀旦出现问题就进⼊对应的回退逻辑处理
针对超时这⼀点，当前有两个超时时间设置（Feign/hystrix），熔断的时候是根据这两个时间的最⼩值来进⾏的，即处理时⻓超过最短的那个超时时间了就熔断进⼊回退降级逻辑

hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            ##########################################Hystrix的超时时⻓设置
            timeoutInMilliseconds: 5000

⾃定义FallBack处理类（需要实现FeignClient接⼝）

@Component
public class ResumeFallback implements ResumeServiceFeignClient{
   
    @Override
    public Integer findResumeStateById(Long userId) {
   
        return -6;
    }
}

在@FeignClient注解中关联2）中⾃定义的处理类

// 使⽤fallback的时候，类上的@RequestMapping的url前缀限定，改成配置在@FeignClient的path属性中
@FeignClient(value = "cloud-service-resume", fallback = ResumeFallback.class, path = "/resume")
// @RequestMapping("/resume")
public interface ResumeServiceFeignClient {
   

    // Feign要做的事情就是，拼装url发起请求
    // 调用该方法就是调用本地接口方法，那么实际上做的是远程请求
    @RequestMapping("/openstate/{userId}")
    public Integer findResumeStateById(@PathVariable("userId") Long userId);

}

测试

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

Feign ⽀持对请求和响应进⾏GZIP压缩，以减少通信过程中的性能损耗。通过下⾯的参数即可开启请求与响应的压缩功能：

# 开启Feign的熔断功能
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的⽇志没有开启。

开启Feign⽇志功能及级别

// Feign的⽇志级别（Feign请求过程信息）
// NONE：默认的，不显示任何⽇志----性能最好
// BASIC：仅记录请求⽅法、URL、响应状态码以及执⾏时间----⽣产问题追踪
// HEADERS：在BASIC级别的基础上，记录请求和响应的header
// FULL：记录请求和响应的header、body和元数据----适⽤于开发及测试环境定位问题
@Configuration
public class FeignLod {
   
    @Bean
    Logger.Level feignLevel() {
   
        return Logger.Level.FULL;
    }
}

配置log⽇志级别为debug

logging:
  level:
    com.elvis.service.ResumeServiceFeignClient: debug

Feign核心源码学习

只定义了接⼝，添加上@FeignClient，肯定是做了代理了，先断点验证⼀下这个⽅法，确实是个代理对象！
从@EnableFeignClients 正向切⼊

接下来，主要追踪下另外⼀⾏主要的代码org.springframework.cloud.openfeign.FeignClientsRegistrar#registerFeignClients方法

org.springframework.cloud.openfeign.FeignClientsRegistrar#registerFeignClient注册客户端，给每⼀个客户端⽣成代理对象

所以，下⼀步，关注FeignClientFactoryBean这个⼯⼚Bean的getObject⽅法，根据经验，这个⽅法会返回代理对象
接下来，FeignClientFactoryBean.getObject⽅法

org.springframework.cloud.openfeign.HystrixTargeter#target

请求进来时候，是进⼊增强逻辑的，所以接下来我们要关注增强逻辑部分，FeignInvocationHandler

feign.SynchronousMethodHandler#invoke

进⼊submit⽅法，进⼀步就会发现使⽤Ribbon在做负载均衡了

最终请求的发起使⽤的是HttpURLConnection, 在feign.Client.Default#execute方法中执行