如何为ANTLR4 Visitor的所有visit方法定义通用行为以避免重复代码？

方法一：基于类继承的前置注入（推荐） #

ANTLR生成的TypeScript代码中，VisitorInterface对应有一个抽象实现类AbstractParseTreeVisitor。你可以先创建一个通用基类，在这个基类里重写核心的visit方法，把通用行为逻辑注入进去，再让业务Visitor继承这个基类即可。

具体实现：

1. 编写通用基类：

import { AbstractParseTreeVisitor, ParseNode } from 'antlr4ts';

export abstract class BaseVisitor<T> extends AbstractParseTreeVisitor<T> {
  // 重写ANTLR的核心visit方法，统一注入通用行为
  override visit(node: ParseNode): T {
    // 先执行通用逻辑
    this.sharedBehaviour(node);
    // 再调用原有的visit调度逻辑（自动分发到对应visitX方法）
    return super.visit(node);
  }

  // 定义通用行为方法
  protected sharedBehaviour(ctx: ParseNode) {
    // 这里写你的通用处理逻辑
    console.log(`进入节点: ${ctx.constructor.name}`);
  }
}

2. 业务Visitor继承该基类，只需实现专属逻辑：

import { LostContext, JackContext, KateContext } from './YourGrammarParser';
import { BaseVisitor } from './BaseVisitor';

export default class MyVisitor extends BaseVisitor<void> {
  visitLost(ctx: LostContext) {
    // 仅写Lost节点的专属处理，通用行为已自动执行
    console.log('处理Lost节点');
  }

  visitJack(ctx: JackContext) {
    console.log('处理Jack节点');
  }

  visitKate(ctx: KateContext) {
    console.log('处理Kate节点');
  }
}

这种方式完全基于TypeScript类继承特性，不需要修改ANTLR生成的代码，类型安全且逻辑清晰。

方法二：用Proxy动态拦截visit方法 #

如果不想改动原有Visitor的继承结构，可以用TypeScript的Proxy特性，动态给所有visitX方法加上前置通用逻辑：

import { ParseNode } from 'antlr4ts';
import MyVisitor from './MyVisitor';

function wrapVisitorWithSharedBehaviour(): MyVisitor {
  const rawVisitor = new MyVisitor();
  const sharedFn = rawVisitor.sharedBehaviour.bind(rawVisitor);

  return new Proxy(rawVisitor, {
    get(target, prop: string) {
      // 匹配所有以visit开头的方法
      if (prop.startsWith('visit') && typeof target[prop] === 'function') {
        return function(ctx: ParseNode) {
          // 先执行通用行为
          sharedFn(ctx);
          // 再执行原方法逻辑
          return target[prop](ctx);
        };
      }
      return target[prop];
    }
  });
}

// 使用时用包装后的实例
const visitor = wrapVisitorWithSharedBehaviour();

这种方式无需修改原Visitor类，通过动态代理实现逻辑注入，适合临时添加通用行为的场景。

注意事项 #

• 方法一的优势是IDE支持完善、类型检查严格；方法二更灵活，对原有代码侵入性为零。
• 两种方案都不需要修改ANTLR的代码生成逻辑，完全符合你的需求。

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