Flutter核心框架扩展插件awareframework_core的使用

awareframework_core 是一个用于增强 Flutter 应用功能的核心插件。它提供了丰富的传感器数据处理能力和事件流管理。

开发 Aware 插件

Flutter

1. 使用 flutter create 命令创建模板应用。

   $ flutter create --org com.awareframework.accelerometer --template=plugin --platforms=android,ios -i swift -a kotlin awareframework_accelerometer
   

2. 在 pubspec.yaml 中添加 awareframework_core 依赖项。

   dependencies:
     awareframework_core:
   

3. 实现传感器类，使用 awareframework_core 提供的功能。

   /// 加速度传感器类
   class AccelerometerSensor extends AwareSensor {
   
     /// 加速度方法通道
     static const MethodChannel _accelerometerMethod = const MethodChannel('awareframework_accelerometer/method');
   
     /// 加速度事件通道
     static const EventChannel  _accelerometerStream  = const EventChannel('awareframework_accelerometer/event');
   
     /// 初始化加速度传感器
     AccelerometerSensor():this.init(null);
     AccelerometerSensor.init(AccelerometerSensorConfig config) : super.init(config){
       super.setMethodChannel(_accelerometerMethod);
     }
   
     Stream<Map<String,dynamic>> get onDataChanged {
        return super.getBroadcastStream( _accelerometerStream, "on_data_changed").map((dynamic event) => Map<String,dynamic>.from(event));
     }
   
     [@override](/user/override)
     void cancelAllEventChannels() {
       super.cancelBroadcastStream("on_data_changed");
     }
   }
   
   ///
   /// 传感器配置参数类
   ///
   class AccelerometerSensorConfig extends AwareSensorConfig {
   
     int frequency    = 5;
     double period    = 1.0;
     double threshold = 0.0;
   
     AccelerometerSensorConfig();
   
     [@override](/user/override)
     Map<String, dynamic> toMap() {
       var map = super.toMap();
       map['frequency'] = frequency;
       map['period']    = period;
       map['threshold'] = threshold;
       return map;
     }
   }
   

Android

在 Android 平台上，你需要配置相应的 Kotlin 文件来支持 awareframework_core。

iOS

在 iOS 平台上，你需要在 ios/awareframework_accelerometer.podspec 文件中添加 awareframework_core 依赖，并运行 pod install 安装依赖。

import Flutter
import UIKit
import com_awareframework_ios_sensor_accelerometer
import com_awareframework_ios_sensor_core
import awareframework_core

public class SwiftAwareframeworkAccelerometerPlugin: AwareFlutterPluginCore, FlutterPlugin, AwareFlutterPluginSensorInitializationHandler, AccelerometerObserver{
        
    var accelerometerSensor:AccelerometerSensor?
    
    public override init() {
        super.init()
        super.initializationCallEventHandler = self
    }
    
    public func initializeSensor(_ call: FlutterMethodCall, result: @escaping FlutterResult) -> AwareSensor? {
        if self.sensor == nil {
            if let config = call.arguments as? Dictionary<String,Any>{
                self.accelerometerSensor = AccelerometerSensor.init(AccelerometerSensor.Config(config))
            }else{
                self.accelerometerSensor = AccelerometerSensor.init(AccelerometerSensor.Config())
            }
            self.accelerometerSensor?.CONFIG.sensorObserver = self
            return self.accelerometerSensor
        }else{
            return nil
        }
    }
    
    public static func register(with registrar: FlutterPluginRegistrar) {
        let instance = SwiftAwareframeworkAccelerometerPlugin()
        // 添加自己的通道
        super.setMethodChannel(with: registrar,
                               instance: instance,
                               channelName: "awareframework_accelerometer/method");
        super.setEventChannels(with: registrar,
                               instance: instance,
                               channelNames: ["awareframework_accelerometer/event"]);

    }
    
    public func onDataChanged(data: AccelerometerData) {
        for handler in self.streamHandlers {
            if handler.eventName == "on_data_changed" {
                handler.eventSink(data.toDictionary())
            }
        }
    }
}

示例应用

以下是一个完整的示例应用，展示了如何使用 awareframework_core 插件。

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:awareframework_core/awareframework_core.dart';

void main() => runApp(new MyApp());

const EventChannel _coreStream = const EventChannel('awareframework_core/event');
AwareSensorCore core = AwareSensorCore(null);

class MyApp extends StatefulWidget {
  var sensor;
  [@override](/user/override)
  _MyAppState createState() => new _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息是异步的，所以我们初始化时使用异步方法。
  Future<void> initPlatformState() async {
    var config = AwareSensorConfig();
    widget.sensor = AwareSensorCore(config);

    core.getBroadcastStream(_coreStream, "get_event").listen((event) {
      print(event);
    });
    core.cancelBroadcastStream("get_event");
  }

  String sampleValue = "";

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: ListView(
          children: [
            Text(sampleValue),
            TextButton(
                child: Text("开始"),
                onPressed: () {
                  setState(() => sampleValue = "start");
                  widget.sensor.start();
                }),
            TextButton(
                child: Text("停止"),
                onPressed: () {
                  setState(() => sampleValue = "stop");
                  widget.sensor.stop();
                }),
            TextButton(
              child: Text("同步"),
              onPressed: () {
                setState(() => sampleValue = "sync");
                widget.sensor.sync(force: true);
              },
            ),
            TextButton(
              child: Text("启用"),
              onPressed: () => setState(() => sampleValue = "enable"),
            ),
            TextButton(
              child: Text("禁用"),
              onPressed: () => setState(() => sampleValue = "disable"),
            ),
            TextButton(
              child: Text("设置标签"),
              onPressed: () => setState(() => sampleValue = "set-label"),
            ),
            TextButton(
              child: Text("是否已启用"),
              onPressed: () => setState(() => sampleValue = "is-enable"),
            ),
          ],
        ),
      ),
    );
  }
}