引入
今天由于项目需要,要将logging库二次封装成一个类,以实现一些自定义的功能。
我将二次封装了一个logService类,然后在其中同样也实现info, warn, error等日志函数。额外加了一个将日志存入数据库的功能。
大概是像下面这样子:
但是在封装的过程中,出现了一个问题:log中,不能正确显示打日志的地方的代码位置了。
表现如图所示:
我们希望打log的时候显示的代码位置是出错的地方的位置,但是这里显示的是logService类中的代码位置。这该怎么办呢?
解决过程
上网查了一下,排在前面的几条结果都是通过直接将logger返回给其他的类来实现的。但是我必须封装多一层以实现自定义的功能。因此,我尝试去logging库中寻找答案。
首先,我们可以看到,error()函数是这样子的:
它调用了self._log()函数,长这样:
我们可以注意到,参数列表之中有一个叫做stacklevel
的参数,且默认值为1.并且这个参数被传递到了一个叫做findCaller的函数里面。这一点值得我们注意,因为这就是解决问题的关键。
要追踪函数的调用位置,那必然与调用栈(callstack)有关,而这里的stacklevel,又传递到了一个“寻找调用者”的函数之中,这是值得我们警觉的。我们猜想:stacklevel也许就是往前追踪的调用栈的层数的意思?因为从打log函数的位置往前追1层,那就是打log的位置了。
带着疑惑,我们继续看findCaller函数,我们可以看到:
根据函数的文档字符串描述,这个函数的作用是“寻找调用者的栈帧,以便于我们定位文件名、代码行数、函数名”。从这一点来看,我们就能明白,这个函数就是逐级的找调用栈的栈帧,然后获取里边的信息。
这个时候,我们可以看到这行代码:
f = currentframe()
这行代码字面上写的是“获取当前栈帧”的意思,那么,什么叫做“当前栈帧”呢?我们继续往下看,看这个函数实现:
我们可以根据上面的代码得知,该函数的作用就是返回从当前位置栈帧往前追踪的第3个栈帧。从currentframe()函数算起,往前的第3个栈帧就是error()函数所在的栈帧。
看到这里,小伙伴们肯定很疑惑:为什么是error()函数而不是调用logging.error()的地方呢?原因是,函数只有被压栈了才会形成一个栈帧.举个小例子,函数A调用函数B,那么在调用的时候,A就会被压栈,因此栈中就有了A的栈帧。
可是,这也不是调用error()的地方所在的栈帧呀?别忘了,前面我们看到了那个stacklevel参数,默认为1。从error()函数往上再追踪1层不就是调用logging.error()的地方了吗?这就是stacklevel默认等于1的原因。
我们再回到findCaller()函数:
我们可以看到,在获取到logging.error()所在的栈帧之后,执行了一个f=f_back的操作。从命名上看,这个f_back很显然是指向更深一层栈帧的指针。结合stacklevel默认等于1的情况以及下面的while循环来看,验证了我们的猜想。
然后下方的while循环对于stacklevel>1的情况,不断的往更深层追踪栈帧。
看到这里,我们已经可以回答最初的问题了:如何解决log位置显示错误的问题?答案就是,我们只需要将stacklevel设置为2即可,这样就会再往上一层,追踪到调用logService.error()的地方,而不是调用logging.error()的位置。
我们只需要1行代码即可应用更改:
更改后,情况如下所示,调用logService.error()的位置被正确的显示了出来。
结语
其实本文所述的问题并不是特别的复杂,只是需要熟悉计算机的函数调用的原理:调用函数时,将当前函数的局部变量和返回地址压栈,函数return的时候,将ret_addr填写到指令指针寄存器之中。当你对这一基本原理熟悉之后,就能很顺理成章的解决本文所述的问题了~
转载请注明来源:https://longjin666.cn/?p=1484
欢迎关注我的公众号“灯珑”,让我们一起了解更多的事物~