本文旨在解决Eclipse E4 RCP应用中集中式日志记录时，日志条目无法准确显示实际调用者类的问题。通过分析E4 RCP的日志机制，并结合Java 9及以上版本提供的`StackWalker` API，我们将演示如何构建一个智能的日志工具，该工具能够动态识别并记录发起日志请求的原始类，从而提升日志的可追溯性和调试效率，同时遵循E4/OSGi的最佳实践。
1. 集中式日志的挑战与E4 RCP环境下的考量
在复杂的应用程序中，为了统一日志格式、管理日志级别或添加额外上下文信息，通常会引入一个集中式的日志工具类。然而，当直接在封装类中调用底层日志API时，日志系统往往会记录封装类本身作为日志源，而非实际发起日志请求的业务逻辑类。这给问题排查带来了不便，因为我们无法直接从日志中判断是哪个具体模块或类触发了某条日志信息。
在Eclipse E4 RCP（以及更广泛的OSGi）环境中，日志机制有其特定的规范。原始问题中尝试使用的org.eclipse.e4.core.services.log.Logger以及通过PlatformUI.getWorkbench().getService()获取日志服务的做法存在以下问题：
- API用途不当：org.eclipse.e4.core.services.log.Logger通常不建议终端用户直接使用。
- 框架依赖混淆：PlatformUI属于Eclipse 3.x兼容层（Compatibility Layer）的API，主要用于基于org.eclipse.ui.xxx插件的传统RCP应用。在纯E4应用中，应避免直接依赖此类API，以保持E4的模块化和解耦特性。
在E4/OSGi环境中，推荐使用org.eclipse.core.runtime.ILog接口来获取和记录日志。ILog可以通过Platform.getLog(Bundle bundle)或Platform.getLog(Class> clazz)方法获取，它能够将日志条目与特定的Bundle或类关联起来，从而更好地集成到OSGi的日志框架中。
2. 利用Java StackWalker获取调用者信息
为了解决日志源识别不准确的问题，我们需要一种机制来动态地获取当前方法的实际调用者。Java 9及以上版本引入的java.lang.StackWalker API提供了一种高效且标准化的方式来遍历和检查调用栈。
StackWalker相比传统的Thread.currentThread().getStackTrace()方法，具有更高的性能和更灵活的控制能力。它允许我们以流式API的方式处理堆栈帧，并可以根据需要选择性地保留类引用或方法类型等信息。
要获取调用当前方法的类，我们可以使用以下步骤：
- 创建一个StackWalker实例，通常配置StackWalker.Option.RETAIN_CLASS_REFERENCE选项，以便能够获取到堆栈帧中的类引用。
- 调用StackWalker.getCallerClass()方法，该方法会返回调用当前方法的直接上层类的Class对象。
3. 构建调用者感知的日志工具
结合ILog和StackWalker，我们可以构建一个简洁而强大的集中式日志工具类。这个工具类将负责获取实际的调用者类，并使用该类作为上下文来记录日志。
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.Platform;
/**
* 集中式日志工具类，能够动态识别并记录发起日志请求的实际调用者。
* 适用于Eclipse E4 RCP (Java 9+) 环境。
*/
public final class AppLog {
/**
* StackWalker实例，用于获取调用者类。
* 配置RETAIN_CLASS_REFERENCE选项以保留类引用。
*/
private static final StackWalker STACK_WALKER = StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
// 私有构造函数，防止实例化工具类
private AppLog() {
// 工具类无需实例化
}
/**
* 记录一条信息级别的日志。
* 日志将与实际调用此方法的类相关联。
*
* @param message 要记录的日志消息
*/
public static void info(final String message) {
// 获取实际调用AppLog.info()方法的类
// StackWalker.getCallerClass() 会跳过AppLog类本身，直接返回其上层调用者
final Class callerClass = STACK_WALKER.getCallerClass();
// 使用获取到的调用者类作为上下文来获取ILog实例
// 这样日志系统就能将消息与正确的Bundle或类关联起来
final ILog log = Platform.getLog(callerClass);
// 记录日志
log.info(message);
}
/**
* 记录一条警告级别的日志。
*
* @param message 要记录的日志消息
*/
public static void warn(final String message) {
final Class callerClass = STACK_WALKER.getCallerClass();
final ILog log = Platform.getLog(callerClass);
log.warn(message);
}
/**
* 记录一条错误级别的日志。
*
* @param message 要记录的日志消息
* @param exception 相关的异常对象
*/
public static void error(final String message, final Throwable exception) {
final Class callerClass = STACK_WALKER.getCallerClass();
final ILog log = Platform.getLog(callerClass);
log.error(message, exception);
}
// 可以根据需要添加其他日志级别的方法，如 debug, trace 等
}使用示例：
假设我们有一个业务逻辑类MyService，它需要记录一条信息日志：
// MyService.java
package com.example.myapp.service;
public class MyService {
public void doSomething() {
// 通过AppLog工具类记录日志
AppLog.info("执行了 doSomething 方法。");
// ... 其他业务逻辑
}
}
// 另一个类 MainApp.java
package com.example.myapp;
public class MainApp {
public static void main(String[] args) {
MyService service = new MyService();
service.doSomething();
}
}当MyService.doSomething()方法调用AppLog.info()时，STACK_WALKER.getCallerClass()将返回com.example.myapp.service.MyService的Class对象。因此，最终写入.log文件的日志条目将正确地显示MyService作为日志源，例如：
!MESSAGE 执行了 doSomething 方法。
（具体输出格式取决于E4/OSGi日志实现，但其内部会正确关联到com.example.myapp.service.MyService）
4. 注意事项与最佳实践
- Java版本要求：StackWalker是Java 9及以上版本引入的API。如果项目仍在使用Java 8或更早版本，则无法直接使用此方法。对于旧版本Java，可能需要依赖更复杂的反射或第三方库来实现类似功能，但性能和准确性可能不如StackWalker。
- E4/OSGi日志上下文：Platform.getLog(Class> clazz)方法会查找与给定类所属的Bundle关联的ILog实例。这确保了日志消息能够正确地归属于其所在的OSGi Bundle，这对于大型模块化应用的管理至关重要。
- 性能考量：StackWalker的设计目标之一就是高性能。与传统的堆栈跟踪方法相比，它通常更高效。然而，在极度性能敏感的“热路径”中，频繁地获取堆栈信息仍然会带来一定的开销。在大多数日常日志场景中，这种开销可以忽略不计。
- 异常处理：在记录错误日志时，应始终包含相关的Throwable对象，以便日志系统能够提供完整的堆栈跟踪信息，这对于问题诊断至关重要。
- 日志级别：根据实际需求，在AppLog工具类中实现所有需要的日志级别（如debug、trace、fatal等），并确保它们都使用StackWalker.getCallerClass()来获取调用者。
总结
通过巧妙地结合Eclipse E4 RCP的ILog日志接口和Java 9+的StackWalker API，我们成功构建了一个集中式且能够准确识别实际调用者的日志工具。这种方法不仅解决了传统集中式日志中日志源模糊的问题，还遵循了E4/OSGi环境下的日志最佳实践，提升了应用程序日志的可读性、可追溯性和维护性。在开发基于E4 RCP的Java 9+应用程序时，强烈推荐采用此模式来实现高效且准确的日志记录。
