Flutter访问控制插件acl_sdk的使用

简介

Flutter ACL Plugin 是一个通过统一智能（Unified Intelligence）提供访问控制功能的插件。它允许开发者收集设备数据、位置信息、通知等，并将数据同步到服务器以进行评分计算。

功能

以下是该插件的主要功能：

• 收集设备数据（电池、资源、网络、应用使用情况）
• 收集地理位置
• 收集通知
• 将数据存储并同步到服务器
• 计算评分

注意：

• 此插件支持 Android 和 iOS。
• 在 iOS 版本中，以下功能不可用：
  • PermissionHelper.isNotificationListenerRunning
  • PermissionHelper.goToNotificationListenerSetting
  • PermissionHelper.isPackageUsageStatsEnable
  • PermissionHelper.goToAppUsageSetting
    使用这些功能时，请务必添加平台条件检查！

安装步骤

Step 1: 添加依赖

在 pubspec.yaml 文件中添加插件依赖：

flutter pub add acl_sdk

Step 2: 配置 Firebase

此插件使用 firebase_messaging 处理服务器消息并执行操作。你需要在项目中安装以下 Firebase 包：

dependencies:
  firebase_core: ^3.4.1
  firebase_messaging: ^15.1.1

Android 配置

1. 打开 android/build.gradle 文件，添加以下代码以支持 aar 库：

   allprojects {
       repositories {
           ...
           // 添加以下行
           maven {
               url "${project(':acl_sdk').projectDir}/build"
           }
       }
   }
   

2. 修改 android/app/build.gradle 文件中的 minSdkVersion 为 24：

   defaultConfig {
       ...
       minSdk = 24
       ...
   }
   

iOS 配置

1. 在 Info.plist 中启用后台模式：

   <key>UIBackgroundModes</key>
   <array>
       <string>fetch</string>
       <string>remote-notification</string>
       <string>location</string>
   </array>
   

2. 如果你的应用未请求位置权限，请添加位置始终权限。

使用方法

初始化插件并注册设备

import 'package:acl_sdk/acl_sdk.dart';

final _aclSdkPlugin = AclSdk();

void initializeAndRegisterDevice() async {
  await _aclSdkPlugin.initialize(AppConfigCreateInput(
    partnerId: '<你的组织唯一名称>',
    apiEndpoint: '<你的 API 地址>',
    apiKey: '<你的 API Key>',
    apiSecret: '<你的 API 密钥>',
    appBundle: '<你的应用包名>',
  ));
  await _aclSdkPlugin.registerDevice();
}

映射设备与成员

注意：

1. 在调用 mapDeviceMember 前，请确保已执行过 registerDevice。
2. 当 memberId 发生变化时调用此函数（例如登录或切换账户）。

await _aclSdkPlugin.mapDeviceMember('<你的 memberId >');

开始收集数据和位置

await _aclSdkPlugin.startCollectData();
await _aclSdkPlugin.startCollectLocation();

监听服务器消息

你可以通过以下方式监听来自 Unified Intelligence 的消息：

import 'package:acl_sdk/work_manager_dispatchers/acl_fcm_on_receive_handler.dart';

// 后台消息处理
FirebaseMessaging.onBackgroundMessage(aclFCMOnReceiveHandler);

// 前台消息处理
FirebaseMessaging.onMessage.listen(aclFCMOnReceiveHandler);

API 示例

获取设备 ID

import 'package:acl_sdk/helpers/device_info_helper.dart';

final deviceId = await DeviceInfoHelper.generateDeviceId();

检查应用使用权限

import 'package:acl_sdk/helpers/permission_helper.dart';

final isAllowAppUsage = await PermissionHelper.isPackageUsageStatsEnable();

打开应用使用设置页面

import 'package:acl_sdk/helpers/permission_helper.dart';

await PermissionHelper.goToAppUsageSetting();

检查通知监听器权限

import 'package:acl_sdk/helpers/permission_helper.dart';

final isNotificationListenerRunning = await PermissionHelper.isNotificationListenerRunning();

手动触发数据同步

import 'package:acl_sdk/helpers/sync_data_helper.dart';

await SyncDataHelper.syncData();

注意事项

1. iOS 背景推送：在 iOS 上，我们通过主题 sync_data 推送通知以收集和同步数据。请勿覆盖此主题。
2. 位置权限：当用户返回应用并授予位置始终权限后，请立即调用 _aclSdkPlugin.startCollectLocation() 开始收集位置数据。

示例代码

以下是完整的示例代码：

import 'dart:async';
import 'dart:io';

import 'package:acl_sdk/acl_sdk.dart';
import 'package:acl_sdk/helpers/permission_helper.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _deviceId = 'Unknown';
  bool _isAllowAppUsage = false;
  bool _isAllowLocationAlways = false;
  bool _isAllowNotificationListener = false;

  final _aclSdkPlugin = AclSdk();

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    String deviceId = 'Unknown';
    bool isAllowAppUsage = false;
    bool isAllowLocationAlways = false;
    bool isAllowNotificationListener = false;

    try {
      await Firebase.initializeApp();
      await _aclSdkPlugin.initialize(
        AppConfigCreateInput(
          partnerId: '<your-partner-id>',
          apiEndpoint: '<your-api-endpoint>',
          apiKey: '<your-api-key>',
          apiSecret: '<your-api-secret>',
          appBundle: '<your-app-bundle>',
        ),
      );
      await _aclSdkPlugin.registerDevice();
      deviceId = await DeviceInfoHelper.generateDeviceId();
      isAllowAppUsage = await PermissionHelper.isPackageUsageStatsEnable();
      isAllowLocationAlways = await Geolocator.checkPermission() == LocationPermission.always;
      isAllowNotificationListener = await PermissionHelper.isNotificationListenerRunning();

      await _aclSdkPlugin.mapDeviceMember('hello-world');
      await _aclSdkPlugin.startCollectData();
      await _aclSdkPlugin.startCollectLocation();
    } catch (e) {
      print('Error initializing plugin: $e');
    }

    setState(() {
      _deviceId = deviceId;
      _isAllowAppUsage = isAllowAppUsage;
      _isAllowLocationAlways = isAllowLocationAlways;
      _isAllowNotificationListener = isAllowNotificationListener;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('ACL SDK Example')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('Device ID: $_deviceId'),
              ElevatedButton(
                onPressed: () async {
                  final isAllowed = await PermissionHelper.isPackageUsageStatsEnable();
                  if (!isAllowed) {
                    await PermissionHelper.goToAppUsageSetting();
                  }
                },
                child: Text(_isAllowAppUsage ? '已允许应用使用权限' : '允许应用使用权限'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final permission = await Geolocator.checkPermission();
                  if (permission == LocationPermission.always) return;
                  await Geolocator.requestPermission();
                  if (permission == LocationPermission.always) {
                    await _aclSdkPlugin.startCollectLocation();
                  }
                },
                child: Text(_isAllowLocationAlways ? '已允许始终定位权限' : '允许始终定位权限'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final isAllowed = await PermissionHelper.isNotificationListenerRunning();
                  if (!isAllowed) {
                    await PermissionHelper.goToNotificationListenerSetting();
                  }
                },
                child: Text(_isAllowNotificationListener ? '已允许通知监听权限' : '允许通知监听权限'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}