Gradle Groovy 插件

由 珍珍阿姨 创建， 最后一次修改 2016-08-12 Groovy 插件Groovy 的插件继承自 Java 插件并添加了对 Groovy 项目的支持。它可以处理 Groovy 代码，以及混合的 Groovy 和 Java 代码，甚至是纯 Java 代码（尽管我们不一定推荐使用）。该插件支持联合编译，可以任意地混合及匹配 Groovy 和 Java 代码各自的依赖。例如，一个 Groovy 类可以继承自一个 Java 类，而这个 Java 类也可以继承自一个 Groovy 类。这样一来，我们就能够在项目中使用最适合的语言，并且在有需要的情况下用其他的语言重写其中的任何类。用法要使用 Groovy 的插件，请在构建脚本中包含以下语句：使用 Groovy 插件build.gradle apply plugin: 'groovy' 任务Groovy 的插件向 project 中添加了以下任务。表 24.1. Groovy 插件 - 任务任务名称依赖于类型描述compileGroovycompileJavaGroovyCompile编译production 的 Groovy 源文件。compileTestGroovycompileTestJavaGroovyCompile编译test 的 Groovy 的源文件。SourceSetGroovySourceSetJavaGroovyCompile编译给定的 source set 里的 Groovy 源文件。groovydoc-Groovydoc为 production 里的 Groovy 源文件生成 API 文档。Groovy 的插件向 Java 插件所加入的 tasks 添加了以下的依赖。表 24.2. Groovy 插件 - 额外的 task 依赖任务名称依赖于classescompileGroovytestClassescompileTestGroovysourceSetClassescompileSourceSetGroovy图 24.1. Groovy 插件 - tasks项目布局Groovy 的插件会假定项目的布局如表 24.3，“Groovy 插件 - 项目布局”中所示。所有 Groovy 的源目录都可以包含 Groovy 和 Java 代码。Java 源目录只能包含 Java 源代码。这些目录不一定得存在或是里面包含有什么内容；Groovy 的插件只会进行编译，而不管它发现什么。表 24.3. Groovy 插件 - 项目布局目录意义src/main/java产品的Java源代码src/main/resources产品的资源src/main/groovyProduction Groovy 源代码。此外可能包含联合编译的 Java 源代码。src/test/javaJava 测试源代码src/test/resources测试资源src/test/groovyTest Groovy 源代码。此外可能包含联合编译的 Java 源代码。sourceSet/java给定的源集的Java源代码sourceSet/resources给定的源集的资源sourceSet/groovy给定的source set 的 Groovy 源代码。此外可能包含联合编译的 Java 源代码。更改项目布局和 Java 插件一样，Groovy 插件允许把 Groovy 的 production 和 test 的源文件配置为自定义的位置。自定义 Groovy 自定义源文件布局build.gradle sourceSets { main { groovy { srcDirs = ['src/groovy'] } } test { groovy { srcDirs = ['test/groovy'] } }} 依赖管理由于 Gradle 的构建语言基于 Groovy 的，且部分的 Groovy 使用 Groovy 实现，因此 Gradle 已经带有了一个 Groovy 库 （截至 Gradle 1.6 所带的 Groovy 库的版本是 1.8.6）。然而，Groovy 项目需要显式地声明一个 Groovy 依赖。这个依赖会在编译和运行的类路径时用到。它还将用于分别获取 Groovy 编译器及 Groovydoc 工具。如果 Groovy 用于 production 代码，Groovy 依赖应该添加到 compile 配置中：Groovy 的依赖配置build.gradlerepositories { mavenCentral()}dependencies { compile 'org.codehaus.groovy:groovy-all:2.2.0'} 如果 Groovy 仅用于测试代码，Groovy 的依赖应该被添加到 testCompile 配置中：配置 Groovy 测试依赖build.gradle dependencies { testCompile "org.codehaus.groovy:groovy-all:2.2.0"} 如果要使用 Gradle 所带的 Groovy 库，请声明 localGroovy()依赖。注意，不同 Gradle 版本附带的 Groovy 版本不同；因此，声明一个固定的 Groovy 依赖要比使用 localGroovy()更安全一些。配置捆绑的 Groovy 依赖build.gradle dependencies { compile localGroovy()} Groovy 库不一定得从远程仓库中获取。它也可以获取自本地中可能检入版本控制的 lib 目录：配置 Groovy 文件依赖build.gradle repositories { flatDir { dirs 'lib' }}dependencies { compile module('org.codehaus.groovy:groovy:1.6.0') { dependency('asm:asm-all:2.2.3') dependency('antlr:antlr:2.7.7') dependency('commons-cli:commons-cli:1.2') module('org.apache.ant:ant:1.9.3') { dependencies('org.apache.ant:ant-junit:1.9.3@jar', 'org.apache.ant:ant-launcher:1.9.3') } }} groovyClasspath 的自动配置GroovyCompile 和 Groovydoc tasks 会以两种方式使用 Groovy： 在它们的 classpath 以及它们的groovyClasspath上。前者用于在源代码中查找类的引用，通常会包含 Groovy 库和其他库。后者用来分别加载和执行 Groovy 编译器和 Groovydoc 工具，并且应该只包含 Groovy 库及其依赖项。除非显式配置了一个 task 的 groovyClasspath ，否则 Groovy（基础）插件会尝试推断该 task 的 classpath。以如下方式进行：如果在在 classpath 中找到 groovy-all(-indy) Jar，相同的 Jar 将添加到groovyClasspath 中。如果在 classpath 中找到 groovy(-indy) Jar ，并且该项目已经在至少一个仓库中声明了它，那么相应的 groovy(-indy)的仓库依赖将添加到 groovyClasspath 中。其他情况，该 task 将执行失败，并提示无法推断 groovyClasspath。 常规属性Groovy 的插件没有向 project 添加任何的常规属性。source set 属性Groovy 的插件向 project 的每一个source set 添加了下列的常规属性。你可以在你的构建脚本中，把这些属性当成是 source set 对象中的属性一样使用。表 24.4. Groovy 插件 - source set 属性属性名称类型默认值描述groovySourceDirectorySet (read-only)非空该source set 中的 Groovy 源文件。包含在 Groovy 源目录中找到的所有的.java文件，并排除所有其他类型的文件。groovy.srcDirsSet<File>.name/groovy]源目录包含该 source set 中的 Groovy 源文件。此外可能还包含用于联合编译的 Java 源文件。allGroovyFileTree (read-only)非空该source set 中的所有 Groovy 源文件。包