Flutter插件pnv的使用方法

Flutte插件pnv的使用方法详解

pnv 是一个Dart包，旨在帮助开发者轻松加密和解密敏感信息，管理环境文件，并生成Dart Define参数。pnv的目标是简化在Dart或Flutter项目中处理环境敏感信息和配置的安全过程。

Flutter插件pnv的特性

• 加密与解密：使用对称密钥安全地加密和解密敏感信息。
• 密钥管理：为跨环境安全使用生成加密密钥。
• 环境文件生成：从.yaml配置文件生成.env文件。
• Dart Define转换：将.env文件轻松转换为Dart Define参数，以便在构建过程中使用。

Flutter插件pnv的安装

本地安装

要使用pnv，将其添加到你的Dart项目的开发依赖项中：

dart pub add pnv --dev # 自动添加最新不冲突的版本

你可以使用以下命令运行它：

dart run pnv <command> [arguments]

全局安装

要全局安装pnv，运行：

dart pub global activate pnv

使用

pnv提供了几个命令来管理敏感信息和环境配置：

pnv <command> [arguments]

全局选项

• -h, --help: 打印使用信息。

命令

• <command> init: 初始化pnv配置文件。
• <command> create key: 创建一个新的用于pnv的加密密钥。
• <command> create flavor: 创建一个与新加密密钥关联的新风味。
• <command> encrypt: 使用之前生成的密钥加密敏感信息。
• <command> decrypt: 使用正确的密钥解密敏感信息。
• <command> generate-env: 从.yaml文件生成.env文件。
• <command> to-dart-define: 将.env文件转换为Dart Define参数，以便在Dart构建过程中使用。

要获取有关特定命令的更多信息，运行：

pnv help <command>

快速开始

创建配置文件

要创建pnv配置文件，运行：

pnv init

此命令会提示你选择要存储加密密钥的目录，默认情况下它们将保存在~/.<project-name>。这些设置将在项目的根目录下（紧邻pubspec.yaml）保存一个.pnvrc文件。

创建风味

要创建新的风味，运行：

pnv create flavor --name <flavor_name>

这将会生成一个新的风味及其对应的加密密钥。加密密钥将保存在初始化过程中指定的目录中。

~
└── .<project-name>
    └── <flavor_name>.key

配置文件将更新以包含新的风味：

{
  "storage": "~/.<project-name>",
  "flavors": {
    "<flavor_name>": []
  }
}

风味名称将用作加密/解密敏感信息的引用。您可以创建多个风味以管理不同的敏感信息集。每个风味都有自己的加密密钥。

加密敏感信息

要加密敏感值，运行：

pnv encrypt "my_secret" --flavor <flavor_name>

这将输出加密后的敏感信息。确保安全地存储密钥。以下是加密后的敏感信息示例：

SECRET;DrQgp57CPCGY9b/0e2po3AYHIP/Svv+JbYc0+g60IKeewjwhmPW/9HtqaNw=

解密敏感信息

要解密敏感值，运行：

pnv decrypt "SECRET;<encoded_data>" --flavor <flavor_name>

如果密钥正确，解密后的敏感信息将被显示。如果密钥不正确，则会显示错误消息。

将环境变量转换为Dart Define

要将.env文件中的环境变量转换为Dart Define参数，运行：

pnv to-dart-define .env

这将生成可以在Dart或Flutter构建过程中使用的--dart-define参数。例如：

# .env
SECRET=my_secret

输出将是：

-DSECRET=my_secret

环境YAML文件

你可以通过组织你的加密敏感信息在一个YAML文件中来更好地结构化和可读性。pnv会通过组合所有嵌套键并用下划线分隔，然后转换为大写，生成环境变量。以下是你可以如何组织YAML文件的示例：

YAML文件

# env_files/app.local.yaml
secret: SECRET;<encoded_data>

api:
  schema: http
  host: localhost
  port: 8080
  key: SECRET;<encoded_data>

然后，你可以运行generate-env命令来创建.env文件：

pnv generate-env --directory env_files --output env_files/outputs

这将生成以下环境变量：

# env_files/outputs/local.env
SECRET=<decoded_data>
API_SCHEMA=http
API_HOST=localhost
API_PORT=8080
API_KEY=<decoded_data>

当调用generate-env命令时，pnv会将键组合起来生成扁平化的环境变量名称，使其兼容大多数CI/CD工具和其他环境管理系统。

多个环境

在典型的项目中，你可能有多个环境，如development、staging和production。你可以分别为每个环境创建一个YAML文件，并为每个环境生成.env文件。

.
└── env_files
    ├── app.development.yaml
    ├── app.staging.yaml
    └── app.production.yaml

这些文件可以具有相同的结构但具有不同的值。然后你可以为每个环境生成.env文件：

# 生成所有环境
pnv generate-env --directory env_files

# 生成开发环境
pnv generate-env --directory env_files --flavor development

# 生成预发布环境
pnv generate-env --directory env_files --flavor staging

# 生成生产环境
pnv generate-env --directory env_files --flavor production

如上所述，你可以配置.pnvrc文件以将不同扩展名与不同风味关联起来。

{
  "storage": "~/.pnv",
  "flavors": {
    "development": ["dev"],
    "staging": ["stg"],
    "production": ["prod", "ci"]
  }
}