Flutter环境变量加密插件encrypt_env的使用

Flutter环境变量加密插件encrypt_env的使用

encrypt_env 是一个用于Dart语言的包，旨在为Flutter应用程序增强敏感环境变量的安全性。它提供了一个方便的解决方案来保护存储在环境配置文件中的敏感信息，如API密钥、密码和令牌。

安装

要安装该包，请使用以下命令：

dart pub global activate encrypt_env

使用

步骤1：配置环境文件夹

导航到你的Flutter项目的根目录，并创建一个名为 environment 的文件夹。在这个文件夹内，创建一个名为 environment.yaml 的文件。此文件将包含你的敏感环境变量。

步骤2：添加敏感环境变量

在 environment.yaml 文件中添加你的敏感环境变量。例如：

environment:
  base_url: "http://localhost:3000"
  version: "1.0.0"
  production: false
  headers:
    api-key: ""
endpoints:
  endpoint_a: ""
  endpoint_b: ""

步骤3：加密环境变量

在终端中运行以下命令以加密环境变量：

encrypt_env gen

注意：确保不要将 environment.yaml 文件添加到 pubspec.yaml 文件的 assets 部分，以防止其被包含在应用程序的最终构建中。

合并

你可以通过提供环境参数（使用 --environment 选项）来合并 YAML 文件。例如，如果你传递 "prod" 作为环境参数，工具将会合并 environment.yaml 文件与 prod_environment.yaml 文件（如果存在），生成一个单一的配置。

# prod_environment.yaml

environment:
  production: true
  base_url: "https://api.example.com"
  api_key: "your_production_api_key_here"
  database_url: "your_production_database_url_here"

然后运行以下命令：

encrypt_env gen --environment prod

更多信息

通过提供可选参数来自定义加密过程：

  • -e --environment: 指定环境名称。
  • -y --yaml: 指定 YAML 文件名，默认为 environment。
  • --folder: 指定文件夹名称，默认为 environment。
  • --file-path: 指定加密文件路径，默认为 lib。
  • --file: 指定加密文件名，默认为 environment。
  • --format: 指定获取器名称格式，默认为 ssc。

注意：使用以下命令获取更多信息：

encrypt_env -h

完整示例

以下是一个完整的示例，演示如何使用 encrypt_env 插件加密和合并环境变量。

1. 创建项目结构

首先，在Flutter项目的根目录下创建 environment 文件夹，并在其中创建 environment.yaml 文件。

mkdir environment
touch environment/environment.yaml

2. 添加环境变量

编辑 environment.yaml 文件，添加以下内容：

environment:
  base_url: "http://localhost:3000"
  version: "1.0.0"
  production: false
  headers:
    api-key: ""
endpoints:
  endpoint_a: ""
  endpoint_b: ""

3. 运行加密命令

在终端中运行以下命令来加密环境变量：

encrypt_env gen

4. 合并生产环境配置

创建一个名为 prod_environment.yaml 的文件，并添加生产环境的配置：

# prod_environment.yaml

environment:
  production: true
  base_url: "https://api.example.com"
  api_key: "your_production_api_key_here"
  database_url: "your_production_database_url_here"

然后运行以下命令来合并生产环境配置：

encrypt_env gen --environment prod

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

1 回复

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


在Flutter中，encrypt_env 是一个用于加密环境变量的插件。它可以帮助你在应用程序中安全地存储和访问敏感的环境变量，如API密钥、数据库凭据等。以下是如何使用 encrypt_env 插件的步骤：

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  encrypt_env: ^1.0.0  # 请检查最新版本

然后运行 flutter pub get 来安装依赖。

2. 创建 .env 文件

在你的项目根目录下创建一个 .env 文件，并在其中定义你的环境变量。例如：

API_KEY=your_api_key_here
DATABASE_URL=your_database_url_here

3. 加密 .env 文件

使用 encrypt_env 插件提供的命令行工具来加密 .env 文件。首先，确保你已经安装了 encrypt_env 插件，然后在终端中运行以下命令：

flutter pub run encrypt_env:encrypt

这将生成一个加密后的 .env.enc 文件。

4. 在代码中加载和使用加密的环境变量

在你的 Flutter 应用中，你可以使用 encrypt_env 插件来加载和解密环境变量。首先，导入 encrypt_env 插件：

import 'package:encrypt_env/encrypt_env.dart';

然后，使用 Env.load 方法加载加密的环境变量：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 加载加密的环境变量
  await Env.load();
  
  runApp(MyApp());
}

现在，你可以在应用中使用 Env.get 方法来获取环境变量：

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final apiKey = Env.get('API_KEY');
    final databaseUrl = Env.get('DATABASE_URL');
    
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('API Key: $apiKey'),
              Text('Database URL: $databaseUrl'),
            ],
          ),
        ),
      ),
    );
  }
}

5. 生成加密密钥（可选）

默认情况下，encrypt_env 插件会生成一个加密密钥并将其存储在 lib/env_key.dart 文件中。你可以手动生成一个新的密钥并将其保存在该文件中。例如：

const String envKey = 'your_encryption_key_here';

确保不要将 lib/env_key.dart 文件提交到版本控制系统中，以防止密钥泄露。

6. 配置 .gitignore（可选）

为了确保 .env 和 lib/env_key.dart 文件不会被提交到版本控制系统中，你可以在 .gitignore 文件中添加以下内容：

.env
lib/env_key.dart
回到顶部