Gradle使用文档

Gradle使用文档

gradle使用文档

2014年

7月

第 1 页 共 17页

Gradle使用文档

1 基本介绍

1.1 前言

gradle是一个基于Apache Ant和Apache Maven概念的项目自动化建构工具。它使用一种基于Groovy的特定领域语言来声明项目设置，而不是传统的XML。

gradle能够完成构建、测试、发布和其他诸如软件打包、生成注释文档等等功能。

其特点包括：

 使用简单

 支持多方式依赖管理

 与ant、maven和ivy有良好的相容，支持轻松地从其他构建方式迁移到gradle上

 支持局部构建

 支持多工程的构建

 免费开源

第 2 页 共 17页

Gradle使用文档

2 安装和使用

2.1 下载

gradle的官方网站地址为：。

官方网站上面可以下载到各种版本，以及文档、和论坛等。目前gradle的最新版本为2.0.

我们下载gradle的最新版本，下载官网上的。

2.2 安装

gradle的安装方法很简单，将解压后的gradle的bin目录加到path目录即可。如下图所示：

其中，gradle_home目录为我们解压gradle下载包的目录。

为了验证我们的gradle是否安装成功。我们可以执行命令gradle –v加以验证。如下图所示：

第 3 页 共 17页

Gradle使用文档

3 开始一个例子

3.1 新建一个空的java project工程

通过eclipse向导新建一个Java Project工程。工程如下：

3.2 编写HelloWorld类和，代码如下

新建一个的package，然后在其下面新建一个HelloWorld类，代码如下：

第 4 页 共 17页

Gradle使用文档

package ;

public class HelloWorld {

public static void main(String[] args) {

n("Hello world!");

}

}

以上是一个java入门级的类。

再编写在我们的工程目录下（如上图所示）。代码如下：

apply plugin: 'java'

3.3 开始构建

在工程所在的目录下，打开cmd，运行gradle build命令，并执行。执行结果如下：

第 5 页 共 17页

Gradle使用文档

3.4 整理成果

通过上面的执行日志，我们可以看到，我们的工程大致经过了编译、运行测试案例、构建这几个大过程。

同时，我们在工程的目录下，发现新生成了一个build的目录，目录内容如下：

根据目录名称，我们也能大概猜到里边存放的内容。

特别地，我们可以在libs目录下，找到。

第 6 页 共 17页

Gradle使用文档

在reports目录下存放了一个html，我们用浏览器打开后，其内容如下：

正如其标题所示，该页面反映了我们的单元测试案例结果。

OK，正如你看到的一样，gradle构建就这么简单。我们这里仅用了一行代码，就完成了一个java工程的基本构建。

4 gradle基本概念介绍

gradle构建过程，逻辑上都基于两个基本的概念，projects和tasks。

4.1 projects

一个Project应该指出最终要生成的内容，例如要生成一个Jar、要构建出一个war等等。为了实现最终的目的，我们要通过一个或多个任务来完成。任务即tasks。

4.2 tasks

一个task可以理解为构建的一个步骤，例如编译java文件为class。Task

第 7 页 共 17页

Gradle使用文档

是原子操作。Task和ant非常相像。

5 常用的task介绍

我们现在尝试一些常用的task，并运行起来看看结果。

5.1 编写自己的简单task

刚开始，我们还是来一个hello world。

在我们自己的电脑的文件目录上，新建一个的文件，文件内容为：

task hello{println 'Hello World'}

此时通过cmd到该文件所在的目录下，此时在cmd上执行命令：

gradle hello

我们可以得到以下结果：

很显然，我们的任务已经被正确调用并执行。

另外，gradle的task也支持这种写法：

task hello << {println 'Hello World'}

执行结果和上面一样的。

第 8 页 共 17页

Gradle使用文档

5.2 增加task的任务依赖

修改，内容改为：

task hello << {println 'Hello World'}

task intro (dependsOn: hello) << {println 'intro runs after hello'}

运行gradle intro命令，得到执行结果如下：

5.3 使用task自带的api

Task自带了一些api接口，我们可以申明这些接口要执行的内容，从而插入我们要额外执行的内容。

修改文件内容如下：

task hello << {

println 'Hello Earth' }

t {

println 'Hello Venus' }

{

println 'Hello Mars' }

hello << {

println 'Hello Jupiter' }

运行命令，得到以下执行结果：

第 9 页 共 17页

Gradle使用文档

注意doFirst中的内容首先被执行。

5.4 构建java工程

通过以上几个简单例子，我们对task已经有些认识了。我们现在来看看把这些任务综合起来完成项目的构建。

也许，我们还记得，在第三章的例子中，我们仅用了一行代码，即完成了对整个java工程的构建。代码为：

apply plugin: 'java'

从其执行的日志，我们可以看到，其实，该行命令带来的结果是，gradle将一套完整的java构建工程的task全引入到了我们的构建过程中。重点是，这些引入都是正确的。

我们之前有说到，project就是多个task一起组合起来完成构建任务，并生成我们想要的内容。既然gradle帮我们已经引入了很多的task，那就意味着，我们只需要再添加一些我们需要的task，就可以完成我们自己的项目的构建过程。

确实是这样的。

第 10 页 共 17页

Gradle使用文档

5.4.1 添加依赖包

接下来，我们做一点更有意义和难度的事情。我们项目里要用到spring，现在需要搭建一个简单的spring工程。那么，第一件事，我们需要做的，就是把spring的jar下载下来。

Ok，修改demo-gradle工程的文件内容为：

apply plugin: 'java'

repositories {

mavenCentral()

}

dependencies {

compile 'framework:spring-context:E'

}

同样地，在所在目录下，执行gradle build命令。可以说是奇迹发生了吧，得到执行结果如下：

第 11 页 共 17页

Gradle使用文档

工程不但构建完成，还下载了我们需要的spring的jar包。此时，如果回到eclipse中，发现下载的jar并没有被引入到工程中。

再在中第二行添加一行：

apply plugin: 'eclipse'

之后，执行命令gradle eclipse，得到以下结果：

第 12 页 共 17页

Gradle使用文档

回到eclipse中，刷新工程，可以看到我们的jar已经被工程引用了。

5.4.2 修改java编译细节

最常见的，就是我们要指定编译生成的jar基于jdk的版本。

修改内容为：

apply plugin: 'java'

apply plugin: 'eclipse'

sourceCompatibility = 1.6

targetCompatibility = 1.6

repositories {

mavenCentral()

}

dependencies {

compile 'framework:spring-context:E'

}

以上两个属性的作用分别如下：

第 13 页 共 17页

Gradle使用文档

sourceCompatibility，指定编译java源代码的jdk版本；

targetCompatibility，指定生成的class文件的jdk版本。

添加后执行gradle build命令，也会是成功的。

另外，以上两个属性，也是compleJava的属性。也可以写成：

compileJava {

sourceCompatibility = 1.6

targetCompatibility = 1.6

}

5.4.3 指定manifest文件及细节

在中添加以下内容：

jar {

manifest {

attributes 'Implementation-Title': 'demo gradle Quickstart',

'Implementation-Version': 1.0

}

}

执行完gradle build命令后，打开中的manifest文件，其内容如下所示：

第 14 页 共 17页

Gradle使用文档

5.4.4 执行单元测试

在工程中添加一个单元测试案例。如图所示：

文件内容调整为：

package ;

public class HelloWorld {

public static void main(String[] args) {

n("Hello world!");

}

public String sayHello(String name){

return "Hello " + name;

}

}

文件内容如下：

package ;

import static Equals;

第 15 页 共 17页