SonarQube自定义规则开发：如何获取变量的名称与值？

阿华AIGC实验室

2026-5-26

获取Sonar自定义规则中变量的名称与值

嘿，刚上手Sonar自定义规则开发就碰到这个问题太正常啦！我来给你一步步拆解怎么同时拿到变量的名称和对应的值。

首先你得明白，在Sonar的Java AST（抽象语法树）里，变量声明是被封装在VariableTree节点里的——它同时包含了变量的标识符（名称）和初始化表达式（值），这正是你需要的“一站式”节点，而不是单独去抓LiteralTree或IdentifierTree。

具体实现步骤

第一步：在自定义规则的Visitor中监听VariableTree节点，而不是只关注字面量或标识符节点。你可以继承BaseTreeVisitor并实现JavaFileScanner接口，重写visitVariable方法来处理变量声明。
第二步：从VariableTree中提取变量名称：通过variableTree.simpleName()拿到对应的IdentifierTree，再调用getName()就能得到变量名（比如你的示例里的a、b）。
第三步：提取变量的初始化值：variableTree.initializer()会返回变量的初始化表达式（ExpressionTree类型），如果这个表达式是字面量（比如你示例里的字符串），就可以强转为LiteralTree，然后用value()拿到具体的值。

示例代码

下面是一个简化的自定义规则实现，能直接处理你示例中的场景：

import org.sonar.plugins.java.api.tree.VariableTree;
import org.sonar.plugins.java.api.tree.LiteralTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.BaseTreeVisitor;

public class VariableValueCollectorRule extends BaseTreeVisitor implements JavaFileScanner {

    private JavaFileScannerContext context;

    @Override
    public void scanFile(JavaFileScannerContext context) {
        this.context = context;
        scan(context.getTree());
    }

    @Override
    public void visitVariable(VariableTree variableTree) {
        // 获取变量名称
        String variableName = variableTree.simpleName().getName();
        
        // 获取并处理变量初始化值
        ExpressionTree initializerExpr = variableTree.initializer();
        if (initializerExpr != null && initializerExpr.is(LiteralTree.class)) {
            LiteralTree literalValue = (LiteralTree) initializerExpr;
            String variableValue = literalValue.value();
            
            // 这里可以根据需求处理变量名和值，比如上报到Sonar作为规则问题
            // context.reportIssue(this, variableTree.simpleName(), "变量名：" + variableName + "，值：" + variableValue);
            System.out.printf("捕获变量：%s = %s%n", variableName, variableValue);
        }
        
        // 必须调用父类方法，保证AST遍历继续进行
        super.visitVariable(variableTree);
    }
}