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

时间:2018-01-29 13:18:09

标签: google-app-engine gradle kotlin gradle-kotlin-dsl

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.kts IntelliJ抱怨时:

  • 未解析的参考:端口
  • 未解决的参考:部署

当从cml运行Gradle时,我得到:

  

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

EDIT2

在下方添加了pluginsbuildscript块:

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"
}

EDIT3

我发现这是由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)

但说实话,我不知道这对我有什么帮助。

2 个答案:

答案 0 :(得分:4)

为了让kotlin-dsl在应用插件的编译时间之前生成静态访问器,您必须使用plugins {}块而不是buildscript {}块。 buildscript {}仍会使脚本类路径可以看到依赖项,但是你不会得到它们。

正如您所注意到的,插件的Maven坐标可能与插件ID不同。您可以使用pluginManagement规范在settings.gradle中处理此问题(Android插件的示例为here。以下是我处理该问题的方法(并使用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 on GitHub的源代码。不幸的是,它没有任何方法或字段。它基本上用作“扩展持有者”类,因为其他扩展名已添加到herehere(可能还有其他地方)。这意味着我们需要做一些类转换技巧才能配置这个对象。源代码是IMO真正弄清楚如何访问这些类型对象的唯一方法。

下面显示了我们如何配置deploy扩展程序,DeployExtension以及我们如何配置run扩展程序,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解决之前,插件本身应提供更友好的配置方法,因此我打开了an issue

答案 1 :(得分:0)

使用版本2.0的appengine gradle插件的类型安全方法:

import com.google.cloud.tools.gradle.appengine.standard.AppEngineStandardExtension

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath("com.google.cloud.tools:appengine-gradle-plugin:2.0.0-rc5")
    }
}

plugins {
    java
    war
    kotlin("jvm") version "..."
}

repositories {
    jcenter()
}
apply {
    plugin("com.google.cloud.tools.appengine")
}

configure<AppEngineStandardExtension> {
    deploy {
        projectId = "..."
        version = "..."
        stopPreviousVersion = true // etc
    }
}