日常学习--调用第三方接口和提供第三方接口时的注意事项--20240728

1、调用第三方接口的注意事项

•     接口测试与验证：
  • 对第三方接口进行充分的测试，包括功能测试、性能测试和安全测试，确保接口的稳定性和安全性。
  •  验证接口的可用性，包括接口地址、请求方式、请求参数、响应格式等是否正确。
•     参数校验与日志记录：
  • 在调用接口前，对请求参数进行严格的校验，确保数据的正确性和完整性。
  • 记录接口调用的入参和出参日志，以便在出现问题时进行排查。
•     异常处理与重试机制
  • 实现异常捕获机制，对接口调用过程中可能出现的异常进行捕获和处理。
  • 对于可能因网络波动或第三方服务故障导致的调用失败，实现合理的重试机制，但需注意设置重试次数和间隔，避免造成雪崩效应。
    • 可以自定义重试机制，通过定时任务线程池在任务失败后，间隔一定时间重试一定次数，超过额定次数，记录调用失败日志（有必要的时候还可以发送邮件、短信等通知运维人员，（实时性要求较高的））
    • 使用spring Retry等工具实现，@Retryable注解中设置捕获何种异常才开始重试、重试次数和间隔，还可以通过@Recover实现自动恢复，可以在其中实现记录调用日志，发送警告等逻辑
•     安全性考虑：
  • 如果接口涉及敏感信息，需要确保数据传输过程中的安全性，如使用HTTPS协议。
  • 对于需要鉴权的接口，确保鉴权信息的正确性和安全性。
•     性能优化：
  •  根据业务需求，合理设置接口的调用频率和并发量，避免对第三方服务造成过大压力。
  • 使用缓存技术减少不必要的接口调用，提高系统性能。

2、实现接口并提供给第三方调用的注意事项

•     接口设计与文档：
  • 设计清晰、易于理解的接口，遵循RESTful等标准API设计规范。
  • 提供详细的接口文档，包括接口地址、请求方式、请求参数、响应格式、错误码等信息。
•     鉴权与安全性：
  • 对接口进行鉴权，确保只有合法的第三方才能调用接口。
    • 即通过apikey或者apikey+时间戳等方式（接口数据不算敏感和机密，无需登录第三方系统）或者通过OATUH认证和JWT令牌机制等方式（一般需要登录第三方）确保调用接口第三方合法
    • 一般会通过双方约定好的签名算法和secret key来生成签名进行
  • 对敏感数据进行加密处理，确保数据传输过程中的安全性。
•     限流与并发控制：
  • 实现限流策略，如令牌桶算法、漏桶算法等，避免第三方对接口进行恶意请求或高并发请求导致服务不可用。
    • 令牌桶算法和漏桶算法主要是限制单位时间内调用接口的次数（不包含桶的原有容量）
    • spring  aop + 自定义的限制调用的注解方式主要是限制接口在窗口时间内能调用的次数；同样的Interceptor和filter也能实现类似限制接口调用次数，防止恶意的第三方攻击
  • 监控接口的调用情况，根据实际情况调整限流策略。
•     性能优化：
  • 对接口进行性能优化，如使用缓存技术减少数据库查询次数、优化SQL语句等。
  • 对于耗时较长的操作，考虑使用异步处理或消息队列等方式进行解耦。
•     监控与告警：
  • 实时监控接口的调用情况、响应时间、错误率等指标。
  • 设置告警阈值，一旦接口性能出现异常或达到告警阈值，及时通知相关人员进行处理。
•     版本控制：
  • 对接口进行版本控制，确保接口的兼容性和稳定性。
  • 在接口升级时，提前通知第三方并给出合理的升级时间和方案。