[享学Feign] 一、原生Feign初体验,Netflix Feign or Open Feign?

死亡不是生命的终点,遗忘才是。

–> 返回专栏总目录 <–
代码下载地址:https://github.com/f641385712/feign-learning

前言

说到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使用JerseyCXF等工具为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-java11feign-googlehttpclient…等等非常多,其中:

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

使用示例

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

<?xml version="1.0" encoding="UTF-8"?>
<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.0</modelVersion>

    <groupId>com.youtbatman</groupId>
    <artifactId>java-feign</artifactId>
    <version>1.0-SNAPSHOT</version>

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

    <dependencies>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-core</artifactId>
            <version>${feign.version}</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.3</version>
                <configuration>
                    <forceJavacCompilerUse>true</forceJavacCompilerUse>
                    <source>1.8</source>
                    <target>1.8</target>
                </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.feign</groupId>
    <artifactId>feign-core</artifactId>
</dependency>

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-core</artifactId>
</dependency>

2、官网地址差异
https://github.com/Netflix/feignhttps://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.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</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 FeignOpen Feign的区别,以及版本号上的差异。我相信害怕来自于未知,当你从底层掌握了这些知识点后,相信你使用起来更够更加得心应手。

分隔线

声明

原创不易,码字不易,多谢你的点赞、收藏、关注。把本文分享到你的朋友圈是被允许的,但拒绝抄袭。你也可【左边扫码/或加wx:fsx641385712】邀请你加入我的 Java高工、架构师 系列群大家庭学习和交流。
往期精选

发布了378 篇原创文章 · 获赞 572 · 访问量 51万+
展开阅读全文

openfeign里面配置httpclient出错。

08-18

因为现在需要使用get方式传递对象参数,所以尝试在openfeign里面配置httpclient。 配置代码如下: 在yml文件里面增加了配置信息 ``` feign: httpclient: enabled: true ``` 在pom.xml文件中引入的依赖: ``` <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.3</version> </dependency> <!-- 使用Apache HttpClient替换Feign原生httpclient --> <dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-httpclient</artifactId> <version>8.16.1</version> </dependency> ``` 配置好以后尝试使用get方式传递对象参数。 服务提供端代码: ``` @GetMapping(value = "testAddRole1",consumes = "application/json") public JsonResult addTest1(@RequestBody Role role){ roleService.addRole(role); return JsonResult.getInstant(ReturnCodeEnum.SUCCESS); } ``` 服务调用接口为: ``` @GetMapping(value = "/testAddRole1",consumes = "application/json") JsonResult testAddRole1(@RequestBody Role role); ``` 现在在尝试调用接口后发现服务提供方可以接受到参数并且能够写到数据库中,但是在服务调用方拿不到正确的返回值并且会报错,错误如下: ``` Caused by: java.lang.NoSuchMethodError: feign.Response.create(ILjava/lang/String;Ljava/util/Map;Lfeign/Response$Body;)Lfeign/Response; ``` 查看源码得知,openfeign在接受返回值时调用的不是httpclient的feign-core包的代码而是调用的本身的feign-core的代码,而本身的feign-core包中的Response类没有create方法。 得知原因后我将httpclient的依赖在pom文件中的位置上移,使openfeign优先调用httpclient的feign-core包的代码,结果在启动项目时就报错,报错信息为: ``` org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'test1Controller' defined in file [D:\workspace\basic\openfeign\target\classes\cn\cloudscope\openfeignTest\Test1\controller\Test1Controller.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'cn.cloudscope.openfeignTest.Test1.service.Test1Service': FactoryBean threw exception on object creation; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'feignRetryer' defined in org.springframework.cloud.openfeign.FeignClientsConfiguration: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [feign.Retryer]: Factory method 'feignRetryer' threw exception; nested exception is java.lang.NoSuchFieldError: NEVER_RETRY ``` 查看原因得知是两个feign-core包中的Retryer接口不一致导致的,求来个大神帮忙解决一下,或者怎么调整jar包的版本去解决这个问题。openfeign的feign-core版本为10.1.0 httpclient的版本为8.16.1 问答

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: Age of Ai 设计师: meimeiellie

分享到微信朋友圈

×

扫一扫,手机浏览