springcloud学习（四）之Feign

﹏ヽ暗。殇╰゛Y 2023-01-02 05:27 241阅读 0赞

## 前言 ##

我们之前调用远程服务的方式如下代码：

String url="http://lagou-service-resume/resume/openstate/"+userId;
    Integer forObject =restTemplate.getForObject(url,Integer.class);

这种方式存在两个问题：

*  需要拼接url
 *  调用方式比较模板化

由此，Feign运用而生。

## Feign简介 ##

Feign是Netflix开发的⼀个轻量级RESTful的HTTP服务客户端（⽤它来发起请求，远程调⽤的） ，是以Java接⼝注解的⽅式调⽤Http请求，⽽不⽤像Java中通过封装HTTP请求报⽂的⽅式直接调⽤， Feign被⼴泛应⽤在Spring Cloud 的解决⽅案中。  
类似于Dubbo，服务消费者拿到服务提供者的接⼝，然后像调⽤本地接⼝⽅法⼀样去调⽤，实际发出的是远程的请求。  
SpringCloud对Feign进⾏了增强，使Feign⽀持了SpringMVC注解（也即**OpenFeign**）

## Feign的使用 ##

新建服务消费者模块lagou-service-autodeliver-8092，在服务消费者模块中引入feign的jar：

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

注意： **Feign = RestTemplate+Ribbon+Hystrix**, 所以我们不需要引入ribbon及Hystrix相关的jar。  
在服务消费者的启动类上添加@EnableFeignClients注解。

### 创建feign接口 ###

接口ResumeServiceFeginClient：

//value是调用的服务名称，和服务提供者yml文件中的spring.application.name保持一致
    @FeignClient(value = "lagou-service-resume")
    @RequestMapping("/resume")
    public interface ResumeServiceFeginClient { 
       @GetMapping("/openstate/{userId}")
        Integer findDefaultResumeState(@PathVariable(value = "userId") Long userId) ;
       }

说明：

1）@FeignClient注解的name属性⽤于指定要调⽤的服务提供者名称，和服务提供者yml⽂件中spring.application.name保持⼀致

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

### feign接口的调用 ###

在controller中实现调用：

@RestController
    public class AutoDeliverController { 
    
        @Autowired
        private ResumeServiceFeginClient resumeServiceFeginClient;
    
        @GetMapping("/checkState/{userId}")
        public Integer checkStateTimeout(@PathVariable Long userId) { 
            return resumeServiceFeginClient.findDefaultResumeState(userId);
        }
    
    }

启动调用效果：  
![6b903c03e42e4f38fb9190878e268d2e.png][]

--------------------

## Feign对Ribbon的支持 ##

在服务消费者模块lagou-service-autodeliver-8092的application.yml文件中配置相关参数，介绍如下：

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

--------------------

## Feign的日志级别 ##

### 配置Feign的⽇志级别（Feign请求过程信息） ###

feign共有下面四种日志级别：

**NONE**：默认的，不显示任何⽇志----性能最好

**BASIC**：仅记录请求⽅法、 URL、响应状态码以及执⾏时间----⽣产问题追踪

**HEADERS**：在BASIC级别的基础上，记录请求和响应的header

**FULL**：记录请求和响应的header、 body和元数据----适⽤于开发及测试环境定位问题

@Configuration
    public class FeignConfig { 
        @Bean
        Logger.Level feignLevel() { 
            return Logger.Level.FULL;
        }
    }

在application.yml中配置对于接口的日志级别为debug：

logging:
      level:
    #Feign⽇志只会对⽇志级别为debug的做出响应
        com.lagou.edu.service.ResumeServiceFeginClient: debug

调用测试：  
![d2dd69d0a8f0ad587fc263570f13922e.png][]  
可以看到输出了详细的日志信息，包含响应时长，返回结果等信息。

--------------------

## Feign对熔断器的支持 ##

#### 开启feign的熔断功能 ####

application.yml：

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

##### 自定义服务降级处理类 #####

自定义服务回退处理类，需要实现ResumeServiceFeignClient接口，并加上@Component注解被spring管理，实现需要降级的处理逻辑：

@Component
    public class ResumeFallback implements ResumeServiceFeginClient{ 
        @Override
        public Integer findDefaultResumeState(Long userId) { 
            return -100;
        }
    }

在ResumeServiceFeginClient接口中也需要稍作修改，添加fallback属性指向回退的服务类，还有之前的@RequestMapping注解改写到path属性当中去：

//value是调用的服务名称，和服务提供者yml文件中的spring.application.name保持一致
    @FeignClient(value = "lagou-service-resume",fallback = ResumeFallback.class,path = "/resume")
    public interface ResumeServiceFeginClient { 
        @GetMapping("/openstate/{userId}")
         Integer findDefaultResumeState(@PathVariable(value = "userId") Long userId) ;
        }

##### 超时时长设置 #####

application.yml中配置hystrix的超时时长：

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

之前我们配置文件中配置的feign的超时时长：  
![ba902f2974c50832399d58606aad798e.png][]

**注意**：

> 这两个超时时长，无论哪一个超时都会进行熔断，服务降级。也就是根据这两个时间的最小值来进行熔断，进入自定义的回退降级逻辑。

测试服务降级效果：  
![fd6d9686dcc60e62a47b57749ccc5eca.png][]

## Feign对请求及响应压缩的支持 ##

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

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

## 附录 ##

feign-demo源码：[feign-demo案例源码][feign-demo]

欢迎访问我的博客：[https://www.liuyj.top][https_www.liuyj.top]

[6b903c03e42e4f38fb9190878e268d2e.png]: /images/20221120/7f782a205e8d4c9d983ba307e79e262a.png
[d2dd69d0a8f0ad587fc263570f13922e.png]: /images/20221120/f314962fff46407ebb0cdeaaa435801c.png
[ba902f2974c50832399d58606aad798e.png]: /images/20221120/1c3f264a950449beb07db2f58407ded1.png
[fd6d9686dcc60e62a47b57749ccc5eca.png]: /images/20221120/29a94c100027470dab57704f6c4629f6.png
[feign-demo]: https://gitee.com/mikecn/feign-demo
[https_www.liuyj.top]: https://www.liuyj.top