文档中心

安装 Android SDK

最近更新时间：2024.04.09 10:35:04

首次发布时间：2023.04.27 17:58:57

使用 SDK 进行日志服务各类操作前，您需要安装 SDK。本文介绍 Android SDK 的安装方法。

前提条件

已创建并获取 AccessKey。
访问密钥 AccessKey 拥有所有 API 的访问权限，风险很高。建议您创建并使用 IAM 用户进行 API 访问或日常运维。使用 IAM 用户操作前，请确认已为 IAM 用户赋予操作日志服务资源的权限。

准备开发环境

日志服务 Android SDK 支持 Android 4.0 及后续版本，安装火山引擎日志服务 Android SDK 之前，请确认已准备对应的 Android 开发环境，详细说明请参考 Android 官方网站和 Android Studio。
您可以执行以下命令检查当前使用的 Android 版本信息。

adb shell getprop ro.build.version.release

集成 Android SDK

创建 Android 项目。通过 Android Studio 创建项目的操作步骤请参考官方文档。
通过 Maven Central 将日志服务 Android SDK 集成到项目中。
1. 在项目根目录下的 build.gradle 文件中添加以下代码，添加 Maven Central 依赖。
```
buildscript {
    repositories {
        ...
        mavenCentral()
    }
    ...
}

 allprojects {
    repositories {
        ...
        mavenCentral()
    }
}
```
2. 在指定模块目录下的 build.gradle 文件中添加以下代码，将日志服务 Android SDK 集成到 Android 项目中。
  说明
  其中，1.1.4 表示 SDK 版本号，目前支持 1.1.4 即后续的版本，推荐使用最新版本。版本号列表请参考 maven。
```
...
 dependencies {
     ...
    implementation 'com.squareup.okhttp3:okhttp:4.10.0'
    implementation 'com.volcengine:volc-tls-android-sdk:1.1.4'
  }
```
为 SDK 添加网络权限。
SDK 采集应用程序的日志并发送到日志服务需要通过公网传输。在 /app/Manifests/AndroidManifest.xml 文件中，在 </application> 后面添加如下权限：
```
<uses-permission android:name="android.permission.INTERNET" />
```
添加混淆配置。
添加以下配置，以防止日志服务 SDK 的代码被混淆。
```
-keep class net.jpountz.** { *; }
```

前提条件

准备开发环境

集成 Android SDK