在Gradle Kotlin DSL中注册和创建有什么区别

Question

Gradle（5.0）中有两种创建方法，即任务：

tasks {
    val javadocJar by creating(Jar::class) {
        val javadoc by tasks

        from(javadoc)
        classifier = "javadoc"
    }
}

和

tasks {
    val javadocJar by registering(Jar::class) {
        val javadoc by tasks

        from(javadoc)
        classifier = "javadoc"
    }
}

基本一样的API，那么有什么区别呢？

Answer 1

公认的答案很好，但我想补充一点，如果您想实际使用由创建的/稍后注册调用创建的引用，那幺API将有所不同。比较

create<MavenPublication>("main") {
    …

    val sourcesJar by tasks.creating(Jar::class) {
        val sourceSets: SourceSetContainer by project
        from(sourceSets["main"].allJava)
        classifier = "sources"
    }

    artifact(sourcesJar)
}

和

create<MavenPublication>("main") {
    …

    val sourcesJar by tasks.registering(Jar::class) {
        val sourceSets: SourceSetContainer by project
        from(sourceSets["main"].allJava)
        classifier = "sources"
    }

    artifact(sourcesJar.get())
}

在注册的情况下，因为它是惰性的，您需要一个额外的. get（）调用，否则您会得到一个异常：

* What went wrong:
Cannot convert the provided notation to an object of type MavenArtifact: task ':experiments:sourcesJar'.
The following types/formats are supported:
  - Instances of MavenArtifact.
  - Instances of AbstractArchiveTask, for example jar.
  - Instances of PublishArtifact
  - Maps containing a 'source' entry, for example [source: '/path/to/file', extension: 'zip'].
  - Anything that can be converted to a file, as per Project.file()

Answer 2

请参阅https://docs . grad le . org/current/user guide/kot Lin _ DSL . html # using _ the _ container _ API:

tasks.named("check")                  
tasks.register("myTask1")

上面的示例依赖于配置避免API。如果您需要或希望急切地配置或注册容器元素，只需将named（）替换为getByName（），将register（）替换为create（）。

创建和注册（或5.0之前的Gradle版本中的create和register）之间的差异与“任务配置避免”新API有关，这里详细介绍了这一点（参见本节）：

如何推迟任务创建？

此功能要求构建作者通过将任务创建从TaskContainer.create（java.lang.String）API迁移到TaskContaineer.register（java.lang.String）APIs来选择加入。寄存器（…​) 当且仅当需要任务时，API注册将在以后创建的任务。创建（…​) API在被调用时继续急切地创建和配置任务。