搜尋套件、儲存庫與 APP 分類

套件詳情v1.5.0

geofence_foreground_service

一個 Flutter 專案,建立一個前臺服務來處理地理圍欄。

AndroidiOS
近 30 天下載
384
喜歡數
38
Pub 分數
160

安裝套件

flutter pub add geofence_foreground_service

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter 套件,可在 Android 與 iOS 上執行前景服務以實現地理圍欄功能。它允許應用程式監控地理邊界,並在使用者進入或離開定義區域時觸發動作,即使應用程式處於背景狀態也能運作。該服務會持續運行並顯示永久通知,確保在各平台特定限制下仍能可靠運作。專為即時位置追蹤設計,支援 Android 與 iOS 平台,設定簡單。

適用情境

  • 即時位置監控
  • 針對零售或物流的地理圍欄警報
  • 基於位置的觸發器在健身應用中
  • 快遞服務的背景追蹤
  • 基於距離的通知

主要特色

  • 持續的前臺服務
  • 跨平台 Android 與 iOS 支援
  • 所需設定最少
  • 與 Flutter 位置服務的整合
  • 支援進入/離開地理圍欄事件

適合對象

  • 需要背景位置追蹤的應用程式
  • 位置感知應用
  • 需要可靠地理圍欄的服務
  • 開發物流或零售解決方案的開發者
  • 具有嚴格背景執行需求的專案

使用建議

  • 需要使用者權限才能存取位置
  • 持續通知可能影響使用者體驗
  • 電池用量隨著持續追蹤而增加
  • 平台特定的後台執行限制
  • 可能需要為iOS後台模式進行額外設定

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

geofence_foreground_service

Flutter Version License Platform Platform

A Flutter plugin that enables you to easily handle geofencing events in your Flutter app by utilizing native OS APIs on Android by creating a foreground service while being battery efficient since it uses the Geofence and WorkManager APIs. And on iOS by utilizing the CLLocationManager

It's important to note that the workmanager and flutter_foreground_task plugins were a great source of inspiration while creating this plugin.

Android iOS
Android Demo iOS Demo

Features

  • Supports geofencing in foreground as well as background 💪
  • Geofence a circular area 🗺️
  • Geofence a polygon 🤯 You can add a geofence using a list of coordinates, the system will calculate the center of them and register it, having full polygon support is a WIP 🚧
  • Notification customization 🔔: ⚠️Android⚠️ Displaying a notification when running a foreground service is mandatory, you can customize what is being displayed on it (title, content or the icon), the plugin displays your app icon by default.
  • Notification responsiveness ⏱️: ⚠️Android⚠️ You can set the responsiveness of the android notifications as per the docs here

Setup

🔧 Android Setup
  • Enable MultiDex, you can check how to do so here
  • Add the service to the AndroidManifest.xml inside the application tag
<service 
    android:name="com.f2fk.geofence_foreground_service.GeofenceForegroundService"
    android:foregroundServiceType="location">
</service>
  • Add the permissions
<!--required-->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />

<!--at least one of the follwoing-->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  • Make sure the minSdkVersion in the app/build.gradle file is 29+
🔧 iOS Setup
  • Navigate to the Podfile and make sure to set the iOS version to 12+
platform :ios, '12.0'
  • Make sure to add the following permission to your Info.plist
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>This app need your location to provide best feature based on location</string>
  • Turn on the Location updates and Background fetch capabilities from XCode iOS capabilities

Example

Define the method that will handle the Geofence triggers

import 'package:geofence_foreground_service/exports.dart';
import 'package:geofence_foreground_service/geofence_foreground_service.dart';
import 'package:geofence_foreground_service/models/zone.dart';

// This method is a top level method
@pragma('vm:entry-point')
void callbackDispatcher() async {
  GeofenceForegroundService().handleTrigger(
    backgroundTriggerHandler: (zoneID, triggerType) {
      log(zoneID, name: 'zoneID');

      if (triggerType == GeofenceEventType.enter) {
        log('enter', name: 'triggerType');
      } else if (triggerType == GeofenceEventType.exit) {
        log('exit', name: 'triggerType');
      } else if (triggerType == GeofenceEventType.dwell) {
        log('dwell', name: 'triggerType');
      } else {
        log('unknown', name: 'triggerType');
      }

      return Future.value(true);
    },
  );
}

Then create an instance of the plugin to initiate it and assign GeoFences to it

final List<LatLng> timesSquarePolygon = [
  const LatLng(40.758078, -73.985640),
  const LatLng(40.757983, -73.985417),
  const LatLng(40.757881, -73.985493),
  const LatLng(40.757956, -73.985688),
];

Future<void> initPlatformState() async {
  // Remember to handle permissions before initiating the plugin

  bool hasServiceStarted = await GeofenceForegroundService().startGeofencingService(
    contentTitle: 'Test app is running in the background',
    contentText: 'Test app will be running to ensure seamless integration with ops team',
    notificationChannelId: 'com.app.geofencing_notifications_channel',
    serviceId: 525600,
    callbackDispatcher: callbackDispatcher,
  );

  if (hasServiceStarted) {
    await GeofenceForegroundService().addGeofenceZone(
      zone: Zone(
        id: 'zone#1_id',
        radius: 10000, // measured in meters
        coordinates: timesSquarePolygon,
        triggers: [
          GeofenceEventType.dwell,
          GeofenceEventType.enter,
          GeofenceEventType.exit
        ], // Currently, only available on Android
        expirationDuration: const Duration(days: 1), // Currently, only available on Android
        dwellLoiteringDelay: const Duration(hours: 1), // Currently, only available on Android
        initialTrigger: GeofenceEventType.enter, // Currently, only available on Android
      ),
    );
  }
}

Something important to point out is the callbackDispatcher method will run in an entirely different isolate than the actual app, so if you were to handle UI related code inside of it you'll need to use Ports, you can find more information here

You can pass a custom icon to the foreground service notification if you wish while initializing the service, this icon will be placed inside the android/app/src/main/res folder, you can check the example for more information, by default, it will take the app icon

const NotificationIconData(
  resType: ResourceType.mipmap,
  resPrefix: ResourcePrefix.ic,
  name: 'launcher',
)

Notes

Handling permissions is not a part of the package, so please refer to permission_handler plugin to grant the required permissions (it's used in the example too)

  • location
  • locationAlways
  • notification

Contributing

We welcome contributions. Please read CONTRIBUTING.md for pull request expectations (including small PRs and a maximum of 15 files per PR), testing, changelog updates, and review practices.

所屬分類

依賴

依賴清單 2 項

  • latlng^2.0.7
  • plugin_platform_interface^2.1.8

原始碼儲存庫

使用此套件的專案

暫無相關資料。