如何在 buildSrc kotlin 文件中配置 Jib 扩展？答案

【问题标题】：How can I configure the Jib Extension inside a buildSrc kotlin file?如何在 buildSrc kotlin 文件中配置 Jib 扩展？
【发布时间】：2020-03-04 14:55:01
【问题描述】：

我正在尝试模块化我的build.gradle.kts。有人建议我创建一个buildSrc 文件夹。经过一些研究和一些询问后，我找到了这篇文章I hated Gradle!...，所以这是我的尝试：

buildSrc树：

buildSrc/
├── build.gradle.kts
├── settings.gradle.kts
└── src
    └── main
        ├── kotlin
        │   ├── Docker.kt
        │   ├── MyProjectExtensions.kt
        │   └── Versions.kt
        └── resources
            └── META-INF
                └── gradle-plugins
                    └── pt.branden.brandenportal.properties

我的build.gradle.kts：

plugins {
    `kotlin-dsl`
    id("com.google.cloud.tools.jib") version Versions.jib
}

repositories {
    mavenCentral()
    google()
    jcenter()
}

dependencies {
    implementation("gradle.plugin.com.google.cloud.tools:jib-gradle-plugin:${Versions.jib}")
    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.50")
    implementation(gradleApi())
    implementation(localGroovy())
}

最后是Docker.kt：

import org.gradle.api.Plugin
import org.gradle.api.Project


open class JibConfigPlugin : Plugin<Project> {
    override fun apply(target: Project) {
        //configureJib()
        TODO("not implemented")
    }

}

//internal fun Project.configureJib() = this.extensions.getByType<JibExtension>().run {}
internal fun Project.configureJib() = project.configure<JibExtension>() {
  TODO("not implemented")
}

我的问题是我找不到JibExtension，所以当我尝试实现和配置Jib 时它不起作用，但在build.gradle.kts 中一切正常。

【问题讨论】：

我虽然有正确的dependencyNotation，但不幸的是没有。所以我的问题是我怎样才能找到正确的dependencyNotation来放入实现函数？

标签： gradle kotlin jib

【解决方案1】：

我的问题是我找不到JibExtension

插件或扩展可以以多种不同的方式应用。您可以使用PluginManager 的withPlugin 方法对正在应用的插件“做出反应”：

class JibConfigPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        project.pluginManager.withPlugin("com.google.cloud.tools.jib") {
            // Configuration happens inside this Action block.
        }
    }
}

使用此方法，您可以确定插件存在/已被应用，而无需强制用户/项目使用该插件。

Jib 插件提供单个扩展和多种任务。

可以通过以下方式配置扩展：

class JibConfigPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        project.pluginManager.withPlugin("com.google.cloud.tools.jib") {
           project.extensions.configure<JibExtension> {
                // Example configuring the `container`
                container {
                    creationTime = "USE_CURRENT_TIMESTAMP"
                }
           }
        }
    }
}

查看 Jib 的 Gradle 插件的 the source，作者使用 lazy configuration 执行任务，因此最好也使用相同的方法来配置这些任务。

例如配置jib任务：

class JibConfigPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        project.pluginManager.withPlugin("com.google.cloud.tools.jib") {
            project.tasks.named<BuildImageTask>("jib") {
                to {
                    setTargetImage("my_acr_name.azurecr.io/my-app")
                }
            }
        }
    }
}

上面使用了named方法，它返回一个TaskProvider

然后只需按照此处记录的方式应用您的插件：https://guides.gradle.org/writing-gradle-plugins/#apply_the_plugin_to_the_host_project

我曾经测试过的build.gradle.kts的来源：

plugins {
    `kotlin-dsl`
}

repositories {
    gradlePluginPortal()
}

dependencies {
    implementation("gradle.plugin.com.google.cloud.tools:jib-gradle-plugin:1.7.0")
}

【讨论】：