Eclipse自定义Source Locator插件调试问题：自定义源定位逻辑未触发

问题背景 #

我正尝试实现一个自定义Source Locator，用来支持常规归档/文件夹之外的源位置（比如在线源码、反编译源码），参考相关思路做了基础配置后，调试时自定义Locator的断点完全没触发——点击断点或栈帧时只显示"Source not found"，完全没走到我的代码里。

当前配置与代码 #

plugin.xml配置 #

<plugin>
 <extension point="org.eclipse.debug.core.sourceLocators">
 <sourceLocator id="com.mypackage.debug.core.sourceLocators.MySourceLocator" class="com.mypackage.debug.core.sourceLocators.MySourceLocator" name="My Source Locator">
 </sourceLocator>
 </extension>
</plugin>

初始实现代码 #

package com.mypackage.debug.core.sourceLocators;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.model.IPersistableSourceLocator;
import org.eclipse.debug.core.model.IStackFrame;

public class MySourceLocator implements IPersistableSourceLocator {
 @Override
 public Object getSourceElement(IStackFrame stackFrame) {
 return null;
 }

 @Override
 public String getMemento() throws CoreException {
 return null;
 }

 @Override
 public void initializeFromMemento(String memento) throws CoreException {
 }

 @Override
 public void initializeDefaults(ILaunchConfiguration configuration) throws CoreException {
 }
}

核心问题原因 #

你当前的问题在于：Java调试会话默认使用的是JavaSourceLookupDirector，而你直接注册的自定义IPersistableSourceLocator并没有被关联到Java启动流程中。Eclipse的Java调试架构里，ISourceLookupDirector是源查找的核心管理者，它会协调多个ISourceLookupParticipant来处理不同类型的源定位需求，单纯注册一个独立的Source Locator不会被Java调试自动使用。

具体实现步骤 #

1. 实现自定义ISourceLookupParticipant #

这是处理源查找逻辑的核心组件，我们需要在这里编写在线源码/反编译源码的定位逻辑：

package com.mypackage.debug.core.sourceLocators;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.model.StackFrame;
import org.eclipse.debug.core.sourcelookup.ISourceLookupParticipant;

public class MySourceLookupParticipant extends ISourceLookupParticipant {

    @Override
    public Object[] findSourceElements(Object object) throws CoreException {
        // 这里处理源查找逻辑
        if (object instanceof StackFrame) {
            StackFrame stackFrame = (StackFrame) object;
            // 获取类名、方法名等信息，用于定位在线/反编译源码
            String className = stackFrame.getDeclaringType().getName();
            
            // 示例：返回自定义的源元素（比如你封装的在线源码对象）
            // 这里可以替换为你的实际逻辑：调用在线API获取源码，或者反编译class文件
            return new Object[]{new MyCustomSourceElement(className)};
        }
        // 如果处理不了，返回null让其他参与者继续处理
        return null;
    }

    @Override
    public String getSourceName(Object object) throws CoreException {
        // 返回源元素的名称，用于编辑器显示
        if (object instanceof StackFrame) {
            return ((StackFrame) object).getDeclaringType().getName();
        }
        return super.getSourceName(object);
    }
}

// 自定义源元素示例，需要实现IEditorInput或适配Eclipse的编辑器打开逻辑
class MyCustomSourceElement {
    private String className;

    public MyCustomSourceElement(String className) {
        this.className = className;
    }

    // 这里可以添加获取源码内容的方法，供编辑器调用
    public String getSourceContent() {
        // 实际场景中替换为在线获取或反编译逻辑
        return "// 模拟在线/反编译的源码内容\npublic class " + className + " { ... }";
    }
}

2. 关联参与者到JavaSourceLookupDirector #

我们需要通过监听Eclipse的启动事件，把自定义参与者添加到Java调试的源查找管理者中。可以在插件的激活类里做这件事：

package com.mypackage.debug.core;

import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchListener;
import org.eclipse.debug.core.ILaunchManager;
import org.eclipse.debug.core.sourcelookup.ISourceLookupDirector;
import org.eclipse.jdt.internal.debug.core.launcher.JavaSourceLookupDirector;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;

import com.mypackage.debug.core.sourceLocators.MySourceLookupParticipant;

public class Activator extends AbstractUIPlugin {

    private static Activator plugin;
    private ILaunchListener launchListener;

    @Override
    public void start(BundleContext context) throws Exception {
        super.start(context);
        plugin = this;
        
        // 注册启动监听器，监听新的调试启动
        ILaunchManager launchManager = getDebugCore().getLaunchManager();
        launchListener = new ILaunchListener() {
            @Override
            public void launchRemoved(ILaunch launch) {}

            @Override
            public void launchChanged(ILaunch launch) {}

            @Override
            public void launchAdded(ILaunch launch) {
                // 获取Java调试的源查找管理者
                Object sourceLocator = launch.getSourceLocator();
                if (sourceLocator instanceof JavaSourceLookupDirector) {
                    JavaSourceLookupDirector director = (JavaSourceLookupDirector) sourceLocator;
                    // 添加自定义参与者
                    director.addParticipants(new MySourceLookupParticipant[]{new MySourceLookupParticipant()});
                }
            }
        };
        launchManager.addLaunchListener(launchListener);
        
        // 处理已存在的启动（如果插件启动时已有调试会话）
        for (ILaunch launch : launchManager.getLaunches()) {
            launchAdded(launch);
        }
    }

    @Override
    public void stop(BundleContext context) throws Exception {
        // 移除监听器，避免内存泄漏
        ILaunchManager launchManager = getDebugCore().getLaunchManager();
        if (launchListener != null) {
            launchManager.removeLaunchListener(launchListener);
        }
        plugin = null;
        super.stop(context);
    }

    public static Activator getDefault() {
        return plugin;
    }
    
    private org.eclipse.debug.core.DebugPlugin getDebugCore() {
        return org.eclipse.debug.core.DebugPlugin.getDefault();
    }
}

3. 适配编辑器打开逻辑（可选但必要） #

为了让Eclipse能打开你的自定义源元素，你需要扩展org.eclipse.ui.editors扩展点，注册一个能处理MyCustomSourceElement的编辑器，或者实现IEditorInput接口并适配现有编辑器（比如文本编辑器）。

测试验证 #

1. 重启你的Eclipse插件开发环境
2. 创建测试项目并设置断点，启动Java调试
3. 当触发断点时，你的MySourceLookupParticipant.findSourceElements方法应该会被调用，此时可以通过断点验证逻辑是否执行
4. 如果逻辑正确，Eclipse应该会加载你提供的自定义源内容，而不是显示"Source not found"

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