Flutter应用小部件插件flutter_app_widget的使用

Flutter应用小部件插件flutter_app_widget的使用

flutter_app_widget 是一个适用于 Flutter 的应用小部件插件，支持 Android 和 iOS 平台。

示例代码

以下是使用 flutter_app_widget 插件的一个完整示例。该示例展示了如何在 Flutter 应用中初始化小部件插件、监听点击事件，并更新和移除小部件数据。

import 'dart:convert';

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

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

import 'flutter_widget_data.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 _platformVersion = '未知';
  String uri = '';

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
    // 初始化插件并设置 App Group ID
    FlutterAppWidget.initialized(appGroupId: 'group.com.toner');
    
    // 监听小部件点击事件
    FlutterAppWidget.widgetClicked.listen((event) {
      uri = event?.toString() ?? '';
      setState(() {});
      print('小部件点击事件: $event');
    });
  }

  // 异步方法用于获取平台版本信息
  Future<void> initPlatformState() async {
    String platformVersion;
    
    // 尝试获取平台版本信息，如果失败则返回未知
    try {
      platformVersion = await FlutterAppWidget.platformVersion ?? '未知平台版本';
    } on PlatformException {
      platformVersion = '无法获取平台版本';
    }

    // 如果小部件被移除且消息还在处理中，则返回
    if (!mounted) return;

    // 更新状态
    setState(() {
      _platformVersion = platformVersion;
    });
  }

  late final textController = TextEditingController();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Column(
          children: [
            Text(
              '请输入文本 🙏🏻, 启动 URI: $uri',
            ),
            TextField(
              controller: textController,
            ),
            ElevatedButton(
                onPressed: () async {
                  print(jsonEncode(
                      FlutterWidgetData(true, textController.text)));
                  final result = await FlutterAppWidget.setWidgetDataAndUpdate(
                      key: 'widgetData',
                      value: jsonEncode(
                          FlutterWidgetData(true, textController.text)),
                      androidWidgetProviderClass: 'RunningWidgetProvider');
                  print('[更新按钮]: $result');
                },
                child: const Text('开始')),
            ElevatedButton(
                onPressed: () async {
                  await FlutterAppWidget.removeWidgetDataAndUpdate(
                      key: 'widgetData',
                      androidWidgetProviderClass: 'RunningWidgetProvider');
                },
                child: const Text('暂停')),
          ],
        ),
      ),
    );
  }
}

代码说明

1. 导入依赖库：

   import 'dart:convert';
   import 'package:flutter/material.dart';
   import 'dart:async';
   import 'package:flutter/services.dart';
   import 'package:flutter_app_widget/flutter_app_widget.dart';
   import 'flutter_widget_data.dart';
   

2. 初始化应用：

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

3. 定义主应用类：

   class MyApp extends StatefulWidget {
     const MyApp({Key? key}) : super(key: key);
     [@override](/user/override)
     State<MyApp> createState() => _MyAppState();
   }
   

4. 定义状态类：

   class _MyAppState extends State<MyApp> {
     String _platformVersion = '未知';
     String uri = '';
     
     [@override](/user/override)
     void initState() {
       super.initState();
       initPlatformState();
       // 初始化插件并设置 App Group ID
       FlutterAppWidget.initialized(appGroupId: 'group.com.toner');
       
       // 监听小部件点击事件
       FlutterAppWidget.widgetClicked.listen((event) {
         uri = event?.toString() ?? '';
         setState(() {});
         print('小部件点击事件: $event');
       });
     }
   

5. 异步方法用于获取平台版本信息：

   Future<void> initPlatformState() async {
     String platformVersion;
     
     // 尝试获取平台版本信息，如果失败则返回未知
     try {
       platformVersion = await FlutterAppWidget.platformVersion ?? '未知平台版本';
     } on PlatformException {
       platformVersion = '无法获取平台版本';
     }
   
     // 如果小部件被移除且消息还在处理中，则返回
     if (!mounted) return;
   
     // 更新状态
     setState(() {
       _platformVersion = platformVersion;
     });
   }
   

6. 定义文本控制器：

   late final textController = TextEditingController();
   

7. 构建应用界面：

   [@override](/user/override)
   Widget build(BuildContext context) {
     return MaterialApp(
       home: Scaffold(
         appBar: AppBar(
           title: const Text('插件示例应用'),
         ),
         body: Column(
           children: [
             Text(
               '请输入文本 🙏🏻, 启动 URI: $uri',
             ),
             TextField(
               controller: textController,
             ),
             ElevatedButton(
                 onPressed: () async {
                   print(jsonEncode(
                       FlutterWidgetData(true, textController.text)));
                   final result = await FlutterAppWidget.setWidgetDataAndUpdate(
                       key: 'widgetData',
                       value: jsonEncode(
                           FlutterWidgetData(true, textController.text)),
                       androidWidgetProviderClass: 'RunningWidgetProvider');
                   print('[更新按钮]: $result');
                 },
                 child: const Text('开始')),
             ElevatedButton(
                 onPressed: () async {
                   await FlutterAppWidget.removeWidgetDataAndUpdate(
                       key: 'widgetData',
                       androidWidgetProviderClass: 'RunningWidgetProvider');
                 },
                 child: const Text('暂停')),
           ],
         ),
       ),
     );
   }