时间戳

首页 > 解决方案 > 自定义 SonarQube 规则以识别实例变量

java - 自定义 SonarQube 规则以识别实例变量

问题描述

我正在创建一个自定义 SonarQube 规则来警告包含特定字符串的实例变量名称。似乎Kind.VARIABLE检测到所有变量，包括局部变量。有没有办法只检测和处理实例变量？

标签： javasonarqube

解决方案

为什么不检查Kind父母的？对于实例变量，它应该是CLASS.

禁止实例变量中的字符串的工作规则BLABLA将如下所示。

@Rule(key = "Banned Keyword Rule")
public class BannedKeywordRule extends IssuableSubscriptionVisitor {
    // Define the word to ban
    private static final String BANNED_KEYWORD = "BLABLA";

    @Override
    public List<Tree.Kind> nodesToVisit() {
        //  visit only the variables
        return ImmutableList.of(Tree.Kind.VARIABLE);
    }

    @Override
    public void visitNode(Tree tree) {
        VariableTree variableTree = (VariableTree) tree;
        // check if parent is CLASS aka variable is instance
        if(variableTree.parent().is(Tree.Kind.CLASS) && variableTree.simpleName().name().contains(BANNED_KEYWORD)) {
            reportIssue(variableTree, "String " + BANNED_KEYWORD + " can not be used as a instance variable.");
        }
    }
}

推荐阅读