如何使用Kotlin DSL配置AppEngine Gradle插件

Question

如https://cloud.google.com/appengine/docs/standard/java/tools/gradle-reference上所述，AppEngine Gradle插件提供如下配置：

appengine {  // App Engine tasks configuration
  run {      // local (dev_appserver) configuration (standard environments only)
    port = 8080                 // default
  }

  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}

使用时，这样的配置应该如何build.gradlke.kts？

我当时在看AppEngine任务，但不知道将其连接到正确的Kotlin DSL设置。

编辑

当简单地将以上代码块添加到build.gradle.ktsIntelliJ时，会抱怨：

• 未解决的参考：端口
• 未解决的参考：部署

当从cml运行Gradle时我得到：

无法打开缓存目录azhqxsd1d4xoovq4o5dzec6iw（/Users/test/.gradle/caches/4.5/gradle-kotlin-dsl/azhqxsd1d4xoovq4o5dzec6iw）。内部错误：无法编译脚本，请参阅日志以获取详细信息

编辑2

在下面添加了plugins和buildscript块：

val kotlinVersion                    = property("kotlin.version")
val javaVersion                      = "1.8"

buildscript {
    repositories {
        jcenter()
        mavenCentral()
        mavenLocal()
        maven("https://plugins.gradle.org/m2/")
        maven("https://repo.spring.io/milestone")
        maven("https://repo.spring.io/snapshot")
    }
    dependencies {
        classpath("com.google.cloud.tools:appengine-gradle-plugin:1.3.4")
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.0.BUILD-SNAPSHOT")
    }
}

apply {
    plugin("com.google.cloud.tools.appengine")
    plugin("org.springframework.boot")
}

plugins {
    val kotlinVersion = "1.2.0"
    `war`
    `idea`
    id("org.jetbrains.kotlin.jvm") version kotlinVersion
    id("org.jetbrains.kotlin.kapt") version kotlinVersion
    id("org.jetbrains.kotlin.plugin.jpa") version kotlinVersion
    id("org.jetbrains.kotlin.plugin.noarg") version kotlinVersion
    id("org.jetbrains.kotlin.plugin.spring") version kotlinVersion
    id("com.ewerk.gradle.plugins.querydsl") version "1.0.9"
    id("io.spring.dependency-management") version "1.0.3.RELEASE"
}

编辑3

我看到这是由产生的kotlinDslAccessorsReport：

/**
 * Retrieves the [appengine][com.google.cloud.tools.gradle.appengine.core.AppEngineExtension] project extension.
 */
val Project.`appengine`: com.google.cloud.tools.gradle.appengine.core.AppEngineExtension get() =
    extensions.getByName("appengine") as com.google.cloud.tools.gradle.appengine.core.AppEngineExtension

/**
 * Configures the [appengine][com.google.cloud.tools.gradle.appengine.core.AppEngineExtension] project extension.
 */
fun Project.`appengine`(configure: com.google.cloud.tools.gradle.appengine.core.AppEngineExtension.() -> Unit): Unit =
    extensions.configure("appengine", configure)

但老实说，我不知道这将如何进一步帮助我。

Answer 1

为了kotlin-dsl在编译应用插件之前生成静态访问器，您必须使用plugins {}块而不是buildscript {}块。buildscript {}仍然会使依赖项对脚本类路径可见，但是您不会获得这些依赖项。

如您所见，插件的Maven坐标可能与插件ID不同。您可以在处理这个问题settings.gradle与pluginManagement规范（Android的一个例子插件是这里这里是我如何处理（并使用。war插件最少应用程序）：

build.gradle,kts

plugins {
  id("com.google.cloud.tools.appengine") version "1.3.4"
  `war`
}

settings.gradle

pluginManagement {
  repositories {
    gradlePluginPortal()
    google()
  }
  resolutionStrategy {
    eachPlugin {
      if (requested.id.id == "com.google.cloud.tools.appengine") {
        useModule("com.google.cloud.tools:appengine-gradle-plugin:${requested.version}")
      }
    }
  }
}

现在，我已应用了该插件，kotlin-dsl并将在脚本编译之前生成访问器。

运行./gradlew kotlinDslAccessorsReport并细读它，我在输出中看到了这一点：

/**
 * Retrieves the [appengine][com.google.cloud.tools.gradle.appengine.core.AppEngineExtension] project extension.
 */
val Project.`appengine`: com.google.cloud.tools.gradle.appengine.core.AppEngineExtension get() =
  extensions.getByName("appengine") as com.google.cloud.tools.gradle.appengine.core.AppEngineExtension

/**
 * Configures the [appengine][com.google.cloud.tools.gradle.appengine.core.AppEngineExtension] project extension.
 */
fun Project.`appengine`(configure: com.google.cloud.tools.gradle.appengine.core.AppEngineExtension.() -> Unit): Unit =
    extensions.configure("appengine", configure)

现在，您可以看到该appengine { ... }代码块将在顶层正常工作。我们只需要根据其类型找出可以放入其中的内容。请注意，如果使用buildscript {}而不是plugins {}，则必须自己复制/粘贴这些访问器，或者extensions.getByType(com.google.cloud.tools.gradle.appengine.core.AppEngineExtension::class)在构建脚本中执行类似的操作。

做一些搜索，您可以AppEngineExtension 在GitHub上找到其源代码。不幸的是，它没有任何方法或字段。它基本上用作“扩展名持有人”类，因为在此处和此处（可能还有其他地方）向其添加了其他扩展名。这意味着我们需要做一些类转换技巧才能配置该对象。源代码是IMO真正弄清楚如何访问这类对象的唯一方法。

下面显示了如何配置deploy扩展名“ a” DeployExtension以及如何配置run扩展名“ a” RunExtension。

import com.google.cloud.tools.gradle.appengine.core.DeployExtension
import com.google.cloud.tools.gradle.appengine.standard.RunExtension

appengine {
  ((this as org.gradle.api.plugins.ExtensionAware).extensions.getByName("run") as RunExtension).apply {
    port = 8080
  }
  ((this as org.gradle.api.plugins.ExtensionAware).extensions.getByName("deploy") as DeployExtension).apply {
    stopPreviousVersion = true // default - stop the current version
    promote = true
  }
}

有几种不同的方法可以完成上述任务，但这就是我采用的方法。插件本身应提供更友好的配置方法，直到解决kotlin-dsl / 457，所以我提出了一个问题