Nodejs中获取当前函数被调用的行数及文件名详解

更新时间：2018年12月12日 11:44:19 作者：苏格团队

这篇文章主要给大家介绍了关于Nodejs中获取当前函数被调用的行数及文件名的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

背景

在自定义Egg.js的请求级别日志这篇文章中，我们实现了自定义请求级别的日志模块。看上去功能是完整了，但好像还缺点什么。

大家在根据日志追查问题的过程中，很多时候看到了某条log信息想去找出处，但是实际上代码里面打相同类型的log地方可能不止一处，这时你就比较难去定位这行log到底是哪里打的。

举个最极端的例子

//home.js
class AppController extends app.Controller {
 async first() {
 this.ctx.swLog.info('in controller');
 await this.ctx.render('first.html');
 }
 
 async second(){
 this.ctx.swLog.info('in controller')
 await this.ctx.render('second.html');
 }
}

上面的例子虽然比较极端，但是我们在代码中难免会碰到类似的情况。两个route对于的controller中都打印了相同的log，你在查日志的时候，是无法区分log到底是first里面打的还是second里面打的。
这个时候，我们就需要在日志打印的时候，同时也将调用日志时的文件名和代码行数记录下来一并打印，效果如下

[2018-11-02 19:25:09.665][22896][home.js:4][/] in controller

开始动手

查了很久的Nodejs文档，发现Nodejs的api中并没有直接提供我们想到的信息，所以只能另找出路。
回忆我们以往的开发，这类的信息好像只有在Nodejs抛出异常的时候看到过。每当Nodejs抛出异常时，我们都能看到一堆异常调用的堆栈，里面就有我们想要的信息，我们从这开始入手。
我们先手动创造一个异常对象，并打印出来

function getException() {
 try {
 throw Error('');
 } catch (err) {
 return err;
 }
}
 
let err = getException();
console.log(err);

console的信息如下图：

在图上我们可以看到，我们想要的信息

err对象在console的时候，会直接输出err对象中的stack属性，该属性是个字符串，我们可以通过一系列的字符串操作，拿到我们想要的文件名和行数。

接下来我们开始对日志模块代码进行改造，新增一个getCallerFileNameAndLine方法，如下：

getCallerFileNameAndLine(){
 function getException() {
  try {
  throw Error('');
  } catch (err) {
  return err;
  }
 }
 
 const err = getException();

 const stack = err.stack;
 const stackArr = stack.split('\n');
 let callerLogIndex = 0;
 for (let i = 0; i < stackArr.length; i++) {
 if (stackArr[i].indexOf('Map.Logger') > 0 && i + 1 < stackArr.length) {
  callerLogIndex = i + 1;
  break;
 }
 }

 if (callerLogIndex !== 0) {
 const callerStackLine = stackArr[callerLogIndex];
 return `[${callerStackLine.substring(callerStackLine.lastIndexOf(path.sep) + 1, callerStackLine.lastIndexOf(':'))}]`;
 } else {
 return '[-]';
 }
}

最终结果

最后我们每条打印的日志后面，都会跟上文件名和行数

有的同学可能担心，每次打log都抛一个异常，会不会对性能造成影响。
我在getCallerFileNameAndLine方法前后进行打点统计，平均执行时间在2ms左右，所以是可以忽略不计的。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

node如何实现简单的脚手架浅析
在工作中,需要开发一个脚手架,用于给相关用户提供相关的开发便利性,下面这篇文章主要给大家介绍了关于node如何实现简单的脚手架的相关资料,需要的朋友可以参考下
2022-05-05
浅谈JS前端模块化的几种规范
这篇文章主要介绍了JS前端模块化的几种规范，对前端模块化感兴趣的同学，可以参考下
2021-05-05
Node.js中使用mongoose操作mongodb数据库的方法
如何利用mongoose将数据写入mongodb数据库呢？操作方法很简单，下面小编给大家分享Node.js中使用mongoose操作mongodb数据库的方法，感兴趣的朋友一起看看吧
2017-09-09
node.js 使用 net 模块模拟 websocket 握手进行数据传递操作示例
这篇文章主要介绍了node.js 使用 net 模块模拟 websocket 握手进行数据传递操作,结合实例形式分析了node.js基于net模块模拟 websocket握手相关原理及进行数据传递具体操作技巧,需要的朋友可以参考下
2020-02-02
Express 框架中使用 EJS 模板引擎并结合 silly-datetime
这篇文章主要介绍了Express 框架中使用 EJS 模板引擎并结合 silly-datetime 库进行日期格式化的实现方法,结合具体实例形式分析了express框架引入EJS模版以及导入 silly-datetime 库的格式化方法传递给EJS模版使用的相关操作技巧,需要的朋友可以参考下
2023-05-05
浅谈nodejs中创建cluster
集群是一组相互独立的、通过高速网络互联的计算机，它们构成了一个组，并以单一系统的模式加以管理。一个客户与集群相互作用时，集群像是一个独立的服务器。集群配置是用于提高可用性和可缩放性。本文将详细介绍如何在nodejs中创建cluster。
2021-06-06
json对象及数组键值的深度大小写转换问题详解
这篇文章主要给大家介绍了关于json对象及数组键值的深度大小写转换问题的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
2018-03-03
node.js express cors解决跨域的示例代码
在Web开发中,当一个网页的源与另一个网页的源不同时,就发生了跨域,本文就来介绍一下node.js express cors解决跨域的示例代码,具有一定的参考价值,感兴趣的可以了解一下
2023-12-12
如何在node的express中使用socket.io
这篇文章主要介绍了如何在node的express中使用socket.io,需要的朋友可以参考下
2014-12-12
express搭建的nodejs项目使用webpack进行压缩打包
对于打包这个问题它并不是难点,但是对于我们这种初学者来说,根本就不知道应该怎么做,下面这篇文章主要给大家介绍了关于express搭建的nodejs项目使用webpack进行压缩打包的相关资料,需要的朋友可以参考下
2022-12-12