Java 如何在工具类静态方法中无需传参获取调用方类的Logger

首先明确：无需传入Logger参数即可实现该需求，主流有两种可行方案，适配不同使用场景。

方案1：通过栈帧动态获取调用方类，生成对应Logger #

该方案直接拿到调用方类对应的Logger实例，完全符合日志按调用方类隔离的需求。

Java 9+ 高性能实现（推荐） #

Java 9引入的StackWalkerAPI相比传统栈轨迹获取方式性能提升明显，代码示例如下：

import java.lang.StackWalker.StackFrame;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UtilClz {
    public static void doSthAndLogIt(Runnable runnable) {
        runnable.run();
        // 遍历栈帧获取调用方类
        Class<?> callerClz = StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE)
                .walk(stream -> stream
                        // 过滤工具类自身栈帧
                        .filter(frame -> !UtilClz.class.equals(frame.getDeclaringClass()))
                        // 过滤lambda、代理等合成类栈帧
                        .filter(frame -> !frame.getDeclaringClass().isSynthetic())
                        .findFirst()
                        .map(StackFrame::getDeclaringClass)
                        .orElseThrow(() -> new IllegalStateException("无法识别调用方类"))
                );
        // 获取调用方对应的Logger
        Logger callerLogger = LoggerFactory.getLogger(callerClz);
        callerLogger.info("操作执行完成");
    }
}

Java 8 兼容实现 #

Java 8及更早版本可以通过线程栈轨迹实现，代码示例如下：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UtilClz {
    public static void doSthAndLogIt(Runnable runnable) throws ClassNotFoundException {
        runnable.run();
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        // 栈帧前两位分别是getStackTrace方法、当前doSthAndLogIt方法，从下标2开始遍历
        for (int i = 2; i < stackTrace.length; i++) {
            StackTraceElement element = stackTrace[i];
            String className = element.getClassName();
            // 过滤lambda、动态代理生成的合成类
            if (className.contains("$$Lambda$") || className.contains("$Proxy")) {
                continue;
            }
            // 使用上下文类加载器加载，避免跨类加载器场景加载失败
            Class<?> callerClz = Class.forName(className, true, Thread.currentThread().getContextClassLoader());
            Logger callerLogger = LoggerFactory.getLogger(callerClz);
            callerLogger.info("操作执行完成");
            break;
        }
    }
}

方案1优缺点

• 优点：Logger本身就是调用方类对应的实例，原有按类配置的日志级别、分文件输出等规则完全生效，不会影响现有日志逻辑。
• 缺点：有轻微的栈遍历性能开销，高并发场景下建议做压测评估；碰到复杂动态代理、AOP增强场景需要调整过滤规则，避免获取到代理类而非实际业务类。

方案2：利用日志框架自带的调用方识别能力 #

如果你只是需要在日志内容中显示调用方信息，不需要按调用方类做日志隔离，可以直接使用工具类自身的Logger，通过日志框架的配置即可打印调用方的类、方法、行号信息，无需修改代码逻辑。
以常用的SLF4J+Logback框架为例，只需修改日志格式配置，新增%caller{1}占位符即可：

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <!-- %caller{1} 表示输出第一层调用方的信息 -->
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %caller{1} - %msg%n</pattern>
    </encoder>
</appender>

方案2优缺点

• 优点：无额外性能开销，不需要修改工具类代码，实现成本极低。
• 缺点：日志本质上还是属于工具类的Logger，原有按类名配置的日志过滤、分文件输出规则不会按调用方类生效。

选型建议 #

• 如果需要按调用方类做日志级别控制、分文件输出，选择方案1。
• 如果只需要在日志中显示调用方定位信息，选择方案2更简单高效。

内容的提问来源于stack exchange，提问作者waynewing