SpringCloud OpenFeign

一、概述

Feign是声明式Web服务客户端，它使编写Web服务客户端更加容易。

Feign不做任何请求处理，通过处理注解相关信息生成Request，并对调用返回的数据进行解码，从而实现简化HTTP API的开发。

如果要使用Feign，需要创建一个接口并对其添加Feign相关注解，另外Feign还支持可插拔编码器和解码器，致力于打造一个轻量级HTTP客户端。

1.1 Feign和Openfeign的区别

Feign最早是由Netflix公司进行维护的，后来Netflix不再对其进行维护，最终Feign由社区进行维护，更名为Openfeign。

为了少打俩字，下文简称Openfeign为Feign。

并将原项目迁移至新的仓库，所以我们在Github上看到Feign的坐标如下：

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>parent</artifactId>
    <version>...</version>
</dependency>

1.2 Starter Openfeign

当然了，基于SpringCloud团队对Netflix的情有独钟，你出了这么好用的轻量级HTTP客户端，我这老大哥不得支持一下，所以就有了基于Feign封装的Starter。

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

Spring Cloud添加了对Spring MVC注解的支持，并支持使用Spring Web中默认使用的相同HttpMessageConverters。

另外，Spring Cloud同时集成了Ribbon和Eureka以及Spring Cloud LoadBalancer，以在使用Feign时提供负载均衡的HTTP客户端。

针对于注册中心的支持，包含但不限于Eureka，比如Consul、Nacos等注册中心均支持。

在我们SpringCloud项目开发过程中，使用的大多都是这个Starter Feign。

二、案例

为了方便大家理解，这里写出对应的生产方、消费方Demo代码，以及使用的注册中心。

注册中心使用的Nacos，生产、消费方代码都比较简单。另外为了阅读体验感，文章原则是少放源码，更多的是给大家梳理核心逻辑。

2.1 生产者服务

添加Nacos服务注册发现注解以及发布出HTTP接口服务。

@EnableDiscoveryClient
@SpringBootApplication
public class NacosProduceApplication {
    public static void main(String[] args) {
        SpringApplication.run(NacosProduceApplication.class, args);
    }
	
    @RestController
    static class TestController {
        @GetMapping("/hello")
        public String hello(@RequestParam("name") String name) {
            return "hello " + name;
        }
    }
}

2.2 消费者服务

定义FeignClient消费服务接口。

@FeignClient(value = "nacos-produce")
public interface DemoFeignClient {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    String sayHello(@RequestParam("name") String name);
}

因为生产者使用Nacos，所以消费者除了开启Feign注解，同时也要开启Nacos服务注册发现。

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

    @Autowired 
    private DemoFeignClient demoFeignClient;

    @GetMapping("/test")
    public String test() {
        String result = demoFeignClient.sayHello("Test");
        return result;
    }
}

三、Feign的启动原理

我们在SpringCloud的使用过程中，如果想要启动某个组件，一般都是@EnableXXX这种方式注入，Feign也不例外，我们需要在类上标记此注解@EnableFeignClients。

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

继续深入看一下注解内部都做了什么。注解内部的方法就不说明了，不加会有默认的配置，感兴趣可以跟下源码。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(FeignClientsRegistrar.class)
public @interface EnableFeignClients {
    //...
}

前三个注解是元注解，重点在第四个@Import上，一般使用此注解都是想要动态注册Spring Bean的。

3.1 注入@Import

通过名字也可以大致猜出来，这是Feign注册Bean使用的，使用到了Spring相关的接口，一起看下起了什么作用。

ResourceLoaderAware、EnvironmentAware为FeignClientsRegistrar中两个属性resourceLoader、environment赋值，对Spring了解的小伙伴理解问题不大。

ImportBeanDefinitionRegistrar负责动态注入IOC Bean，分别注入Feign配置类、FeignClient Bean。

// 资源加载器，可以加载classpath下的所有文件
private ResourceLoader resourceLoader;
// 上下文，可通过该环境获取当前应用配置属性等
private Environment environment;

@Override
public void setEnvironment(Environment environment) {
    this.environment = environment;
}

@Override
public void setResourceLoader(ResourceLoader resourceLoader) {
    this.resourceLoader = resourceLoader;
}

@Override
public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
    // 注册＠EnableFeignClients提供的自定义配置类中的相关Bean实例
    registerDefaultConfiguration(metadata, registry);
    // 扫描package，注册被@FeignClient修饰的接口类为IOC Bean
    registerFeignClients(metadata, registry);
}

3.2 添加全局配置

registerDefaultConfiguration方法流程如下

获取@EnableFeignClients注解上的属性以及对应Value；
生成FeignClientSpecification(存储Feign中的配置类)对应的构造器BeanDefinitionBuilder；
FeignClientSpecification Bean名称为default. + @EnableFeignClients修饰类全限定名称 + FeignClientSpecification；
@EnableFeignClients defaultConfiguration默认为{}，如果没有相关配置，默认使用FeignClientsConfiguration并结合name填充到FeignClientSpecification，最终注册为IOC Bean。

3.3 注册FeignClient接口

将重点放在registerFeignClients上，该方法主要就是将修饰了@FeignClient的接口注册为IOC Bean。

扫描@EnableFeignClients注解，如果有clients，则加载指定接口，为空则根据scanner规则扫描出修饰了@FeignClient的接口；
获取@FeignClient上对应的属性，根据configuration属性去创建接口级的FeignClientSpecification配置类IOC Bean；
将@FeignClient的属性设置到FeignClientFactoryBean对象上，并注册IOC Bean。

@FeignClient修饰的接口实际上使用了Spring的代理工厂生成代理类，所以这里会把修饰了@FeignClient接口的BeanDefinition设置为FeignClientFactoryBean类型，而FeignClientFactoryBean继承自FactoryBean。

也就是说，当我们定义@FeignClient修饰接口时，注册到IOC容器中Bean类型变成了FeignClientFactoryBean。

在Spring中，FactoryBean是一个工厂Bean，用来创建代理Bean。工厂Bean是一种特殊的Bean，对于需要获取Bean的消费者而言，它是不知道Bean是普通Bean或是工厂Bean的。工厂Bean返回的实例不是工厂Bean本身，而是会返回执行了工厂Bean中FactoryBean#getObject逻辑的实例

四、Feign的工作原理

说Feign的工作原理，核心点围绕在被@FeignClient修饰的接口，如何发送及接收HTTP网络请求。

上面说到@FeignClient修饰的接口最终填充到IOC容器的类型是FeignClientFactoryBean，先来看下它是什么。

4.1 FactoryBean接口特征

这里说一下FeignClientFactoryBean都有哪些特征。

它会在类初始化时执行一段逻辑，依据Spring InitializingBean接口；
如果它被别的类@Autowired进行注入，返回的不是它本身，而是FactoryBean#getObject返回的类，依据Spring FactoryBean接口；
它能够获取Spring上下文对象，依据Spring ApplicationContextAware接口。

先来看它的初始化逻辑都执行了什么

@Override
public void afterPropertiesSet() {
    Assert.hasText(contextId, "Context id must be set");
    Assert.hasText(name, "Name must be set");
}

没有特别的操作，只是使用断言工具类判断两个字段不为空。ApplicationContextAware也没什么说的，获取上下文对象赋值到对象的局部变量里，重点以及关键就是FactoryBean#getObject方法。

@Override
public Object getObject() throws Exception {
    return getTarget();
}

getTarget源码方法还是挺长的，这里采用分段的形式展示

<T> T getTarget() {
    // 从IOC容器获取FeignContext
    FeignContext context = applicationContext.getBean(FeignContext.class);
    // 通过context创建Feign构造器
    Feign.Builder builder = feign(context);
    //...
}

这里提出一个疑问？FeignContext什么时候、在哪里被注入到Spring容器里的？