全部产品
Search
文档中心

应用实时监控服务ARMS:接入Android应用

更新时间:Mar 02, 2026

用户体验监控提供了非常全面的移动端应用监控能力,支持对应用性能、崩溃、卡顿等关键指标的进行实时监控与分析。本文介绍如何将Android应用接入。

前提条件

支持 Android 7.0及以上的版本。

步骤一:集成SDK

Maven自动集成(推荐)

在Android Studio工程的build.gradle配置脚本中添加Maven线上依赖,并导入最新版本的SDK。

  1. 在工程根目录下的build.gradle配置脚本中添加插件依赖。

    buildscript {
      repositories {
        mavenLocal()
        google()
        mavenCentral()
        gradlePluginPortal()
      }
      
      dependencies {
            // 导入阿里云 ARMS RUM 插件依赖
            // 建议导入最新版本插件,最新版本SDK说明请参见Android SDK版本说明文档
        classpath "com.aliyun.rum:alibabacloud-android-rum-plugin:2.2.5"
      }
    }
  2. 在工程App模块对应的build.gradle配置脚本中启用插件并添加SDK依赖。

    // 启用阿里云 ARMS RUM 插件
    apply plugin: "com.aliyun.rum"
    
    dependencies {
      // 导入阿里云 ARMS RUM SDK
      // 建议从以下链接获取最新版本SDK
      // https://www.alibabacloud.com/help/zh/arms/user-experience-monitoring/android-sdk-release-notes
      implementation("com.aliyun.rum:alibabacloud-android-rum-sdk:2.2.5")
    }

手动集成

  1. 下载SDK并解压。

    解压.zip文件后得到如下内容:

    • libs文件夹,包含必须的jar包和jni库

    • repo文件夹,包含必须的插件

    • libs/assets文件夹,包含必须的资源文件

  2. 配置工程。

    1. 复制repo文件夹到项目根目录,复制libs文件夹到App Module目录,复制libs/assets中的文件到App/src/assets目录中。

      image

    2. 打开项目根目录下的build.gradle(Gradle 7.0 及以下)或settings.gradle (Gradle 7.0以上)文件,在repositories块中加入以下Maven配置。

      build.gradle文件配置

      buildscript {
          repositories {
              maven {
                  url uri('./repo')
              }
              //... 其他配置
          }
      }
      
      allprojects {
          repositories {
              maven {
                  url uri('./repo')
              }
              //... 其他配置
          }
      }
      
      //... 其他配置

      settings.gradle文件配置

      pluginManagement {
          repositories {
              maven {
                  url uri('./repo')
              }
              //... 其他配置
          }
      }
      dependencyResolutionManagement {
          repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
          repositories {
              maven {
                  url uri('./repo')
              }
              //... 其他配置
          }
      }
      //... 其他配置
    3. 在项目根目录下的build.gradle文件中,加入classpath配置。

      // 不区分Gradle版本,添加下面内容
      buildscript {
          dependencies {
              classpath "com.aliyun.rum:alibabacloud-android-rum-plugin:2.2.5"
          }
      }
      //... 其他配置
    4. 打开App Module下的build.gradle文件,导入AlibabaCloudRUM插件和依赖。

      apply plugin: "com.aliyun.rum"
      //... 其他配置
      android {
          //... 其他配置
          sourceSets {
              main {
                  jniLibs.srcDirs = ['libs']
              }
          }
          //... 其他配置
      }
      
      dependencies {
          implementation files('libs/alibabacloud-android-rum-sdk.jar')
          //... 其他配置
      }

步骤二:插件配置

在项目App Module目录下的 build.gradle 文件中,按需添加plugin配置:

AlibabacloudRumExt {
    // 排除不需要插桩的包
    excludePackages = [
        "com.example.internal",      // 排除内部实现包
        "com.myapp.debug",           // 排除调试相关包
        "com.thirdparty.analytics"   // 排除第三方分析SDK
    ]
}
//... 其他配置

步骤三:权限配置

ARMS RUM SDK需要宿主App授予以下权限。

<!--  必须  -->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<!--  可选  -->
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.READ_BASIC_PHONE_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

步骤四:混淆配置

若您的应用使用ProGuard混淆,请添加以下配置。

-keep public class com.alibabacloud.rum.** { *; }
-dontwarn com.alibabacloud.rum.**

-optimizations !code/simplification/*,!field/*,!class/merging/*,!method/propagation/*,!class/unboxing/enum,!code/allocation/variable

步骤五:初始化SDK

请在自定义Application的onCreate函数首行添加以下代码。

import com.alibabacloud.rum.AlibabaCloudRum;

public class YourApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    // SDK版本 >= 2.0.0
    AlibabaCloudRum.withServiceId("") // ServiceId 在创建 RUM 应用时获取
          .withWorkspace("") // Workspace 在创建 RUM 应用时获取
          .withEndpoint("") // Endpoint 在创建 RUM 应用时获取
          .start(getApplicationContext());

    // SDK版本 < 2.0.0
    AlibabaCloudRum.withAppID("<your appid>") // AppID,步骤一创建RUM应用时获取。
        .withConfigAddress("<your config address>") // ConfigAddress,步骤一创建RUM应用时获取。
        .start(getApplicationContext());
  }
}

接入验证

启动已经集成了SDK的APK应用,查看Android Studio Logcat日志,搜索AlibabaCloudRUM关键字(或者过滤 AlibabaCloudRUM 标签),出现如下log则表示SDK集成成功且数据开始采集。

image