SpringBoot项目中如何让SonarQube跳过整个方法的代码覆盖率扫描？

针对你的需求，有几种实用的方式可以排除整个方法的代码覆盖率扫描，以下是具体方案：

1. 使用Jacoco注解（适配多数SpringBoot项目） #

多数集成SonarQube的SpringBoot项目都会通过Jacoco生成覆盖率报告，你可以借助Jacoco的机制排除目标方法：

• 直接用@Generated注解（根据JDK版本选择javax.annotation.Generated或jakarta.annotation.Generated），Jacoco默认会忽略带有该注解的方法：

import jakarta.annotation.Generated;

@Generated("排除覆盖率扫描")
public void yourMethodToExclude() {
    // 方法逻辑
}

• 若不想引入额外依赖，可自定义注解并配置Jacoco排除规则：
  1. 自定义注解：

  public @interface ExcludeFromCoverage {
  }
  

  2. 在pom.xml的Jacoco插件配置中添加排除规则：

  <plugin>
      <groupId>org.jacoco</groupId>
      <artifactId>jacoco-maven-plugin</artifactId>
      <configuration>
          <excludes>
              <exclude>**/*ExcludeFromCoverage*</exclude>
          </excludes>
      </configuration>
  </plugin>
  

  3. 在目标方法上标注自定义注解：

  @ExcludeFromCoverage
  public void yourMethodToExclude() {
      // 方法逻辑
  }
  

2. 用SonarQube的@SuppressWarnings忽略覆盖率问题 #

如果只是不想让SonarQube把该方法的未覆盖代码标记为问题（而非完全不统计覆盖率），可在方法上添加@SuppressWarnings注解，指定对应规则：

@SuppressWarnings("java:S2699")
public void yourMethodToExclude() {
    // 方法逻辑
}

注：java:S2699是SonarQube中「测试应包含断言」的规则，若需精准忽略未覆盖代码，可确认Sonar中对应规则ID后替换；不推荐直接用@SuppressWarnings("all")，会忽略该方法的所有Sonar规则检查。

3. 全局配置文件排除 #

若不想用注解，也可在项目的sonar-project.properties中直接配置排除特定方法：

sonar.coverage.exclusions=**/YourClassName.java#yourMethodToExclude

内容的提问来源于stack exchange，提问作者Jason Chan