Flutter插件rdc_flutter_sdk_2的介绍与使用

RDC Flutter SDK

概述

Rabbit Mobile SDK 是一组用于移动设备的开发工具包。该 SDK 将被用于标记和收集来自 Rabbit 各业务单元的移动应用程序的在线数据。

SDK 将用于收集所有 Rabbit 客户在各个业务单位中的在线行为交易数据，并将其发展为数据分析和数据科学模型，最终将用于数据货币化。

流程图

功能特性

Rabbit 数据在线收集 SDK for Flutter 提供以下功能：

内联配置

我们将在应用程序启动时通过内联代码配置实现可覆盖的配置。

缓存

SDK 将使用缓存管理器作为其内存缓存来存储设备的静态数据，并使用 MongoDB Realm 来保存跟踪数据以备后用。

发送数据到 API 后端的触发条件

在发送到 API 后端之前会检查 CPU、内存和电池条件。所有条件通过后，SDK 将发送数据到 API 后端。

使用 SDK

前置条件

• iOS 13.0 或更高版本。
• Android 8.0 或更高版本。
• Flutter 2 或更高版本。

平台支持

插件安装

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  rdc_flutter_sdk_2: ^0.0.4

设置

Dart 设置

确保使用以下插件：

import 'package:permission_handler/permission_handler.dart';

await Permission.location.request(); // Android 和 iOS
await Permission.appTrackingTransparency.request(); // 仅适用于 iOS

Android 设置

在 AndroidManifest.xml 文件中添加以下权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

在 build.gradle 文件中添加以下配置：

allprojects {
    repositories {
        google()
        mavenCentral()

        // 添加此行
        configurations.all {
            resolutionStrategy {
                force "com.google.android.gms:play-services-location:21.0.1"
            }
        }
    }
}

iOS 设置

在 Info.plist 文件中添加以下权限选项：

<!-- Location permissions -->
<key>NSLocationWhenInUseUsageDescription</key>
<string>需要使用位置信息</string>
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>始终和使用中都需要位置信息</string>
<key>NSLocationUsageDescription</key>
<string>旧设备需要位置信息</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>可以获取位置信息吗？</string>
<key>UIBackgroundModes</key>
<string>location</string>

<!-- App Tracking Transparency permissions -->
<key>NSUserTrackingUsageDescription</key>
<string>需要获取用户追踪权限</string>

在 Podfile 中添加以下内容：

## dart: PermissionGroup.appTrackingTransparency
'PERMISSION_APP_TRACKING_TRANSPARENCY=1',

## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
'PERMISSION_LOCATION=1',

配置

以下是可用的配置方法及其参数说明：

事件方法

以下是可用的事件方法及其参数说明：

自定义数据层

自定义数据层必须是扁平化的 JSON，且所有对象都必须为字符串类型：

addEvent(dataLayer: {
    'custom_field_1': 'custom_field_1',
    'custom_field_2': 'custom_field_2',
});

示例代码

以下是一个完整的示例代码，展示了如何初始化和使用插件：

import 'package:flutter/material.dart';
import 'package:permission_handler/permission_handler.dart';
import 'package:rdc_flutter_sdk_2/rabbit_data.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 请求权限
  await Permission.location.request();
  await Permission.appTrackingTransparency.request();

  // 初始化配置
  var config = RabbitDataConfig(
    apiKey: 'GUawtArmlVOSlNbaTzwUMxBxlVqirqTc', // 必填
    debugMode: true, // 可选，默认 false
  );

  // 初始化 RabbitData 实例
  var rabbitData = await RabbitData.initializeInstance(config);

  // 添加事件
  await rabbitData.addEvent('init_app', 'init_app');

  // 启动应用
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Flutter Demo',
      home: SplashScreen(), // 替换为你的启动页面
    );
  }
}

运行示例应用

1. 克隆仓库：

   git clone https://bitbucket.org/bssh-rabbit/rdc-flutter-sdk/src/master/example

2. 在 VSCode 或 Android Studio 中打开项目文件夹。

3. 在终端中运行以下命令：

   flutter run