文档

接入Flutter应用

更新时间:

ARMS用户体验监控提供了Flutter插件用于监控通过Flutter开发的iOS和Android应用。本文介绍如何集成Flutter插件并将应用接入用户体验监控。

版本要求

  • iOS:8.0+

  • Android:4.0+

  • Flutter:3.0.0+

步骤一:集成Flutter插件

  1. 在pubspec.yaml配置文件中添加依赖。

    dependencies:
      flutter:
        sdk: flutter
    
      alibabacloud_rum_flutter_plugin: ^0.1.0
  2. 在Flutter项目根目录执行以下命令加载插件。

    flutter packages get
  3. 如果是iOS应用,请在工程ios目录下执行以下命令更新Pod环境。

    pod install
  4. 初始化Flutter SDK。

    1. main.dart文件中导入以下包。

      import 'package:alibabacloud_rum_flutter_plugin/alibabacloud_rum_flutter_plugin.dart';
    2. 初始化SDK。

      void main() {
        // 注释原有的 runApp() ⽅法
        // runApp(MyApp());
        // (必须)初始化SDK
        AlibabaCloudRUM().start(MyApp());
        // (可选)自定义用户名称
        AlibabaCloudRUM().setUserName("xxxxxx");
      }

      API参数

      说明

      start

      启用Flutter插件。

      setUserName

      自定义用户名称。

  5. 插件接入验证。

    启动Flutter应用,DEBUG CONSOLE中返回[INFO][AlibabaCloudRUM]: alibabacloud_rum_flutter_plugin start success即表示SDK接入成功。

    返回示例如下:

    flutter: [2024-05-27 16:43:39][INFO][AlibabaCloudRUM]: alibabacloud_rum_flutter_plugin start success

步骤二:集成原生SDK

Flutter项目在集成Alibaba Cloud RUM SDK时,除了需要集成Flutter插件之外,还需要分别初始化Android和iOS SDK。

Android

  1. 创建应用。

    1. 登录ARMS控制台
    2. 在左侧导航栏选择用户体验监控 > 应用列表,并在顶部菜单栏选择目标地域。

    3. 应用列表页面单击添加应用

    4. 创建应用面板单击Android

    5. Android面板输入应用名称和描述,然后单击创建

      说明

      应用名称唯一,不能与已创建的应用名称重复。

      创建成功后,当前应用将会自动生成对应的ConfigAddress(上报地址)和AppID。

  2. 初始化SDK。

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

    说明

    请将以下代码中的ConfigAddressAppID替换为上一步获取的当前应用对应的ConfigAddress和AppID。

    import com.alibabacloud.rum.AlibabaCloudRum;
    
    public class YourApplication extends Application {
      @Override
      public void onCreate() {
        super.onCreate();
        AlibabaCloudRum.withAppID("<your appid>") // AppID,创建RUM应用时获取。
          .withConfigAddress("<your config address>") // ConfigAddress,创建RUM应用时获取。
          .start(getApplicationContext());
      }
    }
  3. 接入验证。

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

    845ac95cc4d1bb66865e910a58778b51

iOS

  1. 创建应用。

    1. 登录ARMS控制台
    2. 在左侧导航栏选择用户体验监控 > 应用列表,并在顶部菜单栏选择目标地域。

    3. 应用列表页面单击添加应用

    4. 创建应用面板单击iOS

    5. iOS面板输入应用名称和描述,然后单击创建

      说明

      应用名称唯一,不能与已创建的应用名称重复。

      创建成功后,当前应用将会自动生成对应的ConfigAddress(上报地址)和AppID。

  2. 初始化SDK。

    main函数或- application:didFinishLaunchingWithOptions:方法中完成SDK的初始化。

    说明

    请将以下代码中的ConfigAddressAppID替换为上一步获取的当前应用对应的ConfigAddress和AppID。

    Objective-C

    [AlibabaCloudRUM setConfigAddress:@"<your config address>"];// ConfigAddress,创建RUM应用时获取。
    [AlibabaCloudRUM startWithAppID:@"<your appId>"];// AppID,创建RUM应用时获取。

    Swift

    AlibabaCloudRUM.setConfigAddress("<your config address>")// ConfigAddress,创建RUM应用时获取。
    AlibabaCloudRUM.start("<your appId>")// AppID,创建RUM应用时获取。
  3. 接入验证。

    应用运行后,返回SDK Config Succeeded即表示SDK初始化成功。

    返回示例:

    2024-04-23 16:07:18.450 [OpenRUM] [CONFIG]  SDK Config Succeeded.

相关文档