Feign : 优雅的调用 API feign如何调用
yuyutoo 2024-10-25 19:21 5 浏览 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
相关推荐
- Mysql和Oracle实现序列自增(oracle创建序列的sql)
-
Mysql和Oracle实现序列自增/*ORACLE设置自增序列oracle本身不支持如mysql的AUTO_INCREMENT自增方式,我们可以用序列加触发器的形式实现,假如有一个表T_WORKM...
- 关于Oracle数据库12c 新特性总结(oracle数据库19c与12c)
-
概述今天主要简单介绍一下Oracle12c的一些新特性,仅供参考。参考:http://docs.oracle.com/database/121/NEWFT/chapter12102.htm#NEWFT...
- MySQL CREATE TABLE 简单设计模板交流
-
推荐用MySQL8.0(2018/4/19发布,开发者说同比5.7快2倍)或同类型以上版本....
- mysql学习9:创建数据库(mysql5.5创建数据库)
-
前言:我也是在学习过程中,不对的地方请谅解showdatabases;#查看数据库表createdatabasename...
- MySQL面试题-CREATE TABLE AS 与CREATE TABLE LIKE的区别
-
执行"CREATETABLE新表ASSELECT*FROM原表;"后,新表与原表的字段一致,但主键、索引不会复制到新表,会把原表的表记录复制到新表。...
- Nike Dunk High Volt 和 Bright Spruce 预计将于 12 月推出
-
在街上看到的PandaDunk的超载可能让一些球鞋迷们望而却步,但Dunk的浪潮仍然强劲,看不到尽头。我们看到的很多版本都是为女性和儿童制作的,这种新配色为后者引入了一种令人耳目一新的新选择,而...
- 美国多功能舰载雷达及美国海军舰载多功能雷达系统技术介绍
-
多功能雷达AN/SPY-1的特性和技术能力,该雷达已经在美国海军服役了30多年,其修改-AN/SPY-1A、AN/SPY-1B(V)、AN/SPY-1D、AN/SPY-1D(V),以及雷神...
- 汽车音响怎么玩,安装技术知识(汽车音响怎么玩,安装技术知识视频)
-
全面分析汽车音响使用或安装技术常识一:主机是大多数人最熟习的音响器材,有关主机的各种性能及规格,也是耳熟能详的事,以下是一些在使用或安装时,比较需要注意的事项:LOUDNESS:几年前的主机,此按...
- 【推荐】ProAc Response系列扬声器逐个看
-
有考牌(公认好声音)扬声器之称ProAcTablette小音箱,相信不少音响发烧友都曾经,或者现在依然持有,正当大家逐渐掌握Tablette的摆位设定与器材配搭之后,下一步就会考虑升级至表现更全...
- #本站首晒# 漂洋过海来看你 — BLACK&DECKER 百得 BDH2000L无绳吸尘器 开箱
-
作者:初吻给了烟sco混迹张大妈时日不短了,手没少剁。家里有了汪星人,吸尘器使用频率相当高,偶尔零星打扫用卧式的实在麻烦(汪星人:你这分明是找借口,我掉毛是满屋子都有,铲屎君都是用卧式满屋子吸的,你...
- 专题|一个品牌一件产品(英国篇)之Quested(罗杰之声)
-
Quested(罗杰之声)代表产品:Q212FS品牌介绍Quested(罗杰之声)是录音监听领域的传奇品牌,由英国录音师RogerQuested于1985年创立。在成立Quested之前,Roger...
- 常用半导体中英对照表(建议收藏)(半导体英文术语)
-
作为一个源自国外的技术,半导体产业涉及许多英文术语。加之从业者很多都有海外经历或习惯于用英文表达相关技术和工艺节点,这就导致许多英文术语翻译成中文后,仍有不少人照应不上或不知如何翻译。为此,我们整理了...
- Fyne Audio F502SP 2.5音路低音反射式落地音箱评测
-
FyneAudio的F500系列,有新成员了!不过,新成员不是新的款式,却是根据原有款式提出特别版。特别版产品在原有型号后标注了SP字样,意思是SpecialProduction。Fyne一共推出...
- 有哪些免费的内存数据库(In-Memory Database)
-
以下是一些常见的免费的内存数据库:1.Redis:Redis是一个开源的内存数据库,它支持多种数据结构,如字符串、哈希表、列表、集合和有序集合。Redis提供了快速的读写操作,并且支持持久化数据到磁...
- RazorSQL Mac版(SQL数据库查询工具)
-
RazorSQLMac特别版是一款看似简单实则功能非常出色的SQL数据库查询、编辑、浏览和管理工具。RazorSQLformac特别版可以帮你管理多个数据库,支持主流的30多种数据库,包括Ca...
你 发表评论:
欢迎- 一周热门
-
-
前端面试:iframe 的优缺点? iframe有那些缺点
-
带斜线的表头制作好了,如何填充内容?这几种方法你更喜欢哪个?
-
漫学笔记之PHP.ini常用的配置信息
-
其实模版网站在开发工作中很重要,推荐几个参考站给大家
-
推荐7个模板代码和其他游戏源码下载的网址
-
[干货] JAVA - JVM - 2 内存两分 [干货]+java+-+jvm+-+2+内存两分吗
-
正在学习使用python搭建自动化测试框架?这个系统包你可能会用到
-
织梦(Dedecms)建站教程 织梦建站详细步骤
-
【开源分享】2024PHP在线客服系统源码(搭建教程+终身使用)
-
2024PHP在线客服系统源码+完全开源 带详细搭建教程
-
- 最近发表
-
- Mysql和Oracle实现序列自增(oracle创建序列的sql)
- 关于Oracle数据库12c 新特性总结(oracle数据库19c与12c)
- MySQL CREATE TABLE 简单设计模板交流
- mysql学习9:创建数据库(mysql5.5创建数据库)
- MySQL面试题-CREATE TABLE AS 与CREATE TABLE LIKE的区别
- Nike Dunk High Volt 和 Bright Spruce 预计将于 12 月推出
- 美国多功能舰载雷达及美国海军舰载多功能雷达系统技术介绍
- 汽车音响怎么玩,安装技术知识(汽车音响怎么玩,安装技术知识视频)
- 【推荐】ProAc Response系列扬声器逐个看
- #本站首晒# 漂洋过海来看你 — BLACK&DECKER 百得 BDH2000L无绳吸尘器 开箱
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)