在Eclipse E4 RCP应用中，直接封装`org.eclipse.e4.core.services.log.Logger`进行日志记录时，默认无法获取到实际调用日志方法的类信息，且`PlatformUI`不适用于纯E4环境。本文将介绍如何通过结合使用`Platform.getLog()`获取的`ILog`接口与Java 9+的`StackWalker` API，实现一个能够自动识别并记录日志调用源类的专业日志封装方案，从而提升日志的可读性和问题排查效率。
背景与问题分析
在Eclipse E4 RCP开发中，为了实现日志记录的集中管理和标准化，开发者通常会创建一个封装类来统一调用日志服务。然而，直接使用org.eclipse.e4.core.services.log.Logger并通过一个静态封装方法进行日志输出时，日志文件（如.log）中记录的通常是封装类本身或E4框架内部的调用路径，而非实际发起日志请求的业务类。例如，当通过A.info("Foobar")调用时，日志可能显示为org.eclipse.e4.ui.workbench或封装类A的路径，而非期望的业务类B。
此外，需要注意的是，org.eclipse.e4.core.services.log.Logger类在Javadoc中明确指出不适合终端用户直接使用。同时，尝试通过PlatformUI.getWorkbench().getService(...)获取日志服务的方式，在纯粹的E4应用中是不推荐的，因为PlatformUI属于Eclipse 3.x兼容层（Eclipse 3.x Compatibility Layer），不适用于纯E4架构。
推荐的E4日志接口
在E4 RCP应用中，推荐使用org.eclipse.core.runtime.ILog接口来获取和使用日志服务。ILog可以通过org.eclipse.core.runtime.Platform.getLog(Bundle bundle)方法获取，其中Bundle参数通常是当前插件的Bundle对象。这种方式更符合E4的架构原则，并能与Eclipse平台级的日志系统更好地集成。
解决方案：结合ILog与StackWalker实现调用者识别
为了在封装的日志方法中自动识别并记录实际调用日志的类，我们可以利用Java 9及更高版本引入的StackWalker API。StackWalker提供了一种高效且低开销的方式来遍历当前线程的调用栈，从而轻松获取调用者信息。
下面是一个实现带有调用者信息的日志封装类的示例：
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.Platform;
import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;
/**
* 这是一个用于E4 RCP应用的日志封装工具类，
* 能够自动识别并记录实际调用日志方法的类。
* 要求Java 9及以上版本。
*/
public final class Log {
/**
* 用于获取调用者信息的StackWalker实例。
* 配置为保留类引用，以提高性能和准确性。
*/
private static final StackWalker STACK_WALKER =
StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
// 私有构造函数，防止实例化工具类
private Log() {
// 工具类无需实例化
}
/**
* 记录一条信息级别的日志。
* 日志将包含实际调用此方法的类名。
*
* @param message 要记录的日志消息。
*/
public static void info(final String message) {
// 获取实际调用此info方法的类
final Class callerClass = STACK_WALKER.getCallerClass();
// 获取调用者类所在的Bundle
// FrameworkUtil.getBundle(callerClass) 能够获取到定义 callerClass 的 Bundle
final Bundle callerBundle = FrameworkUtil.getBundle(callerClass);
// 如果无法获取到Bundle，则使用当前Log类的Bundle作为备用
// 这通常发生在callerClass不是由OSGi Bundle加载的情况下，但在RCP中不常见
final Bundle logBundle = (callerBundle != null) ? callerBundle : FrameworkUtil.getBundle(Log.class);
// 获取对应Bundle的ILog实例
final ILog log = Platform.getLog(logBundle);
// 使用获取到的ILog实例记录日志
log.info(message);
}
/**
* 记录一条警告级别的日志。
* 日志将包含实际调用此方法的类名。
*
* @param message 要记录的日志消息。
*/
public static void warn(final String message) {
final Class callerClass = STACK_WALKER.getCallerClass();
final Bundle callerBundle = FrameworkUtil.getBundle(callerClass);
final Bundle logBundle = (callerBundle != null) ? callerBundle : FrameworkUtil.getBundle(Log.class);
final ILog log = Platform.getLog(logBundle);
log.warn(message);
}
/**
* 记录一条错误级别的日志。
* 日志将包含实际调用此方法的类名。
*
* @param message 要记录的日志消息。
* @param exception 相关的异常对象。
*/
public static void error(final String message, final Throwable exception) {
final Class callerClass = STACK_WALKER.getCallerClass();
final Bundle callerBundle = FrameworkUtil.getBundle(callerClass);
final Bundle logBundle = (callerBundle != null) ? callerBundle : FrameworkUtil.getBundle(Log.class);
final ILog log = Platform.getLog(logBundle);
log.error(message, exception);
}
// 可以根据需要添加其他日志级别的方法，如 debug, trace 等
}使用示例：
假设您的业务类MyService需要记录日志：
// MyService.java
package com.example.myservice;
public class MyService {
public void doSomething() {
Log.info("执行 doSomething 方法。");
// ...
}
public void handleError(Exception e) {
Log.error("处理错误时发生异常。", e);
}
}当MyService.doSomething()被调用时，日志文件中将记录类似以下内容：
!MESSAGE 执行 doSomething 方法。 !STACK 0 com.example.myservice.MyService
或在某些配置下，日志消息前会直接包含类名信息。关键在于，通过Platform.getLog(callerBundle)，E4日志系统能够正确地将日志事件归因于com.example.myservice这个Bundle，并且在日志输出中，通常会包含发起日志调用的类名信息。
代码解析与注意事项
-
StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE):
- StackWalker是Java 9引入的API，用于高效地遍历调用栈。
- RETAIN_CLASS_REFERENCE选项指示StackWalker在遍历栈帧时保留对Class对象的引用，这使得getCallerClass()方法能够直接返回Class>对象，而不是仅仅是类名字符串，从而提高了性能和便利性。
- 重要提示：此方案要求您的项目使用Java 9或更高版本。
-
STACK_WALKER.getCallerClass():
- 这个方法会返回调用STACK_WALKER实例的那个方法的类。
- 在Log.info()方法中调用时，它会跳过Log类本身，直接返回调用Log.info()的业务类（例如MyService）。
-
Platform.getLog(Bundle bundle):
- 这是E4 RCP中获取日志服务的标准方法。它要求提供一个Bundle对象。
- FrameworkUtil.getBundle(callerClass)能够获取到定义callerClass的OSGi Bundle。这是非常关键的一步，因为它确保日志事件被正确地关联到发出日志的插件。
- 通过将调用者类的Bundle传递给Platform.getLog()，E4日志系统能够更准确地处理日志，例如在日志文件中标识出哪个插件发出了日志。
-
异常处理和备用方案:
- 在Log类中，我们添加了对callerBundle的空检查。虽然在典型的RCP环境中FrameworkUtil.getBundle(callerClass)通常不会返回null，但这是一个良好的防御性编程实践，以防callerClass不是由OSGi Bundle加载的特殊情况。
总结
通过上述方法，我们成功地在Eclipse E4 RCP应用中实现了一个功能强大的日志封装工具。它不仅解决了传统封装方式无法准确识别调用者的问题，还遵循了E4推荐的日志接口使用规范，并利用了Java平台现代化的StackWalker API。这种方案提升了日志的实用性，使得开发者在排查问题时能够更快速、准确地定位到日志的来源，从而提高开发效率和应用的可维护性。请确保您的项目环境支持Java 9及以上版本，以便充分利用StackWalker带来的便利。
