ToB企服应用市场:ToB评测及商务社交产业平台

标题: 快手二面：你有没有调用过第三方接口？碰到过哪些坑？ [打印本页]
作者: 王國慶    时间: 2024-5-20 02:32
标题: 快手二面：你有没有调用过第三方接口？碰到过哪些坑？
在我们的业务开发中，调用第三方接口已经成为常态，比如对接一些ERP系统、WMS系统、一些数据服务系统等，它极大地扩展了我们应用的功能和服务范围。然而，实际对接过程中，我们往往会在这一环节遇到各种意想不到的题目，本文将深入探讨几种常见的第三方接口调用难题及其应对策略。

接口访问不到

在实行第三方接口调用使命时，如果遇到程序响应迟滞直至超时，或者直接抛出诸如Connection refused、Host is unreachable、SocketTimeoutException之类的网络异常情况，这明确指示了无法乐成创建起与目的服务器的通信连接。产生此题目的根源大概源自于多种因素，此中包罗但不限于网络状况不佳、服务器尚未启动、域名剖析错误或接口地址有误等。
为应对这类题目，重要步调是自查当地网络环境是否正常。一旦确定自身网络并无故障，可行的操作之一是运用ping下令对目的域名举行探测，以验证域名能否被正确剖析并得到响应。若域名无法剖析，则大概表明对方服务器DNS设置存在题目；纵然域名可以剖析，但如果ping测试结果显示响应异常或超时，说明目的服务端存在潜伏故障。在这种情况下，及时与对方的技能团队取得联系，共享诊断信息，共同协作举行题目排查是一种有效的解决策略。
接口突然没有返回数据/数据异常

原本正常的接口突然开始返回空数据，或者是返回的数据结构与预期不符，比如缺少须要的字段、数据格式错误、数据内容无效等，导致客户端无法正常剖析和使用。
面对这类接口突然无响应或无法返回数据的题目，首先，我们须要从源头动手，全面核查请求参数和认证凭据的有效性。这包罗细致审查发送至接口的请求数据是否完整正确，以及确保使用的Token、Key等身份认证信息处于有效状态。同时，必须密切关注接口供应商是否有未提前公告的变动，如API版本升级、接口废弃等情况。
在代码实现层面上，为了能快速响应这类异常，我们应当对关键数据字段设置严格的监控与预警机制。比方，可以植入手动埋点并通过企业通讯工具（如钉钉消息、电子邮件提醒）实现即时告警。一旦监测到核心数据未能如期返回，系统应能立刻发出警报，使开发人员可以大概在第一时间获知并处理此类题目，以防止其对整体业务流程造成干扰或经济损失。
以一个实际应用场景为例，当我们在上游系统中使用订单号向卑鄙WMS系统查询出入库订单详情时，若发现特定订单号未能返回预期的订单信息，那么通过预先设定的监控和告警系统，我们将在第一时间接收到告诫信息。在此基础上，应敏捷与第三方系统的技能支持团队取得联系，查明原因并解决题目。同时，对于这类无法匹配的数据，应在业务流程中设立防护机制，及时拦截处理，以免对核心业务造成负面影响。
接口超时/异常，不稳固

由于网络抖动，或者第三方系统不稳固，部署，服务器负载不均、并发访问量过大等等题目，大概会导致调用接口时花费的时间超出预期设定的超时时间，从而引发TimeoutException；或者接收到HTTP状态码表明出现异常，如500 Internal Server Error、404 Not Found等。这种坑使我们平常最容易遇见的也是最头疼的所在，因此须要我们给予足够的重视。
对于这类异常，首先我们在调用接口时设置公道的超时时间，我们以使用Retrofit2调用http接口为例，设置其请求超时时间以及读取超时时间：
  1. import okhttp3.OkHttpClient;
  2. import retrofit2.Retrofit;
  3. import retrofit2.converter.gson.GsonConverterFactory;
  4. import java.util.concurrent.TimeUnit;
  6. // 创建 OkHttpClient 实例并设置超时时间
  7. OkHttpClient okHttpClient = new OkHttpClient.Builder()
  8.     .connectTimeout(30, TimeUnit.SECONDS) // 连接超时时间为30秒
  9.     .readTimeout(30, TimeUnit.SECONDS)      // 读取超时也为30秒
  10.     .build();
  12. // 创建 Retrofit 实例，使用自定义的 OkHttpClient
  13. Retrofit retrofit = new Retrofit.Builder()
  14.     .baseUrl("https://your-api-url.com/")
  15.     .client(okHttpClient) // 使用上面设置超时时间的 OkHttpClient
  16.     .addConverterFactory(GsonConverterFactory.create()) // 使用Gson转换器
  17.     .build();
  19. // 创建你的API接口实例
  20. YourApiInterface apiService = retrofit.create(YourApiInterface.class);
复制代码
有关Retrofit2的说明以及使用介绍，请参考：求求你别再用OkHttp调用API接口了，快来试试这款HTTP客户端库吧
同时，这对此类异常，我们还用做好接口重试机制。我们可以从以下几种方案中考虑重试：
固定间隔重试

设置一个固定的等待时间间隔，在每次失败后等待该间隔再举行下一次实验。比如我们可以使用定时使命框架如Quartz、Spring Task Scheduler、ElasticJob、xxl-job来定期实行重试使命。
这种方案实现简单，但是大概不适用于所有场景，特殊是当失败是由于瞬时题目（如网络抖动）时，固定间隔大概过长或过短。
关于SringBoot自带的定时使命的使用讲解，请参考：玩转SpringBoot：SpringBoot的几种_定时使命_实现方式
指数退避重试

每次失败后，等待时间间隔按指数级增长（比方，第一次失败等待1秒，第二次等待2秒，第三次等待4秒，以此类推）。比如我们可以使用Spring Retry，Guava的Retryer，Resilience4j等去实现指数退避重试。
我们以Spring Retry为例：
  1. import org.springframework.retry.annotation.Backoff;  
  2. import org.springframework.retry.annotation.Retryable;  
  3. import org.springframework.stereotype.Service;  
  4.   
  5. @Service  
  6. public class MyService {  
  7.   
  8.     @Retryable(value = {MyCustomException.class}, maxAttempts = 3, backoff = @Backoff(delay = 1000))  
  9.     public void myMethod() {  
  10.         // 这里是可能会失败的操作  
  11.         // 如果抛出 MyCustomException 异常，方法会被重试，最多重试3次  
  12.         // 每次重试之间会有1秒的延迟（使用指数退避策略的话，延迟会逐渐增加）  
  13.          
  14.         // 假设某些条件下会抛出异常  
  15.         if (someCondition()) {  
  16.             throw new MyCustomException("Operation failed");  
  17.         }  
  18.          
  19.         // 如果操作成功，则正常返回  
  20.     }  
  22.         @Recover  
  23.     public void recoverMyMethod(MyCustomException e) {  
  24.         // 当 myMethod 的重试次数耗尽后，会调用这个方法  
  25.         // 你可以在这里记录日志、发送通知或执行其他恢复操作  
  26.         System.err.println("Operation failed after retries. Cause: " + e.getMessage());  
  27.     }
  28.      
  29. }
复制代码
这种方案可以大概自适应地调整重试间隔，减少一连失败的大概性。但是缺点也很显着，在长时间运行的系统中，如果题目持续存在，重试间隔大概会变得非常长，大概一不小心，会一直实行下去。
接口变动，版本迭代兼容性

第三方系统对API举行版本升级或服务调整属于常见现象，这种情况下，原有的接口大概面对无法继承使用的题目，或者返回的数据结构、格式大概发生变动，部分接口随着版本升级大概存在不向下兼容的情况，调用旧版接口在新版环境下大概失效。针对此类状况，最佳实践是始终保持对服务提供商通告的关注，一旦得知有关更新信息，应敏捷作出响应，及时调整并更新调用接口的方式。在代码层面，有须要预先计划并实现一套接口版本管理和兼容性处理机制，以确保无论接口如何演变，系统都可以大概平滑地适应和处理。
接口变动时，采取接口参数动态化是一种有效的应对策略，其核心理念是让客户端调用接口时具备更强的灵活性和适应性，特殊是在接口新增、删除或修改参数的情况下，比如采取Map，JSON接受参数（当然不是很保举。。。。）。
而且，对接口举行精密的异常监测同样至关重要，通过实时监控接口调用的异常状况，可以大概在题目发生的第一时间发现并上报。及时与第三方系统的技能支持团队沟通协调，并采取相应的调停措施，可以大概最大限度地减少接口变动对业务一连性的影响，确保系统稳固高效运行。
API限制

在一定时间段内频仍调用接口，然后突然所有请求都开始失败，返回的错误提示大概是调用频率过高、超出配额等。这是由于大多数第三方API为了防止滥用，会对调用次数、频次或流量举行限制。我们应密切关注接口文档中的调用限制说明，并在代码中采取限流措施，如设置合适的请求间隔、使用令牌桶算法或漏桶算法控制请求速率。当然也要做好接口监控告警策略。
针对此类题目，我们可以采取以下一些技能方案实现：
设置请求间隔（固定延迟）

在每次请求后，添加固定的延迟时间，比如每次请求后等待1秒（Thread.sleep(1000)），这种方式实现简单，但大概不够灵活，特殊是当API的调用限制在不同时间段内变化时。
令牌桶算法（Token Bucket）

令牌桶算法是一种计算机网络流量整形和速率限制算法。它允许突发流量，但长期均匀输出流量不会超过设定的速率。适用于允许短时间内的高流量，但长期须要控制均匀流量的场景。我们可以使用Google的Guava库中的RateLimiter来实现令牌桶算法。
  1. import com.google.common.util.concurrent.RateLimiter;  
  2.   
  3. @Service  
  4. public class ApiService {  
  5.   
  6.     private final RateLimiter rateLimiter = RateLimiter.create(1.0); // 每秒生成一个令牌  
  7.   
  8.     @Autowired  
  9.     private RestTemplate restTemplate;  
  10.   
  11.     public String callApi() {  
  12.         if (!rateLimiter.tryAcquire()) { // 尝试获取令牌，如果没有则返回false  
  13.             throw new RuntimeException("Rate limit exceeded");  
  14.         }  
  15.         return restTemplate.getForObject("http://example.com/api", String.class);  
  16.     }  
  17. }
复制代码
漏桶算法（Leaky Bucket）

漏桶算法是另一种流量整形和速率限制算法。它将流量视为水倒入一个固定容量的桶中，如果桶满了，水就会溢出（即请求被拒绝）。桶底有一个漏洞，水以一定的速率从桶中漏出，从而控制均匀流量。适用于须要严格控制流量，不允许突发流量的场景。漏桶算法通常须要自己实现，但也可以使用现有的库，比如Bucket4j。
  1. import io.github.bucket4j.Bandwidth;  
  2. import io.github.bucket4j.Bucket;  
  3. import io.github.bucket4j.Refill;  
  4.   
  5. @Service  
  6. public class ApiService {  
  7.   
  8.     private final Bucket bucket = Bucket.builder()  
  9.             .addLimit(Bandwidth.classic(10, Refill.greedy(10, TimeUnit.SECONDS))) // 每10秒添加10个令牌  
  10.             .build();  
  11.   
  12.     @Autowired  
  13.     private RestTemplate restTemplate;  
  14.   
  15.     public String callApi() {  
  16.         try {  
  17.             bucket.asScheduler().consume(1); // 消耗一个令牌  
  18.         } catch (InterruptedException | InsufficientTokensException e) {  
  19.             throw new RuntimeException("Rate limit exceeded", e);  
  20.         }  
  21.         return restTemplate.getForObject("http://example.com/api", String.class);  
  22.     }  
  23. }
复制代码
滑动窗口算法：

滑动窗口算法用于跟踪在特定时间窗口内的请求数量。当窗口内的请求数达到限制时，新的请求将被拒绝或延迟。窗口可以随着时间的推移而滑动，以适应不同的时间间隔。
  1. import java.util.LinkedList;  
  2. import java.util.Queue;  
  3. import java.util.concurrent.TimeUnit;  
  4.   
  5. @Service  
  6. public class ApiService {  
  7.   
  8.     private final long windowSizeInMilliseconds;  
  9.     private final int maxRequestsPerWindow;  
  10.     private final Queue<Long> window = new LinkedList<>();  
  11.   
  12.     public ApiService(long windowSizeInMilliseconds, int maxRequestsPerWindow) {  
  13.         this.windowSizeInMilliseconds = windowSizeInMilliseconds;  
  14.         this.maxRequestsPerWindow = maxRequestsPerWindow;  
  15.     }  
  16.   
  17.     public synchronized boolean tryAcquire() {  
  18.         long currentTime = System.currentTimeMillis();  
  19.         // 移除窗口外的时间戳  
  20.         while (!window.isEmpty() && currentTime - window.peek() > windowSizeInMilliseconds) {  
  21.             window.poll();  
  22.         }  
  23.         // 如果窗口内的请求数已达到上限，则不允许新的请求  
  24.         if (window.size() >= maxRequestsPerWindow) {  
  25.             return false;  
  26.         }  
  27.         // 在窗口内添加当前请求的时间戳  
  28.         window.offer(currentTime);  
  29.         return true;  
  30.     }   
  31. }
复制代码
分布式限流

如果应用部署在多个实例或节点上，须要实现分布式限流以确保全局的调用频率不超过限制。可以使用Redis等分布式缓存系统来共享令牌或记录请求计数。
错误码定义混乱，字段结构不一致

我们常常会遇到接口文档与实际错误码定义、字段结构不一致的题目，比方文档中标明错误码400代表参数错误，但实际上大概收到的是404错误响应；又或者返回的数据结构与文档描述不相吻合，这使得我们难以精准识别并恰当处理结果。针对此类题目，应当采取以下策略：
首先，构建自定义错误处理机制，创建专门的错误处理类，对所有大概出现的错误码举行同一且明确的处理。这样，无论接口返回何种错误码，都能确保有一套标准的逻辑举行响应和记录。
其次，针对那些与文档描述不符或者含义模糊不清的错误码和字段，应及时与第三方系统的技能团队睁开沟通交流，明确其真实含义和用途。这样的互动有助于确保接口对接的精确性，避免因对错误码或字段理解不正确而引发的系统内部错误。
对于接口文档与实际不符的情况，一方面要通过定制化的错误处理机制加强系统的容错性与一致性，另一方面要强化与第三方系统的沟通协作，确保对接接口的清晰性和正确性，从而有效避免潜伏题目对自身系统产生的不良影响。
返回的数据格式不同一

对于同一个系统，接口返回的数据格式在不同场景下大概有所差别，比方有的时候返回JSON对象，有的时候却是字符串或其他格式，比方xml等。
针对这类题目，我们须要编写包容性较强的剖析逻辑，确保在任何情况下都能正确解构并处理返回数据。创建多个数据模子类对应不同格式的数据，根据接口返回的内容决定使用哪个模子类举行反序列化。针对不同的数据格式编写适配器，确保数据能同一转换为应用程序可处理的格式。
作为接口服务提供者，我们应当怎么做？

作为第三方系统接口的开发者，在计划和开发对外接口时，应当遵循一系列最佳实践，以避免给调用方带来上述提及的题目，我们应当注意以下几个方面：
作为第三方系统接口的开发者，可以最大程度地包管接口质量，低落调用方对接难度，同时也提升了自身服务的用户体验和市场竞争力。不然，别人在对接时，真的会在内心时不时的来一句”MMP“。。。
本文已收录于我的个人博客：码农Academy的博客，专注分享Java技能干货，包罗Java基础、Spring Boot、Spring Cloud、Mysql、Redis、Elasticsearch、中间件、架构计划、口试题、程序员攻略等

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4