接口对接分为两种形式：

1. 我方A公司提供接口给B公司，B公司进行一些操作时调用我们的接口进行实现。

例：A开发会员等级同步接口，供B同步会员等级到B系统。B会员等级的变动需要调用A接口主动推送给A（即更新会员卡等级）。

我们首先要做的就是按照对方的要求，在对方调用我们的接口，我方成功处理之后，按照对方所需要的返回数据以及格式反馈给他们信息。

在写本接口中，因为我们会员卡等级的字段是不一样的，所以我们对此主要处理的就是这个事情，1.例如对方传来修改后的卡等级是金卡，因为我们数据库中是分为vipcard和cardgrade两张表的，所以首先我们要去写一个方法，查询cardgrade表中所有的卡等级的id,返回一个list集合，再利用B公司传过来的数据for循环遍历比较，如果相等，则拿到金卡等级在我方A公司的ID,代码如下：

再根据B公司提供的会员卡号在我们查询到该条会员并拿到id;

最后就可以根据拿到跟新后的等级id和该会员的id进行更新了，任务完成！代码如下：

2.B公司开发会员查询接口，A公司调用B公司接口，实时查询会员

调对方接口和对方调我方的接口稍微有些不同，因为中间涉及到安全问题，所以还要满足对方要求我方传入的参数，不然对方不给通过，参数要求如下：

其中AppID,Args,AppSystem是与对方提供给我方特有的，timestamp是当前时间，我们只需获取当前时间按照他的格式生成，这个较简单，稍微复杂点的就是sign的生成了，要做的就是进行加签/验签，按照对方的要求，我们需要将AppId、Timestamp、Token(客户端保存)，按照参数名在英文字典中的顺序排序，然后重新拼成一个标准的query string。然后采用sha1或者md5算法对此加密生成sign，代码如下：

参数都好了之后，对方要求以form表单的形式将参数传过去，这又是一个坑，哎。。，网上找了很久，代码如下：

Url是对方给的方法路径，param是放入的5个参数，然后要处理的就是把对方参数对应转成我方的参数形式，采用set/get即可。

供一起刚入坑的参考。

💨 作者:laker，因为喜欢LOL滴神faker，又是NBA湖人队🏀（laker）粉丝儿（主要是老詹的粉丝儿），本人又姓李，故取笔名：laker
❤️喜欢分享自己工作中遇到的问题和解决方案，以及一些读书笔记和心得分享。
🌰本人创建了微信公众号【Java大厂面试官】，用于和大家交流分享
🏰 个人微信【lakernote】，加作者备注下暗号：cv之道。

前言

无论你是做面向ToB、ToC还是ToG的业务，开发业务系统，永远也逃脱不了与第三方系统对接的命运，例如：常见的支付宝、微信支付平台对接、短信平台对接，还有单点登录对接，以及与友商的数据接口对接等等，大到相对成熟的平台对接，小到一个接口的调用，基本上所有的开发都避免不了对接，它已经充斥在我们的日常工作中✒️，如何做好与第三方的对接，降低对接风险，按时保质的完成对接任务，已经成为我们非常头疼的问题了 ⚡⚡⚡。

今天我就在这里总结下，个人的经验以及互联网上发表的一些比较好的观点。有用的话，麻烦点个赞 👍 ，转发一波☀️。

首先当我们拿到对接需求的时候，直接3W三板斧理论抡起来，来帮助我们梳理一下对接思路。

What 是什么

对接的是什么？

• 一定要从宏观到微观的搞清楚我们自己的系统是做什么业务，有哪些数据、哪些字段；需要提供给第三方哪些数据、哪些字段；又需要从第三方获取哪些数据、哪些字段。

这里的宏观和微观指的是宏观的系统物理架构、逻辑架构、部署架构、业务架构，微观的指系统模块、功能点的实现细节、及其涉及的表和其他三方对接历史。

要找到掌握这么多的人，可不是一件容易的事儿，这里能掌握这么多的人，一般都是团队的核心骨干、首席开发工程师❤️

• 同样的也要掌握第三方系统大致业务流程，部署架构等等，知己知彼，百战不殆。

为什么要搞清楚部署架构？在这里我分享下之前的一个真实案例，当场裂开的那种 🐜。

项目对接开始，前期双方都紧锣旗鼓的对接、测试等等，各个环节都很顺利，于是乎在测试环境稳定一周左右后上线。

上线之后的2-3天，突然的某一天，运营人员的一通电话☎️ 打破了祥和的假象！线上出现了很多重复的业务流水号⚠️。

例如：

正常情况数据应该是这样的：

但是现场的情况是：

存在重复的流水号：QJ00073001⚠️，当场我就裂开了，这TM测试环境跑了一周没事儿，正式环境都搞了2-3天了出现问题，趁事态没有扩大，各种排查，

是不是线程安全问题啊？是不是第三方问题啊？这2天动了什么现场环境等等。

很快我们就定位出问题来了，原来是昨天晚上，又对接了一个新的局点导致的，第三方服务部署架构是分级部署的。

我们以为的对接：

实际的对接：

第三方的部署架构是每个局点单独部署一套服务，所以他们那边的流水号都是从1开始的，导致我们直接拿流水号来用的时候裂开了。

处理方式也很简单，流水号加上局点code即可，例如：HW31QJ00073001、HW89QJ00073001

Why 为什么

为什么要对接第三方系统？

比如我们经常对接支付宝、微信平台，你不可能自己开发个支付系统的，再说了支付宝和微信支付的用户也多，方便你我他，可以让我们更专注自己的业务开发。

再比如对接短信平台、快递鸟平台等等。

总结下：基本上都是自己公司想做一件事情，但是自己又没有足够的物力、财力、精力去实现，那么就去找市面上有成熟的解决方案，把专业的活交给专业的人，来以最小化的成本实现我们的需求。

How 怎么做

这里我们再以对接前、对接中、对接后这3个阶段，来分阶段讨论下每个阶段应该怎么做，才能稳步推进我们的对接需求。

对接前

• 明确需求，以及对接的价值（是否真的有必要做及其实现的意义，有可能这一步直接让对接流产✋。。。）

• 搞清楚我们跟第三方的大致交互流程和双方所需数据。（别鸡蛋里面找骨头，他也找不到啊，你要我没有的数据，我可怎么提供）

• 评估大概所需要花费的钱，毕竟跟别人对接，大部分情况下是花钱的。（花的钱太多有可能得不偿失）

• 确定双方相关业务负责人、技术负责人，以及要指定一个总负责任人来推动双方稳步前进（别双方都是放羊模式）

• 制定一个合理的计划，确定联调时间、上线时间、试运行时间（一定要制定合理的计划）

对接中

1. 确定细节

拉上双方业务人员、技术负责人，共同制定接口调用流程，画出接口调用流程图、泳道图、时序图等，毕竟一图胜千言。

这里一定要拉上真正熟悉业务和技术的人去沟通，别找中间人去传话了，也别找不懂的人去，否则在这一步，坑就已经开始挖了。

泳道图示例：

泳道图很清晰的能看到对接双方交互流程，职责划分清晰。

时序图示例：

时序图能清晰看到消息传递的时间顺序。

下面的关键细节我列一下：

2. 一些建议

• 文档先行，统一规范（双方按照文档来开发，统一规范）

• 需要自己有对接模拟接口，防止三方公司接口迟迟未完成，影响整个项目进度

• 第三方对接模块做成单独的服务最好独立出来，尽最大努力保证服务的高可用、稳定性。（不然你滴电话就要被打爆了☎️）

• 接口升级，尽量做到影响最小，不去修改接口协议，如果必须要动，要做到接口兼容老版本。

• 尽量保证接口的幂等性，因为会有重试机制和补偿方案；

• 接口当中生成requestId，用于日志记录，到返回结果的全流程跟踪，接口接收到的数据，以及解析之后的参数值，都要用日志记录下来，方便查看原因。

• 编码推荐使用注解式声明编程 Feign

举个例子：把第三方对接模块做成单独服务的好处、以及做好对外服务降级操作（业务逻辑降级）。

之前项目中有个需求，需要对接一个厂商的服务，大致流程是调用一个实时接口，输入身份证号，返回这个身份证号关联人的最新的所有的档案信息。

第一阶段

一开始我们是直接把对接代码写到我们业务系统的，这也很正常。

第二阶段

使用一段时间后，公司的另一个团队也需要对接这个厂商，那么现在是否也复制一份儿代码去对接呢？显然我们不会这么去做，第三方接口升级啥的，我们2个团队都要改，耦合性太强了，还有万一后面我们还有其他团队对接呢？不可能都用这种方式。

所以我们的做法是把这个对接模块独立出来，做成一个单独的服务，供所有的团队使用，作为微服务的一部分。

架构如下图：

第三阶段

平稳运行一段时候后，突然的某一天第三方服务厂商服务down掉了，导致我们这边所有相关的业务出现了类似“档案查询接口不可用”的提示。

已经做了断路器、服务通用降级，返回提示信息“档案查询接口不可用”

虽然是第三方的问题，也有提示的降级操作，但是呢，用户体验还是不够友好，于是乎我们开会讨论更完美的方案，我们的需求是返回实时的个人档案信息，

但是如果当第三方服务down了，返回之前查询过的非实时数据，并给个不是最新的提示，也总比提示“档案查询接口不可用”要优雅的多。

于是乎我们会在每个用户查询到档案后，自己本地数据库存一份，当第三方服务不可用的时候去降级到本地数据库查询使用。

架构如下图：

对接后

持续跟踪一段时间系统的使用情况，然后进行总结，看看是否可以把这块对接流程规范化，做标准化接口，将自己的能力或者数据标准化出去，类似于开放平台，让别人按照你的标准来做。（那就乌鸦变凤凰了）

最后我也总结下，之前遇到的风险点：

对接风险

• 对方不配合 （奶茶☕、香烟给安排上，还不行只能让上级去推动了）

• 对接要从源头留痕，防止后面对方扯皮，要留证据。（拿证据说话）

• 对方服务升级，接口变了，未通知升级。（接口版本号制定好，接口做到向下兼容）

• 对方服务不稳定影响自有系统。（服务熔断、降级处理）

• 调用并发频率过高等。（控制频率）

总结与思考

没有最完美的方案，只有尽可能完善的方案，就像系统可用性达不到100%一样，我们做的每一步都要想好失败的场景，以及相应的对应策略，做好降级处理，最终的兜里方案就是人肉补偿了✈️✈️✈️。

QQ群【837324215】
关注我的公众号【Java大厂面试官】，回复：架构、资源等关键词（更多关键词，关注后注意提示信息）获取更多免费资料。

公众号也会持续输出高质量文章，和大家共同进步。

1.准备与第三方接口对接的账号

配置到了Apollo上面

    @Value("${taofake.appId}")
	private String appId;
	@Value("${taofake.url}")
	private String url;
	@Value("${taofake.appSecret}")
	private String appSecret;

2.准备用于接受接口返回结果的实体类

3.准备发HTTP请求的工具类

http工具类

package cn.zhaocha.common.utils;

import java.io.IOException;
import java.util.Map;

import cn.zhaocha.vo.BaseResponseVo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import lombok.extern.slf4j.Slf4j;
import okhttp3.*;

@Slf4j
public class OKHttpUtil {

	private static final Logger logger = LoggerFactory.getLogger(OKHttpUtil.class);

	private static OkHttpClient client = getClient();

	public static OkHttpClient getClient() {
		if (client == null) {
			client = genericClient();// 创建OkHttpClient对象
		}
		return client;
	}

	public static OkHttpClient genericClient() {
		OkHttpClient httpClient = new OkHttpClient.Builder().addInterceptor(new Interceptor() {
			@Override
			public Response intercept(Chain chain) throws IOException {
				Request request = chain.request().newBuilder()
						// .addHeader("Content-Type", "text/html; charset=gb2312")
						// .addHeader("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
						// .addHeader("Accept-Encoding", "gzip, deflate")
						// .addHeader("Connection", "keep-alive")
						// .addHeader("Accept", "*/*")
						// .addHeader("User-Agent", "Mozilla/5.0 (Linux; Android 9.0.0; MI 6 Build/OPR1.170623.032; wv) AppleWebKit/537.36 (KHTML, like Gecko)
						// Version/4.0 Chrome/62.0.3202.84 Mobile Safari/537.36/Android/globalscanner/4.00")
						// .addHeader("Accept-Language", "zh-CN,en-US;q=0.9")
						.addHeader("ApiVersion", "1.0")
						// .addHeader("X-Requested-With", "com.globalscanner")
						.build();
				return chain.proceed(request);
			}
		}).build();

		return httpClient;
	}

	public static String postAsync(String urlStr, Map<String, String> paramMap, Callback callback) {
		return postAsync(urlStr, paramMap, callback, null);
	}

	public static String postAsync(String urlStr, Map<String, String> paramMap, Callback callback, Map<String, String> header) {
		Request.Builder oneBuilder = getOneBuilder(urlStr, paramMap, header);
		Request request = oneBuilder.build();
		getClient().newCall(request).enqueue(callback);
		return null;
	}

	private static Request.Builder getOneBuilder(String urlStr, Map<String, String> paramMap, Map<String, String> header) {
		// 创建表单请求体
		FormBody.Builder formBody = new FormBody.Builder();
		for (String key : paramMap.keySet()) {
			formBody.add(key, paramMap.get(key));
		}
		// 创建Request 对象。//传递请求体
		Request.Builder postBuild = new Request.Builder().url(urlStr).post(formBody.build());
		if (header != null && header.size() > 0) {
			for (String key : header.keySet()) {
				postBuild.addHeader(key, header.get(key));
			}
		}
		return postBuild;
	}

	private static Request.Builder getGetBuilder(String urlStr, Map<String, String> paramMap, Map<String, String> header) {
		HttpUrl.Builder urlBuilder = HttpUrl.parse(urlStr).newBuilder();
		if (paramMap != null) {
			for (String key : paramMap.keySet()) {
				urlBuilder.setQueryParameter(key, paramMap.get(key));
			}
		}
		Request.Builder requestBuilder = new Request.Builder().url(urlBuilder.build())
				.headers(header == null ? new Headers.Builder().build() : Headers.of(header)).get();
		return requestBuilder;
	}

	/**
	 * 同步请求
	 */
	public static <T> BaseResponseVo<T> post(String urlStr, Map<String, String> paramMap, Class clazz) {
		return post(urlStr, paramMap, null, clazz);
	}

	public static <T> BaseResponseVo<T> post(String urlStr, Map<String, String> paramMap, Map<String, String> header, Class clazz) {
		Request.Builder oneBuilder = getOneBuilder(urlStr, paramMap, header);
		Request request = oneBuilder.build();
		try {
			log.info("请求：OKHttpUtil-post-日志信息请求参数:" + urlStr + " " + paramMap.toString());
			Response response = client.newCall(request).execute();
			if (response != null && response.isSuccessful()) {
				if (response.body() == null) {
					log.info("响应：OKHttpUtil-post-日志信息响应结果未空：");
					return BaseResponseVo.err("1", "response.body内容为空", null);
				}
				String content = response.body().string();
				log.info("响应：OKHttpUtil-post-日志信息响应结果：" + content);
				// String content ="{error_msg: \"成功\",error_code: 0}";
				// String content = "{error_msg: \"失败\",error_code: 1}";

				if (!StringUtils.isEmpty(content)) {
					T obj = (T) FastJsonUtil.jsonToBean(content, clazz);
					return BaseResponseVo.succ("0", "获取成功", obj);
				}
			}
		} catch (IOException e) {
			e.printStackTrace();
			return BaseResponseVo.err(e.toString());
		}
		return BaseResponseVo.err("1", "获取失败", null);
	}

	public static <T> BaseResponseVo<T> get(String urlStr, Map<String, String> paramMap, Map<String, String> header, Class clazz) {
		Request.Builder oneBuilder = getGetBuilder(urlStr, paramMap, header);
		Request request = oneBuilder.build();
		try {
			log.info("请求：OKHttpUtil-post-日志信息请求参数:" + urlStr + " " + paramMap.toString());
			Response response = client.newCall(request).execute();
			if (response != null && response.isSuccessful()) {
				if (response.body() == null) {
					log.info("响应：OKHttpUtil-get-日志信息响应结果未空：");
					return BaseResponseVo.err("1", "response.body内容为空", null);
				}
				String content = response.body().string();
				log.info("响应：OKHttpUtil-get-日志信息响应结果：" + content);
				if (!StringUtils.isEmpty(content)) {
					T obj = (T) FastJsonUtil.jsonToBean(content, clazz);
					return BaseResponseVo.succ("0", "获取成功", obj);
				}
			}
		} catch (IOException e) {
			e.printStackTrace();
			return BaseResponseVo.err(e.toString());
		}
		return BaseResponseVo.err("1", "获取失败", null);
	}
}

4.调用第三方接口

黄色线表示访问第三方接口

现在我们可以来测试一下了

与第三方接口对接就完成了