iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >一文教你如何使用原生的Feign
  • 623
分享到

一文教你如何使用原生的Feign

2024-04-02 19:04:59 623人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

目录什么是Feign为什么使用Feign为什么要使用Http client为什么要使用Feign如何使用Feign项目环境说明引入依赖入门例子个性化配置更换为spring的注解自定义

什么是Feign

Feign 是由 Netflix 团队开发的一款基于 Java 实现的 HTTP client,借鉴了 Retrofit、 JAXRS-2.0、websocket 等类库。通过 Feign,我们可以像调用方法一样非常简单地访问 HTTP api。这篇博客将介绍如何使用原生的 Feign,注意,是原生的,不是经过 Spring 层层封装的 Feign。

补充一下,在 Maven 仓库中搜索 feign,我们会看到两种 Feign: OpenFeign Feign 和 Netflix Feign。它们有什么区别呢?简单地说,OpenFeign Feign 的前身就是 Netflix Feign,因为 Netflix Feign 从 2016 年开始就不维护了,所以建议还是使用 OpenFeign Feign。

为什么使用Feign

为什么要使用HTTP client

首先,因为 Feign 本身是一款 HTTP client,所以,这里先回答:为什么使用 HTTP client?

假设不用 HTTP client,我们访问 HTTP API 的过程大致如下。是不是相当复杂呢?直接操作 Socket 已经非常麻烦了,我们还必须在熟知 HTTP 协议的前提下自行完成报文的组装和解析,代码的复杂程度可想而知。

那么,这个过程是不是可以更简单一些呢?

我们可以发现,在上面的图中,红框的部分是相对通用的,是不是可以把这些逻辑封装起来?基于这样的思考,于是就有了 HTTP client(根据类库的不同,封装的层次会有差异)。

所以,为什么要使用 HTTP client 呢?简单地说,就是为了让我们更方便地访问 HTTP API。

为什么要使用Feign

HTTP client 的类库还有很多,例如 Retrofit、jdk 自带的 HttpURLConnection、Apache HttpClient、OkHttp、Spring 的 RestTemplate,等等。我很少推荐说要使用哪种具体的类库,如果真的要推荐 Feign 的话,主要是由于它优秀的扩展性(不是一般的优秀,后面的使用例子就可以看到)。

如何使用Feign

关于如何使用 Feign,官方给出了非常详细的文档,在我看过的第三方类库中,算是比较少见的。

本文用到的例子也是参考了官方文档。

项目环境说明

os:win 10

jdk:1.8.0_231

maven:3.6.3

IDE:Spring Tool Suite 4.6.1.RELEASE

引入依赖

这里引入 gson,是因为入门例子需要有一个 JSON 解码器。


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

入门例子

入门例子中使用 Feign 来访问 github 的接口获取 Feign 这个仓库的所有贡献者。

通过下面的代码可以发现,Feign 本质上是使用了动态代理来生成访问 HTTP API 的代码,定义 HTTP API 的过程有点像在定义 advice。


// 定义HTTP API
interface GitHub {
    
    @RequestLine("GET /repos/{owner}/{repo}/contributors")
    // @RequestLine(value = "GET /repos/{owner}/{repo}/contributors", decodeSlash = false)// 测试转义"/"、"+"
    // @RequestLine("GET /repos/{owner:[a-zA-Z]*}/{repo}/contributors")// 测试正则校验
    // @Headers("Accept: application/json") // 测试添加header
    List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo);
}

public static class Contributor {
    String login;
    int contributions;
}

public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder()) // 返回内容为json格式,所以需要用到json解码器
                // .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true)) // 配置超时参数等
                .target(GitHub.class, "https://api.github.com");

        // 像调用方法一样访问HTTP API
        github.contributors("OpenFeign", "feign").stream()
            .map(contributor -> contributor.login + " (" + contributor.contributions + ")")
            .forEach(System.out::println);
    }
}

个性化配置

除了简单方便之外,Feign 还有一个很大的亮点,就是有相当优秀的扩展性,几乎什么都可以自定义。下面是官方给的一张图,基本涵盖了 Feign 可以扩展的内容。每个扩展支持都有一个对应的适配包,例如,更换解码器为 jackson 时,需要引入io.github.openfeign:feign-jackson的适配包。

更换为Spring的注解

在入门例子中,我们使用 Feign 自带的注解来定义 HTTP API。但是,对于习惯了 Spring 注解的许多人来说,无疑需要增加学习成本。我们自然会问,Feign 能不能支持 Spring 注解呢?答案是肯定的。Feign 不但能支持 Spring 注解,还可以支持 JAX-RS、SOAP 等等。

下面就是使用 Sping 注解定义 HTTP API 的例子。注意,pom 文件中要引入 io.github.openfeign:feign-spring4 的依赖。


// 定义HTTP API
interface GitHub {
    
    @GetMapping("/repos/{owner}/{repo}/contributors")
    List<Contributor> contributors(@RequestParam("owner") String owner, @RequestParam("repo") String repo);
}


public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .contract(new SprinGContract())// 自定义contract
                .target(GitHub.class, "https://api.github.com");
    }
}

自定义解码器和编码器

在入门例子中,我们使用 gson 来解析 json。那么,如果我想把它换成 jackson 行不行?Feign 照样提供了支持。

注意,pom 文件中要引入 io.github.openfeign:feign-jackson 的依赖。


public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new JacksonDecoder()) // 自定义解码器
                .encoder(new JacksonEncoder()) // 自定义编码器
                .target(GitHub.class, "https://api.github.com");
    }
}

自定义内置的HTTP client

接下来的这个自定义就更厉害了。Feign 本身作为一款 HTTP client,竟然还可以支持其他 HTTP client。

这里用 OkHttp 作例子。注意,pom 文件中要引入 io.github.openfeign:feign-okhttp 的依赖。


public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .client(new OkHttpClient())// 自定义client
                .target(GitHub.class, "https://api.github.com");
    }
}

自定义拦截器

我们访问外部接口时,有时需要带上一些特定的 header,例如,应用标识、token,我们可以通过两种方式实现:一是使用注解定义 HTTP API,二是使用拦截器(更常用)。下面的例子中,使用拦截器给请求添加 token 请求头。


public class MyInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate template) {
        template.header("token", LoginUtils.getCurrentToken());
    }
}
public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .requestInterceptor(new MyInterceptor())
                .target(GitHub.class, "https://api.github.com");
    }
}

自定义重试器

默认情况下,Feign 访问 HTTP API 时,如果抛出IOException,它会认为是短暂的网络异常而发起重试,这时,Feign 会使用默认的重试器feign.Retryer.Default(最多重试 5 次),如果不想启用重试,则可以选择另一个重试器feign.Retryer.NEVER_RETRY。当然,我们也可以自定义。

奇怪的是,Feign 通过重试器的 continueOrPropagate(RetryableException e)方法是否抛出RetryableException来判断是否执行重试,为什么不使用 true 或 false 来判断呢?

注意,重试器是用来判断是否执行重试,自身不包含重试的逻辑。


public class MyRetryer implements Retryer {
    
    int attempt = 0;

    @Override
    public void continueOrPropagate(RetryableException e) {
        // 如果把RetryableException抛出,则不会继续重试
        // 否则继续重试
        if(attempt++ >= 3) {// 重试三次
            throw e;
        }
    }

    @Override
    public Retryer clone() {
        return this;
    }
}
public class MyApp {

    public static void main(String... args) {
        // 获取用来访问HTTP API的代理类
        GitHub github = Feign.builder()
                .decoder(new GsonDecoder())
                .retryer(new MyRetryer())
                //.retryer(Retryer.NEVER_RETRY) // 不重试
                .exceptionPropagationPolicy(ExceptionPropagationPolicy.UNWRAP)
                .target(GitHub.class, "https://api.github.com");
    }
}

结语

以上,基本讲完 Feign 的使用方法,其实 Feign 还有其他可以扩展的东西,例如,断路器、监控等等。感兴趣的话,可以自行分析。

到此这篇关于如何使用原生的Feign的文章就介绍到这了,更多相关使用原生的Feign内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

参考资料

Feign github

相关源码请移步:https://github.com/ZhangZiSheng001/feign-demo

--结束END--

本文标题: 一文教你如何使用原生的Feign

本文链接: https://www.lsjlt.com/news/155957.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • 一文教你如何使用原生的Feign
    目录什么是Feign为什么使用Feign为什么要使用HTTP client为什么要使用Feign如何使用Feign项目环境说明引入依赖入门例子个性化配置更换为Spring的注解自定义...
    99+
    2024-04-02
  • 怎么使用原生的Feign
    这篇文章主要介绍了怎么使用原生的Feign,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。什么是FeignFeign 是由 Netflix 团队开发的一款基于 Java 实现的...
    99+
    2023-06-25
  • 一文教你如何优雅的使用WebSocket
    目录简介特性使用场景具体实现一、首先是服务端代码,这里我用的是nodejs。二、然后是客户端代码总结简介 websocket是基于TCP的一种双向通信协议。在此之前,一直是采用轮询的...
    99+
    2024-04-02
  • 一文教你使用AspectJ
    本篇文章为大家展示了一文教你使用AspectJ,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。AOP虽然是方法论,但就好像OOP中的Java一样,一些先行者也开发了一套语言来支持AOP。目前用得比较火...
    99+
    2023-05-31
    aspectj ct
  • 一文教你使用MyBatis
    这期内容当中小编将会给大家带来有关一文教你使用MyBatis,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。什么是 MyBatisMyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架...
    99+
    2023-05-31
    mybatis
  • 一文教你如何在java中使用SpringMVC
    这期内容当中小编将会给大家带来有关一文教你如何在java中使用SpringMVC,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。一、简介在SpringMVC 中,控制器Controller 负责处理由Dis...
    99+
    2023-05-31
    java springmvc ava
  • 一文教你如何在Java 中使用Calendar类
    今天就跟大家聊聊有关一文教你如何在Java 中使用Calendar类,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。Java Calendar类的使用总结  在实际项目当中,我们经常会...
    99+
    2023-05-31
    java calendar ava
  • 详解教你Win10如何使用一键还原精灵
    一键还原精灵是Windows 10操作系统自带的恢复工具,可以帮助用户在系统出现问题时恢复到之前的状态。下面是详细的使用教程:1. ...
    99+
    2023-09-17
    win10
  • 一文教你如何使用Python绘制瀑布图
    目录前期准备方法一:waterfall_ax方法二:waterfall_chart方法三:plotly什么是瀑布图?瀑布图用表达两个数值之间的变化过程,过程值为正的时候,向上加,过程...
    99+
    2023-05-16
    Python绘制瀑布图 Python 瀑布图
  • 一文教你如何使用Databinding写一个关注功能
    目录前言目标ModlePresenter前言 但是没有合理的架构,大家写出来的代码很可能是一大堆的复制粘贴。比如十几个页面,都有这个关注按钮。然后,你是不是也要写十几个地方呢 然后修...
    99+
    2024-04-02
  • 一文教你利用Python制作一个生日提醒
    目录1. 实战1-1  安装依赖1-2  创建数据表1-3  查询数据1-4  遍历,获取距离今天的天...
    99+
    2022-12-27
    Python生日提醒 Python生日 Python 提醒
  • 教你使用Python 的 Template 类生成文件报告
    目录示例:生成最佳图书的报告本文概要很多时候,我发现自己需要进行生成报告、输出文件或字符串的任务。它们或多或少都会遵循某种模式,通常这些模式是如此相似,以至于我们希望拥有一个可以重用...
    99+
    2024-04-02
  • 一文教你如何使用Node进程管理工具-pm2
    目录pm2 是什么pm2 基本命令负载均衡配置文件日志总结pm2 是什么 pm2 是一个守护进程管理工具,它能帮你守护和管理你的应用程序。通常一般会在服务上线的时候使用 pm2 进行...
    99+
    2023-05-16
    Node进程管理工具pm2 进程管理工具pm2
  • 一篇文章教你如何在SpringCloud项目中使用OpenFeign
    目录OpenFeign的介绍OpenFeign是一种声明式 、模板化的HTTP客户端。OpenFeign与Feign的之间的关系OpenFegin中的两个常用注解在项目中使用Open...
    99+
    2024-04-02
  • 一文教你如何封装安全的go
    目录前言封装SafeGoSafeGoAndWait实现说明首先是接口设计方面其次是日志兼容hade最后是打印panic的trace记录总结前言 在业务代码开发过程中,我们会有很大概率...
    99+
    2024-04-02
  • 教你如何使用 JavaScript 读取文件
    目录使用 JavaScript 读取文件概述选择带有输入元素的文件处理输入元素的变化事件从输入元素的 files 属性中获取一个 File 对象使用 FileReader 读取 Fi...
    99+
    2024-04-02
  • 一文教你正确的使用Spring boot框架
    今天就跟大家聊聊有关一文教你正确的使用Spring boot框架,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。前言首先来说一下为什么使用 Spring Boot,之前我用的后端 WE...
    99+
    2023-05-31
    springboot spring boo
  • 一篇文章教你如何用 Python 记录日
    (点击上方公众号,可快速关注)编译: Python开发者 - 李趴趴要化身女超人,英文:Mario Corcherohttp://python.jobbole.com/89007/对一名开发者来说最糟糕的情况,莫过于要弄清楚一个不熟...
    99+
    2023-01-31
    教你 一篇文章 如何用
  • 如何使用git和Python教程一起load你的程序和文档?
    Git是一种用于版本控制和协作的工具,而Python是一种广泛使用的编程语言。两者的结合可以帮助您更轻松地管理代码、文档和其他项目文件。在本教程中,我们将介绍如何使用Git和Python一起load您的程序和文档。 第一步:安装Git和P...
    99+
    2023-06-26
    教程 load git
  • 一文教会你如何在JavaScript中使用展开运算符
    目录前言语法功能以及参数创建数组创建对象将 NodeList 转换为数组从数组中删除重复项扩展运算符与休息运算符结论总结前言 在本教程中,您将了解在 JavaScript 中使用扩展...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作