Flutter启动参数获取插件flutter_launch_arguments的使用

Flutter启动参数获取插件flutter_launch_arguments的使用

flutter_launch_arguments 是一个用于在 Flutter 应用中获取 Android 和 iOS 启动参数的插件。

动机

有时你需要在启动应用时传递一些参数。通常情况下，你可以使用 --dart-define 或 --dart-define-from-file 在 Flutter 中传递参数。然而，这些参数仅在运行时可用，并且不适用于已经安装的应用。此插件允许你在启动时从 Android 和 iOS 获取这些参数。

该插件在执行测试时特别有用。例如，你可能需要在运行测试时设置特定的测试环境或配置应用。此插件允许你在启动测试时传递参数并在应用中获取它们。

开始使用

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter_launch_arguments: latest

使用方法

flutter_launch_arguments 提供了一个简单的 API 来从平台检索启动参数。要获取启动参数，可以使用以下方法：

• getString(String key)：从启动参数中检索字符串。
• getBool(String key)：从启动参数中检索布尔值。
• getDouble(String key)：从启动参数中检索双精度浮点数。
• getInt(String key)：从启动参数中检索整数值。

这些方法返回一个包含所需类型参数的 Future。如果找不到参数，则 Future 将返回 null。

在使用这些方法之前，你需要通过调用 FlutterLaunchArguments() 初始化插件，它是一个单例。

示例代码

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

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

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late final FlutterLaunchArguments _flutterLaunchArgumentsPlugin;

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

    _flutterLaunchArgumentsPlugin = FlutterLaunchArguments();
  }

  @override
  Widget build(BuildContext context) => MaterialApp(
        home: Scaffold(
          appBar: AppBar(
            title: const Text('flutter_launch_arguments 示例应用'),
          ),
          body: ListView(
            children: [
              FutureBuilder<String?>(
                future: _flutterLaunchArgumentsPlugin.getString('foo'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('foo'),
                ),
              ),
              FutureBuilder<bool?>(
                future: _flutterLaunchArgumentsPlugin.getBool('isFooEnabled'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('isFooEnabled'),
                ),
              ),
              FutureBuilder<double?>(
                future: _flutterLaunchArgumentsPlugin.getDouble('fooValue'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('fooValue'),
                ),
              ),
              FutureBuilder<int?>(
                future: _flutterLaunchArgumentsPlugin.getInt('fooInt'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('fooInt'),
                ),
              ),
              FutureBuilder<String?>(
                future: _flutterLaunchArgumentsPlugin.getString('fooAbsent'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('不存在的 String 参数'),
                ),
              ),
              FutureBuilder<bool?>(
                future: _flutterLaunchArgumentsPlugin.getBool('fooAbsent'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('不存在的 Bool 参数'),
                ),
              ),
              FutureBuilder<double?>(
                future: _flutterLaunchArgumentsPlugin.getDouble('fooAbsent'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('不存在的 Double 参数'),
                ),
              ),
              FutureBuilder<int?>(
                future: _flutterLaunchArgumentsPlugin.getInt('fooAbsent'),
                builder: (context, snapshot) => ListTile(
                  title: Text('${snapshot.data}'),
                  subtitle: const Text('不存在的 Int 参数'),
                ),
              ),
            ],
          ),
        ),
      );
}

如何向应用传递参数

Android

要在 Android 上向应用传递参数，可以使用 adb shell am start 命令。例如：

adb shell am start -n com.example.myapp/com.example.myapp.MainActivity --es foo bar --ez isFooEnabled true --ed fooValue 3.14 --ei fooInt 42

iOS

要在 iOS 上向应用传递参数，可以使用 xcrun simctl 命令。例如：

xcrun simctl launch booted com.example.myapp -foo bar -isFooEnabled "true" -fooValue 3.14 -fooInt 42