如何在单个Jenkins任务中配置多Maven模块独立SonarQube分析

这个需求我之前帮团队落地过，核心思路就是把原来的「整项目合并扫描」改成「逐个模块单独执行Sonar扫描」，让每个模块都被SonarQube识别为独立项目。具体步骤如下：

1. 先清理全局合并配置 #

首先得把原来导致所有模块合并成一个Sonar项目的配置删掉：

• 移除父项目中sonar-project.properties文件里的sonar.modules=module1,module2这一行，这个配置是用来告诉Sonar把这些模块当成一个大项目的子模块的。
• 如果父pom.xml里也配置了Sonar的继承属性（比如<sonar.sources>src</sonar.sources>），可以考虑把这些配置移到每个子模块的pom里，或者后续用命令行参数覆盖，确保每个模块的扫描配置完全独立。

2. 在Jenkins任务中遍历模块单独扫描 #

因为要在单个Jenkins任务里完成，我们可以用Shell脚本（Windows环境用批处理）遍历每个模块目录，针对每个模块单独执行SonarQube的Maven扫描命令，并且指定专属的项目Key、名称。

举个Shell脚本的例子：

# 遍历所有需要单独扫描的模块
for module in module1 module2; do
  # 进入模块目录，失败则退出任务
  cd "${module}" || exit 1
  
  # 执行Maven清理、验证，然后启动Sonar扫描
  mvn clean verify sonar:sonar \
    -Dsonar.projectKey=org.mycompany.myproject.${module} \
    -Dsonar.projectName="My Project - ${module}" \
    -Dsonar.projectVersion=1.0 \
    -Dsonar.host.url=${SONAR_HOST_URL} \
    -Dsonar.login=${SONAR_TOKEN}
  
  # 返回父项目目录
  cd ..
done

这里的关键是每个模块单独执行sonar:sonar目标，并且通过-D参数指定了独立的sonar.projectKey（这是SonarQube区分项目的唯一标识）和sonar.projectName，这样每个模块扫描完成后，SonarQube里就会出现对应的独立项目。

3. 可选：子模块pom.xml预配置Sonar属性 #

如果不想在命令行写一大堆参数，可以把每个模块的Sonar专属配置放到子模块的pom.xml里，这样脚本会更简洁。比如在module1的pom.xml里添加：

<build>
  <plugins>
    <plugin>
      <groupId>org.sonarsource.scanner.maven</groupId>
      <artifactId>sonar-maven-plugin</artifactId>
      <version>3.10.0.2594</version> <!-- 建议使用最新稳定版本 -->
      <configuration>
        <sonar.projectKey>org.mycompany.myproject.module1</sonar.projectKey>
        <sonar.projectName>My Project - Module 1</sonar.projectName>
      </configuration>
    </plugin>
  </plugins>
</build>

对应的Jenkins脚本就可以简化成：

for module in module1 module2; do
  cd "${module}" || exit 1
  mvn clean verify sonar:sonar \
    -Dsonar.projectVersion=1.0 \
    -Dsonar.host.url=${SONAR_HOST_URL} \
    -Dsonar.login=${SONAR_TOKEN}
  cd ..
done

这种方式的好处是Sonar配置和模块代码绑定，后续修改模块名称或者Key时，直接改pom就行，不用动Jenkins脚本。

4. Jenkins任务的关键注意事项 #

• Sonar变量配置：确保Jenkins全局配置里已经设置了SONAR_HOST_URL和SONAR_TOKEN这两个环境变量（可以通过Jenkins的「凭据管理」存储token，然后在任务里引用），避免硬编码敏感信息。
• 失败处理：脚本里的|| exit 1是为了如果某个模块扫描失败，整个任务就停止；如果希望某个模块失败后其他模块继续扫描，可以把这部分改成|| continue。
• Maven环境：Jenkins任务要选择正确的Maven安装版本，确保Sonar Maven插件能正常运行。

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