Gradle 起步

优质
小牛编辑
140浏览
2023-12-01

Gradle 目前的版本是 2.4,根据其Wiki上的Roadmap,Gradle 有着 让很多成熟项目都汗颜的文档,其包括了安装指南、基本教程、以及一份近300页的全面用户指南。这对于用户来说是非常友好的,同时也说明了Gradle的开发者对这个项目非常有信心,要知道编写并维护文档可不是件轻松的工作,对于Gradle这样未来仍可能发生很大变动的项目来说尤为如此。

类似于 Maven 的 pom.xml文件,每个 Gradle 项目都需要有一个对应的 build.gradle 文件,该文件定义一些任务(task)来完成构建工作,当然,每个任务是可配置的,任务之间也可以依赖,用户亦能配置缺省任务,就像这样:

defaultTasks 'taskB'
task taskA << {
println "i'm task A"
}
task taskB << {
println "i'm task B, and I depend on " + taskA.name
}
taskB.dependsOn taskA

运行命令 $ gradle -q 之后(参数 q 让 Gradle 不要打印错误之外的日志),就能看到如下的预期输出:

i'm task A
i'm task B, and I depend on taskA

这不是和 Ant 如出一辙么?的确是这样,这种 任务 的概念与用法与 Ant 及其相似。Ant 任务是 Gradle 世界的第一公民,Gradle 对 Ant 做了很好的集成。除此之外,由于 Gradle 使用的 Grovvy 脚本较 XML 更为灵活,因此,即使我自己不是 Ant 用户,我也仍然觉得 Ant 用户会喜欢上 Gradle。

依赖管理和集成 Maven 仓库

我们知道依赖管理、仓库、约定优于配置等概念是Maven的核心内容,抛开其实现是否最优不谈,概念本身没什么问题,并且已经被广泛学习和接受。那Gradle实现了这些优秀概念了么?答案是肯定的。

先看依赖管理,我有一个简单的项目依赖于一些第三方类库包括SpringFramework、JUnit、Kaptcha等等。原来的Maven POM配置大概是这样的(篇幅关系,省略了部分父POM配置):

<properties>
  <kaptcha.version>2.3</kaptcha.version>
</properties>
<dependencies>
  <dependency>
    <groupId>com.google.code.kaptcha</groupId>
    <artifactId>kaptcha</artifactId>
    <version>${kaptcha.version}</version>
    <classifier>jdk15</classifier>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-beans</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
  </dependency>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
  </dependency>
</dependencies></pre>

然后我将其转换成 Gradle 脚本,结果是惊人的:

dependencies {
  compile('org.springframework:spring-core:2.5.6')
  compile('org.springframework:spring-beans:2.5.6')
  compile('org.springframework:spring-context:2.5.6')
  compile('com.google.code.kaptcha:kaptcha:2.3:jdk15')
  testCompile('junit:junit:4.7')
}

注意配置从原来的 28 行缩减至 7 行!这还不算我省略的一些父 POM 配置。依赖的 groupId、artifactId、 version,scope 甚至是 classfier,一点都不少。较之于 Maven 或者 Ant 的 XML 配置脚本,Gradle 使用的 Grovvy 脚本杀伤力太大了,爱美之心,人皆有之,相比于七旬老妇松松垮垮的皱纹,大家肯定都喜欢少女紧致的脸蛋,XML就是那老妇的皱纹。

关于 Gradle 的依赖管理起初我有一点担心,就是它是否有传递性依赖的机制呢?经过文档阅读和实际试验后,这个疑虑打消了,Gradle 能够解析现有的 Maven POM 或者 Ivy 的 XML 配置,从而得到传递性依赖的信息,并且引入到当前项目中,这实在是一个聪明的做法。在此基础上,它也支持排除传递性依赖或者干脆关闭传递性依赖,其中第二点是 Maven 所不具备的特性。

自动化依赖管理的基石是仓库,Maven 中央仓库已经成为了 Java 开发者不可或缺的资源,Gradle 既然有依赖管理,那必然也得用到仓库,这当然也包括了 Maven 中央仓库,就像这样:

repositories {
  mavenLocal()
  mavenCentral()
  mavenRepo urls: "http://repository.sonatype.org/content/groups/forge/"
}

这段代码几乎不用解释,就是在 Gradle 中配置使用 Maven 本地仓库、中央仓库、以及自定义地址仓库。在我实际构建项目的时候,能看到终端打印的下载信息,下载后的文件被存储在 USER_HOME/.gradle/cache/ 目录下供项目使用,这种实现的方法与Maven又是及其类似了,可以说Gradle不仅最大限度的继承Maven的很多理念,仓库资源也是直接拿来用。

Gradle项目使用Maven项目生成的资源已经不是个问题了,接着需要反过来考虑,Maven用户是否能够使用 Gradle生成的资源呢?或者更简单点问,Gradle项目生成的构件是否可以发布到Maven仓库中供人使用呢?这一点非常重要,因为如果做不到这一点,你可能就会丢失大量的用户。幸运的是Gradle再次给出了令人满意的答案。使用Gradle的Maven Plugin,用户就可以轻松地将项目构件上传到Maven仓库中:

apply plugin: 'maven'
...
uploadArchives {
  repositories.mavenDeployer {
    repository(url: "http://localhost:8088/nexus/content/repositories/snapshots/") {
      authentication(userName: "admin", password: "admin123")
      pom.groupId = "com.juvenxu"
      pom.artifactId = "account-captcha"
    }
  }
}

在上传的过程中,Gradle 能够基于 build.gradle 生成对应的 Maven POM 文件,用户可以自行配置 POM 信息,比如这里的 groupId 和 artifactId,而诸如依赖配置这样的内容,Gradle是会自动帮你进行转换的。由于Maven项目之间依赖交互的直接途径就是仓库,而 Gradle 既能够使用 Maven 仓库,也能以 Maven 的格式将自己的内容发布到仓库中,因此从技术角度来说,即使在一个基于Maven的大环境中,局部使用Gradle也几乎不会是一个问题。

约定优于配置

如同 Ant 一般,Gradle 给了用户足够的自由去定义自己的任务,不过同时 Gradle 也提供了类似 Maven 的约定优于配置方式,这是通过 Gradle 的 Java Plugin 实现的,从文档上看,Gradle 是推荐这种方式的。Java Plugin 定义了与 Maven 完全一致的项目布局:

  • src/main/java
  • src/main/resources
  • src/test/java
  • src/test/resources

区别在于,使用 Groovy 自定义项目布局更加的方便:

sourceSets {
  main {
    java {
      srcDir 'src/java'
    }
    resources {
      srcDir 'src/resources'
    }
  }
}

Gradle Java Plugin 也定义了构建生命周期,包括编译主代码、处理资源、编译测试代码、执行测试、上传归档等等任务:

Figure 1. Gradle 的构建生命周期

相对于Maven完全线性的生命周期,Gradle 的构建生命周期略微复杂,不过也更为灵活,例如jar这个任务是用来打包的,它不像Maven那样依赖于执行测试的test任务,类似的,从图中可以看到,一个最终的build任务也没有依赖于 uploadArchives 任务。这个生命周期并没有将用户限制得很死,举个例子,我希望每次build都发布 SNAPSHOT版本到Maven仓库中,而且我只想使用最简单的$ gradle clean build 命令,那只需要添加一行任务依赖配置即可:

build.dependsOn 'uploadArchives'

由于Gradle完全是基于灵活的任务模型,因此很多事情包括覆盖现有任务,跳过任务都非常易于实现。而这些事情,在Maven的世界中,实现起来就比较的麻烦,或者说Maven压根就不希望用户这么做。

小结

一番体验下来,Gradle 给我最大的感觉是两点。其一是简洁,基于 Groovy 的紧凑脚本实在让人爱不释手,在表述意图方面也没有什么不清晰的地方。其二是灵活,各种在 Maven 中难以下手的事情,在 Gradle 就是小菜一碟,比如修改现有的构建生命周期,几行配置就完成了,同样的事情,在 Maven 中你必须编写一个插件,那对于一个刚入门的用户来说,没个一两天几乎是不可能完成的任务。

不过即使如此,Gradle 在未来能否取代 Maven,在我看来也还是个未知数。它的一大障碍就是 Grovvy,几乎所有 Java 开发者都熟悉 XML,可又有几个人了解 Groovy 呢?学习成本这道坎是很难跨越的,很多人抵制Maven就是因为学起来不容易,你现在让因为一个构建工具学习一门新语言(即使这门语言和Java非常接近),那得到冷淡的回复几乎是必然的事情。

Gradle 的另外一个问题就是它太灵活了,虽然它支持约定优于配置,不过从本文你也看到了,破坏约定是多么容易的事情。人都喜欢自由,爱自定义,觉得自己的需求是多么的特别,可事实上,从Maven的流行来看,几乎95%以上的情况你不需要自行扩展,如果你这么做了,只会让构建变得难以理解。

从这个角度来看,自由是把双刃剑,Gradle给了你足够的自由,约定优于配置只是它的一个选项而已,这初看起来很诱人,却也可能使其重蹈Ant的覆辙。Maven在Ant的基础上引入了依赖管理、仓库以及约定优于配置等概念,是一个很大的进步,不过在我现在看来,Gradle 并没有引入新的概念,给我感觉它是一个结合Ant和Maven理念的优秀实现。

如果你了解 Groovy,也理解 Maven 的约定优于配置,那试试 Gradle 倒也不错,尤其是它几乎能和现有的 Maven 系统无缝集成,而且你也能享受到简洁带来的极大乐趣。其实说到简洁,也许在不久的将来 Maven 用户也能直接享受到,Polyglot Maven 在这方面已经做了不少工作。