npm 包 @types/dotenv-safe 使用教程
在前端开发过程中，我们经常需要使用不同的环境变量来管理一些敏感信息，例如 API key、数据库密码等等，以此来保证代码的安全性。在这样的情况下，我们通常会使用 .env 配置文件来存储这些信息，并通过 dotenv 这个工具来将这些信息添加到环境变量中。不过，这个过程中我们还需要写一些额外的代码来判断环境变量是否设置，以及设置默认值等等。这时候，dotenv-safe 这个 npm 包就可以帮助我们轻松地实现这些需求。本文将详细介绍 dotenv-safe 的使用方法，并提供示例代码帮助大家更好地理解。
安装
在开始使用 dotenv-safe 前，我们需要首先通过 npm 将其安装到我们的项目中：
npm install --save @types/dotenv-safe
使用
安装完成后，我们就可以在项目中引入 dotenv-safe。
import dotenvSafe from 'dotenv-safe';
然后，我们需要写一个用来存储环境变量的 .env.example 示例文件，如下所示：
API_KEY=123456 DB_PASSWORD=abc123
在实际使用过程中，我们会将这个文件复制一份为 .env，并将其中的变量赋上真实的值，但是为了保护我们的敏感信息，这个 .env 文件不应该被存储在版本控制中。因此，我们可以在 .gitignore 中将其加入忽略列表中，从而避免泄露敏感信息。
接下来，我们还需要为我们的项目添加一些环境变量，例如：
export const PORT = process.env.PORT || 3000;
dotenvSafe.config({
allowEmptyValues: true,
example: './.env.example',
});在这个代码示例中，我们首先定义了一个 PORT 变量来存储我们的服务器端口。然后，我们使用 dotenvSafe.config 函数来加载我们的 .env.example 示例文件，同时添加了一些配置参数。其中，allowEmptyValues 的作用是允许环境变量的值为空，而 example 参数则指定了用来验证环境变量合法性的示例文件路径。在实际使用中，dotenvSafe.config 应该在程序的入口处被调用，以便我们的环境变量能够在整个项目中生效。
最后，我们还可以使用 process.env 来读取我们的环境变量，并为其设置默认值。例如，在获取数据库密码的环境变量时，我们可以这样写：
const dbPassword = process.env.DB_PASSWORD || 'default_password';
至此，我们就完成了 dotenv-safe 的基本使用教程。接下来，我们将通过一个具体的示例来更深入地了解它的使用方法。
示例代码
假设我们有一个后端服务，其代码如下所示：
-- -------------------- ---- ------- ------ ---------- ---- -------------- ------ ------- ---- ---------- ------------------- ----------------- ----- -------- ----------------- --- ----- --- - ---------- ----- ---- - ---------------- -- ----- ----- ---------- - ----------------------- -- ------------------- ---------------- -- -- - ------------------- -- --------- -- ---- ---------- --- ------------ ----- ---- -- - -------------- -------- -------- --- ---------------- ---
在这个示例中，我们使用 dotenv-safe 添加了一个配置项，然后用 express 创建了一个简单的 Web 服务器，监听指定的端口号。同时，我们还使用 process.env 读取了我们的环境变量，并设置了一个默认值。
另外，我们需要注意的是，我们的后端服务应该存储在一个名为 server.ts 的 TypeScript 文件中，并通过以下命令启动：
ts-node server.ts
最后，我们需要为它添加一些测试，以确保我们的 .env 文件中的环境变量可以被正常读取：
-- -------------------- ---- -------
------ ---------- ---- -------------
------ - ------ - ---- -------
---------------- ------ -- -- -
--- ------- ----
----------- -- -
------ - ----------------------------
---------------------- ------
---
---------- -- -
-------------------
---
---------- ------ -------- -------- ---- - ------- -- -- -
------ ------------------------------------------------ -- -
------------------------------- -------- -------- --- ---------
---
---
---在这个测试代码中，我们首先使用 superagent 发送了一个 GET 请求，并期望它返回一个包含 dbPassword 的字符串。如果代码运行正常，我们的测试就会通过。这个测试也向我们展示了如何在 TypeScript 项目中使用 dotenv-safe。
总结
dotenv-safe 提供了一种简单而安全地管理环境变量的方式，让我们的工作变得更加便捷。本文介绍了 dotenv-safe 的基本使用方法，并提供了示例代码帮助读者更好地理解其使用。希望这篇文章对前端的同学们有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/types-dotenv-safe