conf

本节介绍项目中用于加载和读取配置文件的 conf 模块。该模块通常用于加载 JSON 格式的配置文件，并提供统一的访问接口，适用于管理项目中的各类配置项。

---

引入模块

const conf = require("conf")

const c = conf.load("./conf.json")

const confData = c.get("key")

1. 加载配置文件 - conf.load(filePath) 用于加载指定路径的 JSON 配置文件。

filePath: string 配置文件的相对或绝对路径。 返回值: Conf 返回一个配置对象实例。

2. 获取配置项 - conf.get(key) 用于获取已加载配置中指定键名的值。

key: string 要获取的配置项键名。 返回值: any | undefined 返回对应的值，若不存在则返回 undefined。

完整使用示例

假设 ./conf.json 内容如下：

{
  "key": "value",
  "database": {
    "host": "localhost",
    "port": 3306
  }
}

代码中使用方式：

const conf = require("conf");

const config = conf.load("./conf.json");

const key = config.get("key"); // 获取简单字段
const dbConfig = config.get("database"); // 获取嵌套对象

注意事项

确保配置文件路径正确，否则会抛出异常或返回 undefined。 建议将敏感信息（如数据库密码）从配置文件中移除，改用环境变量注入。 多个模块共用配置时，建议封装为单例模式以提高性能与一致性。