本文旨在解决eclipse e4 rcp应用中，构建集中式日志系统时无法准确识别日志调用来源类的问题。针对直接使用`org.eclipse.e4.core.services.log.logger`和`platformui`的局限，本教程推荐采用`platform.getlog()`获取`ilog`接口，并利用java 9及以上版本提供的`stackwalker`机制，动态捕获调用者的类信息，从而在日志输出中清晰地展现原始调用位置，显著提升日志的可追溯性和调试效率。
在开发大型或模块化的Eclipse E4 RCP应用程序时，为了保持代码的整洁性和一致性，通常会倾向于构建一个集中式的日志工具类。然而，这种做法的一个常见挑战是，当日志消息通过这个工具类发出时，日志系统往往会将工具类本身记录为消息的来源，而非实际调用日志方法的原始类。这会大大降低日志的有用性，因为无法快速定位问题发生的具体业务代码位置。
问题分析与传统方法的局限性
许多开发者可能会尝试创建一个静态的日志工具类，并在其中封装org.eclipse.e4.core.services.log.Logger的实例，如下所示：
import org.eclipse.e4.core.services.log.Logger;
import org.eclipse.ui.PlatformUI; // 注意：此为SWT/JFace/Workbench API
class A {
// 这种获取Logger的方式在纯E4应用中不推荐
static Logger logger = PlatformUI.getWorkbench().getService(org.eclipse.e4.core.services.log.Logger.class);
public static void info(String message) {
logger.info(message);
}
}
class B {
public void doSomething() {
A.info("Foobar");
}
}当B类调用A.info("Foobar")时，日志文件可能会显示类似[...]
- org.eclipse.e4.core.services.log.Logger的设计意图： 根据Eclipse E4的Javadoc，org.eclipse.e4.core.services.log.Logger并非为终端用户直接使用而设计。它更多是作为E4内部服务提供日志功能的基础接口。
- PlatformUI的使用： PlatformUI.getWorkbench()是Eclipse 3.x（SWT/JFace/Workbench）API的一部分。在纯粹的E4应用程序中，应避免使用org.eclipse.ui.xxx插件中的任何API，因为E4有其自身的生命周期和服务管理机制。混合使用可能导致不兼容或不稳定的行为。
- 日志系统对调用堆栈的识别： 大多数日志框架在没有额外配置的情况下，会直接记录日志方法被调用的位置，即A.info()内部调用logger.info()的位置，而不是B.doSomething()调用A.info()的位置。
推荐方案：结合 ILog 与 StackWalker
为了在E4 RCP应用中实现一个既集中又能够准确识别调用者的日志系统，我们应该遵循E4推荐的日志接口，并利用Java 9及以上版本提供的StackWalker机制来动态获取调用者的类信息。
1. 使用 ILog 接口
在Eclipse RCP/OSGi环境中，推荐的日志接口是org.eclipse.core.runtime.ILog，可以通过org.eclipse.core.runtime.Platform.getLog()方法获取。Platform.getLog()可以接受一个Bundle对象或一个Class对象作为参数，这样日志系统就可以知道日志消息是来自哪个插件或哪个类。
2. 利用 Java 9+ StackWalker
StackWalker是Java 9引入的一个强大API，用于高效地遍历和检查当前线程的调用堆栈。它比传统的Thread.currentThread().getStackTrace()方法更高效，并且提供了更灵活的过滤和访问堆栈帧的方式。其中，StackWalker.getCallerClass()方法可以直接获取到当前方法调用者的Class对象。
实现细节与示例代码
结合ILog和StackWalker，我们可以构建一个简洁高效的日志工具类：
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.Platform;
/**
* 集中式日志工具类，能够准确识别日志调用者。
* 要求 Java 9 或更高版本。
*/
public final class Log {
/**
* 用于获取调用者的StackWalker实例。
* 配置为保留类引用，以便直接获取Class对象。
*/
private static final StackWalker STACK_WALKER =
StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
// 私有构造函数，防止实例化
private Log() {
// 工具类无需实例化
}
/**
* 记录信息级别的日志消息。
*
* @param msg 要记录的日志消息。
*/
public static void info(final String msg) {
// 获取实际调用Log.info()方法的类
final Class callerClass = STACK_WALKER.getCallerClass();
// 使用调用者类获取对应的ILog实例，确保日志系统能识别来源
final ILog logger = Platform.getLog(callerClass);
// 记录日志
logger.info(msg);
}
/**
* 记录警告级别的日志消息。
*
* @param msg 要记录的日志消息。
*/
public static void warn(final String msg) {
final Class callerClass = STACK_WALKER.getCallerClass();
final ILog logger = Platform.getLog(callerClass);
logger.warn(msg);
}
/**
* 记录错误级别的日志消息。
*
* @param msg 要记录的日志消息。
* @param throwable 相关的异常。
*/
public static void error(final String msg, final Throwable throwable) {
final Class callerClass = STACK_WALKER.getCallerClass();
final ILog logger = Platform.getLog(callerClass);
logger.error(msg, throwable);
}
// 可以根据需要添加其他日志级别的方法，如 debug, trace 等
}使用方法
在您的应用程序代码中，只需像往常一样调用这个Log工具类的方法即可：
// 假设这是您的一个业务类
package com.example.myapp.core;
import com.example.myapp.util.Log; // 导入您的日志工具类
public class MyService {
public void performTask(String data) {
Log.info("开始执行任务，数据: " + data);
try {
// 模拟一些操作
if (data == null || data.isEmpty()) {
throw new IllegalArgumentException("输入数据不能为空");
}
// ... 业务逻辑 ...
Log.info("任务执行成功。");
} catch (Exception e) {
Log.error("任务执行失败！", e);
}
}
}当MyService.performTask()方法调用Log.info()或Log.error()时，StackWalker.getCallerClass()将准确地返回com.example.myapp.core.MyService.class。这样，Platform.getLog(callerClass)就能获取到与MyService类所属的Bundle相关的ILog实例，从而在日志输出中正确地标记出MyService作为消息的来源。
注意事项
- Java 版本要求： StackWalker API 是在 Java 9 中引入的。如果您的项目仍在使用 Java 8 或更早版本，则无法直接使用此方法。对于旧版本Java，您可能需要依赖更复杂的堆栈跟踪解析（如Thread.currentThread().getStackTrace()）或集成第三方日志框架（如Log4j、SLF4J/Logback），这些框架通常提供了获取调用者信息的功能。
- 性能考量： 尽管StackWalker比旧的堆栈跟踪方法更高效，但频繁地获取调用堆栈仍然会带来一定的性能开销。对于极度性能敏感的场景，应谨慎使用，或考虑在生产环境中限制日志级别。
- E4/OSGi 环境： Platform.getLog(Class)方法依赖于OSGi运行时来确定给定类所属的Bundle，并为其提供相应的日志服务。确保您的应用程序运行在正确的OSGi环境中。
- 日志输出格式： 实际的日志输出格式（如!MESSAGE Class A Foobar）取决于Eclipse日志系统的配置。通过Platform.getLog(callerClass)获取的ILog实例，通常会在日志中包含调用者Bundle的信息，这通常足够用于追溯。如果需要更精细的格式控制，可能需要进一步配置Eclipse的日志服务。
总结
通过采用E4 RCP推荐的ILog接口并结合Java 9+的StackWalker机制，我们可以构建一个既符合平台规范，又能有效解决日志来源识别问题的集中式日志系统。这种方法不仅提升了日志的可读性和可追溯性，也促进了代码的专业性和可维护性，是现代Eclipse E4 RCP应用中日志管理的一个高效实践。
