开发自定义Sonar插件：能否重写NoSonarFilter实现及方法？

当然可以重写NoSonarFilter的实现啦！在SonarQube的插件生态里，这类核心组件是支持通过依赖注入机制替换默认实现的，我给你拆解下具体操作步骤：

1. 实现自定义的NoSonarFilter类 #

你可以选两种方式：要么直接实现NoSonarFilter接口，要么继承SonarQube提供的DefaultNoSonarFilter（如果只是想扩展原有功能而不是完全重写，继承会更省心）。

举个继承的例子，这里我们重写部分方法添加自定义逻辑：

import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.sensor.issue.NoSonarFilter;
import org.sonar.batch.sensor.issue.DefaultNoSonarFilter;

public class CustomNoSonarFilter extends DefaultNoSonarFilter {

    // 重写添加忽略标记的方法，加入自定义日志或校验
    @Override
    public void addIssue(InputFile inputFile, int line) {
        // 这里可以添加你的自定义逻辑，比如记录哪些文件被标记了NOSONAR
        System.out.println("NOSONAR标记被添加到文件：" + inputFile.relativePath() + "，行号：" + line);
        // 保留原有功能，调用父类方法
        super.addIssue(inputFile, line);
    }

    // 重写判断是否忽略的方法，扩展自定义忽略规则
    @Override
    public boolean isIgnored(InputFile inputFile, int line) {
        // 先获取默认的判断结果
        boolean defaultIgnored = super.isIgnored(inputFile, line);
        // 添加你的自定义判断条件，比如针对特定文件类型或内容的额外忽略规则
        boolean customIgnored = checkCustomIgnoreRule(inputFile, line);
        // 合并结果
        return defaultIgnored || customIgnored;
    }

    // 自定义的忽略规则判断方法
    private boolean checkCustomIgnoreRule(InputFile inputFile, int line) {
        // 示例：如果是test目录下的文件，行号大于100则忽略
        return inputFile.relativePath().startsWith("src/test/") && line > 100;
    }
}

2. 在插件中注册自定义组件 #

SonarQube使用Guice作为依赖注入框架，你需要在插件的主类（实现Plugin接口的类）里，将自定义的CustomNoSonarFilter绑定到NoSonarFilter接口，替换默认实现：

import org.sonar.api.Plugin;
import org.sonar.api.batch.sensor.issue.NoSonarFilter;

public class MyCustomSonarPlugin implements Plugin {
    @Override
    public void define(Context context) {
        // 注册自定义NoSonarFilter，替换默认实现
        context.addExtension(NoSonarFilter.class, CustomNoSonarFilter.class);
        
        // 别忘了注册你的自定义Sensor等其他插件组件
        context.addExtension(MyCustomSensor.class);
    }
}

3. 注意事项 #

• 如果选择完全实现NoSonarFilter接口（而非继承），一定要确保实现所有接口方法，否则SonarQube运行时可能出现功能异常。
• 自定义类如果需要依赖其他Sonar组件（比如FileSystem、Logger等），可以通过构造方法声明这些依赖，Guice会自动完成注入。
• 开发完成后一定要做测试：比如在代码中添加//NOSONAR标记，或者触发你自定义的忽略规则，验证过滤逻辑是否按预期生效。

内容的提问来源于stack exchange，提问作者Vladimir Topolev