SonarQube自定义规则扩展：日志方法字符串忽略及AST元素问询

我之前刚好处理过类似的SonarQube Java规则扩展需求，给你梳理下可行的方案和相关细节：

一、Base Visitor Tree（AST）常见元素定义与解析示例 #

SonarJava的AST（Abstract Syntax Tree）基于JavaParser实现，核心节点类型对应Java代码的语法结构，常用的节点和解析示例如下：

核心节点类型 #

• MethodInvocationTree: 对应所有方法调用语句，包含methodSelect（方法选择器，比如实例调用的obj.method或直接调用的method）和arguments（参数列表）。
• MemberSelectTree: 成员选择节点，比如weeLogger.Log中的Log部分，包含expression（左侧的实例/类名）和identifier（方法名标识符）。
• IdentifierTree: 标识符节点，用于表示变量名、方法名、类名等单独的名称。
• LiteralTree: 字面量节点，字符串、数字等字面量都属于这个类型，STRING_LITERAL是我们关注的子类型。

代码解析示例 #

示例1：weeLogger.Log(exception, "exception occurred");

AST结构层级：

CompilationUnitTree
└── ExpressionStatementTree
    └── MethodInvocationTree
        ├── methodSelect: MemberSelectTree
        │   ├── expression: IdentifierTree (weeLogger)
        │   └── identifier: IdentifierTree (Log)
        └── arguments: List<Tree>
            ├── IdentifierTree (exception)
            └── LiteralTree ("exception occurred")

示例2：logger(exception1, "exception occured");

AST结构层级：

CompilationUnitTree
└── ExpressionStatementTree
    └── MethodInvocationTree
        ├── methodSelect: IdentifierTree (logger)
        └── arguments: List<Tree>
            ├── IdentifierTree (exception1)
            └── LiteralTree ("exception occured")

二、从AST中提取方法名的实现方案 #

要准确提取方法名，需要处理两种常见的方法调用场景：实例/类的成员方法调用（如weeLogger.Log）和直接方法调用（如logger，可能是静态导入或本地方法）。以下是具体实现代码：

1. 通用方法名提取工具 #

private String extractMethodName(MethodInvocationTree methodInvocation) {
  Tree methodSelect = methodInvocation.methodSelect();
  // 处理实例/类调用的情况（MemberSelectTree）
  if (methodSelect instanceof MemberSelectTree) {
    return ((MemberSelectTree) methodSelect).identifier().name();
  }
  // 处理直接调用的情况（IdentifierTree）
  else if (methodSelect instanceof IdentifierTree) {
    return ((IdentifierTree) methodSelect).name();
  }
  return "";
}

2. 在StringLiteralDuplicatedCheck中集成方法名判断 #

修改原规则的visitLiteral方法，向上遍历AST找到当前字符串所在的方法调用，判断是否为日志方法后跳过检查：

// 定义需要忽略的日志方法名集合，可根据需求扩展
private static final Set<String> LOG_METHODS = new HashSet<>(Arrays.asList(
    "log", "info", "warn", "error", "debug", "trace"
));

@Override
public void visitLiteral(LiteralTree tree) {
  if (tree.is(Tree.Kind.STRING_LITERAL)) {
    // 向上遍历父节点，找到最近的MethodInvocationTree
    Tree parentNode = tree.parent();
    while (parentNode != null && !(parentNode instanceof MethodInvocationTree)) {
      parentNode = parentNode.parent();
    }
    
    // 如果当前字符串是日志方法的参数，跳过检查
    if (parentNode instanceof MethodInvocationTree) {
      String methodName = extractMethodName((MethodInvocationTree) parentNode);
      if (LOG_METHODS.contains(methodName.toLowerCase())) {
        return;
      }
    }
  }
  // 执行原规则的检查逻辑
  super.visitLiteral(tree);
}

三、调试与验证技巧 #

• AST可视化: 在IDE中调试规则时，可以通过断点查看AST节点的结构，或者使用JavaParser相关插件来可视化AST，辅助理解节点层级。
• 测试用例覆盖: 编写包含不同日志调用场景的测试代码（静态方法、实例方法、静态导入方法等），验证规则是否正确忽略这些场景下的字符串字面量。

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