Eclipse E4 RCP 日志记录：实现带有调用者信息的日志封装

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.java
package com.example.myservice;

public class MyService {

    public void doSomething() {
        Log.info("执行 doSomething 方法。");
        // ...
    }

    public void handleError(Exception e) {
        Log.error("处理错误时发生异常。", e);
    }
}

!MESSAGE 执行 doSomething 方法。
!STACK 0
com.example.myservice.MyService