Flutter环境变量管理插件flutter_dot_json_env的使用

Flutter环境变量管理插件flutter_dot_json_env 的使用

关于

此库是 java-james/flutter_dotenv Dart 库的一个分支，最初修改以确保与 Flutter 兼容。

一个 环境 包含由进程识别的变量（如 PATH、PORT 等）。在开发过程中（包括测试和预生产阶段），通过从文件读取这些值来复制生产环境是有益的。

该库解析文件并将其中的值与内置的 <a href="https://api.dart.dev/stable/3.4.4/dart-io/Platform-class.html#id_environment"><code>Platform.environment</code></a> 映射集成在一起。

使用

1. 在项目的根目录下创建一个名为 local.json 的文件，内容如下所示：

{
  "api_url": "https://api.local.dev.com",
  "foo": "foo",
  "bar": "bar"
}

1. 在 pubspec.yaml 文件中添加 local.json 文件到资源包中。确保路径与 local.json 文件的位置匹配！

assets:
  - local.json

1. 在 main.dart 中加载 local.json 文件。

import 'package:flutter_dot_json_env/flutter_dot_json_env.dart';

Future<void> main() async {
  await dotjsonenv.load(fileName: "local.json");
  //...runapp
}

1. 在整个应用程序中访问 local.json 中的对象键值。

import 'package:flutter_dot_json_env/flutter_dot_json_env.dart';

String variable_name = dotjsonenv.env['key_value'] ?? 'default fallback value';

使用 --dart-define 选择环境 JSON 文件

1. 创建一个名为 [envFileName].json 的文件，包含相同的对象键，例如以下示例内容：

{
  "api_url": "https://api.local.dev.com",
  "foo": "foo",
  "bar": "bar"
}

1. 在 pubspec.yaml 文件中将环境 JSON 文件添加到资源包中。确保路径与 local.json 文件的位置匹配！

assets:
  - assets/env/local.json
  - assets/env/dev.json
  - assets/env/test.json
  - assets/env/prelive.json
  - assets/env/live.json

1. 创建一个新的类，例如 Environment 类。

class Environment {
  static const env = String.fromEnvironment('ENV');

  String get envFileName {
    switch (env) {
      case 'dev': // flutter run --dart-define=ENV=dev
        return 'assets/env/dev.json';
      case 'test': // flutter run --dart-define=ENV=test
        return 'assets/env/test.json';
      case 'prelive': // flutter run --dart-define=ENV=prelive
        return 'assets/env/prelive.json';
      case 'live': // flutter run --dart-define=ENV=live
        return 'assets/env/live.json';
      default: // flutter run
        return 'assets/env/local.json';
    }
  }

  static String get environmentName {
    return env.isNotEmpty ? env : "Environment name not found";
  }

  static String get apiUrl =>
      dotjsonenv.get('api_url', fallback: 'api url default fallback value');
  static String get foo =>
      dotjsonenv.env['foo'] ?? 'foo default fallback value';
  static String get bar =>
      dotjsonenv.env['bar'] ?? 'bar default fallback value';
}

1. 在整个应用程序中访问 Environment 类中的值。

Future<void> main() async {
  // await dotjsonenv.load(fileName: "assets/env/local.json"); // load as static json
  await dotjsonenv.load(fileName: Environment().envFileName);
  print('appURL::: ${Environment.apiUrl}'); // appURL::: https://api.local.com
  print('Foo::: ${Environment.foo}'); // Foo::: prelive foo
  print('Bar::: ${Environment.bar}'); // Bar::: prelive bar
  //...runapp
}

1. 运行应用程序或构建时：

flutter run --dart-define=ENV=<envFileName>
// flutter run --dart-define=ENV=dev
flutter build web --dart-define=ENV=<envFileName>
// flutter build web --dart-define=ENV=dev

零安全

为了避免对已知存在的变量进行空安全检查，有一个 get() 方法会在变量未定义时抛出异常。你还可以为 .env 文件中未定义的变量指定默认回退值。

Future<void> main() async {
  await dotjsonenv.load(fileName: "local.json");

  String foo = dotjsonenv.get('key_value');

  // 或者使用回退。
  String bar = dotjsonenv.get('missing_key_value', fallback: 'default fallback value');

  // 这将返回 null。
  String? baz = dotenv.maybeGet('missing_key_value', fallback: null);
}

讨论

使用 问题跟踪器 报告错误和提出功能请求。

欢迎提交拉取请求。

前置工作

• java-james/flutter_dotenv (dart)

许可证

许可证: MIT

完整示例 Demo

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_dot_json_env/flutter_dot_json_env.dart';

Future<void> main() async {
  // await dotjsonenv.load(fileName: "assets/env/local.json"); // load as static json
  await dotjsonenv.load(fileName: Environment().envFileName);

  print(
      'app URL::: ${dotjsonenv.env['api_url'] ?? 'api url default fallback value'}');
  print('appURL::: ${Environment.apiUrl}');
  print('Foo::: ${Environment.foo}');
  print('Bar::: ${Environment.bar}');

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.teal),
        useMaterial3: true,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: const Text('DotJSONEnv Demo'),
          backgroundColor: Colors.teal,
        ),
        body: SingleChildScrollView(
          child: FutureBuilder<String>(
            future: rootBundle.loadString('assets/env/local.json'),
            initialData: '',
            builder: (context, snapshot) => Container(
              padding: const EdgeInsets.all(50),
              child: Center(
                child: Column(
                  children: [
                    Text(
                      'Env map: ${dotjsonenv.env.toString()}',
                    ),
                    Text(dotjsonenv.get('api_url',
                        fallback: 'api url default fallback value')),
                    Text(dotjsonenv.get('foo',
                        fallback: 'foo default fallback value')),
                    Text(dotjsonenv.get('bar',
                        fallback: 'bar default fallback value')),
                    const Text("Environment class values"),
                    Text('appURL::: ${Environment.apiUrl}'),
                    Text('Foo::: ${Environment.foo}'),
                    Text('Bar::: ${Environment.bar}'),
                  ],
                ),
              ),
            ),
          ),
        ),
      ),
    );
  }
}

class Environment {
  static const env = String.fromEnvironment('ENV');

  String get envFileName {
    switch (env) {
      case 'dev': // flutter run --dart-define=ENV=dev
        return 'assets/env/dev.json';
      case 'test': // flutter run --dart-define=ENV=test
        return 'assets/env/test.json';
      case 'prelive': // flutter run --dart-define=ENV=prelive
        return 'assets/env/prelive.json';
      case 'live': // flutter run --dart-define=ENV=live
        return 'assets/env/live.json';
      default: // flutter run
        return 'assets/env/local.json';
    }
  }

  static String get environmentName {
    return env.isNotEmpty ? env : "Environment name not found";
  }

  static String get apiUrl =>
      dotjsonenv.get('api_url', fallback: 'api url default fallback value');
  static String get foo =>
      dotjsonenv.env['foo'] ?? 'foo default fallback value';
  static String get bar =>
      dotjsonenv.env['bar'] ?? 'bar default fallback value';
}