如何在Xtext编辑器中展示外部验证工具的错误与警告？

Xtext完全支持集成自定义解析器的错误/警告信息，并且能精准定位到代码的行和列，同时满足仅在用户主动触发时运行验证的需求（避免实时验证带来的性能问题）。下面是具体的实现方案：

1. 核心思路：自定义验证逻辑 + 按需触发 #

我们不需要依赖Xtext默认的实时验证机制，而是打造一套独立的验证流程：

• 编写自定义验证器，调用你的现有解析器获取问题报告
• 将解析器返回的行/列位置映射为Xtext能识别的文本区域
• 提供用户触发入口（比如右键菜单、快捷键），在后台运行验证并展示结果

2. 实现自定义验证器 #

首先创建一个验证类，负责调用现有解析器，并将解析结果转换为Xtext的Issue对象（这些对象会被Problems视图识别）：

import org.eclipse.xtext.validation.Issue;
import org.eclipse.xtext.validation.IssueCollector;
import org.eclipse.xtext.util.TextLocation;
import org.eclipse.xtext.util.TextRegion;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IProgressMonitor;
import java.util.List;

public class ExternalParserValidator {

    // 假设你的现有解析器返回的问题对象结构如下
    static class ParserProblem {
        private String message;
        private int line;
        private int column;
        private int length; // 可选：错误文本的长度，无则设为1
        private boolean isError;

        // 构造器、getter方法省略
    }

    public void validate(IResource eclipseResource, IssueCollector collector, IProgressMonitor monitor) throws Exception {
        // 1. 获取要验证的内容：优先取编辑器未保存的文本，否则读磁盘文件
        String content = getContentFromEditorOrFile(eclipseResource);
        // 2. 调用你的现有解析器生成问题报告
        List<ParserProblem> problems = yourExistingParser.validate(content);

        // 3. 将每个问题转换为Xtext Issue并收集
        for (ParserProblem problem : problems) {
            // 注意：Xtext行号从1开始，列号从0开始，要和你的解析器输出对齐
            int xtextLine = problem.getLine();
            int xtextColumn = problem.getColumn() - 1; // 若解析器列号从1开始，此处需减1
            int xtextLength = problem.getLength() > 0 ? problem.getLength() : 1;

            // 创建文本区域和位置信息
            TextRegion region = new TextRegion(xtextColumn, xtextLength);
            TextLocation location = TextLocation.create(eclipseResource.getURI(), xtextLine, region);

            // 添加到IssueCollector，指定错误级别和自定义代码
            collector.accept(
                Issue.fromMessage(
                    problem.getMessage(),
                    location,
                    "com.yourcompany.yourlanguage.externalparser", // 自定义错误代码
                    problem.isError() ? Severity.ERROR : Severity.WARNING
                )
            );
        }
    }

    // 辅助方法：获取编辑器文本或磁盘文件内容
    private String getContentFromEditorOrFile(IResource eclipseResource) {
        // 实现逻辑：检查当前编辑器是否关联该资源，若打开则取编辑器文本，否则读文件
        // 可基于XtextEditor的API实现，此处省略具体细节
    }
}

3. 添加用户主动触发的入口 #

接下来给用户提供触发验证的方式，比如在编辑器右键菜单加一个“运行外部解析器验证”的选项，或者绑定快捷键。这里以Eclipse命令Handler为例：

import org.eclipse.core.commands.AbstractHandler;
import org.eclipse.core.commands.ExecutionEvent;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.handlers.HandlerUtil;
import org.eclipse.xtext.ui.editor.XtextEditor;
import org.eclipse.xtext.validation.IssueCollector;
import org.eclipse.xtext.validation.IssuesUtil;
import org.eclipse.core.runtime.jobs.Job;

public class TriggerExternalValidationHandler extends AbstractHandler {

    @Override
    public Object execute(ExecutionEvent event) throws ExecutionException {
        IEditorPart activeEditor = HandlerUtil.getActiveEditor(event);
        if (!(activeEditor instanceof XtextEditor)) {
            MessageDialog.openInformation(
                HandlerUtil.getActiveShell(event),
                "提示",
                "请打开Xtext语言编辑器后重试"
            );
            return null;
        }

        XtextEditor xtextEditor = (XtextEditor) activeEditor;
        IResource resource = xtextEditor.getResource();

        // 在后台线程运行验证，避免阻塞UI
        Job validationJob = new Job("运行外部解析器验证") {
            @Override
            protected IStatus run(IProgressMonitor monitor) {
                try {
                    IssueCollector collector = new IssueCollector();
                    ExternalParserValidator validator = new ExternalParserValidator();
                    validator.validate(resource, collector, monitor);

                    // 将验证结果展示到Problems视图
                    IssuesUtil.displayIssues(collector.getIssues(), xtextEditor.getResourceSet());
                    return Status.OK_STATUS;
                } catch (Exception e) {
                    return new Status(IStatus.ERROR, "com.yourcompany.yourlanguage", "验证失败", e);
                }
            }
        };

        // 标记为用户任务，显示进度对话框
        validationJob.setUser(true);
        validationJob.schedule();
        return null;
    }
}

之后你需要在插件的plugin.xml中注册这个Handler，添加菜单和快捷键绑定，具体配置可参考Eclipse命令扩展的文档。

4. 关键注意事项 #

• 位置映射要准确：务必确认你的解析器返回的行/列索引是1-based还是0-based，和Xtext的规则（行1-based，列0-based）对齐，否则会出现位置偏移。
• 处理未保存的内容：如果用户修改了代码但未保存，解析器应该读取编辑器中的文本而非磁盘文件，否则会验证旧内容。
• 性能优化：因为验证耗时，一定要在后台线程运行，并提供进度提示，避免UI卡顿。

这样就能完美实现你的需求：用户主动触发验证后，现有解析器的错误/警告会精准显示在Xtext编辑器的对应位置，同时不会影响日常编辑的流畅性。

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