后端【免费下载链接】log4js-nodeA port of log4js to node.js项目地址https://gitcode.com/gh_mirrors/lo/log4js-node点击查看免费下载导读Categories分类是 log4js-node 将日志事件分组路由到不同 appender 的核心机制。本文以官方文档 docs/categories.md 为主线结合 lib/categories.js 等源码实现与测试用例系统讲解分类的定义方式、最小配置、基于点号的层级继承、inherit开关以及配置校验规则帮助你在多模块 Node.js 应用中按业务域精细控制日志的输出目标与级别。什么是 CategoriesCategories 是日志事件log event的分组。每个日志事件的分类在通过log4js.getLogger(somecategory)获取Logger时就已确定同一category的日志事件会被路由到相同的appenders。const logger log4js.getLogger(myapp); logger.info(这是一条属于 myapp 分类的日志);分类名以字符串形式存在可以是任意自定义名称如app、db、myapp.submodule获取 Logger 时若不传参数则默认使用default分类分类与 appender 的映射关系完全由log4js.configure()中的categories配置块决定。从源码结构看这个映射关系在配置阶段被解析并写入一个Map见 lib/categories.js运行时log4js主模块正是通过categories.appendersForCategory(logEvent.categoryName)来查找该分类对应的 appender 列表并逐个分发见 lib/log4js.js。默认配置至少定义一个分类通过配置定义 appender 时categories块中至少必须定义一个分类且通常必须包含名为default的分类default是唯一被强制要求的分类详见下文配置校验一节。const log4js require(log4js); log4js.configure({ appenders: { out: { type: stdout }, app: { type: file, filename: application.log }, }, categories: { default: { appenders: [out], level: trace }, app: { appenders: [app], level: trace }, }, }); const logger log4js.getLogger(); logger.trace(This will use the default category and go to stdout); const logToFile log4js.getLogger(app); logToFile.trace(This will go to a file);要点说明配置项说明appenders数组该分类使用的 appender 名称列表名称必须在顶层appenders块中已定义且数组不能为空level字符串不区分大小写该分类允许输出的最低日志级别如trace、debug、info、warn、error、fatal等上述示例中logger log4js.getLogger()未传分类名归入default分类输出到stdoutlogToFile log4js.getLogger(app)归入app分类输出到application.log文件。与最小化用法的关系如果你不调用log4js.configure()直接使用log4js.getLogger()则 log4js 会自动使用内置默认配置一个stdoutappender 一个 level 为OFF的default分类见 lib/log4js.js。OFF意味着默认情况下任何日志都不会输出这保证了库被嵌入时不会产生噪音——只有显式设置级别或调用configure后日志才会真正出现。Categories 继承层级体系log4js 支持分类的层级继承用点号.分隔层级。例如分类myapp.submodule的日志事件在myapp.submodule自身未定义 level 时会使用myapp的 level同时也会使用myapp定义的任何 appender。该行为可通过在子分类上设置inherit: false来禁用。const log4js require(log4js); log4js.configure({ appenders: { console: { type: console }, app: { type: file, filename: application.log }, }, categories: { default: { appenders: [console], level: trace }, catA: { appenders: [console], level: error }, catA.catB: { appenders: [app], level: trace }, }, }); const loggerA log4js.getLogger(catA); loggerA.error(This will be written to console with log level ERROR); loggerA.trace(This will not be written); const loggerAB log4js.getLogger(catA.catB); loggerAB.error( This will be written with log level ERROR to console and to a file ); loggerAB.trace( This will be written with log level TRACE to console and to a file );上述配置定义了两个分类路由结果如下分类catA的日志事件只进入 appenderconsole分类catA.catB的日志事件会同时进入 appenderconsole和app继承自catA的console再加上自身定义的app。注意其中的级别差异catA的 level 为error因此loggerA.error(...)会输出而loggerA.trace(...)会被过滤掉catA.catB的 level 为trace因此loggerAB.error(...)与loggerAB.trace(...)都能输出。继承的具体语义结合 lib/categories.js 中的inheritFromParent实现继承规则可以精确归纳为level 继承子分类未显式设置level时向上取最近祖先的 levelappender 合并子分类拥有父分类的所有 appender再加上自己定义的 appender且自动去重同一 appender 不会重复出现见parentCategory.appenders.forEach中的includes判断递归生效继承是递归的父分类本身也会先完成它从祖父分类的继承然后再传递给子分类inherit: false阻断一旦某个分类设置了inherit: false它既不会从父分类继承同时其子分类的继承链也会在此中断子分类最多只能继承到该分类为止隐式创建中间父级如果定义了catA.catB.catC但中间层catA.catB未在配置中显式声明log4js 会隐式创建该父级并让它继承自catA从而保证深层子分类仍能正确继承测试用例见 test/tap/configuration-inheritance-test.js。过滤规则appender 只有在事件的级别event level大于等于分类级别category level时才会看到并记录该事件。即分类的 level 是一个最低门槛——低于门槛的日志事件在到达 appender 之前就被丢弃。运行时查找未定义分类如何回退除了配置阶段显式定义的分类log4js 在运行时还提供了回退查找逻辑configForCategory见 lib/categories.js若请求的分类已在配置中定义直接使用其配置若分类名包含点号且未被定义则从其父分类克隆配置父分类又可能继续向上回退否则无点号、未定义回退到default分类的配置并克隆。这意味着你可以在不预先声明的情况下使用log4js.getLogger(any.new.name)它会自动继承default分类的 level 与 appender。测试 test/tap/subcategories-test.js 就验证了这种未定义即继承的行为例如未定义的sub0最终得到default的TRACE级别。配置校验log4js 强制哪些规则log4js 在加载配置时会进行严格校验见 lib/categories.js任何一项不满足都会直接抛出异常配置必须包含categories属性且类型为对象categories中至少定义一个分类必须定义default分类must define a default category每个分类必须是包含appenders与level两个属性的对象appenders必须是字符串数组且至少包含一个appender 名称引用的 appender 名称必须在顶层appenders块中已定义level必须是 log4js 认识的级别字符串不区分大小写否则会提示当前可用的级别列表可选属性enableCallStack若存在则必须是布尔值。这些校验通过 lib/configuration.js 的throwExceptionIf统一抛出错误信息会包含出错时的配置片段便于定位问题。其他可选配置项分类定义中还有一个可选属性enableCallStack默认false设为true后该分类的日志事件会携带调用栈信息文件名、行号等配合 pattern layout 的相关 token 输出详见 docs/api.md 与 types/log4js.d.ts。如果你在日志参数中传入了Error对象则该 Error 的栈会被优先用于生成行列信息。此外顶层配置块中的levels属性允许自定义级别或重定义现有级别见 lib/levels.js 与 lib/levels.js。自定义级别后分类的level校验会同步接受新级别。内置级别的数值顺序为ALL TRACE DEBUG INFO WARN ERROR FATAL MARK OFF级别字符串匹配不区分大小写getLevel内部统一转大写。分类级别的运行时调整Logger.level通过配置设置的分类 level 并不是一成不变的。每个Logger实例暴露了level属性见 lib/logger.jslogger.level debug; // 允许运行时覆盖该分类的 levelLogger.level的读写都代理到 lib/categories.js 的getLevelForCategory/setLevelForCategory因为 level 是按分类存储而非按 Logger 实例存储改变该分类 level 会影响到所有同分类的 Logger 实例判定某条日志是否输出走的是isLevelEnabled(otherLevel)→this.level.isLessThanOrEqualTo(otherLevel)见 lib/logger.js即分类级别小于等于事件级别时才会派发。完整实战示例按模块分层配置综合以上特性一个典型的多模块应用可以这样组织分类const log4js require(log4js); log4js.configure({ appenders: { console: { type: console }, app: { type: file, filename: application.log }, errors: { type: file, filename: errors.log }, }, categories: { // default 分类兜底所有未特别声明分类的日志都走这里 default: { appenders: [console], level: info }, // 业务模块控制台 全量文件且允许更细的 trace 级别 api: { appenders: [console, app], level: trace }, // 子模块继承 api 的 appender仅覆盖 level api.database: { level: debug }, // 独立子系统只写文件不继承任何父级配置 api.legacy: { appenders: [app], level: warn, inherit: false }, // 错误集中归档单独一个分类 fatal: { appenders: [errors], level: fatal }, }, }); const apiLogger log4js.getLogger(api); const dbLogger log4js.getLogger(api.database); // 继承 api 的 console app const legacyLogger log4js.getLogger(api.legacy); // 仅 app不继承 console该示例中api.database未声明appenders因此自动获得api的console与applevel 覆盖为debugapi.legacy设置了inherit: false因此不会继承api的console只使用自己声明的appdefault分类保证任何遗漏的分类如log4js.getLogger(anything-else)仍有明确的输出去向。相关资源分类机制官方文档docs/categories.md分类核心实现继承、校验、运行时查找lib/categories.jsLogger 与分类的联动level 代理、级别判定lib/logger.js配置入口与默认配置lib/log4js.js级别体系与自定义级别lib/levels.js继承行为测试test/tap/configuration-inheritance-test.js子分类回退测试test/tap/subcategories-test.js配置格式的类型定义types/log4js.d.ts赞分享后端【免费下载链接】log4js-nodeA port of log4js to node.js项目地址https://gitcode.com/gh_mirrors/lo/log4js-node点击查看免费下载相关推荐TypeGraphQL 继承机制完全指南类型继承与 Resolver 类继承的实战应用TypeGraphQL 继承机制完全指南类型继承与 Resolver 类继承的实战应用 导读 本文基于 TypeGraphQL 官方文档 website/v后端GraphQLAPI设计TypeGraphQL 继承机制实战类型继承与 Resolver 类继承的完整指南TypeGraphQL 继承机制实战类型继承与 Resolver 类继承的完整指南 本指南系统讲解 TypeGraphQL 中基于 TypeScript 类继后端GraphQLAPI设计TypeGraphQL 继承机制全解析类型继承与 Resolver 类继承的实战指南TypeGraphQL 继承机制全解析类型继承与 Resolver 类继承的实战指南 导读 本文基于 TypeGraphQL v0.17.0 官方文档《Inh后端GraphQLAPI设计上一篇腾讯开源全球最大文生图模型HunyuanImage-3.0重构多模态技术格局下一篇如何在团队中推广Magic CLI建立高效的命令行协作文化创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考