Flutter环境变量转换插件env2dart的使用

release Apache License 2.0 open issues code lines

简体中文

Env2dart 是一个简单的工具，可以从 .env 文件生成 Dart 代码。

快速开始

安装命令行工具：

dart pub global activate env2dart

env2dart

命令行接口（CLI）

-p, --path      指定工作目录，CLI 将在当前目录查找 `.env` 文件。
                (默认为空)
-o, --output    指定输出文件路径。
                (默认为 "lib/env.g.dart")
-a, --active    指定要使用的环境变量。例如，如果指定 `-active prod`，CLI 将查找 `.env.prod` 文件并将其与 `.env` 文件合并。
-c, --class     指定生成类的名称。
                (默认为 "Env")
-e, --encoder   使用编码器对值进行编码以避免原始字符串。允许 'base64' 和 'utf8'。
-h, --help      查看帮助选项。

示例

示例代码

import 'package:env2dart/env2dart.dart';

void main() => parseAndGen(['-o', './lib/env.g.dart']);

统计数据

许可证

Copyright 2023 iota9star

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

更多关于Flutter环境变量转换插件env2dart的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

eggper 1楼

更多关于Flutter环境变量转换插件env2dart的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

当然，以下是一个关于如何使用Flutter环境变量转换插件env2dart的示例代码案例。这个插件可以帮助你将.env文件中的环境变量转换为Dart代码，从而在Flutter应用中使用这些变量。

步骤 1: 添加依赖

首先，你需要在pubspec.yaml文件中添加env2dart依赖：

dependencies:
  flutter:
    sdk: flutter
  env2dart: ^x.y.z  # 请替换为最新版本号

然后运行flutter pub get来获取依赖。

步骤 2: 创建`.env`文件

在你的项目根目录下创建一个.env文件，并添加你的环境变量，例如：

API_URL=https://api.example.com
API_KEY=your_api_key_here

步骤 3: 生成Dart文件

使用env2dart命令行工具将.env文件转换为Dart文件。你可以在pubspec.yaml中添加一个脚本来简化这个过程：

scripts:
  generate_env: flutter pub run env2dart:convert --input=.env --output=lib/config/env_config.dart

然后运行以下命令生成Dart文件：

flutter pub run script:generate_env

或者，如果你没有使用脚本，可以直接运行：

flutter pub run env2dart:convert --input=.env --output=lib/config/env_config.dart

步骤 4: 使用生成的Dart文件

生成的lib/config/env_config.dart文件将包含类似以下内容的代码：

// This is an auto-generated file. Do not edit or check into version control!

class EnvConfig {
  static const String apiUrl = 'https://api.example.com';
  static const String apiKey = 'your_api_key_here';
}

现在，你可以在你的Flutter应用中使用这些环境变量：

import 'package:flutter/material.dart';
import 'config/env_config.dart';  // 导入生成的配置文件

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Env Example'),
        ),
        body: Center(
          child: Text('API URL: ${EnvConfig.apiUrl}\nAPI KEY: ${EnvConfig.apiKey}'),
        ),
      ),
    );
  }
}

总结

通过以上步骤，你可以使用env2dart插件将.env文件中的环境变量转换为Dart代码，并在Flutter应用中使用这些变量。这样不仅方便了环境变量的管理，还提高了代码的可读性和可维护性。

Flutter环境变量转换插件env2dart的使用