高防 SDK 接入概览与联调清单
整理客户端平台、版本和网络资料，获取匹配的 SDK 文档，完成测试、灰度发布与回退验证。
本文目录
先确认 SDK 与项目是否匹配
高防 SDK 盾用于游戏和 APP 的客户端接入。本站产品说明列有 Windows、Android、iOS，具体 SDK 版本、系统版本、开发框架及协议适配范围，需要根据项目向技术顾问确认。
接入前取得与项目匹配的 SDK、版本文档和授权资料，按对应版本文档完成集成。
账户、线路与订单的共通核对事项见 购买前提与计费说明。
接入前应具备的条件
- 能修改并构建客户端项目，安排测试和版本发布。
- 有可联调的服务端与测试业务流程，能获取必要的客户端和服务端错误信息。
- 明确目标系统、应用框架、连接协议以及现有登录、鉴权和重连机制。
- 有原版本或原连接方案的恢复安排，能够区分新旧客户端的运行结果。
- 已向客服确认适用平台、授权范围、源机数量、业务规模及费用，取得实际接入包和文档。
申请接入时提供的资料
| 资料 | 填写内容 |
|---|---|
| 应用信息 | 游戏或 APP 名称、使用场景、拟接入的平台 |
| 构建环境 | 操作系统版本范围、开发语言、引擎或框架、编译工具与架构 |
| 连接方式 | 服务端地址、协议、端口、连接持续时间、鉴权与重连方式 |
| 业务规模 | 日活、并发连接、峰值带宽、主要用户地区及源站数量 |
| 外部依赖 | 登录、支付、更新、推送等需要共同验证的服务 |
| 联调计划 | 测试环境、客户端构建版本、上线窗口与负责人员 |
如果交付需要应用标识、包名或签名信息，应按服务团队给出的字段提供。授权凭据与密钥通过约定渠道处理，不写入公开问题描述。
应取得哪些交付内容
在开始修改代码前，向技术人员核对以下资料：
- SDK 支持的平台、版本、依赖和升级兼容说明。
- 正式分发的 SDK 包、示例或最小接入流程，以及版本识别方法。
- 本项目的授权方式、初始化配置和需要接入的业务连接范围。
- 错误码、日志收集方法、联调联系渠道及故障处理说明。
- 发布、升级、停用和回退时需要注意的行为。
建议的接入顺序
- 建立基线。 记录原客户端版本的启动、登录、连接耗时、业务成功率与异常信息。
- 接入测试版本。 按交付文档集成 SDK，确认构建、初始化和连接均完成，再接入完整业务流程。
- 完成联合调试。 配合服务团队核对请求路径、授权结果和服务端行为，逐项处理兼容问题。
- 小范围发布。 利用项目现有发布能力向部分测试用户开放，观察不同系统、设备及网络环境。
- 扩大使用范围。 达到事先约定的验收标准后发布，并保留版本与配置记录。
如何验证接入成功
| 场景 | 需要观察的结果 |
|---|---|
| 启动与登录 | 冷启动、重复启动和登录能完成，失败时可收集对应错误 |
| 业务连接 | 客户端与服务端均能确认正常会话，关键操作结果一致 |
| 网络变化 | Wi-Fi 与移动网络切换、短时断网、弱网下的超时与重连符合业务预期 |
| 系统行为 | 前后台切换、休眠唤醒或长时间空闲后，业务按预期恢复 |
| 版本兼容 | 拟支持的系统、架构和客户端版本分别通过测试 |
| 外部流程 | 登录、支付、更新等依赖没有因连接方案变化而失败 |
| 回退 | 原版本或约定的恢复方案可使用，恢复后能再次完成核心流程 |
联调时一并检查所用 SDK 版本的调度、加密与故障恢复行为，并记录测试结果。
提交问题与回退
遇到异常时，记录 SDK 版本、应用版本、系统及设备、网络环境、发生时间、复现步骤和脱敏日志，说明同一场景在原版本中是否正常。错误码按本次交付文档解释。
按预先验证的方案停止扩大范围或恢复原版本；SDK 停用是否还需要调整服务端或授权配置，交由服务团队确认。