Appearance
conf — 配置管理
conf 模块用于加载和读取 JSON 格式的配置文件。
引入方式
javascript
var conf = require("conf")API 列表
Load — 加载配置文件
javascript
var config = conf.load("./conf.json")| 参数 | 类型 | 说明 |
|---|---|---|
| filePath | string | 配置文件路径(相对或绝对) |
| 返回值 | Conf | 配置对象实例 |
Get — 获取配置项
javascript
var value = config.get("key")
var dbConfig = config.get("database.host")| 参数 | 类型 | 说明 |
|---|---|---|
| key | string | 配置项键名,支持点号分隔的嵌套路径 |
| 返回值 | any | 配置值,不存在则返回 undefined |
完整示例
假设 ./conf.json 内容如下:
json
{
"app": {
"name": "SSS-RUN",
"version": "1.0.0"
},
"database": {
"host": "localhost",
"port": 3306
},
"features": ["api", "ws"]
}脚本中使用:
javascript
var conf = require("conf")
var config = conf.load("./conf.json")
var appName = config.get("app.name") // "SSS-RUN"
var dbHost = config.get("database.host") // "localhost"
var dbPort = config.get("database.port") // 3306
var features = config.get("features") // ["api", "ws"]
var notExist = config.get("not.exist") // undefined注意事项
- 确保配置文件路径正确,否则会抛出异常
- 敏感信息(如数据库密码)建议通过环境变量注入,不要写在配置文件中
- 多个模块共用配置时,建议加载一次后传递使用