如何在SonarQube中编写自定义规则禁止特定方法调用？

1. 适配开发环境与语言 #

根据你的项目语言（以下以Java为例），使用SonarQube官方提供的自定义规则SDK开发。提前准备JDK、Maven/Gradle，以及对应语言的Sonar插件依赖。

2. 初始化规则项目 #

创建一个Maven项目，在pom.xml中引入SonarJava插件及规则开发相关依赖，比如sonar-java-plugin、sonar-plugin-api，确保依赖版本与你的SonarQube服务器版本兼容。

3. 编写规则检测逻辑 #

创建规则类，继承JavaFileScanner并实现Check接口，通过语法节点扫描识别目标方法调用：

import org.sonar.check.Rule;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
import org.sonar.plugins.java.api.tree.Tree;

@Rule(key = "AvoidMet3Invocation", 
      name = "禁止调用Class A的met3方法", 
      description = "调用Class A的met3方法不符合规范，请使用met1或met2替代")
public class AvoidMet3InvocationRule implements JavaFileScanner {

    @Override
    public void scanFile(JavaFileScannerContext context) {
        // 注册方法调用节点的扫描逻辑
        context.registerSyntaxNodeConsumer(Tree.Kind.METHOD_INVOCATION, this::checkTargetMethod);
    }

    private void checkTargetMethod(MethodInvocationTree tree) {
        // 校验调用的方法所属类为A，且方法名为met3
        String className = tree.methodSelect().symbol().owner().name();
        String methodName = tree.methodSelect().symbol().name();
        if ("A".equals(className) && "met3".equals(methodName)) {
            // 触发违规提示
            context.reportIssue(this, tree, "禁止调用Class A的met3方法，请替换为合规方法");
        }
    }
}

4. 配置插件元数据 #

在src/main/resources/sonar-plugin.properties中配置插件基础信息：

sonar.plugin.name=Custom Rule Plugin
sonar.plugin.description=自定义规则插件，用于检测Class A的met3方法调用
sonar.plugin.version=1.0
sonar.java.checks=com.your.package.AvoidMet3InvocationRule

5. 打包部署插件 #

执行mvn clean package生成插件jar包，将jar包放入SonarQube服务器的extensions/plugins目录，重启SonarQube服务。

6. 启用规则并扫描 #

在SonarQube的项目质量配置中，找到你创建的AvoidMet3Invocation规则，将其加入活跃规则集。之后运行Sonar扫描时，代码中所有调用A类met3方法的位置都会被标记为不合规项。

内容的提问来源于stack exchange，提问作者sameer kr bhardwaj