自定义SonarQube插件实现NOSONAR功能：抽象类实现与验证疑问

核心结论：必须实现NoSonarFilter的具体子类 #

SonarQube提供的NoSonarFilter是抽象类，仅定义了接口规范，没有内置关键字识别逻辑。要实现自定义语言的NOSONAR功能，你必须创建它的具体实现类，完成含NOSONAR关键字行的识别与注册。

具体实现步骤 #

• 步骤1：编写NoSonarFilter实现类
  继承NoSonarFilter抽象类，重写noSonarInFile方法。在方法里遍历目标文件的所有行，检测是否存在NOSONAR关键字（注意要区分注释和代码字符串，仅处理注释中的关键字，避免误判），把符合条件的行号存入noSonarLines集合。
  示例代码框架：

  public class CustomLangNoSonarFilter extends NoSonarFilter {
    @Override
    public void noSonarInFile(InputFile inputFile, Collection<Integer> noSonarLines) {
      // 读取文件内容，逐行解析注释
      // 识别包含NOSONAR的行，将行号添加到noSonarLines
    }
  }
  

• 步骤2：注册过滤器到插件
  在你的插件主类（实现Plugin接口的类）中，通过Context对象注册自定义过滤器，确保SonarQube分析时能加载到它：

  public class CustomLangPlugin implements Plugin {
    @Override
    public void define(Context context) {
      context.addExtension(CustomLangNoSonarFilter.class);
      // 同时注册你的语言定义、自定义规则等其他扩展
    }
  }
  

• 步骤3：在自定义规则中关联过滤逻辑
  所有自定义规则在上报违规前，都要检查当前行是否在NoSonarFilter的忽略列表里。通过依赖注入获取NoSonarFilter实例，判断行号是否需要跳过：

  public class CustomLangRule extends IssuableSubscriptionVisitor {
    @Inject
    private NoSonarFilter noSonarFilter;
  
    @Override
    public void visitNode(Tree tree) {
      int currentLine = tree.line();
      InputFile currentFile = context().inputFile();
      if (noSonarFilter.hasNoSonarInFile(currentFile, currentLine)) {
        return; // 跳过当前行的违规上报
      }
      // 正常执行规则检查逻辑
    }
  }
  

功能验证方法 #

• 本地单元测试
  编写测试代码：构造包含NOSONAR关键字的测试文件，其中包含会触发自定义规则违规的代码。运行本地分析，查看该违规是否被抑制。
• 调试断点验证
  在自定义过滤器的noSonarInFile方法和规则的visitNode方法中加断点，确认过滤器正确识别了含NOSONAR的行，且规则在对应行跳过了违规上报。
• SonarQube界面验证
  将插件部署到SonarQube服务器，上传测试项目，查看含NOSONAR的代码行是否没有显示违规标记。

内容的提问来源于stack exchange，提问作者Dushyant Aneja