后端【免费下载链接】sailsRealtime MVC Framework for Node.js项目地址https://gitcode.com/gh_mirrors/sa/sails点击查看免费下载导读lib/hooks/logger是 Sails 框架Realtime MVC Framework for Node.js中负责日志能力的核心 Hook它负责实例化基于captains-log的日志器、向全局暴露sails.logAPI并为应用启动时绘制那艘标志性的 ASCII 帆船横幅。本文以仓库内 logger Hook 说明文档 为主体结合 Hook 实现源码、ship 绘制源码 以及 官方 Logging 概念文档完整讲解该 Hook 的职责、依赖、隐式配置、初始化链路、日志级别体系与实战用法帮助读者理解 Sails 日志系统的底层运作方式。Hook 状态已标记为 DeprecatedStability: 0原文档开头明确标注了该 Hook 的稳定性等级Stability: 0 - Deprecated该 Hook 几乎可以肯定会被合并进核心见文末 FAQ。这意味着在文档写作时的项目规划中logger 作为独立 Hook 存在是一种“职责分离”的历史设计但其能力与核心配置流程高度重合未来很可能被并入app核心逻辑。这一规划在仓库源码中留有明确注记默认 Hook 注册表 中logger: true的注释写着logger: true, // FUTURE: absorb into core (i.e. like what we did w/ the controllers hook -- can live in lib/app/private/log-ship.js, and the rest can be inlined)也就是说未来计划将log.ship()抽到lib/app/private/log-ship.js其余逻辑直接内联进核心。尽管如此在当前版本中 logger 仍然是一个标准的、可配置的 Hook理解它的加载与初始化方式对排查日志问题仍有实际价值。Dependencies加载顺序依赖原文档明确列出了该 Hook 正常加载所需的前置 Hookmoduleloader模块加载器负责按约定加载用户代码模块userconfig用户配置负责在 Hook 初始化前合并应用的自定义配置也就是说logger 的initialize必须等到用户配置加载完成之后才执行——因为它的默认日志级别来自sails.config.log.level需要userconfig先就绪。这一约束在源码注释中得到印证lib/hooks/logger/index.js#L31-L34/** * Initialize is fired when the hook is loaded, * but after waiting for user config. */Dependents无下游依赖原文档同时指出如果禁用该 Hook没有任何其他核心 Hook 必须跟着禁用N/A。换言之logger 是一个“末端节点”式依赖——它依赖别人但不被别人依赖禁用它只会让sails.log与 ASCII 横幅消失不会引发级联的加载失败。PurposeHook 的三大职责原文档将该 Hook 的职责归纳为三件事下面逐一结合源码展开。职责一实例化 CaptainsLog 日志器logger Hook 的核心动作是创建一个captains-log日志实例。在 初始化源码 中初始化函数按以下顺序执行initialize: function(cb) { // Get basic log functions var log CaptainsLog(sails.config.log); // Mix in log.ship() method log.ship buildShipFn( sails.version ? (v sails.version) : , log.info ); // Expose log on sails object sails.log log; return cb(); }第 39 行将sails.config.log包含日志级别等配置整体传给CaptainsLog得到带有多级日志能力、支持彩色与前缀输出的日志对象。第 42-45 行调用buildShipFn生成log.ship()方法并把当前sails.version若无则传空字符串与log.info注入其中。第 48 行把日志器挂载到sails.log向整个应用暴露。第 50 行调用回调cb()通知框架初始化完成。captains-log是 Sails 内置的简单日志器其用法与 Node 的console.log高度相似但额外支持多日志级别与带颜色的前缀输出详见 Logging 概念文档。职责二暴露sails.log函数初始化完成后应用代码即可全局使用sails.log()注意 Sails 默认启用了全局变量若在 sails.config.globals 中关闭了全局暴露则需通过sails对象访问。sails.log既是函数也是对象可按级别调用sails.log.info(I am an info-level message.); sails.log(I am a debug-level message); sails.log.warn(I am a warn-level message);captains-log服务于两个目的一方面输出 Sails 框架内部产生的警告、错误与其他控制台信息另一方面允许应用代码通过sails.log发射自定义的日志消息作为console.log的可配置替代品详见 Custom log messages 概念文档。职责三添加sails.log.ship()方法Hook 为日志器额外注入了log.ship()方法用于在控制台绘制一艘 ASCII 帆船。其实现位于 ship.js要点如下该函数接收两个参数message通常是vX.Y.Z形式的版本号字符串与log默认回退到console.log。为了对齐第二行船桅的位置该行桅杆前共有 20 个字符其中包含一个起始的v代码通过19 - message.length计算出需要补的空格数将版本号左对齐到固定位置。返回的闭包执行时依次输出多行 ASCII 图形最终效果形如.-..-. Sails | .-..-. v2.0.0 |\ /|.\ / || \ , | \ .-.-|/_-- --------- __---___--___---___--___---___--___ ____---___--___---___--___---___--___-__log.ship()的实际调用时机在应用启动链路中见 lib/app/lift.js#L89sails.log.ship sails.log.ship();即在sails.lift()启动流程完成时若日志器存在ship方法则绘制帆船横幅这也是每次启动 Sails 应用时控制台出现帆船图案的直接原因。Implicit Defaults隐式默认配置该 Hook 会在sails.config上设置以下隐式默认配置原文档表格Property类型默认值sails.config.log.levelstringinfo源码层面这一默认值定义在 Hook 的 defaults 声明defaults: { log: { level: info } }这意味着即使应用没有提供任何日志配置Sails 也至少会以info级别输出日志。应用可在config/log.js新 Sails 项目默认生成中覆盖该配置例如// config/log.js module.exports.log { level: silly };日志级别优先级日志级别采用“等于或高于当前级别才会输出”的过滤规则输出会写入 stdout/stderr且该级别还会被归一化并应用到 Grunt、Socket.io、Waterline、Express 等依赖的日志输出上。各级别优先级如下表摘自 Logging 概念文档PriorityLevel可见输出的日志函数0silentN/A1error.error()2warn.warn(),.error()3debug.debug(),.warn(),.error()4info.info(),.debug(),.warn(),.error()5verbose.verbose(),.info(),.debug(),.warn(),.error()6silly.silly(),.verbose(),.info(),.debug(),.warn(),.error()使用要点原文档 Notes默认级别为info此时 Sails 只输出关于服务器/应用状态的有限信息。运行自动化测试时常将级别设为error以屏蔽无关输出。设为verbose时会输出 Grunt 的日志以及关于已加载路由、模型、Hook 等更详细的信息。设为silly时除 verbose 的全部内容外还会输出路由绑定等框架生命周期、诊断与实现细节。sails.log提供的具体方法在 Custom log messages 概念文档 中sails.log的各方法约定如下。所有方法都接受任意数量的、任意类型的参数用逗号分隔并像console.log一样通过 Node 的util.inspect()自动美化输出对象例如打印{ pet: { name: Hamlet } }而不是[object Object]若对象自带自定义inspect()方法日志器会自动调用它。sails.log.error()以error级别写入stderr适合追踪重大错误sails.log.error(Sending 500 (Server Error) response.); // - error: Sending 500 (Server Error) response.sails.log.warn()以warn级别写入stderr适合追踪静默失败的操作sails.log.warn(File upload quota exceeded for user #%d. Request aborted., user.id); // - warn: File upload quota exceeded for user #94271. Request aborted.sails.log()即sails.log.debug()默认日志函数以debug级别写入stderr适合在团队间传递重要技术信息或作为console.log()的通用替代sails.log(This endpoint (POST /accounts) will be deprecated in the next few days. Please use POST /signup instead.); // - debug: This endpoint (POST /accounts) will be deprecated in the next few days. Please use POST /signup instead.sails.log.info()以info级别写入stdout适合记录业务逻辑信息sails.log.info(A new user (, newUser.emailAddress, ) just signed up!); // - info: A new user ( irlfoobar.com ) just signed up!sails.log.verbose()以verbose级别写入stdout适合记录偶尔才需要的应用细节sails.log.verbose(A user (IP adddress: %s) initiated an account transfer..., req.ip); // - verbose: A user (IP adddress: 10.48.1.191) initiated an account transfer...sails.log.silly()以silly级别写入stdout适合记录仅供诊断/排障的技术细节sails.log.silly( Successfully fetched Account record for requesting authenticated user (%d)., Took %dms., req.param(id), msElapsed); // - silly: Successfully fetched Account record for authenticated user (49722). Took 41ms.Eventshook:logger:loaded原文档声明该 Hook 在被 Sails 核心自动加载、且其initialize函数中的回调被触发后会发出hook:logger:loaded事件。这一事件发射机制在 lib/app/private/loadHooks.js#L238 得到印证sails.emit(hook: id :loaded);其中id即 Hook 名logger因此拼接出的完整事件名正是hook:logger:loaded。应用或第三方 Hook 可通过sails.on(hook:logger:loaded, ...)监听该事件以便在日志系统就绪后执行依赖它的逻辑。FAQ为什么这是一个 Hook 而不是核心的一部分原文档 FAQ 对此的回答是初衷作为一种分离关注点separation of concerns的方式。现状实际上由于核心的配置流程已经完成了该 Hook 所做的几乎所有事情这个 Hook“不如干脆”合并进核心app之下。展望未来版本中很有可能实现这一合并。这一回答与前述 default-hooks.js 中的注释 完全一致——仓库作者已把“合并进核心”写进了代码注释作为 TODO。因此读者在阅读旧版本文档或代码时若看到 logger 仍是独立 Hook应理解为这是历史演进过程中的过渡状态而非最终形态。小结logger Hook 的完整运行链路将本文内容串联起来logger Hook 的完整运行链路为Sails 启动时读取 默认 Hook 注册表确认logger启用等待moduleloader、userconfig两个前置 Hook 加载完成应用defaults中的隐式配置log.level info可被config/log.js覆盖执行initialize创建CaptainsLog实例 → 注入log.ship()携带版本号与log.info→ 挂载到sails.log→ 回调完成发射hook:logger:loaded事件应用正式 lift 时调用sails.log.ship sails.log.ship()在控制台绘制 ASCII 帆船横幅。此后无论是框架内部还是应用代码都可以通过sails.log按级别输出带前缀、带颜色的日志并依据sails.config.log.level的优先级规则过滤可见输出。想进一步了解日志级别的配置参考可查阅 Logging 概念文档想深入了解各个方法的行为约定可参阅 Custom log messages 概念文档。赞分享后端【免费下载链接】sailsRealtime MVC Framework for Node.js项目地址https://gitcode.com/gh_mirrors/sa/sails点击查看免费下载相关推荐Sails 自定义日志消息sails.log 多级日志实战指南Sails 自定义日志消息sails.log 多级日志实战指南 Sails 框架内置了基于 captains log 的日志系统并通过 sails.log后端Sails 框架日志机制完全指南sails.log 用法、日志级别与自定义日志器配置Sails 框架日志机制完全指南sails.log 用法、日志级别与自定义日志器配置 Sails 作为一款面向 Node.js 的实时 MVC 框架内置了一后端Sails Policies 核心 Hook 深度解析授权中间件的加载、映射与绑定原理Sails Policies 核心 Hook 深度解析授权中间件的加载、映射与绑定原理 Policies策略是 Sails 实时 MVC 框架中用于 授权后端上一篇办公生产力配置下一篇react-use 的 useTween基于 requestAnimationFrame 的 0~1 数值补间动画 Hook 完全指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考