Flutter环境配置管理插件flavored_env的使用

Flutter环境配置管理插件flavored_env的使用

flavored_env 是一个用于生成和同步 .env 文件和 Dart 配置类的工具。它特别适用于 Firebase 应用程序，可以帮助你在云函数和 Flutter 应用之间保持常量的一致性。

功能

• 管理应用程序和云函数的所有常量在一个文件中。
• 从配置生成 .env 和 Dart 类。
• 支持多口味、复制和位置。

安装

该插件旨在支持使用 package:build 的 Dart 项目。通常将其放在 dev_dependencies 中，并在 pubspec.yaml 中指定：

dev_dependencies:
  build_runner:

内置命令

flavored_env 包含一个名为 flavord_env 的二进制文件，可以通过以下命令调用：

dart run flavored_env <command>

可用的命令包括：

• create-yaml: 创建一个样例 flavored_env.yaml 文件。
• generate: 基于 yaml 文件编辑生成配置文件，并在必要时进行重建。

创建 flavored_env.yaml

在项目根目录创建一个模板 flavored_env.yaml 文件，可以运行以下命令：

pub run flavored_env --create-yaml

默认的样例文件如下：

# flavored_env example

dotenv_to:  
  # 列出要生成 .env 文件的现有子文件夹列表。
  - lib/config
  - functions

class_to:
  # 列出要生成 Dart 配置文件的现有子文件夹列表。
  - lib  # (默认)
  - lib/config

# 要封装所有常量的 Dart 类的名称。每个口味都会生成相同的类，但文件名会有 _<flavor> 后缀。
class_name: EnvConfig

flavors:
# 应用程序口味的列表。
  default:
  # 默认口味将成为 .env.default 
    keys:
      user_collection_name:              # 键名称
        value: "users"                   # 键值
        info: "用户集合名称"               # 可选信息，用于输出保留的说明。   

      show_exception_on_crash:
        value: false
        info: "在应用崩溃时向用户显示异常"

      additional_debug_timeout:
        value: 0
        info: "为测试添加到应用中的额外超时时间"

  development:
    # 开发口味将成为 .env.development 
    keys:
      # 集合名称将从 'default' 配置中传播到 Dart。

      show_exception_on_crash: # 为开发覆盖的常量。
        value: true
        info: "在应用崩溃时向用户显示异常"
        
      additional_debug_timeout: # 为开发覆盖的常量。
        value: 0
        info: "为测试添加到应用中的额外超时时间"

      slack_url: 
        value: https://slack.com/abcd_dev
        info: "开发环境的 webhook URL"

  beta:
    keys:
      slack_url: 
        value: https://slack.com/jkdl_beta
        info: "测试环境的 webhook URL"
        
  production:
    keys:
      slack_url: 
        value: https://slack.com/xyz_production
        info: "生产环境的 webhook URL"
      
      fancy_value_prod_only:
        value: 42
        info: "仅在生产环境中可用的常量"

在配置完成后，运行以下命令生成文件：

pub run flavored_env --generate

YAML 规范

• dotenv_to: 指定要创建 .env 文件的相对路径列表。
• class_to: 指定要创建 Dart 文件的相对路径列表。
• class_name: 指定要使用的类的名称，默认为 EnvConfig。
• flavors: 指定每个口味或开发环境。
• default 环境（可选）用于基础配置。其内容将用于生成 .env.default。当为其他口味生成 Dart 文件时，未被覆盖的 default 环境中的键将合并以确保所有常量对 Flutter 应用可用。
• keys: 指定特定环境的常量列表。每个键由其名称指定，并且可以有两个属性；value 表示要使用的常量值，info 提供一条描述，将在生成的文件中作为注释使用。

生成时，键名将转换为 Dart 文件中的驼峰命名法，.env 文件中的大写带下划线分隔符以匹配常规约定。

任何在文件中列出的 environment 将翻译为 .env.<environment> 和 env_config_<environment>.dart 在每个指定的位置。

限制

• 目的地路径只能是相对路径。
• 目的地路径必须存在且不会被创建。
• 目前对 Dart 和 .env 文件中的键采用意见格式。

示例代码

为了更好地理解如何使用 flavored_env 插件，我们可以看一个简单的示例。假设你已经安装并配置了 flavored_env，接下来我们看看如何使用它。

首先，创建一个 flavored_env.yaml 文件，内容如下：

dotenv_to:  
  - lib/config
  - functions

class_to:
  - lib
  - lib/config

class_name: EnvConfig

flavors:
  default:
    keys:
      user_collection_name:
        value: "users"
        info: "用户集合名称"
      show_exception_on_crash:
        value: false
        info: "在应用崩溃时向用户显示异常"
      additional_debug_timeout:
        value: 0
        info: "为测试添加到应用中的额外超时时间"

  development:
    keys:
      show_exception_on_crash:
        value: true
        info: "在应用崩溃时向用户显示异常"
      additional_debug_timeout:
        value: 0
        info: "为测试添加到应用中的额外超时时间"
      slack_url: 
        value: https://slack.com/abcd_dev
        info: "开发环境的 webhook URL"

  beta:
    keys:
      slack_url: 
        value: https://slack.com/jkdl_beta
        info: "测试环境的 webhook URL"
        
  production:
    keys:
      slack_url: 
        value: https://slack.com/xyz_production
        info: "生产环境的 webhook URL"
      fancy_value_prod_only:
        value: 42
        info: "仅在生产环境中可用的常量"

然后运行以下命令生成所需的文件：

pub run flavored_env --generate

这将在 lib/config 和 functions 文件夹中生成相应的 .env 文件，在 lib 和 lib/config 文件夹中生成相应的 EnvConfig Dart 类。

接下来，我们可以在 Dart 代码中使用这些配置：

import 'package:flutter/material.dart';
import 'package:path/path.dart' as p;
import 'package:dotenv/dotenv.dart' load env;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final env = await loadEnvFile(p.join('lib', 'config', '.env.default'));
  runApp(MyApp(env: env));
}

class MyApp extends StatelessWidget {
  final EnvConfig env;

  MyApp({required this.env});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  final String title;

  MyHomePage({required this.title});

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            Text(
              'User Collection Name: ${env['user_collection_name']}',
              style: Theme.of(context).textTheme.bodyText1,
            ),
            Text(
              'Show Exception on Crash: ${env['show_exception_on_crash'] == 'true' ? 'Yes' : 'No'}',
              style: Theme.of(context).textTheme.bodyText1,
            ),
            Text(
              'Additional Debug Timeout: ${env['additional_debug_timeout']}',
              style: Theme.of(context).textTheme.bodyText1,
            ),
            Text(
              'Slack URL: ${env['slack_url']}',
              style: Theme.of(context).textTheme.bodyText1,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}