如何从Gradle项目中获取sonar-project.properties所需配置信息

Hey there! 很高兴能帮你搞定Gradle项目的适配工作——毕竟从Maven转Gradle确实得摸清楚它的配置逻辑，我来一步步给你拆解怎么获取SonarQube需要的那些关键信息～

一、先搞懂Gradle项目的核心配置文件 #

Gradle和Maven不一样，它的配置更灵活：

• 单模块项目：核心是根目录的build.gradle（Groovy DSL）或build.gradle.kts（Kotlin DSL）
• 多模块项目：除了每个子模块的build.gradle，根目录的settings.gradle（或settings.gradle.kts）负责定义所有子模块

接下来分点讲你需要的两个核心信息：

二、获取多模块项目的sonar.modules #

SonarQube的sonar.modules对应Gradle里的子模块列表，获取方式有两种，推荐第二种更可靠：

方式1：解析settings.gradle文件（简单但易出错） #

多模块的settings.gradle里一定会有include语句，比如：

include ':module-a', ':module-b', ':module-c'

你可以通过读取文件内容，用正则匹配提取模块名：

• 匹配include\s*(.*)的内容，然后去掉引号、冒号，拆分逗号分隔的项
• 比如:module-a要转换成module-a（SonarQube需要相对路径格式）

但这种方式怕遇到复杂配置（比如动态生成模块名的情况），所以更推荐下面的方式。

方式2：用Gradle Tooling API（官方推荐，稳定可靠） #

Gradle提供了Tooling API，可以让Java程序直接和Gradle项目交互，获取标准化的模型信息，避免解析配置文件的麻烦。

示例代码片段（Java）：

import org.gradle.tooling.GradleConnector;
import org.gradle.tooling.ProjectConnection;
import org.gradle.tooling.model.GradleProject;

import java.io.File;
import java.util.List;
import java.util.stream.Collectors;

public class GradleModuleExtractor {
    public List<String> getSonarModules(File gradleRootDir) {
        try (ProjectConnection connection = GradleConnector.newConnector()
                .forProjectDirectory(gradleRootDir)
                .connect()) {
            // 获取根项目模型，拿到所有子模块
            GradleProject rootProject = connection.getModel(GradleProject.class);
            return rootProject.getChildren().stream()
                    .map(GradleProject::getName) // 直接拿到模块名，不用处理冒号
                    .collect(Collectors.toList());
        } catch (Exception e) {
            throw new RuntimeException("Failed to extract Gradle modules", e);
        }
    }
}

拿到列表后，直接用逗号拼接就是sonar.modules的值。

三、获取源代码目录sonar.sources和测试目录sonar.tests #

Gradle的源代码目录可以自定义，但Java插件有默认值（src/main/java、src/test/java），用Tooling API可以准确获取实际配置的目录：

示例代码（获取单个模块的源代码目录） #

import org.gradle.tooling.model.java.JavaProject;
import org.gradle.tooling.model.java.SourceSet;

import java.io.File;
import java.util.List;
import java.util.stream.Collectors;

public class GradleSourceDirExtractor {
    public List<String> getMainSourceDirs(File gradleRootDir, String modulePath) {
        try (ProjectConnection connection = GradleConnector.newConnector()
                .forProjectDirectory(gradleRootDir)
                .connect()) {
            // 获取指定模块的Java项目模型
            JavaProject javaProject = connection.getModel(JavaProject.class, modulePath);
            // 找到main源码集
            SourceSet mainSourceSet = javaProject.getSourceSets().stream()
                    .filter(set -> set.getName().equals("main"))
                    .findFirst()
                    .orElseThrow(() -> new RuntimeException("No main source set found"));
            // 转换为相对于项目根目录的路径（Sonar需要相对路径）
            return mainSourceSet.getAllJava().getSrcDirs().stream()
                    .map(File::getAbsolutePath)
                    .map(absPath -> absPath.replace(gradleRootDir.getAbsolutePath() + File.separator, ""))
                    .collect(Collectors.toList());
        } catch (Exception e) {
            throw new RuntimeException("Failed to extract source directories", e);
        }
    }
}

• 测试目录的话，只需要把main换成test即可
• 拿到目录列表后，逗号拼接就是对应模块的{moduleName}.sonar.sources或{moduleName}.sonar.tests的值

四、整合到你的Java应用的注意事项 #

1. 引入Gradle Tooling API依赖
   如果你的应用是Maven管理的，需要在pom.xml里加：

   <dependency>
       <groupId>org.gradle</groupId>
       <artifactId>gradle-tooling-api</artifactId>
       <version>7.6</version> <!-- 选择兼容主流Gradle版本的号，比如7.x或8.x -->
       <scope>runtime</scope>
   </dependency>
   

2. 处理Gradle版本兼容性
   Tooling API会自动下载对应项目的Gradle版本（如果本地没有），可以通过connector.useGradleVersion("x.x.x")指定版本，避免自动下载的开销
3. 非Java项目的兼容
   如果遇到没有应用Java插件的Gradle项目（比如纯Kotlin、Groovy项目），需要调整获取源码集的逻辑，先判断插件是否存在

如果还有具体的问题，比如处理特殊的Gradle配置（比如动态生成的源码目录），或者整合到现有代码时遇到报错，随时补充细节就好～

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