Node.js主应用如何与依赖库模块共享config文件夹配置信息？

最佳实现是将你的日志库改造为显式初始化的工厂模式，不要在依赖库内部直接创建logger单例，而是对外暴露初始化方法接收上层传入的配置，具体改造如下：

1. 改造@myCompany/logging库代码

• myWinston.js改为导出工厂函数，接收配置参数：

const { createLogger } = require('winston');
module.exports = (logConfig) => {
  return createLogger({
    level: logConfig.level,
    prettyPrint: true
  });
};

• myLogger.js存储初始化后的logger实例，对外暴露初始化方法和日志方法：

let loggerInstance = null;

// 显式初始化方法，由主应用调用传入配置
const initLogger = (logConfig) => {
  loggerInstance = require('./myWinston')(logConfig);
};

const warning = (myWarningMsg) => {
  if (!loggerInstance) throw new Error('请先调用initLogger方法初始化日志组件');
  loggerInstance.warn(myWarningMsg);
};

module.exports = { initLogger, warning };

2. 主应用调用逻辑

// 主应用读取自身配置
const appConfig = require('./config');
const { initLogger, warning } = require('@myCompany/logging');

// 应用启动阶段先初始化日志
initLogger(appConfig.get('logging'));

// 后续业务逻辑直接调用日志方法
warning('my warning msg here');

该方案的优势：

• 完全解耦：日志库不依赖主应用的配置实现方案，不管主应用用config包、环境变量、远程配置中心都可以正常接入
• 灵活性高：支持创建多个不同配置的logger实例，满足不同模块的差异化日志需求
• 接入透明：显性的初始化要求会直接提示开发者需要传入配置，不会出现隐式依赖导致的未知报错

该方案不合理，不建议使用，核心问题如下：

• 强耦合限制：强制要求所有使用该日志库的主应用必须使用config npm包，且必须在根目录下的config文件夹中定义logging.level字段，只要主应用的配置方案不符合要求，日志库直接无法运行
• 加载逻辑不可靠：config包默认读取进程运行目录下的config文件夹，如果应用启动时的工作目录不是项目根目录，或者依赖树中存在多个版本的config包，会出现配置读取错误的问题，排查成本极高
• 隐式依赖问题：其他开发者接入该日志库时，无法从调用逻辑上看到需要提前配置config文件夹的要求，很容易踩坑
• 逻辑不一致：日志库本地测试用的是自带的config，发布后用主应用的config，两套逻辑容易出现测试覆盖不到的生产问题

内容的提问来源于stack exchange，提问作者user3552178