npm 包 config-yml 使用教程

在前端开发中，我们经常需要对应用程序的配置进行管理。对于 Node.js 项目，可以使用 dotenv 等工具来读取外部的 .env 配置文件，但对于其他语言及运行环境则需要另外的工具。而 config-yml 这个 npm 包可以帮助我们更方便地管理和读取 YAML 格式的配置文件。

什么是 YAML

YAML 的全称为 YAML Ain't Markup Language，是一种基于文本的数据格式，用于表达复杂的数据结构和配置信息。与 JSON 相比，YAML 更加便于人类阅读和编辑，也更加易于扩展。

下面是一个简单 YAML 配置文件的例子：

name: Mark
age: 24
contact:
  email: mark@example.com
  phone: +1-123-456-7890

我们可以轻松地通过这个配置文件获取 name、age 和 contact.email 等键对应的值。

安装 config-yml

在项目的根目录下执行下面的命令：

npm install config-yml

使用 config-yml

加载配置文件

首先，我们需要加载配置文件。在项目中创建 config 目录，并添加一个 config.yml 配置文件，如下所示：

server:
    port: 3000
    logs: true
database:
    host: localhost
    port: 5432

通过 config-yml 的 load 函数来加载配置文件：

const config = require("config-yml").load("config/config.yml");

访问配置项

获得配置项的值非常简单，只需要使用点号 . 来访问一个嵌套对象的属性即可：

const port = config.server.port; // 3000
const logsEnabled = config.server.logs; // true
const databaseHost = config.database.host; // localhost
const databasePort = config.database.port; // 5432

注意，如果在访问时没有找到对应的属性，那么返回值将为 undefined，而不是抛出异常。

添加默认配置

如果我们需要在配置文件中添加一些默认配置，以确保即使在没有提供配置文件时程序仍能正常运行，可以使用 default 方法：

-- -------------------- ---- -------
----- ------------- - -------------------------------
  ------- -
      ----- -----
      ----- -----
  --
  --------- -
      ----- ------------
      ----- ----
  -
---

这些默认配置将会被 load 方法读取的配置文件中的配置项覆盖。

支持环境变量

通常情况下，我们希望通过环境变量来控制一些配置项的值。可以使用 ${ENV_VAR} 的语法，把环境变量的值插入到配置文件中：

server:
    port: ${SERVER_PORT}
database:
    host: ${DATABASE_HOST}
    port: ${DATABASE_PORT}

在代码中使用 process.env 对象即可读取环境变量的值：

const serverPort = process.env.SERVER_PORT || config.server.port;
const dbConfig = {
  host: process.env.DATABASE_HOST || config.database.host,
  port: process.env.DATABASE_PORT || config.database.port
};

如果环境变量中没有指定对应的值，则会使用配置文件中的默认值。

总结

config-yml 是一个非常实用的 Node.js 模块，可以帮助开发者更加方便地管理和读取 YAML 格式的配置文件。通过加载、访问、添加默认配置和支持环境变量等功能，我们可以更加灵活地配置应用程序，从而提高我们的开发效率。

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