文章目录

  • 简介
  • project和task
  • 一个例子
  • task详细讲解
    • task脚本
    • task依赖
    • 动态task
    • 默认task
    • build script的外部依赖

简介

build.gradle是gradle中非常重要的一个文件,因为它描述了gradle中可以运行的任务,今天本文将会带大家体验一下如何创建一个build.gradle文件和如何编写其中的内容。

project和task

gradle是一个构建工具,所谓构建工具就是通过既定的各种规则,将原代码或者原文件通过一定的task处理过后,打包生成目标文件的步骤。

所以我们在gradle中有两个非常重要的概念,分别是项目和任务。

每一个gradle的构建任务可以包含一个或者多个项目,项目可以有多种类型,比如是一个web项目或者一个java lib项目等。为了实现project要完成的目标,需要定义一个个的task来辅助完成目标。

task主要用来执行特定的任务,比如编译class文件,打包成jar,生成javadoc等等。

一个例子

接下来我们使用一个具体的例子来讲解一下,gradle到底是怎么用的。

首先我们创建一个新的project目录:

$ mkdir gradle-test
$ cd gradle-test

gradle提供了一个init方法,来方便的创建gradle项目的骨架,我们用下看:

gradle init
Starting a Gradle Daemon (subsequent builds will be faster)Select type of project to generate:1: basic2: application3: library4: Gradle plugin
Enter selection (default: basic) [1..4] 2Select implementation language:1: C++2: Groovy3: Java4: Kotlin5: Scala6: Swift
Enter selection (default: Java) [1..6] 3Split functionality across multiple subprojects?:1: no - only one application project2: yes - application and library projects
Enter selection (default: no - only one application project) [1..2] 1Select build script DSL:1: Groovy2: Kotlin
Enter selection (default: Groovy) [1..2] 1Select test framework:1: JUnit 42: TestNG3: Spock4: JUnit Jupiter
Enter selection (default: JUnit 4) [1..4] 1Project name (default: gradle-test):
Source package (default: gradle.test):> Task :init
Get more help with your project: https://docs.gradle.org/6.7/samples/sample_building_java_applications.htmlBUILD SUCCESSFUL in 45s
2 actionable tasks: 2 executed

按照你的需要,经过一系列的选择之后,就可以生成一个基本的gradle项目了。

我们看下生成的文件和目录:

.
├── app
│   ├── build.gradle
│   └── src
│       ├── main
│       │   ├── java
│       │   │   └── gradle
│       │   │       └── test
│       │   │           └── App.java
│       │   └── resources
│       └── test
│           ├── java
│           │   └── gradle
│           │       └── test
│           │           └── AppTest.java
│           └── resources
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
└── settings.gradle14 directories, 8 files

其中gradle-wrapper是帮你自动设置和安装gradle的工具,同时它还提供了gradlew和gradlew.bat这两个执行文件,用来执行gradle的任务。

我们主要看其中的两个配置文件,settings.gradle和build.gradle。

settings.gradle中配置的是gradle中要build的项目信息:

rootProject.name = 'gradle-test'
include('app')

上面的例子中,rootProject.name指定了项目的名字,include(‘app’)表示需要引入一个叫做app的子项目,这个子项目中包含着实际的要打包的内容。

再看一下app中的build.gradle文件:

plugins {// Apply the application plugin to add support for building a CLI application in Java.id 'application'
}repositories {// Use JCenter for resolving dependencies.jcenter()
}dependencies {// Use JUnit test framework.testImplementation 'junit:junit:4.13'// This dependency is used by the application.implementation 'com.google.guava:guava:29.0-jre'
}application {// Define the main class for the application.mainClass = 'gradle.test.App'
}

很简单,指定了插件,仓库地址,依赖包和应用程序的main class路径。

一切准备好之后,我们就可以进行构建和运行了。

有两种方式来运行,一种方式就是使用系统自带的gradle命令,一种方式就是使用刚刚gradle为你生成的gradlew。

gradle run> Configure project :app
Repository ${repo.url} replaced by $REPOSITORY_URL .> Task :app:run
Hello World!
gradle build> Configure project :app
Repository ${repo.url} replaced by $REPOSITORY_URL .BUILD SUCCESSFUL in 2s
7 actionable tasks: 6 executed, 1 up-to-date

你还可以带上 --scan 参数将build上传到gradle scan中,得到更加详细的构建分析:

./gradlew build --scanBUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executedPublishing a build scan to scans.gradle.com requires accepting the Gradle Terms of Service defined at https://gradle.com/terms-of-service.
Do you accept these terms? [yes, no] yesGradle Terms of Service accepted.Publishing build scan...
https://gradle.com/s/5u4w3gxeurtd2

task详细讲解

上面的例子中,我们使用的都是gradle默认的tasks,并没有看到自定义task的使用,接下来我们将会探讨一下,如何在build.gradle编写自己的task。

这里我们使用的groovy来编写build.gradle,所以我们可以像运行代码一样来运行它。

task脚本

先创建一个非常简单的task:

task hello {doLast {println 'Hello www.flydean.com!'}
}

上面定义了一个名叫hello的task,并且会在执行最后输出 “Hello www.flydean.com!”。

我们这样运行:

gradle -q hello
Hello www.flydean.com!

-q的意思是悄悄的执行,将会忽略gradle自身的log信息。我们把要执行的task名字写在gradle后面就可以了。

如果你熟悉ant命令的话,可以看到gradle的task和ant很类似,不过更加的强大。

因为是groovy脚本,所以我们可以在其中执行代码:

task upper {doLast {String someString = 'www.flydean.com'println "Original: $someString"println "Upper case: ${someString.toUpperCase()}"}
}

运行结果:

> gradle -q upper
Original: www.flydean.com
Upper case: WWW.FLYDEAN.COM

或者执行times操作:

task count {doLast {4.times { print "$it " }}
}
> gradle -q count
0 1 2 3

task依赖

gradle中的一个task可以依赖其他的task:

task hello {doLast {println 'Hello www.flydean.com!'}
}
task intro {dependsOn hellodoLast {println "I'm flydean"}
}

上面两个task的顺序是无关的,可以依赖的写在前面,被依赖的写在后面,或者反过来都成立。

动态task

除了静态的task之外,我们还可以通过代码来动态创建task:

4.times { counter ->task "task$counter" {doLast {println "I'm task number $counter"}}
}
> gradle -q task1
I'm task number 1

我们还可以将task看做成为一个对象,调用gradle的api进行操作:

4.times { counter ->task "task$counter" {doLast {println "I'm task number $counter"}}
}
task0.dependsOn task2, task3

上面的例子中,我们调用API手动创建了task之间的依赖关系:

> gradle -q task0
I'm task number 2
I'm task number 3
I'm task number 0

还可以task之间的属性调用:

task myTask {ext.myProperty = "www.flydean.com"
}task printTaskProperties {doLast {println myTask.myProperty}
}

默认task

如果不想每次都在调用gradle命令的时候手动指定某个具体的task名字,我们可以使用defaultTasks:

defaultTasks 'clean', 'run'task clean {doLast {println 'Default Cleaning!'}
}task run {doLast {println 'Default Running!'}
}task other {doLast {println "I'm not a default task!"}
}

上面的代码执行gradle和gradle clean run是相当的。

build script的外部依赖

既然build script可以用groovy代码来编写,那么如果我们想要在build script中使用外部的jar包怎么办呢?

这个时候,我们可以将外部依赖放到buildscript()方法中,后面的task就可以使用引入的依赖了:

import org.apache.commons.codec.binary.Base64buildscript {repositories {mavenCentral()}dependencies {classpath group: 'commons-codec', name: 'commons-codec', version: '1.2'}
}task encode {doLast {def byte[] encodedString = new Base64().encode('hello world\n'.getBytes())println new String(encodedString)}
}

上面的例子中,encode使用了一个外部的依赖包Base64,这个依赖包是在buildscript方法中引入的。

本文已收录于 http://www.flydean.com/gradle-build-script/

最通俗的解读,最深刻的干货,最简洁的教程,众多你不知道的小技巧等你来发现!

欢迎关注我的公众号:「程序那些事」,懂技术,更懂你!

gradle中的build script详解相关推荐

  1. ios首次加载web_IOS_IOS中UIWebView的使用详解,一、初始化与三种加载方式 UI - phpStudy...

    IOS中UIWebView的使用详解 一.初始化与三种加载方式 UIWebView继承与UIView,因此,其初始化方法和一般的view一样,通过alloc和init进行初始化,其加载数据的方式有三种 ...

  2. timm 视觉库中的 create_model 函数详解

    timm 视觉库中的 create_model 函数详解 最近一年 Vision Transformer 及其相关改进的工作层出不穷,在他们开源的代码中,大部分都用到了这样一个库:timm.各位炼丹师 ...

  3. Eclipse Java Build Path详解

    Eclipse Java Build Path详解 1.设置"source folder"与"output folder". * source folder:存 ...

  4. JScript中的条件注释详解(转载自网络)

    JScript中的条件注释详解-转载 这篇文章主要介绍了JScript中的条件注释详解,本文讲解了@cc_on.@if.@set.@_win32.@_win16.@_mac等条件注释语句及可用于条件编 ...

  5. smarty手册-smarty中foreach循环语句详解

    原文地址:smarty手册-smarty中foreach循环语句详解作者:谭博 {foreach}循环也有自身属性的变量,可以通过{$smarty.foreach.name.property}访问,其 ...

  6. Ant之build.xml详解

    Ant的概念  可能有些读者并不连接什么是Ant以及入可使用它,但只要使用通过Linux系统得读者,应该知道 make这个命令.当编译Linux内核及一些软件的源程序时,经常要用这个命令.Make命令 ...

  7. pm2 start 带参数_pm2 start命令中的json格式详解

    就像苏南大叔所说的那样,pm2 start npm -- start这条命令是pm2的万能命令,pm2 start ,就是这一系列命令中的最豪华命令.这个json我们可以理解为一个任务参数描述文件.通 ...

  8. Go中strings的常用方法详解

    string操作在编程中具有极高的频率,那么string中有哪些有用的方法呢? 使用strings直接操作 Compare func Compare(a, b string) int 按照字典序比较两 ...

  9. html5代码转换为视频,HTML5中的视频代码详解

    摘要 腾兴网为您分享:HTML5中的视频代码详解,智学网,云闪付,易推广,小红书等软件知识,以及360win10,流量魔盒,fitbit,上港商城,安卓2.3.7,全民惠,五年级下册英语单词表图片,t ...

最新文章

  1. 深度学习(3)基础3 -- 前向传播与反向传播
  2. [Ruby01]Class, Module, Object,Kernel的关系
  3. BeautifulSoup安装及其应用
  4. Effective C++ 的52个条款列表
  5. 报名开启 | 神策 2019 数据驱动大会「矩·变」等你!
  6. Error: Flash Download failed - Target DLL has been cancelled
  7. leetcode315. 计算右侧小于当前元素的个数(树状数组解法)
  8. 动漫的python语言代码大全_下载动漫壁纸-Python代码
  9. 【面经】中软-数据实习生
  10. Linux 命令(132)—— groupadd 命令
  11. code block怎样导入整个文件夹_XRD分析软件Xpert HighScore Plus 3安装和导入pdf卡片图文教程...
  12. RecyclerView+Retrofit+OkHttp+RxJava
  13. 增加Router接口
  14. 山西医科大学计算机部,山西医科大学医学计算机教学改革探讨.pdf
  15. 谷歌创始人布林申请离婚:身价930亿美元 曾出轨前妻闺蜜
  16. NUnit 入门知识
  17. SpringBoot JPA多对一 持久化是报错object references an unsaved transient instance - save the transient instanc
  18. 超前进位加法器 verilog代码
  19. Jdbc系列八:批量处理
  20. 74HC245的作用

热门文章

  1. js:点击button后返回值
  2. 2013年长沙网络赛G题
  3. HDU3929(容斥原理)
  4. Go语言初探gRPC服务
  5. delphi初级教程之delphi断点调试二
  6. 【Boost】boost库中timer定时器
  7. 第48讲:分布式利器 Scrapy-Redis 原理
  8. QUIC实战(五) 使用nginx quic开发分支部署支持HTTP3 的NGINX
  9. IDEA 的 debug 怎么实现?出于这个好奇心,我越挖越深!
  10. 扔掉,MySQL!性能被 MariaDB 吊打…