接入Flutter应用

更新时间:
复制 MD 格式

阿里云用户体验监控 RUM 官方 Flutter 插件,当前支持 Android、iOS、HarmonyOS 平台。

版本要求

  • Flutter:3.0.0+

  • iOS:12.0+

  • Android:7.0+

  • HarmonyOS:API 12+

插件集成

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter

  alibabacloud_rum_flutter_plugin: ^2.3.6

2. 在 Flutter 项目根目录执行以下命令

flutter packages get

3.(仅 iOS 平台)在工程 ios 目录下执行以下命令

pod install

4. 初始化 SDK

main.dart 文件中导入以下包:

import 'package:alibabacloud_rum_flutter_plugin/alibabacloud_rum_flutter_plugin.dart';

完成 SDK 的初始化:

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

5.(可选)采集 actions 事件

RUM Flutter 插件支持采集 Flutter 的点击等 action 事件。使用 AlibabaCloudActionCapture 采集用户点击事件,以下为使用示例:

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return AlibabaCloudActionCapture(
          child: Scaffold(
          appBar: AppBar(
            title: const Text('AlibabaCloudRUM'),
          ),
          body: // 你的其他代码
        ));
  }
}

6. 接入验证

Flutter 应用启动后,DEBUG CONSOLE 中返回 [INFO][AlibabaCloudRUM]: alibabacloud_rum_flutter_plugin initialized successfully 即表示 SDK 接入成功。示例如下:

flutter: [2024-05-27 16:43:39][INFO][AlibabaCloudRUM]: alibabacloud_rum_flutter_plugin initialized successfully

更多 SDK 配置方法(路由监听、错误回调、自定义事件、资源快照采集等),请参见SDK配置参考

Native SDK 集成

Flutter 项目在集成 Alibaba Cloud RUM SDK 时,除了需要集成 Flutter 插件之外,还需要分别集成 Android、iOS、HarmonyOS SDK。可以参考以下文档集成: