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

本文涉及的产品
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
简介: 公司原有日志记录需手动输入类名与方法名,繁琐且易错。目标是开发工具类简化此过程。调研发现`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日志并进行多维度分析。
相关文章
|
3月前
|
Kubernetes Ubuntu Windows
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
【Azure K8S | AKS】分享从AKS集群的Node中查看日志的方法(/var/log)
129 3
|
6月前
|
C++ 开发者 Python
实现Python日志点击跳转到代码位置的方法
本文介绍了如何在Python日志中实现点击跳转到代码位置的功能,以提升调试效率。通过结合`logging`模块的`findCaller()`方法记录代码位置信息,并使用支持点击跳转的日志查看工具(如VS Code、PyCharm),开发者可以从日志直接点击链接定位到出错代码,加快问题排查。
100 2
|
2月前
|
设计模式 SQL 安全
PHP中的设计模式:单例模式的深入探索与实践在PHP的编程实践中,设计模式是解决常见软件设计问题的最佳实践。单例模式作为设计模式中的一种,确保一个类只有一个实例,并提供全局访问点,广泛应用于配置管理、日志记录和测试框架等场景。本文将深入探讨单例模式的原理、实现方式及其在PHP中的应用,帮助开发者更好地理解和运用这一设计模式。
在PHP开发中,单例模式通过确保类仅有一个实例并提供一个全局访问点,有效管理和访问共享资源。本文详细介绍了单例模式的概念、PHP实现方式及应用场景,并通过具体代码示例展示如何在PHP中实现单例模式以及如何在实际项目中正确使用它来优化代码结构和性能。
44 2
|
2月前
|
存储 运维 监控
超级好用的C++实用库之日志类
超级好用的C++实用库之日志类
38 0
|
3月前
|
数据可视化 应用服务中间件 Apache
优化集中式日志记录的方法:添加 Logstash 过滤器
优化集中式日志记录的方法:添加 Logstash 过滤器
45 1
|
3月前
|
开发者 前端开发 编解码
Vaadin解锁移动适配新境界:一招制胜,让你的应用征服所有屏幕!
【8月更文挑战第31天】在移动互联网时代,跨平台应用开发备受青睐。作为一款基于Java的Web应用框架,Vaadin凭借其组件化设计和强大的服务器端渲染能力,助力开发者轻松构建多设备适应的Web应用。本文探讨Vaadin与移动设备的适配策略,包括响应式布局、CSS媒体查询、TouchKit插件及服务器端优化,帮助开发者打造美观且实用的移动端体验。通过这些工具和策略的应用,可有效应对屏幕尺寸、分辨率及操作系统的多样性挑战,满足广大移动用户的使用需求。
62 0
|
3月前
|
存储 运维 监控
Entity Framework Core 实现审计日志记录超棒!多种方法助你跟踪数据变化、监控操作,超实用!
【8月更文挑战第31天】在软件开发中,审计日志记录对于跟踪数据变化、监控用户操作及故障排查至关重要。Entity Framework Core (EF Core) 作为强大的对象关系映射框架,提供了多种实现审计日志记录的方法。例如,可以使用 EF Core 的拦截器在数据库操作前后执行自定义逻辑,记录操作类型、时间和执行用户等信息。此外,也可通过在实体类中添加审计属性(如 `CreatedBy`、`CreatedDate` 等),并在保存实体时更新这些属性来记录审计信息。这两种方法都能有效帮助我们追踪数据变更并满足合规性和安全性需求。
66 0
|
3月前
|
SQL JavaScript 前端开发
【Azure 应用服务】Azure JS Function 异步方法中执行SQL查询后,Callback函数中日志无法输出问题
【Azure 应用服务】Azure JS Function 异步方法中执行SQL查询后,Callback函数中日志无法输出问题
|
3月前
|
数据采集 监控 Kubernetes
Job类日志采集问题之iLogtail以减小容器发现和开始采集的延时如何优化
Job类日志采集问题之iLogtail以减小容器发现和开始采集的延时如何优化
|
3月前
|
数据采集 Kubernetes Java
Job类日志采集问题之在日志中添加容器的元信息标签,如何操作
Job类日志采集问题之在日志中添加容器的元信息标签,如何操作
下一篇
无影云桌面