使用 Gradle Kotlin DSL 添加新 SourceSet

1. 简介

在实际的 Kotlin 项目开发中，我们经常需要引入新的源码目录或源集（SourceSet）来更好地组织代码结构。Gradle 的 Kotlin DSL 提供了简洁且类型安全的方式来完成这一目标。

本文将介绍如何使用 Kotlin DSL 在 Gradle 构建的 Kotlin 项目中添加新的 SourceSet。通过这种方式，我们可以更高效地管理代码与依赖，提升项目的模块化与可维护性。

2. 创建新的 SourceSet

在 Gradle 中，SourceSet 是 Java 插件提供的一个核心概念，它允许我们定义不同的源码集合。通过创建新的 SourceSet，我们可以将相关代码和资源文件组织在一起，实现逻辑上的隔离。

下面是一个使用 Kotlin DSL 创建新 SourceSet 的示例：

plugins {
    java
}

sourceSets {
    create("analytics") {
        java.srcDir("src/analytics/java")
        java.srcDir("src/analytics/kotlin")
        resources.srcDir("src/analytics/resources")
    }
}

上面的代码中，我们创建了一个名为 analytics 的 SourceSet，并指定了 Java 源码目录、Kotlin 源码目录以及资源文件目录。这样，我们可以将与 analytics 相关的代码独立出来，便于管理。

✅ 推荐做法：为不同功能模块划分独立的 SourceSet，有助于后期维护和测试分离。

3. 配置 SourceSet 的依赖

创建完 SourceSet 后，我们通常需要为其添加特定的依赖项。可以通过 dependencies 块来完成。

3.1 显式指定 SourceSet 并添加依赖

dependencies {
    sourceSets.named("analytics") {
        implementation("org.apache.commons:commons-lang3:3.12.0")
    }
}

这段代码通过 sourceSets.named("analytics") 明确地获取了 analytics 这个 SourceSet，并为其添加了一个依赖。

3.2 使用自动生成的依赖配置方法

Gradle Kotlin DSL 提供了一种更简洁的方式：它会为每个 SourceSet 自动生成对应的依赖配置函数。比如，我们可以这样写：

dependencies {
    "analyticsImplementation"("org.apache.commons:commons-math3:3.6.1")
}

⚠️ 注意：这里的 analyticsImplementation 是 Gradle 自动生成的方法名，命名规则为 <sourceSetName>Implementation。

使用这种方式可以避免手动调用 named()，让代码更简洁，也更容易阅读。

🔗 了解更多 Gradle 依赖配置类型

4. 使用新 SourceSet

除了配置依赖，我们还可以将新创建的 SourceSet 作为依赖项引入到主程序中。例如：

plugins {
    java
    application
    kotlin("jvm") version "1.8.22"
}

sourceSets {
    create("analytics") {
        java.srcDir("src/analytics/java")
        java.srcDir("src/analytics/kotlin")
        resources.srcDir("src/analytics/resources")
    }
}

dependencies {
    implementation(sourceSets.named("analytics").get().output)
}

application {
    mainClass.set("com.baeldung.SampleKt")
    applicationDefaultJvmArgs = listOf("-Dconfig.file=analytics.conf")
}

在这个例子中，我们通过 implementation(sourceSets.named("analytics").get().output) 将 analytics SourceSet 的编译输出作为依赖引入，这样主程序就可以直接使用其中的类和资源。

此外，我们还配置了应用程序的入口类和 JVM 参数，使得整个项目可以顺利运行。

5. 小结

通过本文的介绍，我们学习了如何使用 Gradle Kotlin DSL 在 Kotlin 项目中添加新的 SourceSet，包括：

创建新的 SourceSet 并指定源码目录
为 SourceSet 添加依赖
使用自动生成的依赖配置方法简化代码
将 SourceSet 引入主程序作为依赖

这种方式不仅提升了项目的模块化程度，也使得代码结构更清晰、维护更方便。

✅ 建议：对于大型项目，合理划分 SourceSet 可以有效隔离业务模块，避免代码混乱。

如需进一步了解 Gradle 构建配置，推荐阅读：Gradle 构建最佳实践

Persistence

REST

Security