百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

Feign : 优雅的调用 API feign如何调用

yuyutoo 2024-10-25 19:21 6 浏览 0 评论


前言

在项目开发中,系统间会存在接口调用,在微服务架构中可以使用 Dubbo 来实现服务间的 RPC 调用,也可以使用 Spring Could 完成 API 调用,这些框架屏蔽了 API 调用中的像服务建连、通信协议、序列化等等细节,让开发者可以很轻松发起一个接口调用,但是当需要调用一个外部系统时,由于通信协议、技术框架、网络隔离、安全性等因素,一般会采用原生 HTTP 协议进行接口调用

URLConnection

在 Java 中,JDK 提供了 HTTP 的工具类 URLConnection,通过 URLConnection 可以发起 HTTP 请求,如:

HttpURLConnection connection = null;
InputStream inputStream = null;
InputStreamReader inputStreamReader = null;
BufferedReader bufferedReader = null;
try {
    connection = (HttpURLConnection)(new URL("http://www.api.com/get")).openConnection();
    connection.connect();
    // 读取接口返回内容
    inputStream = connection.getInputStream();
    inputStreamReader = new InputStreamReader(inputStream);
    bufferedReader = new BufferedReader(inputStreamReader);
    String line = bufferedReader.readLine();
    StringBuffer lines = new StringBuffer();
    while(line != null) {
        line = bufferedReader.readLine();
        lines.append(line);
    }
   
    // 反序列化成 json
    JSONObject jsonObject = JSON.parseObject(EntityUtils.toString(response.getEntity()));
    // TODO
    // jsonObject.get('xx')
    // ……
    
} catch(Exception e) {
    e.printStackTrace();
} finally {
    connection.disconnect();
    if(inputStream != null) inputStream.close();
    if(inputStreamReader != null) inputStreamReader.close();
    if(bufferedReader != null) bufferedReader.close();
}

在不借助任何框架的前提下使用 JDK 自带的类库来发起 HTTP 调用

HttpClient

在实际项目中一般不会使用 JDK 自带的 URLConnection,原因是性能不高,没有连接池,代码也很臃肿,所以一般会使用 HttpClient 来代替 URLConnection,这也是大家比较常见的使用方式,如:

SchemeRegistry schreg = new SchemeRegistry();
schreg.register(new Scheme("http", 80, PlainSocketFactory.getSocketFactory()));
PoolingClientConnectionManager conMgr = new PoolingClientConnectionManager(schreg);
conMgr.setMaxTotal(200);// 连接池最大数
conMgr.setDefaultMaxPerRoute(conMgr.getMaxTotal());

// 发起 API 调用
DefaultHttpClient defaultHttpClient = new DefaultHttpClient(conMgr);
HttpGet get = new HttpGet("http://www.api.com/get");
CloseableHttpResponse response = defaultHttpClient.execute(get);

// 反序列化成 json
JSONObject jsonObject = JSON.parseObject(EntityUtils.toString(response.getEntity()));
// TODO
// jsonObject.get('xx')
// ……

EntityUtils.consume(response.getEntity());

一般来说 HttpClient 可以满足日常的开发了,如果是使用 json 作为序列化协议的话,则需要在调用接口和获取接口返回值时分别进行序列化和反序列化操作,这样看似没有问题,但假如当系统中需要调用100个不同的 HTTP 接口,每个接口都需要处理序列化、反序列化以及上面的 HttpClient 相关的代码,代码可读性就非常差,系统的可维护性就低,当然你可以封装 HttpClient 的相关方法,对序列化、反序列化进行泛化封装,提高可读性,此外也有另一种更好的处理方法,使用 Feign 框架,像调用本地方法一样调用 API。

Feign

引入依赖

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

使用 Feign 调用接口跟调用 RPC 一样,都是先定义 API 的接口

interface API {
    @RequestLine("GET /get")
    @Headers("Content-Type: application/json")
    Response get(Request request);
}

API 接口声明了一个 get 方法,接口的地址为 /get ,同时在 header 头中加入了 Content-Type,Request 作为参数是 get 接口的参数,Response 作为返回值是 get 接口的返回值,Feign 会自动将 Request 对象序列化成 /get 的参数,同时把接口返回值序列化成 Response 对象。

定义好接口后,就可以通过 Feign 来生成 "http://www.api.com" 接口的代理类

API api = Feign.builder()
                .decoder(new JacksonDecoder())
                .encoder(new JacksonEncoder())
                .client(new ApacheHttpClient(HttpClientBuilder.create().setMaxConnPerRoute(100).setMaxConnTotal(500).build()))
                .logger(new Slf4jLogger())
                .addCapability(new Metrics5Capability())
                .retryer(Retryer.NEVER_RETRY)
                .target(Oudianyun.class, "http://www.api.com");

通过 Feign.builder() 为每个域名生成一个 API 代理类,其中序列化协议使用了 json;HTTP 框架使用了 Apache HttpClient,在 Feign 内部最终还是通过 HttpClient 来发送 HTTP 请求,也可以只用 OkHttp;日志使用了 Slf4j

通过 Feign.builder 得到 API 的代理类后,就可以发起接口调用了

// 构建参数
Request request = new Request();
request.setId("abc");
// 调用 get 接口
Response response = api.get(request);

发现没有,使用 Feign 后根据不用关心 HTTP 请求中需要处理的序列化、请求头等硬编码,这些都是 Feign 帮我们实现了,使用时只需要根据不同的域名通过 Feign 来生成代理类,然后跟调用本地方法一样直接调用接口

上面完成简单的 Feign 的使用,在实际开发中这还是远不够的,上面的 API 对象是通过硬编码的方式来创建的,而实际项目中对象一般都是交给 Spring 来管理的,因此最佳的方式是把 Feign 和 Spring 整合

Spring Cloud Feign

Spring Cloud 整合了 Feign,并对其进行改造并将整合内容放到了 spring-cloud-openfeign 模块中,相比原生的 Feign 来说 Spring 容器管理了所有的对象,并对其进行了增强,加入了 fallback机制、负载均衡等特性。

引入依赖

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

跟 Feign 一样,Spring Cloud Feign 也是先定义 API 的接口

@FeignClient(value = "SpringCloudAPI", url ="http://www.api.com", fallback = SpringCloudAPIFallback.class)
interface SpringCloudAPI {
    
    @GetMapping("/get")
    Response get(Request request);
    
}

使用 @FeignClient 注解来声明 url 以及 fallback 降级处理类,当接口出现异常时会调用 SpringCloudAPIFallback 类中的降级方法,降级类如下:

@Component
class SpringCloudAPIFallback implements SpringCloudAPI{
    public Response get(Request request) {
        return "接口出现异常,使用 mock 数据";
    }
}

通过在 Spring Boot 中新增 @EnableFeignClients 开启 Spring Cloud Feign 功能

@SpringBootApplication(scanBasePackages = "feign")
@EnableFeignClients(basePackages = "feign")
public class SpringCloudFeignDemo {
    public static void main(String[] args) {
        new SpringApplication(SpringCloudFeignDemo.class).run(args);
    }
}

Spring Boot 中启用 Feign HttpClient 的参数配置如下:

feign.httpclient.enabled=true
feign.httpclient.connection-timeout=2000
feign.httpclient.connection-timer-repeat=3000
feign.httpclient.max-connections=500
feign.httpclient.max-connections-per-route=500
feign.httpclient.time-to-live=900
feign.httpclient.time-to-live-unit=SECONDS

Spring Could Feign 的 Fallback 是依赖 hystrix 来实现降级的,由于 hystrix 已经不维护了,因此推荐使用 Alibaba 的 Sentinel 来代替 hystrix,加入以下配置启用 Sentinel

引入依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    <version>2.2.3.RELEASE</version>
</dependency>

开启配置

feign.sentinel.enabled=true

相关推荐

12、高阶组件:魔法增幅器——React 19 HOC模式

一、魔法增幅器的本质"高阶组件是魔法师用咒语叠加的炼金术,"霍格沃茨魔咒研究院院长凝视着发光的增幅器,"通过函数式能量场的嵌套,让基础组件获得预言家日报式的逻辑继承!"...

深入理解nodejs的异步IO与事件模块机制

一、node为什么要使用异步I/O异步最先诞生于操作系统的底层,在底层系统中,异步通过信号量、消息等方式有广泛的应用。但在大多数高级编程语言中,异步并不多见,这是因为编写异步的程序不符合人习惯的思维逻...

前端时间同步利器:React + useEffect 实现高性能动态时钟

前言在你奋笔疾敲代码的瞬间,是不是突然一低头,发现时间像偷偷跑路的变量,一眨眼就从上午飘到下午?饭没吃、会没开、工位也快被前端猫霸占了。仿佛你写的不是代码,而是“时间穿梭机”。别慌,咱们今天就来用R...

JavaScript 异步编程指南 - 聊聊 Node.js 中的事件循环

作者:五月君来源:编程界|事件循环是一种控制应用程序的运行机制,在不同的运行时环境有不同的实现,上一节讲了浏览器中的事件循环,它们有很多相似的地方,也有着各自的特点,本节讨论下Node.js中...

10个Vue开发技巧「实践」

作者:WahFung转发链接:https://juejin.im/post/5e8a9b1ae51d45470720bdfa路由参数解耦一般在组件内使用路由参数,大多数人会这样做:...

通过番计时器实例学习 React 生命周期函数 componentDidMount

大家好,今天我们将通过一个实例——番茄计时器,学习下如何使用函数生命周期的一个重要函数componentDidMount():componentDidMount(),在组件加载完成,render之后...

SRE监控四大黄金指标,任何一个有异常都会是灾难……

导读...

前端必看!10 个 Vue3 救命技巧,解决你 90% 的开发难题?

写Vue3项目时,是不是总被数据更新延迟、组件间传值混乱、页面加载缓慢这些问题折磨得头秃?别担心!作为摸爬滚打多年的老前端,今天掏出压箱底的10个实战技巧,从性能优化到复杂逻辑处理,每一个都能...

如何用2 KB代码实现3D赛车游戏?2kPlus Jam大赛了解一下

选自frankforce作者:Frank机器之心编译参与:王子嘉、GeekAI控制复杂度一直是软件开发的核心问题之一,一代代的计算机从业者纷纷贡献着自己的智慧,试图降低程序的计算复杂度。然而,将一款...

证明你访问的网站是你想访问的,Safari 真的需要

安全研究员在Safari上找到了一个新漏洞,能让网站在浏览器的地址栏内将自己伪装成另一个网站——得益于Safari地址栏的“智能缩略”功能。在Deusen最近公开的攻击演示(PoC,P...

抓狂!TS 组件性能拉胯到崩溃?4 个绝杀技巧逆风翻盘!

前端兄弟姐妹们五一假期快乐,咱们谁还没被TypeScript组件的性能问题折磨过?页面加载转圈圈,点击按钮没反应,代码改了一轮又一轮,性能却还是原地踏步,分分钟想砸电脑!别慌,今天这4个绝杀技...

让小球做圆周运动,你有几种办法?

最近在阅读外国技术文章中无意中发现了一个神奇的CSS属性motion-path,它可以让Dom元素可以按照自定义的路径移动。又想起了很久之前参加校招面试的时候,面试官问了我一个问题“能不能不借助库实现...

前端基础进阶(十四):深入核心,详解事件循环机制

EventLoopJavaScript的学习零散而庞杂,很多时候我们学到了一些东西,但是却没办法感受到进步!甚至过了不久,就把学到的东西给忘了。为了解决自己的这个困扰,在学习的过程中,我一直在试图寻...

从0搭建一个WebRTC,实现多房间多对多通话,并实现屏幕录制

这篇文章开始会实现一个一对一WebRTC和多对多的WebRTC,以及基于屏幕共享的录制。本篇会实现信令和前端部分,信令使用fastity来搭建,前端部分使用Vue3来实现。为什么要使用WebRTCWe...

Vue2 开发卡壳?这 10 个实战技巧专治各种不服

干前端开发的兄弟,谁还没被Vue2折腾过?数据不更新、组件通信乱成麻、性能差到想砸电脑……这些痛点,我都懂!今天直接甩出10个超实用的实战技巧,每一个都是从项目“血坑”里爬出来总结的,专...

取消回复欢迎 发表评论: