Flutter地理围栏功能插件geofencing_flutter_plugin的使用

geofencing_flutter_plugin 是一个扩展了 Woosmap Geofencing Mobile SDKs 功能的 Flutter 插件。它支持 iOS 和 Android 平台，允许开发者在应用中实现地理围栏功能。

支持平台

• iOS
• Android

模块和对象

• GeofencingFlutterPlugin: 包含监控位置、区域和兴趣点的方法。
• Location: 代表位置对象。
• POI: 代表兴趣点。
• Region: 代表地理区域/地理围栏。
• GeofenceRegion: 在本地数据库中添加新区域时使用。

类型

• ProfileSource: 表示跟踪配置文件来源，可以是 ProfileSource.local 或 ProfileSource.external。
• RegionType: 表示区域类型，可能值为 RegionType.circle 和 RegionType.isochrone。

使用方法

初始化插件

首先需要导入插件并创建实例：

import 'package:geofencing_flutter_plugin/geofencing_flutter_plugin.dart';

final geofencingFlutterPlugin = GeofencingFlutterPlugin();

检查和请求权限

在初始化 SDK 之前，必须请求所需的定位权限。

检查定位权限状态

Future<String?> returnVal = geofencingFlutterPlugin.getPermissionsStatus();

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

请求定位权限

bool background = true; // 设置为true以请求后台定位权限
Future<String?> returnVal = geofencingFlutterPlugin.requestPermissions(background);

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

初始化插件

通过调用 initialize 方法来初始化插件：

Map<String, String> woosmapSettings = {
    "privateKeyWoosmapAPI": "<<WOOSMAP_KEY>>",
    "trackingProfile": "liveTracking"
};

Future<String?> returnVal = geofencingFlutterPlugin.initialize(woosmapSettings);

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: $error');
});

开始和停止跟踪

一旦用户授权了定位权限，可以开始跟踪用户的位置：

// 开始跟踪
Future<String?> returnVal = geofencingFlutterPlugin.startTracking('liveTracking');

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

// 停止跟踪
Future<String?> returnVal = geofencingFlutterPlugin.stopTracking();

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

监听事件

可以通过监听位置和区域事件来获取更新：

监听位置

Future<String?> returnVal = geofencingFlutterPlugin.watchLocation();

returnVal.then((value) {
    // 获取位置流
    watchLocationStream = geofencingFlutterPlugin.getWatchLocationStream();
    // 监听流
    watchLocationStream.listen((location) {
        if (location != null) {
            debugPrint(location.locationDescription);
        } else {
            debugPrint("Location is null");
        }
    });
}).catchError((error) {
    debugPrint('An error occurred: $error');
});

监听区域

Future<String?> returnVal = geofencingFlutterPlugin.watchRegion();

returnVal.then((value) {
    // 获取区域流
    watchRegionStream = geofencingFlutterPlugin.getWatchRegionStream();
    // 监听流
    watchRegionStream.listen((region) {
        if (region != null) {
            debugPrint(region.eventName);
        } else {
            debugPrint("Region is null");
        }
    });
}).catchError((error) {
    debugPrint('An error occurred: $error');
});

添加和移除区域

创建自定义圆形区域

GeofenceRegion geofenceRegion = GeofenceRegion(
    '7F91369E-467C-4CBD-8D41-6509815C4780', 
    51.50998, 
    -0.1337, 
    180, 
    RegionType.circle
);

Future<String?> returnVal = geofencingFlutterPlugin.addRegion(geofenceRegion);

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

移除区域

Future<String?> returnVal = geofencingFlutterPlugin.removeRegions('7F91369E-467C-4CBD-8D41-6509815C4780');

returnVal.then((value) {
    debugPrint(value!);
}).catchError((error) {
    debugPrint('An error occurred: ${error.message}');
});

完整示例 Demo

以下是一个完整的示例 Demo，展示了如何使用 geofencing_flutter_plugin 实现基本的地理围栏功能：

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

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'GeoFencing Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: GeoFencingDemoWidget(),
    );
  }
}

class GeoFencingDemoWidget extends StatefulWidget {
  @override
  _GeoFencingDemoWidgetState createState() => _GeoFencingDemoWidgetState();
}

class _GeoFencingDemoWidgetState extends State<GeoFencingDemoWidget> {
  final GeofencingFlutterPlugin geofencingFlutterPlugin = GeofencingFlutterPlugin();

  @override
  void initState() {
    super.initState();
    initializePlugin();
  }

  Future<void> initializePlugin() async {
    Map<String, String> settings = {
      "privateKeyWoosmapAPI": "<<YOUR_WOOSMAP_API_KEY>>",
      "trackingProfile": "liveTracking"
    };

    await geofencingFlutterPlugin.initialize(settings);
    await geofencingFlutterPlugin.requestPermissions(true);
  }

  void startTracking() {
    geofencingFlutterPlugin.startTracking('liveTracking').then((value) {
      debugPrint('Tracking started: $value');
    }).catchError((error) {
      debugPrint('Error starting tracking: ${error.message}');
    });
  }

  void stopTracking() {
    geofencingFlutterPlugin.stopTracking().then((value) {
      debugPrint('Tracking stopped: $value');
    }).catchError((error) {
      debugPrint('Error stopping tracking: ${error.message}');
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('GeoFencing Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: startTracking,
              child: Text('Start Tracking'),
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: stopTracking,
              child: Text('Stop Tracking'),
            ),
          ],
        ),
      ),
    );
  }
}

这个示例展示了如何初始化插件、请求权限、开始和停止跟踪。您可以根据需要扩展此示例以实现更复杂的地理围栏功能。