如何将自定义Gradle插件放在另一个项目构建类路径上？

Question

我有一个发布的gradle插件，看起来像这样：

|__root
|     |
|     |
|     |__java
|     |    |__SomeJavaClass.java
|     |    |__SomeJavaClass2.java
|     |
|     |__kotlin
|          |__MyPluginClass.kts
|          |__MyTaskClass.kts
|          |__Utils.kts   

我想将这个插件作为一个项目包含在我的多项目构建中，而不是将其发布到repo以便于开发。

这个插件有3个项目A正在使用的静态编程语言文件。MyPluginClass.kts有我自己的插件类，MyTaskClass.kts有我自己的任务类，Utils.kts只包含kotlin函数。java类用于MyPlugin和MyTask。

它被放在项目A的build.gradle.kts类路径上

classpath("com.my:custom.plugin:version")

我希望实现一个非常简化的项目结构：

root
| 
|__Project A
|     |
|     |__build.gradle.kts
|     |__x.gradle.kts
|     |__y.gradle.kts
|     |__settings.gradle
|
|__Project build-logic
|     |
|     |__build.gradle.kts
|     |
|     |__java
|     |    |__SomeJavaClass.java
|     |    |__SomeJavaClass2.java
|     |
|     |__kotlin
|          |__MyPluginClass.gradle.kts
|          |__MyTaskClass.gradle.kts
|          |__Utils.gradle.kts   

我正在尝试从这些kotlin文件创建插件并将它们包含在我的主构建中，因为我需要它们预编译，但是当build.gradle在那里运行时，我似乎找不到一种方法将它们放在Project A的类路径上。这可能吗？什么是正确的解决方案？

我用的是gradle 7.3

Answer 1

您可以使用复合构建组合多个独立的Gradle项目。Gradle插件也是如此。

包括来自另一个目录的Gradle插件在测试Gradle插件部分中有记录。

因此，如果您有一个共享构建逻辑项目，该项目提供了一个ID为my的Gradle插件。共享构建逻辑，您希望在project-a中使用它。

my-projects/
├── shared-build-logic/
│   ├── src/
│   │   └── ...
│   ├── build.gradle.kts
│   └── settings.gradle.kts
└── project-a/
    ├── src/
    │   └── ...
    ├── build.gradle.kts
    └── settings.gradle.kts

然后，您需要在您的Project-aGradle设置文件中包含shared-build-gic。

// my-projects/project-a/settings.gradle.kts

rootProject.name = "project-a"

pluginManagement {
  includeBuild("../shared-build-logic")
}

现在，只要shading-build-logic正确提供了Gradle插件，在Project-a中您就可以引用该插件。

// my-projects/project-a/settings.gradle.kts

plugins {
  id("my.shared-build-logic")
}