如何更优雅地对接第三方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提供方，聚合数据：
api接口详情：
appkey（建议注册账号免费申请）：71e065a2cdf2753a5d6261b5002498b7
实现的功能：根据股票代码获取股票名称
原生jdk构造http请求客户端，调用api
这种方式需要手动去创建http连接，并将数据写入流中，再将数据转换为json对象进行解析。
存在以下几个问题：
- 配置未抽取，以硬编码方式注入不利于维护
- 返回的数据是字符串，将它转换为json对象极其不直观
- 原生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的一级项目（）这足以体现它的地位。
在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
关注公众号：coderbuff，回复“es”获取《elasticsearch6.x实战教程》完整版pdf。