← 返回文档

Android 集成指南 v1.0.0

1. 添加依赖

方式一:本地 AAR 文件

下载 AAR 文件并放入 app/libs/ 目录:

// app/build.gradle.kts
dependencies {
    implementation(files("libs/mc-gateway-release.aar"))
}

方式二:Maven 仓库(推荐)

// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://api.example.com/maven") }
    }
}

// app/build.gradle.kts
dependencies {
    implementation("com.mc:template:1.0.0")
}

2. 初始化 SDK

在 Application 类中初始化:

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()

        val config = UmcUgatewayConfig.Builder()
            .appId("your_app_id")
            .serverUrl("https://api.example.com")
            .debugMode(BuildConfig.DEBUG)
            .build()

        UmcUgateway.initialize(this, config)
    }
}

3. 权限配置

SDK 需要以下权限(已在 SDK 的 Manifest 中声明):

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

4. 基本使用

// 手动触发采集和上报
lifecycleScope.launch {
    val result = UmcUgateway.getInstance().collectAndReport()
    if (result.isSuccess) {
        Log.d("UmcUgateway", "上报成功")
    }
}

// 获取本地缓存的数据
val cachedData = UmcUgateway.getInstance().getCachedData()

5. ProGuard 配置

如果开启了代码混淆,请添加以下规则:

-keep class com.mc.gateway.** { *; }
注意:SDK 最低支持 Android API 21 (Android 5.0),建议 targetSdk 设置为 34。

6. 下载 SDK

下载 Android SDK