IntelliJ PSI 元素遍历：JavaRecursiveElementVisitor 与 XmlRecursiveElementVisitor 的 5 个核心用例

IntelliJ PSI 元素遍历：JavaRecursiveElementVisitor 与 XmlRecursiveElementVisitor 的 5 个核心用例

在 IntelliJ 平台插件开发中，PSI（Program Structure Interface）是理解代码结构的关键。作为程序结构接口，PSI 将源代码解析为结构化元素树，而访问者模式（Visitor Pattern）则是遍历和操作这些元素的核心机制。本文将深入探讨两种重要的递归访问者实现：JavaRecursiveElementVisitor和XmlRecursiveElementVisitor，并通过 5 个典型场景展示它们的强大能力。

1. 理解访问者模式在 PSI 中的应用

访问者模式是处理复杂对象结构的经典设计模式，特别适合像 PSI 这样具有多层次嵌套结构的场景。IntelliJ 平台为不同语言提供了专门的 Visitor 实现：

• JavaRecursiveElementVisitor：专为 Java 代码设计，能遍历类、方法、字段等所有 Java 元素
• XmlRecursiveElementVisitor：用于 XML 文件处理，可访问标签、属性等 XML 特有元素

这两种访问者都继承自PsiRecursiveElementVisitor，采用深度优先算法遍历整个 PSI 树。与基础 Visitor 不同，递归访问者会自动遍历子元素，开发者只需重写关心的节点类型处理方法。

// 基础使用模板 psiFile.accept(new JavaRecursiveElementVisitor() { @Override public void visitMethod(PsiMethod method) { // 处理每个方法 super.visitMethod(method); } });

2. Java 代码分析与增强

2.1 方法级代码扫描

通过重写visitMethod，我们可以实现各种方法级别的分析。以下示例展示如何收集所有方法及其参数信息：

public class MethodCollector extends JavaRecursiveElementVisitor { private final List<MethodInfo> methods = new ArrayList<>(); @Override public void visitMethod(PsiMethod method) { MethodInfo info = new MethodInfo(); info.name = method.getName(); info.returnType = method.getReturnType().getPresentableText(); Arrays.stream(method.getParameterList().getParameters()) .forEach(p -> info.params.add(p.getText())); methods.add(info); super.visitMethod(method); } // 使用方法 // MethodCollector collector = new MethodCollector(); // psiFile.accept(collector); // List<MethodInfo> results = collector.getMethods(); }

2.2 注解处理器

注解处理是插件开发的常见需求。下面的代码演示如何查找特定注解并提取其属性：

@Override public void visitAnnotation(PsiAnnotation annotation) { if ("@MyCustomAnnotation".equals(annotation.getQualifiedName())) { PsiNameValuePair[] attributes = annotation.getParameterList().getAttributes(); // 处理注解属性 } super.visitAnnotation(annotation); }

典型应用场景对比：

3. XML 文件深度处理

3.1 MyBatis Mapper 文件分析

对于 MyBatis 插件开发，解析 Mapper XML 是核心功能。以下代码展示如何建立 Java 方法与 SQL 语句的关联：

xmlFile.accept(new XmlRecursiveElementVisitor() { @Override public void visitXmlTag(XmlTag tag) { if ("select|insert|update|delete".contains(tag.getName())) { String id = tag.getAttributeValue("id"); String namespace = ((XmlTag)tag.getParent()).getAttributeValue("namespace"); // 建立方法全限定名：namespace + "." + id } super.visitXmlTag(tag); } });

3.2 动态 SQL 片段提取

MyBatis 的动态 SQL 是复杂功能，需要特殊处理：

@Override public void visitXmlTag(XmlTag tag) { if ("if|foreach|choose|when|otherwise".contains(tag.getName())) { String test = tag.getAttributeValue("test"); // 分析条件表达式 } super.visitXmlTag(tag); }

4. 跨语言元素关联

4.1 Java 与 XML 双向导航

实现 Java 方法与 Mapper XML 的跳转是 MyBatis 插件的核心价值。关键步骤包括：

1. Java 侧处理：

// 在JavaRecursiveElementVisitor中 @Override public void visitMethodCallExpression(PsiMethodCallExpression expression) { PsiMethod method = expression.resolveMethod(); if (isMapperMethod(method)) { // 记录方法调用位置 } super.visitMethodCallExpression(expression); }

2. XML 侧匹配：

// 在XmlRecursiveElementVisitor中 @Override public void visitXmlAttribute(XmlAttribute attribute) { if ("id".equals(attribute.getName())) { String methodName = attribute.getValue(); // 与Java方法名匹配 } super.visitXmlAttribute(attribute); }

4.2 元素关系验证

确保 Java 接口与 XML 配置的一致性：

public void verifyMapperConsistency(PsiJavaFile javaFile, XmlFile xmlFile) { // 收集Java接口方法 MethodCollector javaCollector = new MethodCollector(); javaFile.accept(javaCollector); // 收集XML语句ID XmlIdCollector xmlCollector = new XmlIdCollector(); xmlFile.accept(xmlCollector); // 对比两个集合找出差异 validateMethodMapping(javaCollector.getMethods(), xmlCollector.getIds()); }

5. 高级应用技巧

5.1 PSI 修改与代码生成

访问者不仅能分析代码，还能修改 PSI 树。以下是添加方法注释的示例：

@Override public void visitMethod(PsiMethod method) { if (method.getDocComment() == null) { PsiElementFactory factory = JavaPsiFacade.getElementFactory(project); PsiComment comment = factory.createCommentFromText("/**\n * 自动生成的方法注释\n */", method); method.addBefore(comment, method.getFirstChild()); } super.visitMethod(method); }

注意：PSI 修改必须放在 WriteCommandAction 中执行：

WriteCommandAction.runWriteCommandAction(project, () -> { psiFile.accept(visitor); });

5.2 性能优化策略

处理大型项目时，Visitor 性能至关重要：

1. 选择性访问：只重写需要的 visit 方法
2. 提前终止：在合适时机返回不再继续遍历
3. 缓存机制：对重复使用的信息建立缓存
4. 并行处理：对独立文件采用多线程分析

访问者模式性能对比：

掌握 JavaRecursiveElementVisitor 和 XmlRecursiveElementVisitor 的高级用法，能够帮助开发者构建出更强大、更智能的 IntelliJ 平台插件。无论是代码分析、重构辅助，还是跨语言关联，这两种访问者实现都是不可或缺的核心工具。