日志记录当前类和当前方法

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
云数据库 Redis 版,标准版 2GB
推荐场景:
搭建游戏排行榜
云原生内存数据库 Tair,内存型 2GB
简介: 公司原有日志记录需手动输入类名与方法名,繁琐且易错。目标是开发工具类简化此过程。调研发现`Thread.currentThread().getStackTrace()`可获取调用栈信息,0号索引为该方法自身。在被调用的方法内,可通过访问1号索引获取所在类及方法名。为此,创建`CurClassAndMethodUtil`工具类,其`getCurClazzAndMethod`方法返回调用者的类名与方法名,解决手动输入问题。实际应用中,因多一层工具方法调用,需访问2号索引。最终实现自动化获取记录信息,提高效率。

背景 & 问题

公司日志记录方式:每次记录日志的时候都会记录这个日志是在哪个类,哪个方法中记录的。 这个行为很好理解,看日志的时候能够更加快速定位到日志打印的位置。 可是他们得到纪录类和记录方法是直接在代码中写死类名和方法名的,这就造成了每个打印日志地方都要手动去写这个类名和方法名,实在是太繁琐了,然后我就想解决一下。

当前记录方式:

调研分析

我的初衷就是为了简化打印当前类和当前方法的方式,想去写一个工具类,里面写一个工具方法,功能就是:帮忙打印调用这个工具方法的类和具体方法名。这样的话在每次日志记录就不需要那么麻烦自己手写类名和方法名了。

自己分析可行性:一个线程进来执行嵌套方法,没有完成的方法是需要入栈的,这个栈是线程私有的,所以java中是不是提供了对这个栈进行查看的api?

带着这个问题,我去网上调研了一下,发现jdk的确是有提供入栈方法对外查询的方式的。

java

代码解读

复制代码

Thread.currentThread().getStackTrace()

这个返回是个数组格式,越往前调用的方法在越前面,0号位置固定是getStackTrace(),因为它本身也是一个方法,所以在0号位置,也就是最前面的位置

举个例子:在A类的a方法中调用B类的b方法,在b方法中调用C类的c方法,在C方法中调用Thread.currentThread().getStackTrace() ,所以此时栈中信息如下图所示:

所以此时在c方法中取1号位置元素就能得到c方法所处类和所处方法,代码如下:

java

代码解读

复制代码

public void c() {
    // 获取当前线程的StackTraceElement数组
    StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
    String className = stackTrace[1].getClassName();
    String methodName = stackTrace[1].getMethodName();
    System.out.println(className + " => " + methodName);
}

具体解决

根据上面那个调研,我们已经知道解决办法了,但是我不想在每个地方都写getStackTrace,我想封装一个工具类,里面写一个工具方法,在需要调用的时候,我直接调用就好了,所以此时就在C.cThread.getStackTrace之间多了一层工具方法调用,此时栈中信息如下所示:

所以此时我们应该固定调用的是2号位置元素,工具类具体代码如下:

java

代码解读

复制代码

public class CurClassAndMethodUtil {

    public static void getCurClazzAndMethod() {
        // 获取当前线程的StackTraceElement数组
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        // 由于这里提取了一个工具类出来,所以直接取第三个位置的。第一个位置是getStackTrace本身
        String className = stackTrace[2].getClassName();
        String methodName = stackTrace[2].getMethodName();
        System.out.println(className + " => " + methodName);
    }

}

完美解决!!!

总结

  • 了解了线程私有的方法调用链路:getStackTrace。
  • 对getStackTrace进行了详细了解,解决了我们打印当前类和方法的问题。


转载来源:https://juejin.cn/post/7353543714152382503

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
4月前
|
Linux 应用服务中间件 nginx
【PUSDN】centos查看日志文件内容,包含某个关键字的前后5行日志内容,centos查看日志的几种方法
【PUSDN】centos查看日志文件内容,包含某个关键字的前后5行日志内容,centos查看日志的几种方法
110 0
|
14天前
|
Kubernetes Ubuntu Windows
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
|
4月前
|
C++ 开发者 Python
实现Python日志点击跳转到代码位置的方法
本文介绍了如何在Python日志中实现点击跳转到代码位置的功能,以提升调试效率。通过结合`logging`模块的`findCaller()`方法记录代码位置信息,并使用支持点击跳转的日志查看工具(如VS Code、PyCharm),开发者可以从日志直接点击链接定位到出错代码,加快问题排查。
68 2
|
4月前
|
存储 数据采集 Kubernetes
一文详解K8s环境下Job类日志采集方案
本文介绍了K8s中Job和Cronjob控制器用于非常驻容器编排的场景,以及Job容器的特点:增删频率高、生命周期短和突发并发大。文章重点讨论了Job日志采集的关键考虑点,包括容器发现速度、开始采集延时和弹性支持,并对比了5种采集方案:DaemonSet采集、Sidecar采集、ECI采集、同容器采集和独立存储采集。对于短生命周期Job,建议使用Sidecar或ECI采集,通过调整参数确保数据完整性。对于突发大量Job,需要关注服务端资源限制和采集容器的资源调整。文章总结了不同场景下的推荐采集方案,并指出iLogtail和SLS未来可能的优化方向。
141 1
|
25天前
|
数据可视化 应用服务中间件 Apache
优化集中式日志记录的方法:添加 Logstash 过滤器
优化集中式日志记录的方法:添加 Logstash 过滤器
17 1
|
14天前
|
SQL JavaScript 前端开发
【Azure 应用服务】Azure JS Function 异步方法中执行SQL查询后,Callback函数中日志无法输出问题
【Azure 应用服务】Azure JS Function 异步方法中执行SQL查询后,Callback函数中日志无法输出问题
|
24天前
|
数据采集 监控 Kubernetes
Job类日志采集问题之iLogtail以减小容器发现和开始采集的延时如何优化
Job类日志采集问题之iLogtail以减小容器发现和开始采集的延时如何优化
|
24天前
|
数据采集 Kubernetes Java
Job类日志采集问题之在日志中添加容器的元信息标签,如何操作
Job类日志采集问题之在日志中添加容器的元信息标签,如何操作
|
24天前
|
存储 容器
Job类日志采集问题之DaemonSet采集方式的参数以减小采集延时如何调整
Job类日志采集问题之DaemonSet采集方式的参数以减小采集延时如何调整
|
24天前
|
容器
Job类日志采集问题之ECI产品采集方式对于弹性扩缩容是如何支持的
Job类日志采集问题之ECI产品采集方式对于弹性扩缩容是如何支持的