Android 客户端接入

适用平台：Android库文件：protect.aar最后更新：2026 年 10 月

本文说明如何在 Android 项目中集成客户端 SDK。SDK 以 AAR 形式提供，支持 Java 与 Kotlin 项目。

前置条件

拥有项目源码，开发环境可正常编译打包
Android Studio 环境正常，Gradle 可同步
已在控制台创建 Android 平台实例，取得接入码

客户端 SDK 安装包含 Windows / Android / iOS 三个平台的库文件

下载 SDK

集成步骤

解压 SDK 包，找到 android/java11/protect.aar。
把 protect.aar 放到项目模块的 libs 目录下（没有就新建一个）。
在模块级 build.gradle 中引用 libs 目录并添加依赖。
点击 File → Sync Project with Gradle Files 同步配置。
在 App 启动时调用 ProtectLibrary.start()，退出前调用 ProtectLibrary.stop()。

Gradle 配置

repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    implementation(name: 'protect', ext: 'aar')
}

如果项目使用 Kotlin DSL（build.gradle.kts），依赖写法为 implementation(files("libs/protect.aar"))，其余配置相同。

启动与停止

在 App 启动时（建议放在 Application 的 onCreate 或主 Activity 的 onCreate）加入：

import com.shield.protect.ProtectLibrary;

// 配置
String config = "{\"access_key\": \"接入码\"}";

// 启动，返回 0 表示成功，其他表示错误
int result = ProtectLibrary.start(this, config);

在 App 退出前加入停止代码：

ProtectLibrary.stop();

返回值说明

ProtectLibrary.start() 返回 0 表示启动成功，其他值表示失败。失败原因可查阅 SDK 日志或联系技术支持。

接入码区分平台。在控制台创建实例时必须选择 Android，使用 Windows 或 iOS 的接入码会导致启动失败。

常见问题

Gradle 同步后找不到 ProtectLibrary

确认 protect.aar 位于模块级 libs 目录，不是项目根目录
确认 repositories 与 dependencies 写在同一个模块级 gradle 文件里
执行一次 Clean Project 后重新 Sync

启动返回非 0

检查接入码是否属于 Android 平台实例
确认实例未暂停、未到期
确认传入的 context 不是 null