Springboot中@FeignClient详解

一、概述

在微服务架构中，服务之间的调用是非常频繁的。为了简化服务之间的调用，Spring Boot 提供了一个叫做 Feign 的组件，Feign 可以帮助我们定义和实现服务之间的 RESTful 接口，

@FeignClient 注解是 Spring Cloud 中的一个组件，基于 Netflix Feign 实现的，@FeignClient 注解可以帮助我们定义和实现服务之间的 RESTful 接口，使得服务之间的调用更加方便和可靠。

二、@FeignClient 注解原理分析

（1）工作原理：

1.首先在springboot启动类上通过@EnableFeignCleints注解开启FeignCleint。

2.根据Feign的规则实现接口，添加@FeignCleint注解。程序启动后，会扫描所有有@FeignCleint的类，并将这些类注入到spring的IOC容器中。

3.注入时从FeignClientFactoryBean.class获取FeignClient。

4.当定义的@FeignClient中的接口被调用时，通过JDK的动态代理来生成RequestTemplate。RequestTemplate中包含请求的所有信息，如请求参数，请求URL等。

5.Request交给client处理，client默认是JDK的HTTPUrlConnection，也可以是OKhttp、Apache的HTTPClient等。

6.最后client封装成LoadBaLanceClient，结合ribbon负载均衡地发起调用。

（2）分析：

Feign远程调用，核心就是通过一系列的封装和处理，将以JAVA注解的方式定义的远程调用API接口，最终转换成HTTP的请求形式，然后将HTTP的请求的响应结果，解码成JAVA Bean，返回给调用者。

(3) @FeignClient 注解的核心

@FeignClient 注解的核心组件包括 Feign.Builder、FeignClientFactoryBean 和 FeignClientsRegistrar。

1.Feign.Builder：用于生成 Feign 的代理对象。Feign.Builder 可以根据指定的 HTTP API 接口生成一个 Java 接口，并自动注入 Ribbon 进行负载均衡。

2.FeignClientFactoryBean：用于创建 Feign 的代理对象。FeignClientFactoryBean 可以根据指定的 HTTP API 接口和 Feign.Builder 生成一个代理对象，并将其注入到 Spring 容器中。

3.FeignClientsRegistrar：用于注册 @FeignClient 注解。FeignClientsRegistrar 可以扫描项目中所有的 @FeignClient 注解，并将其注册到 Spring 容器中。

（4）@FeignClient 注解中的属性

value：服务名（接口提供方的服务名）

path：定义当前FeignClient的统一路径前缀

name：指定FeignClient的名称，如果项目使用了Ribbon 或spring-cloud-loadbalancer，name属性会作为微服务的名称，用于服务发现

contextId：解决bean名冲突的标识

url：url一般用于调试，可以手动指定@FeignClient调用的地址

decode404：当发生http 404错误时，如果该字段位true，会调用decoder进行解码，否则抛出FeignException

configuration：Feign配置类，可以自定义Feign的Encoder、Decoder、LogLevel、Contract

fallback：定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback指定的类必须实现@FeignClient标记的接口

fallbackFactory：工厂类，用于生成fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码

三、@FeignClient 注解使用

1.添加maven依赖

    org.springframework.cloud    spring-cloud-starter-openfeign    2.0.2.RELEASE

2.编写新建控制器类。

@RestControllerpublic class FileController {   @PostMapping(value = "/demo/upload")    Result uploadFile(@RequestPart(value = "file") MultipartFile file) {         return new Result();    }}

3.定义Feign接口

import org.springframework.cloud.openfeign.FeignClient;import org.springframework.web.bind.annotation.PostMapping;@FeignClient(contextId="FileFeignClient ",name = "file-upload", url = "http://127.0.0.1:8001")public interface FileFeignClient {    @PostMapping(value = "/demo/upload",consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})    Result uploadFile(@RequestPart(value = "file") MultipartFile file);}

4.新建Spring Boot启动类

import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.openfeign.EnableFeignClients;@SpringBootApplication@EnableFeignClientspublic class SpringBootFeignApplication {    public static void main(String[] args) {        SpringApplication.run(SpringBootFeignApplication .class, args);    }}

启动项目就可以尝试调用了。

5.如果想使用Apache的httpclient的连接池，可以做如下配置：

    org.apache.httpcomponents    httpclient    4.5.6    io.github.openfeign    feign-httpclient    9.7.0

添加属性配置

feign:  okhttp:     enabled: false  httpclient:    enabled: true    maxConnections: 20480    maxConnectionsPerRoute: 512    timeToLive: 60    connectionTimeout: 10000