SonarQube多模块Java项目缺失类警告的高效解决咨询

问题背景 #

你有一个包含近100个相互依赖模块的Java项目，使用SonarQube 7.1和SonarQube Scanner 2.6.1进行代码分析，当前的简化配置如下：

sonar.java.binaries=classes
sonar.java.test.binaries=classes
sonar.java.libraries=../**/*.jar, ../../**/*.jar, ../../../**/*.jar
sonar.java.test.libraries=../**/*.jar, ../../**/*.jar, ../../../**/*.jar
sonar.tests=testsrc
sonar.sources=src
sonar.modules=moduleA, moduleB, moduleC
moduleA.sonar.projectBaseDir=project/moduleA
moduleB.sonar.projectBaseDir=project/subfolder/moduleB
moduleC.sonar.projectBaseDir=project/subfolder/anothersubfolder/moduleC

分析时收到了类缺失的警告：

The following classes needed for analysis were missing:
....
....

你尝试手动给每个模块添加依赖模块的二进制文件夹（比如moduleA.sonar.java.binaries=classes, ../subfolder/moduleB/classes, ../subfolder/anothersubfolder/moduleC）解决了问题，但模块数量太多，手动配置不现实。

问题根源 #

你的核心问题在于全局配置的二进制文件路径没有覆盖跨模块的依赖编译产物：

• 全局的sonar.java.binaries和sonar.java.test.binaries仅设置为classes，这只会扫描当前模块目录下的classes文件夹，而其他依赖模块的classes文件夹在不同的子目录中，SonarQube不会自动跨模块识别这些路径。
• 你配置的sonar.java.libraries仅匹配jar文件，但项目内模块的依赖如果是未打包的class文件（直接依赖其他模块的编译产物），并不会被libraries参数识别，因为这个参数针对的是jar/zip等库文件，而binaries才是指定class文件目录的参数。

解决方案 #

方案1：用通配符自动匹配所有依赖模块的classes目录

不需要手动逐个添加依赖模块路径，只需要修改全局的二进制文件配置，利用递归通配符**自动扫描所有上级目录下的classes文件夹：

sonar.java.binaries=classes, ../**/classes
sonar.java.test.binaries=classes, ../**/classes

每个模块的projectBaseDir是各自的根目录，../**/classes会从当前模块目录开始，向上递归查找所有层级下的classes文件夹，自动涵盖所有依赖模块的编译产物，完美适配多模块嵌套的目录结构。

方案2：切换到SonarQube Scanner for Maven（推荐）

如果你的项目是用Maven管理的，强烈建议使用SonarQube Scanner for Maven，它会自动识别Maven多模块的依赖关系、编译产物路径、源码路径等，完全不需要手动配置sonar.java.binaries、sonar.java.libraries这些参数。

只需要在父pom.xml中添加SonarQube的配置（或者直接在命令行指定参数），然后运行：

mvn clean install sonar:sonar

这个命令会先编译所有模块，再自动完成SonarQube分析，彻底避免手动配置路径的繁琐和错误，对于100个模块的项目来说，这是最省心的解决方案。

额外注意事项

• 确保在运行SonarQube扫描前，所有模块都已经完成编译，生成了对应的classes文件，否则即使路径配置正确，也会出现类缺失的警告。
• 如果你使用Gradle管理项目，也可以使用SonarQube Scanner for Gradle，同样能自动处理多模块依赖路径。

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