[享学Feign] 一、原生Feign初体验，Netflix Feign or Open Feign？

生命太短暂，不要去做一些根本没有人想要的东西。本文已被 https://www.yourbatman.cn 收录，里面一并有Spring技术栈、MyBatis、JVM、中间件等小而美的专栏供以免费学习。关注公众号【BAT的乌托邦】逐个击破，深入掌握，拒绝浅尝辄止。

–> 返回Netflix OSS套件专栏汇总 <–
代码下载地址：https://github.com/f641385712/feign-learning

前言

各位小伙伴大家好，我是A哥。从本系列开始，我们将一起进入Netflix Feign的学习。说到HTTP客户端，大家都不会感到陌生。Java自己源生的就有java.net包下的HttpURLConnection（虽然不太好用），同时优秀的开源产品更是百花齐放：

• Apache HttpClient
• OkHttp
• Spring的RestTemplate
  • 说明：它基于以上三种Client做的包装
• Feign（本专栏详述）

Feign的中文意思：假装；装作；捏造；想象

JDK源生的HC偏于底层且不好用，在Java9之前你几乎可以忽略它；作为老牌的Apache HttpClient凭借着各种优秀特征，似乎已成为了事实的标准；后起之秀OkHttp有着低网络延迟、更优秀的连接池性能，亦是一股不可轻视的力量；Spring它自己并不去重复发明轮子，而是借力打力提供了Http统一调用方式RestTemplate，屏蔽了细节，规范了开发者的使用。

说明：如果你在Spring环境，并不建议直接使用具体的HttpCLient技术，而是使用面向中间语言的RestTemplate。

本专栏将介绍一种 声明式 Http客户端：Feign。很多人认识Feign、使用Feign是因为Spring Cloud，它作为Spring Cloud最重要的组件之一，深入了解Feign对我们在云计算领域实践将具有很强的实战意义。
本专栏追本溯源，从最源生的Feign出发，再到和Spring整合、和Spring Boot整合，最后到Spring Cloud上的应用。目的是让你“一文在手，说走就走”。

---

版本声明

本专栏使用的各库的版本号做出如下声明：

• Feign版本号：10.4.0
• Spring版本号：5.2.2.RELEASE
• Spring Boot版本号：2.2.2.RELEASE
  • 基于Spring5.2.2.RELEASE构建的
• Spring Cloud版本号：Hoxton.SR1
  • 要求的Spring Boot 2.2.0版本以上（所以请确保和Spring Boot刚好搭配使用）

说明：Feign选择10.4.0版本，是为了保持和最新的SC的Hoxton.SR1版本“携带”的版本号保持一致。

feign-xxx模块附带的版本号公示（括号内为当前最新版本）：

• feign-okhttp -> okhttp 3.6.0（3.14.6）
  • 虽然okhttp最新版是4.x版，但因只是源码用kotlin改写了，所以Java环境下一班还是用3.x版本居多
• feign-httpclient -> Apache HttpClient4.5.3（4.5.11）
• feign-jackson -> Jackson 2.9.9.3（2.10.2）
• feign-slf4j -> slf4j 1.7.13（1.7.30）
• feign-hystrix -> hystrix-core 1.5.18（1.5.18） archaius-core 0.76（0.7.7）
• feign-ribbon -> ribbon-core 2.3.0（2.7.17） ribbon-loadbalancer 2.3.0（2.7.17）
• feign-spring4 -> spring-web 4.3.x (5.2.x)
  • feign-spring4它从feign的10.5.0版本才开始有哦，依赖于spring-web的4.3.x版本即可

说明：以上列出是开发中常见的库的版本号，基本上只要保持大版本号不变，可以替换成你自己的版本号，不会有冲突和不兼容现象（特别说明：okhttp并不建议使用4.x版本哦，因为3.x版本也一直在开发维护着…）

---

正文

Feign灵感来源于Retrofit、JAXRS-2.0和WebSocket，它旨在通过最少的资源和代码来实现和HTTP Client的能力。并且通过可定制的解码器和错误处理，编写任意的HTTP API。Feign使得 Java HTTP 客户端编写更方便。
该项目的github地址是：https://github.com/OpenFeign/feign

---

官网介绍

学习任何一门新技术，先官网，再实践，这是应有的态度。

---

产品原理图

产品路线图

官网最显眼部分放置了它的产品路线图。Feign还是蛮活跃的一个开源项目，它目前的最新版本是10.7.4，接下来它会把重心放在大版本11上，继续简化API的构建。

---

短期：目前正在做的

• 响应缓存
  • 支持api响应的缓存。允许用户定义响应在什么条件下可以进行缓存，以及应该使用什么类型的缓存机制
  • 支持内存缓存和外部缓存实现(EhCache、咖啡因、Redis、Spring等)
• 完整的URI模板表达式支持
  • 如果你是在Spring下构建它，好像Spring有提供URL构建工具
• 日志API重构
  • 重构Logger API，使其更接近SLF4J这样的框架，从而为在Feign中进行日志记录提供一个通用的心智模型。这个模型将被整个过程中使用，并提供如何使用记录器的更清晰的方向。
• 重试API重构
  • 重构Retry API以支持用户提供的条件并更好地控制回退策略。这可能导致非向后兼容的中断更改（向下不兼容）

---

中期：下一步会做的

• Metric API（度量API，监控用）
  • 提供一个一流的度量API，用户可以利用它来洞察请求/响应的生命周期。可能提供更好的OpenTracing支持。
• 通过CompletableFuture支持异步执行
  • 许对请求/响应生命周期进行未来的链接和执行程序管理。实现将需要非向后兼容的中断更改。但是，在考虑反应性执行Reactor模式之前，需要这个特性。
• 支持Reactive Streams
  • 对于JDK 9+，考虑使用java.util.concurrent.Flow的本机实现。
  • 对于Java8，支持用Project Reactor或者RxJava 2+实现

---

长期：将来会做的

• 附加断路器支持
  • 支持额外的断路器实现，如:Resilience4J以及和Spring自己的断路器（目前只支持到了Netflix的Hystrix）

---

为何选择Feign而非其它？

Feign使用Jersey和CXF等工具为REST或SOAP服务编写java客户端。此外，Feign允许您在http库(如Apache HttpClient)上编写自己的代码。Feign通过可定制的解码器和错误处理将您的代码与http API连接起来，并且只需要很少的开销。

---

Feign是如何工作的？

Feign的工作原理是：将注解处理成模板化的请求。参数在输出之前以一种简单的方式应用于这些模板。尽管Feign仅限于支持基于文本的api，但它极大地简化了系统方面如回放请求、重试。此外，了解这一点后，Feign可以轻松地对转换进行单元测试。

---

对Java版本的兼容性

Feign10.x和以上版本都是在Java 8上构建的（所以像feign-java8模块直接就移除了），且适用于Java 9、10和11。对于那些需要JDK 6兼容性的，请使用Feign 9.x

相关模块

Feign是一个完整的工程项目，除了core模块，还有众多其它实用模块（均为官方维护），截图展示如下：

除了截图这些模块其实还有比如：feign-java11、feign-googlehttpclient…等等非常多，其中：

• feign-spring4模块自10.5.0版本才有
• feign-googlehttpclient模块自10.4.0版本才有
• …绝大多数模块从9.0开始就都有了，所以使用中不用担心

---

使用示例

对于程序员来说，文字说明都太过于抽象且枯燥，因此下面是重头戏，用示例来感受一把它Feign的使用。
若要使用Feign，你仅仅只需导入核心包即可，因是首个示例，所以展示其POM文件如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>

    <groupId>com.youtbatmangroupId>
    <artifactId>java-feignartifactId>
    <version>1.0-SNAPSHOTversion>

    <properties>
        <java.version>1.8java.version>
        <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
        <feign.version>10.4.0feign.version>
        <lombok.version>1.18.10lombok.version>
    properties>

    <dependencies>
        <dependency>
            <groupId>io.github.openfeigngroupId>
            <artifactId>feign-coreartifactId>
            <version>${feign.version}version>
        dependency>

        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <version>${lombok.version}version>
            <scope>providedscope>
        dependency>
        <dependency>
            <groupId>junitgroupId>
            <artifactId>junitartifactId>
            <version>4.12version>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <version>3.3version>
                <configuration>
                    <forceJavacCompilerUse>trueforceJavacCompilerUse>
                    <source>1.8source>
                    <target>1.8target>
                configuration>
            plugin>
        plugins>
    build>
project>

准备服务端响应接口：

@Slf4j
@RestController
@RequestMapping("/feign")
public class FeignController {

    @GetMapping("/demo1")
    public String getDemo1(@RequestParam String name) {
        log.info(name);
        return "success:" + name;
    }
}

使用Feign书写客户端代码：

public interface DemoClient {
    @RequestLine("GET /feign/demo1?name={name}")
    String getDemo1(@Param("name") String name);
}

说明：因为使用的JDK动态代理，所以此处必须必须必须是接口

测试程序：

public static void main(String[] args) {
    DemoClient client = Feign.builder().target(DemoClient.class, "http://localhost:8080");
    String result = client.getDemo1("YourBatman");
    System.out.println(result);
}

运行程序，正常work。客户端正常收到返回值，输出为：

success:YourBatman

这是最最最最最最简单的一个Feign的使用案例，这里有很多的使用细节、坑等后面文章会一一描述，并且帮你填平。

---

Netflix Feign还是Open Feign？

在这个时间节点上，很多人对这“两种”Feign傻傻分不清楚，不知有何区别和联系，本文将给与告知。
首先需要明确：他俩是属于同一个东西，Feign属于Netflix开源的组件。针对于于差异性，下面分这几个方面展开做出对比

1、GAV坐标差异：

<dependency>
    <groupId>com.netflix.feigngroupId>
    <artifactId>feign-coreartifactId>
dependency>

<dependency>
    <groupId>io.github.openfeigngroupId>
    <artifactId>feign-coreartifactId>
dependency>

2、官网地址差异：
https://github.com/Netflix/feign和https://github.com/OpenFeign/feign。不过现在访问https://github.com/Netflix/feign已经被重定向到了后者上。

3、发版历史：

• Netflix Feign：1.0.0发布于2013.6，于2016.7月发布其最后一个版本8.18.0
• Open Feign：首个版本便是9.0.0版，于2016.7月发布，然后一直持续发布到现在（未停止）

从以上3个特点其实你可以很清楚的看到两者的区别和联系，简单的理解：Netflix Feign仅仅只是改名成为了Open Feign而已，然后Open Feign项目在其基础上继续发展至今。

9.0版本之前它叫Netflix Feign，自9.0版本起它改名叫Open Feign了。

但是请注意，虽然GAV完全变了，但是源码的包名和核心API是没有任何变化的，所以扔具有很好的向下兼容性（并不是100%向下兼容）。

---

spring-cloud-starter-feign还是spring-cloud-starter-openfeign？

他俩的差异类似于上述描述的差异，也从几个方面说明：

1、GAV坐标差异：

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-feignartifactId>
dependency>

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

发版历史：

• spring-cloud-starter-feign：2015.3发布1.0.0版本，2019.5.23发布器最后一个版本1.4.7.RELEASE
  • 值得注意的是，从1.4.0.RELEASE开始，它的1.4.x的发版轨迹完全同下的1.4.x的发版轨迹
• spring-cloud-starter-openfeign：2017.11发布其首个版本，版本号为：1.4.0.RELEASE。现在仍持续更新中，当下最新版为2.2.1.RELEASE

说明：1.4.7.RELEASE是整个Spring Cloud1.x关于Feign方面的最终版本，2.x版本还在持续维护更新中

注意：老的spring-cloud-starter-feign 从1.2.0.RELEASE开始 已放弃Netflix feign而全面使用更新的Open Feign版本，而spring-cloud-starter-openfeign更是和Netflix Feign已经没有关系了。

对于版本，可粗略的理解为：spring-cloud-starter-openfeign是为Spring Cloud2.x准备的，只不过维持了一段时间的对1.x的兼容。而spring-cloud-starter-feign是专为Spring Cloud1.x服务。

核心API包名：
Spring Cloud的大版本升级具有向下不兼容性，这也体现在了Feign上：

• @FeignClient注解：
  • 1.x版本包名是org.springframework.cloud.netflix.feign.FeignClient，所在Jar是spring-cloud-netflix-core
    • 说明：这里的1.x不仅仅指的feign，还包括openfeign的1.4.x版本哦
  • 2.x版本包名是org.springframework.cloud.openfeign.FeignClient，所在Jar是spring-cloud-openfeign-core
• @EnableFeignClients注解：
  • 差异同上

总结

关于Feign的基本介绍就到这了，通过这篇文章能够了解到Feign作为一个Http Client的基本使用方法，以及它的产品线路图。
同时也介绍了困扰很多小朋友的Netflix Feign和Open Feign的区别，以及版本号上的差异。我相信害怕来自于未知，当你从底层掌握了这些知识点后，相信你使用起来更够更加得心应手。

---

关注A哥

Author	A哥(YourBatman)
个人站点	www.yourbatman.cn
E-mail	[email protected]
微 信	fsx641385712
活跃平台
公众号	BAT的乌托邦（ID：BAT-utopia）
知识星球	BAT的乌托邦
每日文章推荐	每日文章推荐

• [享学Jackson] 一、初识Jackson – 世界上最好的JSON库
• [享学Jackson] 二、jackson-core之流式API与JsonFactory、JsonGenerator、JsonParser
• [享学Jackson] 三、jackson-databind之ObjectMapper与数据绑定、树模型
• [享学Jackson] 四、控制Jackson行为的特征们之JsonFactory.Feature、JsonGenerator.Feature、JsonParser.Feature
• [享学Jackson] 五、控制Jackson行为的特征们之JsonWriteFeature、JsonReadFeature
• [享学Jackson] 六、控制Jackson行为的特征们之MapperFeature、SerializationFeature、DeserializationFeature
• [享学Jackson] 七、Jackson使用bit位运算来开启/禁用Feature的原理解析
• [享学Jackson] 八、jackson-databind数据绑定基础配置之BaseSettings、MapperConfig、MapperConfigBase
• [享学Jackson] 九、jackson-databind数据绑定序列化/反序列化配置之SerializationConfig、DeserializationConfig
• [享学Jackson] 十、jackson-databind序列化之ObjectMapper序列化原理、序列化器匹配原理
• [享学Jackson] 十一、jackson-databind之JsonSerializer序列化器全解析
• [享学Jackson] 十二、jackson-databind反序列化之ObjectMapper反序列化原理、JsonDeserializer反序列化器全解析
• [享学Jackson] 十三、jackson-annotation注解模块全解析及Jackson注解大全
• [享学Jackson] 十四、深入理解Jackson的Module模块化设计及原理分析
• [享学Jackson] 十五、第三方模块Module的深度实践：JavaTimeModule、JSR310Module、ParameterNamesModule、Jdk8Module
• [享学Jackson] 十六、Jackson在Spring MVC中的使用之Date、JSR310时间类型的处理
• [享学Jackson] 十七、spring-web整合Jackson源码解析之Jackson2ObjectMapperBuilder
• [享学Jackson] 十八、Spring容器深度整合Jackson的桥梁之SpringHandlerInstantiator
• [享学Jackson] 十九、Spring下使用ObjectMapper的正确姿势 — Jackson2ObjectMapperFactoryBean
• [享学Jackson] 二十、Spring MVC下的Jackson — MappingJackson2HttpMessageConverter
• [享学Jackson] 二十一、Spring Boot下的Jackson — JacksonAutoConfiguration自动配置
• [享学Jackson] 二十二、Jackson与Fastjson的恩怨情仇（完结篇）