实现自定义SonarQube规则：检测Java Stream单行多方法调用违规

首先，针对你的需求——识别stream()调用后同一行存在多个链式方法调用的违规情况，SonarQube Java插件提供了一系列AST辅助工具，完全可以替代PMD的节点查找方式，下面一步步帮你解决问题：

一、精准识别stream()方法调用 #

要区分stream()调用和其他方法（包括参数内的调用），你需要从方法名、所属类型、上下文位置三个维度判断，SonarQube的Symbol和TreeUtils类可以帮你快速实现：

1. 筛选stream()方法 #

通过MethodInvocationTree的符号信息，判断方法名是否为stream，且所属类型是Collection（或数组的Arrays.stream()，可按需扩展）：

import org.sonar.java.model.JavaType;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
import org.sonar.plugins.java.api.tree.Tree;

private boolean isStreamInvocation(MethodInvocationTree mit) {
    // 检查方法名是否为"stream"
    if (!"stream".equals(mit.methodName().name())) {
        return false;
    }

    Symbol.MethodSymbol methodSymbol = mit.symbol();
    if (methodSymbol == null) {
        return false;
    }

    // 区分集合的stream()和Arrays.stream()
    String ownerName = methodSymbol.owner().type().fullyQualifiedName();
    return ownerName.equals("java.util.Collection") 
        || ownerName.equals("java.util.Arrays");
}

2. 排除参数内的方法调用 #

要跳过像s -> s.length()这类参数里的方法调用，可以用TreeUtils查找当前节点的祖先是否为参数列表（ArgumentsTree）：

import org.sonar.plugins.java.api.tree.ArgumentsTree;
import org.sonar.plugins.java.api.utils.TreeUtils;

private boolean isInMethodParameter(MethodInvocationTree mit) {
    // 如果当前节点的祖先存在ArgumentsTree，说明在方法参数中
    return TreeUtils.firstAncestorOfType(mit, ArgumentsTree.class) != null;
}

二、检测同一行的链式调用 #

接下来需要判断stream()之后的链式方法是否和它在同一行。SonarQube的Tree节点提供了firstToken()和lastToken()方法，可以获取节点对应的代码行号：

核心逻辑： #

1. 找到合法的stream()调用（非参数内）
2. 追踪后续的链式调用节点（即stream()被作为下一个方法调用的methodSelect）
3. 检查后续调用的起始行是否和stream()的起始行一致

示例代码片段：

import org.sonar.plugins.java.api.tree.MethodSelectTree;
import org.sonar.plugins.java.api.tree.Tree;

@Override
public void visitMethodInvocation(MethodInvocationTree mit) {
    // 先处理当前节点的子节点
    super.visitMethodInvocation(mit);

    // 跳过参数内的调用，且只处理stream()调用的后续链式节点
    if (isInMethodParameter(mit)) {
        return;
    }

    // 检查当前方法调用是否是链式调用中的一环，且上游是stream()
    if (mit.methodSelect().is(Tree.Kind.METHOD_INVOCATION)) {
        MethodInvocationTree upstreamInvocation = (MethodInvocationTree) mit.methodSelect();
        if (isStreamInvocation(upstreamInvocation)) {
            int streamLine = upstreamInvocation.firstToken().line();
            int currentMethodLine = mit.firstToken().line();
            
            // 如果在同一行，触发违规
            if (streamLine == currentMethodLine) {
                reportIssue(mit, "Stream链式调用应每行一个方法，避免与stream()在同一行");
            }
        }
    }
}

三、SonarQube的AST辅助工具说明 #

你提到的PMD风格的节点查找，SonarQube有对应的工具类：

• TreeUtils.firstAncestorOfType(Tree, Class)：查找当前节点的第一个指定类型的祖先节点，对应PMD的getFirstChildOfType反向查找
• TreeUtils.childrenOfType(Tree, Class)：获取当前节点下所有指定类型的子节点
• JavaType类：提供了常用Java类型的常量（如JavaType.Collection），方便快速判断类型归属
• Symbol体系：通过节点的符号信息，可以精准获取方法/类的元数据（所属类、方法签名等）

四、测试用例验证 #

针对你的示例代码：

// BAD CODE:
strings.stream().filter(s -> s.length() > 2).sorted() .map(s -> s.substring(0, 2)).collect(Collectors.toList());

// GOOD CODE:
strings.stream()
.filter(s -> s.length() > 2)
.sorted()
.map(s -> s.substring(0, 2))
.collect(Collectors.toList());

上述规则会触发BAD CODE中的filter、sorted、map节点的违规报告，而GOOD CODE中的每个方法调用都在单独行，不会触发违规。

内容的提问来源于stack exchange，提问作者V. Hunter