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

插件介绍

native_geofence 是一个高效的Flutter地理围栏插件，它利用了iOS和Android的原生API。地理围栏允许您的应用程序在用户进入或离开特定地理区域时收到通知。这可以用于设置提醒、跟踪位置等场景。

功能特点

• 平台支持：基于iOS的CLLocationManager和Android的GeofencingClient
• 事件监听：创建地理围栏并接收进入/退出/停留事件的通知
• 工作状态：支持应用在前台、后台或终止状态下运行
• 重启后重新注册：设备重启后自动重新注册地理围栏
• 获取已注册的地理围栏
• [Android] 前台服务处理地理围栏事件

环境配置

Android 配置

1. 在 AndroidManifest.xml 文件中添加以下代码段：

   <receiver android:name="com.chunkytofustudios.native_geofence.receivers.NativeGeofenceBroadcastReceiver"
             android:exported="true"/>
   <receiver android:name="com.chunkytofustudios.native_geofence.receivers.NativeGeofenceRebootBroadcastReceiver"
             android:exported="true">
       <intent-filter>
           <action android:name="android.intent.action.BOOT_COMPLETED"/>
       </intent-filter>
   </receiver>
   <service android:name="com.chunkytofustudios.native_geofence.NativeGeofenceForegroundService"
            android:permission="android.permission.BIND_JOB_SERVICE" android:exported="true"/>
   

2. 添加必要的权限：

   <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
   <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
   <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
   <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
   <uses-permission android:name="android.permission.WAKE_LOCK"/>
   

3. 设置 minSdkVersion 为26或更高版本。

iOS 配置

1. 在 Info.plist 中添加以下键值对：

   <key>NSLocationWhenInUseUsageDescription</key>
   <string>描述您的应用如何使用位置信息。</string>
   <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
   <string>描述您的应用如何使用后台位置信息。</string>
   

2. 更新 AppDelegate.swift 或 AppDelegate.m 文件以调用 NativeGeofencePlugin。

3. 将 iOS 版本设置为14.0或更高版本。

使用示例

初始化插件

await NativeGeofenceManager.instance.initialize();

获取权限

请确保已经通过第三方插件（如permission_handler）请求了以下权限：

• Permission.location
• Permission.locationAlways（如果需要在应用未运行时接收地理围栏事件）

创建地理围栏

定义地理围栏参数并创建地理围栏：

final zone1 = Geofence(
  id: 'zone1',
  location: Location(latitude: 40.75798, longitude: -73.98554), // Times Square
  radiusMeters: 500,
  triggers: {
    GeofenceEvent.enter,
    GeofenceEvent.exit,
    GeofenceEvent.dwell,
  },
  iosSettings: IosGeofenceSettings(
    initialTrigger: true,
  ),
  androidSettings: AndroidGeofenceSettings(
    initialTriggers: {GeofenceEvent.enter},
    expiration: const Duration(days: 7),
    loiteringDelay: const Duration(minutes: 5),
    notificationResponsiveness: const Duration(minutes: 5),
  ),
);

@pragma('vm:entry-point')
Future<void> geofenceTriggered(GeofenceCallbackParams params) async {
  debugPrint('Geofence triggered with params: $params');
}

await NativeGeofenceManager.instance.createGeofence(zone1, geofenceTriggered);

获取已注册的地理围栏

final List<ActiveGeofence> myGeofences = await NativeGeofenceManager.instance.getRegisteredGeofences();
print('There are ${myGeofences.length} active geofences.');

移除地理围栏

// 移除单个地理围栏
await NativeGeofenceManager.instance.removeGeofenceById('zone1');

// 移除所有地理围栏
await NativeGeofenceManager.instance.removeAllGeofences();

错误处理

捕获并处理可能抛出的 NativeGeofenceException 异常：

try {
  await NativeGeofenceManager.instance.createGeofence(zone1, geofenceTriggered);
} on NativeGeofenceException catch (e) {
  if (e.code == NativeGeofenceErrorCode.missingLocationPermission) {
    print('Did the user grant us the location permission yet?');
    return;
  }
  if (e.code == NativeGeofenceErrorCode.pluginInternal) {
    print('Some internal error occurred: message=${e.message}, detail=${e.details}, stackTrace=${e.stacktrace}');
    return;
  }
  // Handle other cases.
}

完整示例代码

以下是包含初始化、创建地理围栏及UI展示的完整示例代码：

import 'dart:async';
import 'dart:isolate';
import 'dart:ui';

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

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

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String geofenceState = 'N/A';
  ReceivePort port = ReceivePort();

  @override
  void initState() {
    super.initState();
    IsolateNameServer.registerPortWithName(port.sendPort, 'native_geofence_send_port');
    port.listen((dynamic data) {
      debugPrint('Event: $data');
      setState(() {
        geofenceState = data;
      });
    });
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    debugPrint('Initializing...');
    await NativeGeofenceManager.instance.initialize();
    debugPrint('Initialization done');
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Native Geofence'),
        ),
        body: Container(
          padding: const EdgeInsets.all(20.0),
          child: SingleChildScrollView(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                Text('Current state: $geofenceState'),
                const SizedBox(height: 20),
                ElevatedButton(
                  onPressed: () async {
                    final zone1 = Geofence(
                      id: 'zone1',
                      location: Location(latitude: 40.75798, longitude: -73.98554), // Times Square
                      radiusMeters: 500,
                      triggers: {
                        GeofenceEvent.enter,
                        GeofenceEvent.exit,
                        GeofenceEvent.dwell,
                      },
                      iosSettings: IosGeofenceSettings(
                        initialTrigger: true,
                      ),
                      androidSettings: AndroidGeofenceSettings(
                        initialTriggers: {GeofenceEvent.enter},
                        expiration: const Duration(days: 7),
                        loiteringDelay: const Duration(minutes: 5),
                        notificationResponsiveness: const Duration(minutes: 5),
                      ),
                    );

                    @pragma('vm:entry-point')
                    Future<void> geofenceTriggered(GeofenceCallbackParams params) async {
                      debugPrint('Geofence triggered with params: $params');
                    }

                    try {
                      await NativeGeofenceManager.instance.createGeofence(zone1, geofenceTriggered);
                      setState(() {
                        geofenceState = 'Geofence created successfully';
                      });
                    } on NativeGeofenceException catch (e) {
                      setState(() {
                        geofenceState = 'Error creating geofence: ${e.message}';
                      });
                    }
                  },
                  child: const Text('Create Geofence'),
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}

这个完整的示例展示了如何初始化插件、创建地理围栏，并在界面上显示当前的状态。希望这些信息能帮助您更好地理解和使用 native_geofence 插件！