如何更优雅地对接第三方API

2024-09-09 04:58
文章标签 优雅 对接 api 第三方

本文主要是介绍如何更优雅地对接第三方API，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

如何更优雅地对接第三方API

本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third

我们在日常开发过程中，有不少场景会对接第三方的API，例如第三方账号登录，第三方服务等等。第三方服务会提供API或者SDK，我依稀记得早些年Maven还没那么广泛使用，通常要对接第三方服务的时候会去下载第三方服务的SDK开发包，也就是jar包，拷贝到自己的工程中进行开发。但现如今，几乎所有的大中小企业都使用Maven进行依赖管理，第三方服务通过提供SDK包的情况越来越少，有的SDK也早已处于不再更新的状态。并且现在流行的微服务以及轻量级的RESTful通信方式，使得第三方服务主要提供API接口。

API接口，指的是通过HTTP的方式提供服务对接，也就需要对接方发起HTTP请求，解析第三方服务返回的数据；而SDK开发包，指的是对接方直接调用第三方服务提供的Java方法进行调用，不再对第三方服务发起HTTP请求。从便利性上讲，以SDK的方式对接第三方服务，的确能更加方便地进行开发对接工作。而从目前的趋势看，以RESTful通信的微服务正逐渐成为主流，服务的提供方也不再对外提供SDK开发包，因为这涉及开发量以及包的依赖问题。

我仍记得在第一家公司对接第三方API时的场景，业务要求能通过微信发起WiFi连接，这自然需要对接微信提供的API接口。那时我用了“最低级”的对接方式，也就是使用原生JDK发起HTTP请求，以及对HTTP响应的JSON数据进行解析获取我想要的数据。这其中的坑不胜其数，手写的HTTP请求客户端本身的不健壮，解析响应数据时经常抛出空指针，其中的苦恼不尽其数。

直到现在，SpringBoot为我们封装了RestTemplate，再到SpringCloud可以通过Feign让我们调用API就好像在调用接口一般顺滑。

Feign诠释了什么是面向对象，什么是一切皆为对象，我甚至认为，它可以作为面向对象编程实践的典型。

所以本文将以下4个示例讲述如何优雅地对接第三方API。

  • 原生JDK构造HTTP请求客户端，调用API
  • 在SpringBoot下使用RestTemplate，以及抽取配置的方式调用API
  • 使用OpenFeign以及抽取配置的方式调用API

准备工作

第三方API提供方，聚合数据：www.juhe.cn

API接口详情：https://www.juhe.cn/docs/api/id/21

appKey（建议注册账号免费申请）：71e065a2cdf2753a5d6261b5002498b7

实现的功能：根据股票代码获取股票名称

原生JDK构造HTTP请求客户端，调用API

这种方式需要手动去创建HTTP连接，并将数据写入流中，再将数据转换为JSON对象进行解析。

存在以下几个问题：

  1. 配置未抽取，以硬编码方式注入不利于维护
  2. 返回的数据是字符串，将它转换为JSON对象极其不直观
  3. 原生JDK构造HTTP客户端不能保证健壮性

第一个问题，首先是不可取的，必须将它抽取为properties或者yml配置。将appId或者appKey以硬编码的方式注入，不是一个合格的工程师。

第二个问题，转换为JSON对象获取数据：

//本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third
String data = getResponse(code);		//获取API返回数据
JSONObject jsonObject = JSONObject.parseObject(data);		//将数据转换为JSON对象
if (jsonObject.getInteger("error_code") != 0) {		//判断API接口是否调用成功return ;
}
//解析数据，获取股票名称
JSONArray resultArray = JSONArray.parseArray(jsonObject.getString("result"));
JSONObject result = JSONObject.parseObject(resultArray.getString(0));
JSONObject stockObject = JSONObject.parseObject(result.getString("data"));
String stockName = stockObject.getString("name");

你写完后，还能回忆起这个API接口所返回的数据格式吗？

第三个问题，也就是上面代码片段中的getResponse方法：

//本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third
String strUrl = String.format(URL, code, APPKEY);
StringBuffer sb = new StringBuffer();
URL url = new URL(strUrl);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();		//创建一个HTTP连接
//构造HTTP请求数据
conn.setRequestMethod("GET");
conn.setRequestProperty("User-agent", USER_AGENT);
conn.connect();		//打开连接
InputStream is = conn.getInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(is, "UTF-8"));
//将API接口的返回数据写入
String strRead = null;
while ((strRead = reader.readLine()) != null) {sb.append(strRead);
}
return sb.toString();

这种“教科书”式的实现方式，其代码的复杂度，健壮性都值得商榷，有的工程中将HTTP请求客户端封装成一个公共类，有的使用现有的一些HTTP请求客户端。但我认为这都不是好的方式。就算例如Okhttp有很好的稳定性，但也解决不了第二个接口返回数据解析的问题，

在SpringBoot下使用RestTemplate，以及抽取配置的方式调用API

前面我们使用最“古老”的方式发现了3个问题，在SpringBoot大行其道的今天，将一些配置抽取出来，不同的环境运行不同的配置文件是常见的做法。例如我们可以将上面的appKey放到application.yml配置文件中。

juhe-stock:appKey: 71e065a2cdf2753a5d6261b5002498b7

同时定义第三方服务的配置类。

package com.coderbuff.third2resttemplateprop;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** 配置* @author yulinfeng* @date 2019/12/26*/
@Data
@Component
@ConfigurationProperties("juhe-stock")
public class JuheConfig {/*** appkey*/private String appKey;
}

这样当Spring容器启动时，appKey就被注入到了JuheConfig类的appKey字段中。

第一个问题被完美解决了，接下来我们来看如何通过RestTemplate解决第二、第三个问题。

RestTemplate简化了我们发起HTTP请求，它内部默认使用JDK构造HTTP客户端，它发起HTTP请求获取响应数据通过getForObject和getForEntity，前者能直接将响应数据封装成一个对象，后者则将封装HTTP调用的一些响应状态，在我们使用getForObject。

getForObject能将响应数据直接转换为一个对象供我们使用，这意味着我们不再依靠繁琐的JSON格式转换获取我们想要的数据，但同时也意味着我们需要定义返回对象。我们先看示例中，返回的JSON是怎么的格式。

{"resultcode":"200","reason":"SUCCESSED!","result":[{//省略"dapandata":{"name":"贵州茅台"//省略}}],"error_code":0
}

因为篇幅原因，我省略了一些字段信息。观察JSON数据格式，我们只需要拿到股票名称，股票名称处于比较底层的位置，我们定义一个叫做JuheStockResultDapanData的类，字段和JSON中的key相同。

package com.coderbuff.third2resttemplateprop.entity;import lombok.Data;/*** @author yulinfeng* @date 2019/12/26*/
@Data
public class JuheStockResultDapanData {private String name;
}

它的外层key是一个数组，对应的也就是List，其中的一个对象就是我们定义的JuheStockResultDapanData，所以我们定义一个JuheStockResult类，对应JSON中key=result的数据。

package com.coderbuff.third2resttemplateprop.entity;import lombok.Data;/*** @author yulinfeng* @date 2019/12/26*/
@Data
public class JuheStockResult {private JuheStockResultDapanData dapandata;
}

在最外层是一些调用信息和错误码，所以我们继续定义一个响应类JuheStockResponse。

package com.coderbuff.third2resttemplateprop.entity;import lombok.Data;import java.util.List;
import java.util.Map;/*** @author yulinfeng* @date 2019/12/26*/
@Data
public class JuheStockResponse {/*** 响应码*/private String resultcode;/*** 错误信息*/private String reason;/*** 错误码*/private String error_code;/*** 数据*/private List<JuheStockResult> result;
}

注意字段名要和API接口返回的JSON数据key值保持一致。这样我们就定义好了整个JSON对象所对应的Java对象，其中我省略了很多字段，Java对象中没有JSON中对应的字段，数据自然也不会映射到Java对象中。接下来就是使用RestTemplate#getForObject方法调用API接口。

//本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third
String url = String.format(URL, code, juheConfig.getAppKey());	//拼接URL
RestTemplate restTemplate = new RestTemplate();
restTemplate.setMessageConverters(parseContentType());	//设置ContentType支持的类型
JuheStockResponse response = restTemplate.getForObject(url, JuheStockResponse.class);
JuheStockResultDapanData juheStockResultDapanData = response.getResult().get(0).getDapandata();
String name = juheStockResultDapanData.getName();

可以看到这种方式相比较于第一种“教科书”式调用HTTP接口，无论从易用性和健壮性都要略胜一筹，特别是不再去解析JSON对象，RestTemplate已经为我们做好了转换，这样的代码，即使换了一个人维护，也同样能明白是什么含义。

这种对接第三方API的方式，我想也是常年使用SpringBoot所采用的方式，因为它都解决了我们在开头提到几个问题，似乎想不到还能有什么更优雅地方式，直到遇到了下面的方式。

使用OpenFeign以及抽取配置的方式调用API

在使用这种方式调用第三方API时，我简直想要大呼一声Amazing！，简直太完美太优雅了。它不但解决了上面的3个问题，它同时把面向对象的思想发挥到了极致。

上面的思路不过是封装再封装，封装完HTTP客户端后又封装了JSON数据转换，实际上的思路仍然是传递一个URL->请求->响应的思路，但接下来的这种方式，真真正正地诠释了什么是面向对象，什么是一切皆为对象。

它将API调用变得更加像调用普通接口一样方便。

使用过SpringCloud的同学对Feign并不陌生，甚至觉得我孤陋寡闻。原版的OpenFeign可不依赖Spring独立使用（ https://github.com/OpenFeign/feign），SpringCloud整合了OpenFeign，在SpringCloud2.x，Feign甚至成为了SpringCloud的一级项目（ https://cloud.spring.io/spring-cloud-openfeign/）这足以体现它的地位。

在SpringCloud中，OpenFeign的功能很强大，它为微服务架构下服务之间的调用提供了解决方案，同时它可以结合其它组件可以实现负载均衡的HTTP客户端。

接下来我们将展示使用原版的OpenFeign优雅地调用第三方API服务。

我们同样需要定义JuheStockResponse、JuheStockResult、JuheStockResultDapanData类，因为在OpenFeign中，也自动的将JSON数据转换为了Java对象。但我们需要定义一个接口——JuheClient。

package com.coderbuff.third3feignprop;import com.coderbuff.third3feignprop.entity.JuheStockResponse;
import feign.Param;
import feign.RequestLine;/*** @author yulinfeng* @date 2019/12/26*/
public interface JuheClient {/*** 根据股票代码查询股票信息* @param code 股票代码* @return 接口返回*/@RequestLine("GET /finance/stock/hs?gid={gid}&key={key}")JuheStockResponse queryStock(@Param("gid") String code, @Param("key") String appKey);
}

这简直就是面向对象思想的最佳实践，接下来的工作基本上就是直接调用这个方法，就能调用我们想要调用的API。

//本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third
JuheClient client = Feign.builder().encoder(new JacksonEncoder()).decoder(new JacksonDecoder()).target(JuheClient.class, juheConfig.getUrl());
JuheStockResponse response = client.queryStock(code, juheConfig.getAppKey());
JuheStockResultDapanData juheStockResultDapanData = response.getResult().get(0).getDapandata();
String name = juheStockResultDapanData.getName();

这看起来似乎和直接使用RestTemplate并无大异，但我仍然想表达我的激动，我仍然认为这其中的奥秘不在于编码的具体实现，而在于将API接口调用上升到了面向对象的最佳实践。没有了URL的拼接，像调用普通接口一样方便地调用第三方API。

本文所有示例完整代码地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/third

这篇关于如何更优雅地对接第三方API的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1150220。

相关文章

【LabVIEW学习篇 - 21】：DLL与API的调用

【LabVIEW学习篇 - 21】：DLL与API的调用

文章目录 DLL与API调用DLLAPIDLL的调用 DLL与API调用 LabVIEW虽然已经足够强大，但不同的语言在不同领域都有着自己的优势，为了强强联合，LabVIEW提供了强大的外部程序接口能力，包括DLL、CIN(C语言接口)、ActiveX、.NET、MATLAB等等。通过DLL可以使用户很方便地调用C、C++、C#、VB等编程语言写的程序以及windows自带的大
阅读更多...
Java基础回顾系列-第五天-高级编程之API类库

Java基础回顾系列-第五天-高级编程之API类库

Java基础回顾系列-第五天-高级编程之API类库 Java基础类库StringBufferStringBuilderStringCharSequence接口AutoCloseable接口RuntimeSystemCleaner对象克隆 数字操作类Math数学计算类Random随机数生成类BigInteger/BigDecimal大数字操作类 日期操作类DateSimpleDateForma
阅读更多...
Restful API 原理以及实现

Restful API 原理以及实现

先说说API 再说啥是RESRFUL API之前，咱先说说啥是API吧。API大家应该都知道吧，简称接口嘛。随着现在移动互联网的火爆，手机软件，也就是APP几乎快爆棚了。几乎任何一个网站或者应用都会出一款iOS或者Android APP，相比网页版的体验，APP确实各方面性能要好很多。 那么现在问题来了。比如QQ空间网站，如果我想获取一个用户发的说说列表。 QQ空间网站里面需要这个功能。
阅读更多...
京东物流查询｜开发者调用API接口实现

京东物流查询｜开发者调用API接口实现

快递聚合查询的优势 1、高效整合多种快递信息。2、实时动态更新。3、自动化管理流程。 聚合国内外1500家快递公司的物流信息查询服务，使用API接口查询京东物流的便捷步骤，首先选择专业的数据平台的快递API接口：物流快递查询API接口-单号查询API - 探数数据 以下示例是参考的示例代码： import requestsurl = "http://api.tanshuapi.com/a
阅读更多...
【Python知识宝库】上下文管理器与with语句：资源管理的优雅方式

【Python知识宝库】上下文管理器与with语句：资源管理的优雅方式

🎬 鸽芷咕：个人主页  🔥 个人专栏: 《C++干货基地》《粉丝福利》 ⛺️生活的理想，就是为了理想的生活! 文章目录 前言一、什么是上下文管理器？二、上下文管理器的实现三、使用内置上下文管理器四、使用`contextlib`模块五、总结 前言 在Python编程中，资源管理是一个重要的主题，尤其是在处理文件、网络连接和数据库
阅读更多...
Python中的属性装饰器：解锁更优雅的编程之道

Python中的属性装饰器：解锁更优雅的编程之道

引言 在Python的世界里，装饰器是一个强大的工具，它允许我们以一种非侵入性的方式修改函数或方法的行为。而当我们谈论“属性装饰器”时，则是在探讨如何使用装饰器来增强类中属性的功能。这不仅让我们的代码更加简洁、易读，同时也提供了强大的功能扩展能力。本文将带你深入了解属性装饰器的核心概念，并通过一系列实例展示其在不同场景下的应用，从基础到进阶，再到实际项目的实战经验分享，帮助你解锁Python编程
阅读更多...
WordPress开发中常用的工具或api文档

WordPress开发中常用的工具或api文档

http://php.net/ http://httpd.apache.org/ https://wordpress.org/ https://cn.wordpress.org/ https://core.svn.wordpress.org/ zh-cn:开发者文档： https://codex.wordpress.org/zh-cn:%E5%BC%80%E5%8F%91%E8%80%
阅读更多...
Java后端微服务架构下的API限流策略：Guava RateLimiter

Java后端微服务架构下的API限流策略：Guava RateLimiter

Java后端微服务架构下的API限流策略：Guava RateLimiter 大家好，我是微赚淘客返利系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！ 在微服务架构中，API限流是保护服务不受过度使用和拒绝服务攻击的重要手段。Guava RateLimiter是Google开源的Java库中的一个组件，提供了简单易用的限流功能。 API限流概述 API限流通过控制请求的速率来防止
阅读更多...
SW - 引入第三方dwg图纸后，修改坐标原点

SW - 引入第三方dwg图纸后，修改坐标原点

文章目录 SW - 引入第三方dwg图纸后，修改坐标原点概述笔记设置图纸新原点END SW - 引入第三方dwg图纸后，修改坐标原点 概述 在solidworks中引入第三方的dwg格式图纸后，坐标原点大概率都不合适。 全图自动缩放后，引入的图纸离默认的原点位置差很多。 需要自己重新设置原点位置，才能自动缩放后，在工作区中间显示引入的图纸。 笔记 将dwg图纸拖到SW中
阅读更多...
Docker远程连接和Docker Remote Api

Docker远程连接和Docker Remote Api

在Docker生态系统中一共有3种API：Registry API、Docker Hub API、Docker Remote API 这三种API都是RESTful风格的。这里Remote API是通过程序与Docker进行集成和交互的核心内容。 Docker Remote API是由Docker守护进程提供的。默认情况下，Docker守护进程会绑定到一个所在宿主机的套接字：unix:///v
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2