npm 包 protect-env 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要在代码中使用敏感的环境变量，如 API 密钥或数据库密码等。然而，这些敏感信息在代码库中暴露出来会带来潜在的安全风险，而且如果有多个开发者合作开发，那么环境变量的管理将变得更加困难。因此，使用 npm 包 protect-env 可以有效地保护敏感信息，让代码更安全可靠。

什么是 protect-env

protect-env 是一个 npm 包，它可以帮助我们在代码中使用敏感的环境变量时，保证它们不会暴露在代码库中。它通过对环境变量进行加密和解密处理，使得只有在正确的运行环境下，才能正确地获取到环境变量的值。

运行以下命令来在你的项目中安装 protect-env 包：

npm install protect-env --save-dev

在项目的根目录下创建一个名为 .env.enc 的文件，并将需要保护的环境变量加密写入该文件。

我们可以使用以下两种方式将环境变量的值加密后写入文件：

运行以下命令将 .env.example 中定义的环境变量加密并写入 .env.enc 文件：

npx protect-env .env.example .env.enc

在代码中（如 index.js）使用 encryptEnvVars 函数对需要保护的环境变量进行加密。

const protectEnv = require('protect-env');
protectEnv.encryptEnvVars({
  API_SECRET: process.env.API_SECRET,
}, './.env.enc');

将 .env.enc 文件添加到 .gitignore 文件中，以确保它不会被提交到代码库中。

在代码中使用 protect-env 的 loadEnv 方法，读取解密后的环境变量。loadEnv 方法会将 .env.enc 中的环境变量解密，并将其放入当前进程的环境变量中。

const protectEnv = require('protect-env');
protectEnv.loadEnv('./env.enc');

const apiSecret = process.env.API_SECRET;
console.log(apiSecret);

在项目启动时，运行 protect-env 的 loadEnv 方法，确保所有的环境变量已经被解密并写入进程的环境变量中。这样，就可以在代码中直接使用环境变量了。

以下是一个使用 protect-env 包的示例代码，演示了如何使用它来保护敏感信息，并在代码中使用解密后的环境变量。

$ npx protect-env .env.example .env.enc

const protectEnv = require('protect-env');

protectEnv.loadEnv('./.env.enc');

console.log(process.env.API_SECRET);

使用 protect-env 可以帮助我们在前端开发中更好地保护敏感环境变量，减少了代码泄露的风险，代码更加安全可靠。

在使用 protect-env 时，我们需要注意保护 .env.enc 文件，并且在项目启动时，调用 loadEnv 方法确保所有的环境变量已经被解密并写入进程的环境变量中，这样就可以在代码中直接使用环境变量了。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055f1c81e8991b448dcb2c