ANTLR4 JavaScript解析器：如何捕获解析过程中的错误

嘿，针对你用ANTLR4 JavaScript解析器捕获解析错误的需求，我给你整理了几种实用的方案，结合你的语法场景来一步步讲解：

ANTLR4的JavaScript解析器默认会自带一个ConsoleErrorListener，它会把语法/词法错误直接打印到控制台。但如果需要自己捕获、存储或者自定义处理这些错误，就得替换掉这个默认监听器。

这是日常开发中最实用的方式，通过自定义错误监听器，你可以收集错误信息、格式化输出，甚至把错误存入日志系统。具体步骤如下：

首先，定义一个继承自BaseErrorListener的自定义监听器，重写syntaxError方法来捕获错误：

const { ANTLRInputStream, CommonTokenStream, BaseErrorListener } = require('antlr4');
// 导入你生成的词法分析器和解析器
const SomeGrammarLexer = require('./SomeGrammarLexer');
const SomeGrammarParser = require('./SomeGrammarParser');

class CustomErrorListener extends BaseErrorListener {
  constructor() {
    super();
    this.errors = []; // 用来存储所有捕获到的错误
  }

  // 当遇到语法/词法错误时，这个方法会被自动调用
  syntaxError(recognizer, offendingSymbol, line, column, msg, e) {
    // 按你需要的格式整理错误信息
    const errorDetail = {
      line: line,
      column: column,
      message: msg,
      problematicToken: offendingSymbol?.text || '无法识别的字符'
    };
    this.errors.push(errorDetail);
    
    // 也可以在这里直接打印错误，或者做其他处理
    console.error(`[错误] 第${line}行第${column}列: ${msg}`);
  }
}

然后，在解析流程中替换默认监听器，使用自定义的监听器：

function parseInput(inputText) {
  // 初始化ANTLR的输入流、词法分析器、token流
  const inputStream = new ANTLRInputStream(inputText);
  const lexer = new SomeGrammarLexer(inputStream);
  const tokenStream = new CommonTokenStream(lexer);
  const parser = new SomeGrammarParser(tokenStream);

  // 移除默认的控制台错误监听器
  parser.removeErrorListeners();
  lexer.removeErrorListeners(); // 如果需要捕获词法错误，也要移除lexer的默认监听器

  // 添加自定义错误监听器
  const errorListener = new CustomErrorListener();
  parser.addErrorListener(errorListener);
  lexer.addErrorListener(errorListener); // 同时监听词法错误

  // 调用你的起始解析规则（替换成你语法中实际的入口规则，比如operand或者其他）
  const parseTree = parser.yourStartRule();

  // 返回解析结果和错误列表
  return {
    parseTree: parseTree,
    errors: errorListener.errors
  };
}

// 测试一下，比如输入一个不符合你语法的内容
const testInput = '123.abc'; // 这会触发FLOAT后的语法错误
const result = parseInput(testInput);
console.log('捕获到的所有错误:', result.errors);

上面的例子中，我们同时给lexer也添加了自定义监听器，这样就能捕获词法错误——比如输入了不符合你词法规则的字符（比如@#$%这类既不是ID也不是LITERAL的内容），这时候lexer会生成无效token，自定义监听器也能捕获到这些错误。

如果你的需求不仅仅是捕获错误，还需要让解析器在遇到错误后继续解析后续内容（错误恢复），可以自定义ErrorStrategy：

const { DefaultErrorStrategy } = require('antlr4');

class CustomErrorRecoveryStrategy extends DefaultErrorStrategy {
  recover(recognizer, e) {
    // 先调用默认的恢复逻辑
    super.recover(recognizer, e);
    // 在这里添加你自己的恢复逻辑，比如跳过当前无效token、插入缺失的token等
    console.log('执行自定义错误恢复逻辑');
  }
}

// 在解析器中设置自定义策略
parser.errorHandler = new CustomErrorRecoveryStrategy();

这个方案适合需要容错解析的场景，比如编辑器实时语法检查，即使有错误也要继续解析剩余内容。

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