Gradle 中 buildscript 块的用途

Question

我是 Gradle 新手，我正在阅读文档，但我不明白其中的某些部分。这些部分之一与buildscript 块连接。它的目的是什么？

如果您的构建脚本需要使用外部库，您可以将它们添加到构建脚本本身的脚本类路径中。您可以使用 buildscript() 方法执行此操作，传入一个声明构建脚本类路径的闭包。

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath group: 'commons-codec', name: 'commons-codec', version: '1.2'
  }
}

好的，但有什么区别：

repositories {
  mavenCentral()
}
dependencies {
  compile group: 'commons-codec', name: 'commons-codec', version: '1.2'
}

比如为什么一定要用buildscript？

Answer 1

https://docs.gradle.org/current/userguide/tutorial_using_tasks.html#sec:build_script_external_dependencies

构建脚本的外部依赖项

而不是操纵 直接编写类路径，建议应用插件 带有自己的类路径。对于自定义构建逻辑， 建议使用自定义插件。如果您的构建脚本需要 要使用外部库，您可以将它们添加到脚本的类路径中 在构建脚本本身中。您可以使用 buildscript() 方法，传入一个声明构建脚本类路径的块。

传递给 buildscript() 方法的块配置一个 ScriptHandler 实例。 您可以通过将依赖项添加到 类路径配置。这与您声明的方式相同，因为 例如，Java 编译类路径。您可以使用任何 项目依赖之外的依赖类型。

声明了构建脚本类路径后，您可以使用 你的构建脚本就像你在类路径上的任何其他类一样。这 以下示例添加到前面的示例，并使用来自的类 构建脚本类路径。

import org.apache.commons.codec.binary.Base64

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath group: 'commons-codec', name: 'commons-codec', version: '1.2'
    }
}

tasks.register('encode') {
    doLast {
        def byte[] encodedString = new Base64().encode('hello world\n'.getBytes())
        println new String(encodedString)
    }
}

Answer 2

通过演示 Android 顶级 gradle 文件进行更多解释。

buildscript {
    // this is where we are going to find the libraries defined in "dependencies block" at below
    repositories {
        google()
        jcenter()
        maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
    }

    // everything listed in the dependencies is actually a plugin, which we'll do "apply plugin" in our module level gradle file.
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.2' // this is android gradle plugin
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" // kotlin gradle plugin
    }
}

模块级gradle文件

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'

什么是“插件”？它们只是实现 Plugin 接口的 java 类。在界面下，它有一个方法“apply”来添加多个不同名称的任务对象。 Task 是一个我们可以实现工作流的类。例如，构建任务包含构建应用程序的流程。

那么，buildscript 是做什么的？它定义了在哪里可以找到插件。插件有什么作用？它包含多项任务。任务是做什么的？它为我们提供了构建、安装、lint 等功能。

我的理解可能有误。如果您发现有任何误导，请随时纠正我。

Answer 3

水平有点高，但希望有所帮助。

对我来说，一旦我开始了解什么是 a building block、方法和任务，就开始形成明显的区别。语法是什么样的，如何配置它们等等。所以我建议你通过所有这些。之后，您就可以开始理解这种语法了。

那么了解对象 build.gradle（Project 类的一个实例）的类型是非常重要的，以便了解 build.gradle 文件中可以包含什么。这将回答“buildScript”和其他人的来源。要扩展您的功能/特性（比如说 android），请查看 plugins 可以如何提供帮助。

最后但同样重要的是，这里有一个非常好的tutorial，它讨论了闭包和委托，这是理解脚本所必需的概念。

Answer 4

“buildscript”配置部分用于 gradle 本身（即更改 gradle 执行构建的方式）。所以这部分通常会包含 Android Gradle 插件。

Answer 5

我很欣赏 Peter 的回答...但对于我来说，构建脚本的其余部分 的含义并没有立即显而易见，正如答案和文档中所强调的那样。

通常引入相关功能是为了在 Java 程序或您可能正在编写的任何其他程序中使用。引入 Spring 说，不是在构建脚本中使用，而是在 Java 程序中使用。将它放在 buildscript 闭包中可确保依赖项可在 gradle 构建本身中使用。不是输出程序。

Answer 6

• 全局级别 dependencies 和 repositories 部分列出了构建源代码和运行源代码等所需的依赖项。
• buildscript 用于build.gradle 文件本身。因此，这将包含用于创建 RPM、Dockerfile 的依赖项，以及用于在所有依赖项 build.gradle 中运行任务的任何其他依赖项

Answer 7

buildScript 块确定哪些插件、任务类和其他类可用于构建脚本的其余部分。如果没有 buildScript 块，您可以使用开箱即用的 Gradle 附带的所有内容。如果您还想使用第三方插件、任务类或其他类（在构建脚本中！），您必须在 buildScript 块中指定相应的依赖项。