标签：src task 文件 Gradle 讲解 println gradle 全攻略

//这是快捷写法，用<<替换doLast，后面解释

task hl << {

println ‘Hello world!’

}

//创建upper的task，使用Groovy语言编写

task upper << {

String someString = ‘mY_nAmE’

println "Original: " + someString

println "Upper case: " + someString.toUpperCase()

}

通过如下命令运行构建上面名为hello的task，具体如下：

xxx@XXX:~/$ gradle hello

:hello

Hello world!

BUILD SUCCESSFUL

Total time: 1.037 secs

可以看见，gradle命令会在当前目录中查找一个叫build.gradle的构建脚本文件，这个构建脚本定义了一个叫做hello的独立task，并且添加了一个action，我们执行了这个task就得到了想要的结果。

在这里再多嘴一句，我们看下task有无action的区别，如下：

//有Action的task

task actionTask << {

println ‘I am actionTask’

}

//无Action的task

task noActionTask {

println ‘I am noActionTask’

}

一定要记住，在上面这个例子中如果task没有加<<则这个任务在脚本初始化initialization阶段（即无论执行啥task都被执行，具体参见上一章的第一个例子）被执行，如果加了<<则在gradle actionTask后才执行。因为没有加<<则闭包在task函数返回前会执行，而加了<<则变成调用actionTask.doLast()，所以会等到gradle actionTask时执行。

任务task依赖：

我们通过上面task基础感受的例子可以发现，一个build.gradle文件中定义多个task互相没有关系，决定执行的是我们gradle命令后面跟的task名字；那我们要是让他们之间有依赖关系咋办呢？如下：

task taskX(dependsOn: ‘taskY’) << {

println ‘taskX’

}

task taskY << {

println ‘taskY’

}

运行结果如下：

xxx@XXX:~/$ gradle taskX

:taskY

taskY

:taskX

taskX

BUILD SUCCESSFUL

Total time: 1.039 secs

动态任务task：

我们还可以在Gradle中使用Groovy来创建动态task，如下：

4.times { counter ->

task “task$counter” << {

println “I’m task number $counter”

}

}

运行结果如下：

xxx@XXX:~/$ gradle task1

:task1

I’m task number 1

BUILD SUCCESSFUL

Total time: 1.397 secs

使用已存在任务task：

我们除过在上面定义任务task时指明依赖以外还可以通过API为任务加入一个依赖，如下：

4.times { counter ->

task “task$counter” << {

println “I’m task number $counter”

}

}

task0.dependsOn task2, task3

运行结果如下：

xxx@XXX:~/$ gradle task0

:task0

I’m task number 2

I’m task number 3

I’m task number 0

BUILD SUCCESSFUL

Total time: 1.397 secs

或者我们还可以通过API为任务加入一些新行为，如下：

task hello << {

println ‘Hello Earth’

}

hello.doFirst {

println ‘Hello Venus’

}

hello.doLast {

println ‘Hello Mars’

}

hello << {

println ‘Hello Jupiter’

}

运行结果如下：

xxx@XXX:~/$ gradle hello

:hello

Hello Venus

Hello Earth

Hello Mars

Hello Jupiter

BUILD SUCCESSFUL

Total time: 1.397 secs

可以发现，doFirst和doLast可以被执行多次，<<操作符实质就是doLast。

任务task短标记：

我们可以通过美元符将一个task作为另一个task的属性，如下：

task hello << {

println ‘Hello world!’

}

hello.doLast {

println “Greetings from the $hello.name task.”

}

执行结果如下：

xxx@XXX:~/$ gradle hello

:hello

Hello world!

Greetings from the hello task.

BUILD SUCCESSFUL

Total time: 1.397 secs

可以看见，上面脚本中使用的name其实是任务的默认属性, 代表当前任务的名称。

自定义任务task属性：

我们还可以给任务task加入自定义的属性，如下例子：

task myTask {

ext.myProperty = “myValue”

}

task printTaskProperties << {

println myTask.myProperty

}

执行结果如下：

xxx@XXX:~/$ gradle printTaskProperties

:printTaskProperties

myValue

BUILD SUCCESSFUL

Total time: 1.397 secs

定义默认任务task：

Gradle允许在脚本中定义一个或多个默认任务，如下：

defaultTasks ‘clean’, ‘run’

task clean << {

println ‘Default Cleaning!’

}

task run << {

println ‘Default Running!’

}

task other << {

println “I’m not a default task!”

}

执行结果如下：

xxx@XXX:~/$ gradle

:clean,run

Default Cleaning!

Default Running!

BUILD SUCCESSFUL

Total time: 1.397 secs

【工匠若水 http://blog.csdn.net/yanbober 转载请注明出处。点我开始Android技术交流】

4 Gradle依赖管理基础

==================

大多数项目都不是完全独立的，它们需要依赖其他项目进行编译等，Gradle允许你告诉它你项目的依赖关系,以便找到这些依赖关系,并在你的构建中维护这些依赖关系，依赖关系可能需要从远程的Maven等仓库中下载，也可能是在本地文件系统中，或者是通过多项目构建另一个构建，我们称这个过程为依赖解析。

Gradle依赖声明：

关于依赖声明不解释，直接给个例子，如下：

apply plugin: ‘java’

repositories {

mavenCentral()

}

dependencies {

compile group: ‘org.hibernate’, name: ‘hibernate-core’, version: ‘3.6.7.Final’

testCompile group: ‘junit’, name: ‘junit’, version: ‘4.+’

}

Gradle依赖配置：

在Gradle中依赖可以组合成configurations（配置），一个配置简单地说就是一系列的依赖，通俗说也就是依赖配置；我们可以使用它们声明项目的外部依赖，也可以被用来声明项目的发布。下面我们给出几种Java插件中常见的配置，如下：

• compile

用来编译项目源代码的依赖；

• runtime

在运行时被生成的类需要的依赖，默认项，包含编译时的依赖；

• testCompile

编译测试代码依赖，默认项，包含生成的类运行所需的依赖和编译源代码的依赖；

• testRuntime

运行测试所需要的依赖，默认项，包含上面三个依赖；

各种各样的插件支持许多标准的配置，我们还可以定义自己的配置。

Gradle外部依赖：

我们可以用Gradle声明许多种依赖，其中有一种是外部依赖（external dependency），它是在当前构建之外的一种依赖，一般存放在远程（譬如Maven）或本地的仓库里。如下是一个外部依赖的例子：

dependencies {

compile group: ‘org.hibernate’, name: ‘hibernate-core’, version: ‘3.6.7.Final’

}

可以看见，引用一个外部依赖需要用到group、name、version属性。上面的写法还有一种简写，如下规则：

group:name:version

这是一个简写的例子：

dependencies {

compile ‘org.hibernate:hibernate-core:3.6.7.Final’

}

Gradle仓库：

有了上面的外部依赖，你指定会想Gradle是咋找到那些外部依赖文件的。其实Gradle会在一个仓库（repository）里找这些依赖文件，仓库其实就是很多依赖文件的集合服务器, 他们通过group、name、version进行归类存储，好在Gradle可以解析好几种不同的仓库形式（譬如Maven等），但是Gradle默认不提前定义任何仓库，我们必须手动在使用外部依赖之前定义自己的仓库。

下面是一个使用MavenCentral仓库的例子：

repositories {

mavenCentral()

}

这是一个使用远程Maven仓库的例子：

repositories {

maven {

url “http://repo.mycompany.com/maven2”

}

}

这是一个使用本地文件系统里库的例子：

repositories {

ivy {

// URL can refer to a local directory

url “…/local-repo”

}

}

当然了，一个项目可以有好几个库，Gradle会根据依赖定义的顺序在各个库里寻找它们，在第一个库里找到了就不会再在第二个库里找它了，否则在第二个库找。

Gradle发布artifacts：

依赖配置也可以用来发布文件，我们可以通过在uploadArchives任务里加入仓库来完成。下面是一个发布到Maven 库的例子，Gradle将生成和上传pom.xml，如下：

apply plugin: ‘maven’

uploadArchives {

repositories {

mavenDeployer {

repository(url: “file://localhost/tmp/myRepo/”)

}

}

}

【工匠若水 http://blog.csdn.net/yanbober 转载请注明出处。点我开始Android技术交流】

5 Gradle命令

==============

多任务调用命令：

gradle task1 task2 […]

排除任务命令：

gradle -x task1 task2 […]

失败后继续执行构建命令：

只要有任务调用失败Gradle默认就会中断执行，我们可以使用–continue选项在一次调用中不中断执行，然后发现所有失败原因。

简化任务名命令：

当我们调用某个任务时如果名字太长我们可以采用简化操作，但是必须保证可以唯一区分出该任务的字符，譬如：

//简写

gradle -x t1

//替换

gradle -x task1

选择执行构建命令：

调用gradle命令默认会构建当前目录下的build.gradle文件，我们可以使用-b参数选择其他目录的构建文件且当使用此参数时settings.gradle将不会生效。如下：

//选择文件构建subdir/myproject.gradle

task hello << {

println “using build file ‘ b u i l d F i l e . n a m e ′ i n ′ buildFile.name' in ' buildFile.name′in′buildFile.parentFile.name’.”

}

执行过程：

xxx@XXX:~/$ gradle -b subdir/myproject.gradle hello

:hello

using build file ‘myproject.gradle’ in ‘subdir’.

BUILD SUCCESSFUL

Total time: 1.397 secs

此外我们还可以使用-p参数来指定构建的目录，譬如在多项目构建中可以用-p替代-b参数。如下执行过程：

xxx@XXX:~/$ gradle -p subdir hello

:hello

using build file ‘build.gradle’ in ‘subdir’.

BUILD SUCCESSFUL

Total time: 1.397 secs

获取构建信息：

• gradle projects命令：列出子项目名称列表。

• gradle tasks命令：列出项目中所有任务。

• gradle help –task someTask命令：可以显示指定任务的详细信息。

• gradle dependencies命令：列出项目的依赖列表，所有依赖会根据任务区分，以树型结构展示。

【工匠若水 http://blog.csdn.net/yanbober 转载请注明出处。点我开始Android技术交流】

6 编写Gradle脚本

================

Gradle是以Groovy语言为基础，基于DSL语法的自动化构建工具，一个构建脚本能够包含任何Groovy语言元素，每个脚本都是UTF-8编码的文件。

6-1 Project对象API

---

前面我们说过，Gradle在构建脚本中定义了一个project，对于构建脚本中每个project其实Gradle都创建了一个 Project类型的对象来关联，当构建脚本执行时它会去配置所关联的Project对象；构建脚本中每个被调用的方法和属性都委托给了当前Project对象。

如下我们看一个使用Project属性的例子：

println name

println project.name

上面两个println语句的输出是一样的；由于name属性没有在当前脚本中定义，所以可以像第一个那样使用自动委托 ，通常我们使用第二中写法。

Project对象提供了一些标准的属性，我们可以在构建脚本中很方便的使用他们，如下：

| Name | Type | Default Value |

| — | — | — |

| project | Project | Project实例对象 |

| name | String | 项目目录的名称 |

| path | String | 项目的绝对路径 |

| description | String | 项目描述 |

| projectDir | File | 包含构建脚本的目录 |

| build | File | projectDir/build |

| group | Object | 未具体说明 |

| version | Object | 未具体说明 |

| ant | AntBuilder | Ant实例对象 |

具体关于Project的方法详情参阅Project的API文档。这里我们给出Project的apply方法的一个例子，如下：

//加载一个gradle文件

apply from: rootProject.getRootDir().getAbsolutePath() + “/common.gradle”

6-2 Script对象API

---

当Gradle执行一个脚本时它会将这个脚本编译为实现了Script的类（在上篇博客《Groovy脚本基础全攻略》Groovy的本质编译class代码那块有介绍），也就是说所有的属性和方法都是在Script的接口中声明。

6-3 Gradle对象API

---

关于Gradle对象的详细属性和API介绍点我即可。这里直接给出一个使用Gradle对象的例子，如下：

6-4 Gradle变量声明

---

在Gradle脚本中有两种类型的变量可以声明，如下：

• 局部变量

• 扩展变量

局部变量使用关键字def声明，它只在声明的地方可

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整内容开源分享

见，如下：

def dest = “dest”

task copy(type: Copy) {

form “source”

into dest

}

在Gradle中所有被增强的对象可以拥有自定义属性（譬如projects、tasks、source sets等），使用ext扩展块可以一次添加多个属性。如下：

apply plugin: “java”

ext {

springVersion = “3.1.0.RELEASE”

emailNotification = “build@master.org”

}

sourceSets.all { ext.purpose = null }

sourceSets {

main {

purpose = “production”

}

test {

purpose = “test”

}

plugin {

purpose = “production”

}

}

task printProperties << {

println springVersion

println emailNotification

sourceSets.matching { it.purpose == “production” }.each { println it.name}

}

上面我们用一个ext扩展块向Project对象添加两个扩展属性，当这些扩展属性被添加后，它们就像预定义的属性一样可以被读写。

6-5 Gradle中Groovy使用

---

这个没啥说的，具体可以参考《Groovy脚本基础全攻略》这篇博客，里面有详细介绍。我们这里粗略总结回忆一下即可：

• Groovy会自动将一个属性的引用转换为相应的getter/setter方法。

• Groovy调用方法时圆括号可有可无。

• Groovy为List和Map集合提供了一些操作捷径，譬如apply plugin:’java’中的plugin:’java’其实就是Groovy中的Map，apply是一个方法，省略了括弧而已。

哎呀，详细的还是去看前一篇博客吧。

【工匠若水 http://blog.csdn.net/yanbober 转载请注明出处。点我开始Android技术交流】

7 Gradle文件操作基础

==================

实际使用Gradle过程中大多数时候需要操作文件，好在Gradle给我们提供了一些API来快捷处理。

定位文件：

我们可以使用Project.file()方法来定位一个文件获取File对象（详情参考Project的API），如下：

//相对路径

File configFile = file(‘src/config.xml’)

//绝对路径

File configFile = file(configFile.absolutePath)

//项目路径的文件对象

File configFile = file(new File(‘src/config.xml’))

可以从Project的API发现file()方法能够接收任何形式的对象参数，它会将参数值转换为一个绝对文件对象，通常我们可以传一个String或File实例；如果传的路径是绝对路径，则会被直接构造为一个文件实例，否则会被构造为项目目录加上传递目录的文件对象；当然了，file()方法还能识别URL（譬如file:/some/path.xml等）。

文件集合：

文件集合其实是一组文件，Gradle使用FileCollection接口表示文件集合，Gradle API中许多类都实现了这个接口，譬如dependency configurations等。获取FileCollection实例的一种方法是Project.files()，我们可以传递任何数量的对象参数。如下：

FileCollection collection = files(‘src/file1.txt’,

new File(‘src/file2.txt’),

[‘src/file3.txt’, ‘src/file4.txt’])

使用迭代操作还能将其转换为其他的一些类型，同时我们还可以使用+操作将两个文件集合合并，使用-操作对一个文件集合做减法。如下例子：

// 对文件集合进行迭代

collection.each {File file ->

println file.name

}

// 转换文件集合为其他类型

Set set = collection.files

Set set2 = collection as Set

List list = collection as List

String path = collection.asPath

File file = collection.singleFile

File file2 = collection as File

// 增加和减少文件集合

def union = collection + files(‘src/file3.txt’)

def different = collection - files(‘src/file3.txt’)

我们也可以向files()方法传递闭包或者可回调的实例参数，当查询集合的内容时就会调用它，然后将返回值转换为一些文件实例，返回值可以是files()方法支持的任何类型的对象。如下例子：

task list << {

File srcDir

// 使用闭合创建一个文件集合

collection = files { srcDir.listFiles() }

srcDir = file(‘src’)

println “Contents of $srcDir.name”

collection.collect { relativePath(it) }.sort().each { println it }

srcDir = file(‘src2’)

println “Contents of $srcDir.name”

collection.collect { relativePath(it) }.sort().each { println it }

}

文件树：

文件树可以代表一个目录树结构或一个ZIP压缩文件的内容，FileTree继承自FileCollection，所以我们可以像处理文件集合一样处理文件树，使用Project.fileTree()方法可以得到FileTree实例，它会创建一个基于基准目录的对象。如下：

/以一个基准目录创建一个文件树

FileTree tree = fileTree(dir: ‘src/main’)

// 添加包含和排除规则

tree.include ‘**/*.java’

tree.exclude ‘**/Abstract*’

// 使用路径创建一个树

tree = fileTree(‘src’).include(’**/*.java’)

// 使用闭合创建一个数

tree = fileTree(‘src’) {

include ‘**/*.java’

}

// 使用map创建一个树

tree = fileTree(dir: ‘src’, include: ‘**/*.java’)

tree = fileTree(dir: ‘src’, includes: [’/*.java’, '/*.xml’])

tree = fileTree(dir: ‘src’, include: ‘/*.java’, exclude: '/test/**’)

// 遍历文件树

tree.each {File file ->

println file

}

// 过滤文件树

FileTree filtered = tree.matching {

include ‘org/gradle/api/**’

}

// 合并文件树A

FileTree sum = tree + fileTree(dir: ‘src/test’)

// 访问文件数的元素

tree.visit {element ->

println “$element.relativePath => $element.file”

}

我们还可以使用ZIP或TAR等压缩文件的内容作为文件树，Project.zipTree()和Project.tarTree()方法可以返回一个FileTree实例。如下：

// 使用路径创建一个ZIP文件

FileTree zip = zipTree(‘someFile.zip’)

// 使用路径创建一个TAR文件

FileTree tar = tarTree(‘someFile.tar’)

//TarTree可以根据文件扩展名得到压缩方式，如果我们想明确的指定压缩方式则可以如下操作

FileTree someTar = tarTree(resources.gzip(‘someTar.ext’))

指定输入文件：

Gradle中有些对象的属性可以接收一组输入文件，譬如JavaComplile任务的source属性（定义编译的源文件）。如下：

//使用一个File对象设置源目录

compile {

source = file(‘src/main/java’)

}

//使用一个字符路径设置源目录

compile {

source = ‘src/main/java’

}

//使用一个集合设置多个源目录

compile {

source = [‘src/main/java’, ‘…/shared/java’]

}

//使用FileCollection或者FileTree设置源目录

compile {

source = fileTree(dir: ‘src/main/java’).matching {include ‘org/gradle/api/**’}

}

//使用闭包设置源目录

compile {

source = {

// Use the contents of each zip file in the src dir

file(‘src’).listFiles().findAll {it.name.endsWith(’.zip’)}.collect { zipTree(it) }

}

}

compile {

//使用字符路径添加源目录

source ‘src/main/java’, ‘src/main/groovy’

//使用File对象添加源目录

source file(’…/shared/java’)

//使用闭包添加源目录

source { file(‘src/test/’).listFiles() }

}

复制文件：

我们可以使用复制任务（Copy）进行文件复制操作，复制任务扩展性很强，它可以过滤复制文件的内容，使用复制任务要提供想要复制的源文件和一个目标目录，如果要指定文件被复制时的转换方式则可以使用复制规则，复制规则是一个CopySpec接口的实现，我们使用CopySpec.from()方法指定源文件，CopySpec.into()方法指定目标目录即可。如下：

task copyTask(type: Copy) {

from ‘src/main/webapp’

into ‘build/explodedWar’

}

task anotherCopyTask(type: Copy) {

//复制src/main/webapp目录下的所有文件

from ‘src/main/webapp’

//复制一个单独文件

from ‘src/staging/index.html’

//复制一个任务输出的文件

from copyTask

//显式使用任务的outputs属性复制任务的输出文件

from copyTaskWithPatterns.outputs

//复制一个ZIP压缩文件的内容

from zipTree(‘src/main/assets.zip’)

//指定目标目录

into { getDestDir() }

}

task copyTaskWithPatterns(type: Copy) {

from ‘src/main/webapp’

into ‘build/explodedWar’

include ‘**/*.html’

include ‘**/*.jsp’

exclude { details -> details.file.name.endsWith(’.html’) &&

details.file.text.contains(‘staging’) }

}

task copyMethod << {

copy {

from ‘src/main/webapp’

into ‘build/explodedWar’

include ‘**/*.html’

include ‘**/*.jsp’

}

}

//在复制时重命名文件

task rename(type: Copy) {

from ‘src/main/webapp’

into ‘build/explodedWar’

//使用闭包映射文件名

rename { String fileName ->

fileName.replace(’-staging-’, ‘’)

}

// 使用正则表达式映射文件名

rename ‘(.+)-staging-(.+)’, ‘$1$2’

rename(/(.+)-staging-(.+)/, ‘$1$2’)

}

文件同步任务：

同步任务（Sync）继承自复制任务（Copy），当执行时会复制源文件到目标目录，然后从目标目录删除所有非复制文件。如下：

task libs(type: Sync) {

from configurations.runtime

into “$buildDir/libs”

}

创建归档文件：

使用归档任务可以创建Zip、Tar、Jar、War、Ear等归档文件，如下：

apply plugin: ‘java’

task zip(type: Zip) {

from ‘src/dist’

into(‘libs’) {

from configurations.runtime

}

}

关于文件操作的其他请参考API文档。

【工匠若水 http://blog.csdn.net/yanbober 转载请注明出处。点我开始Android技术交流】

8 Gradle插件

==============

8-1 Gradle插件概述

---

插件基础：

关于Gradle支持的插件可以点我搜索。其实Gradle的核心只是一个空空的框架，所谓的Gradle构建便捷脚本其实都是由插件提供支持的，插件添加了新的任务。在Gradle中一般有两种类型的插件，如下：

• 脚本插件

是额外的构建脚本，它会进一步配置构建，通常会在构建内部使用。脚本插件可以从本地文件系统或远程获取，如果从文件系统获取则是相对于项目目录，如果是远程获取则是由HTTP URL指定。

• 二进制插件

是实现了Plugin接口的类，并且采用编程的方式来操纵构建。

插件需要通过Project.apply()方法完成声明应用，相同的插件可以应用多次。如下例子：

//脚本插件

apply from: ‘other.gradle’

//二进制插件

apply plugin: ‘java’

插件还可以使用插件ID，插件的id作为给定插件的唯一标识符，我们可以给插件注册一个缩写字符的id。譬如下面例子：

//通过Java插件的id进行引用

apply plugin: JavaPlugin

使用构建脚本块应用插件：

我们可以向构建脚本中加入插件的类路径然后再应用插件和使用插件的任务，如下：

buildscript {

repositories {

jcenter()

标签：src,task,文件,Gradle,讲解,println,gradle,全攻略
来源： https://blog.csdn.net/m0_64604367/article/details/121819312

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。