gradle中的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: basic
2: application
3: library
4: Gradle plugin
Enter selection (default: basic) [1..4] 2 Select implementation language:
1: C++
2: Groovy
3: Java
4: Kotlin
5: Scala
6: Swift
Enter selection (default: Java) [1..6] 3 Split functionality across multiple subprojects?:
1: no - only one application project
2: yes - application and library projects
Enter selection (default: no - only one application project) [1..2] 1 Select build script DSL:
1: Groovy
2: Kotlin
Enter selection (default: Groovy) [1..2] 1 Select test framework:
1: JUnit 4
2: TestNG
3: Spock
4: JUnit Jupiter
Enter selection (default: JUnit 4) [1..4] 1 Project 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.html BUILD 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.gradle 14 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 --scan

BUILD SUCCESSFUL in 0s
7 actionable tasks: 7 executed Publishing 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] yes Gradle 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 hello
doLast {
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.Base64

buildscript {
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. Eclipse中的build path详解

    http://blog.csdn.net/qqqqqq654/article/details/53043742

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

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

  3. build.xml详解

    build.xml详解1.<project>标签每个构建文件对应一个项目.<project>标签时构建文件的根标签.它可以有多个内在属性,就如代码中所示,其各个属性的含义分别如 ...

  4. js中鼠标滚轮事件详解

    js中鼠标滚轮事件详解   (以下内容部分内容参考了http://adomas.org/javascript-mouse-wheel/ ) 之前js 仿Photoshop鼠标滚轮控制输入框取值中已使用 ...

  5. VMware虚拟机中如何安装VMWare-Tools详解

    VMware虚拟机中如何安装VMWare-Tools详解 好处:可以支持图形界面,可以支持共享文件功能等 VMware虚拟机中如何配置显 VMware作为一款虚拟机利器,很多人都利用它来实现Linux ...

  6. PHP开发中常见的安全问题详解和解决方法(如Sql注入、CSRF、Xss、CC等

    页面导航: 首页 → 网络编程 → PHP编程 → php技巧 → 正文内容 PHP安全 PHP开发中常见的安全问题详解和解决方法(如Sql注入.CSRF.Xss.CC等) 作者: 字体:[增加 减小 ...

  7. JavaScript中return的用法详解

    JavaScript中return的用法详解 最近,跟身边学前端的朋友了解,有很多人对函数中的this的用法和指向问题比较模糊,这里写一篇博客跟大家一起探讨一下this的用法和指向性问题. 1定义 t ...

  8. Ant之build.xml详解

    Ant之build.xml详解 关键字: ant build.xml Ant的概念 可能有些读者并不连接什么是Ant以及入可使用它,但只要使用通过Linux系统得读者,应该知道make这个命令.当编译 ...

  9. Asp.net中web.config配置文件详解(一)

    本文摘自Asp.net中web.config配置文件详解 web.config是一个XML文件,用来储存Asp.NET Web应用程序的配置信息,包括数据库连接字符.身份安全验证等,可以出现在Asp. ...

随机推荐

  1. 1V升压5V和1.5V升压5V的集成电路芯片

    1.5V和1V输入,要升压输出5V的集成电路芯片合适? 干电池标准电压是1.5V,放电电压后面在0.9V-1V左右,如果要选用干电池1.5V升压到5V的合适的芯片,需要满足低压1V或者0.9V更好的低 ...

  2. 性能测试WAS内存使用的探索和分析

    性能测试中,CPU和内存是关注最多的两个性能指标.以我行应用最多的系统架构(WAS+Oracle)来说,CPU使用率高的问题多发生于数据库,比如索引不当引发的表扫描.绑定变量使用不当引发的硬解析.连接 ...

  3. ESXI6.7主机降级至ESXI6.5

    上一条博客vcenter添加主机失败:https://www.cnblogs.com/Crazy-Liu/p/11211760.html 原因esxi主机和vcenter版本不一致,因为vcenter ...

  4. javax.servlet.ServletException: No adapter for handler

    问题描述: 我的web.xml如下: <?xml version="1.0" encoding="UTF-8"?> <web-app xmln ...

  5. BFS DFS与回溯

    https://blog.csdn.net/u014303647/article/details/88328526 cyc: https://github.com/CyC2018/CS-Notes/b ...

  6. REST以及RESTful

    java作为一门后端语言,其厉害之处在于web,大家比较熟知的各种网络应用,java都能做,那么在这个移动优先的时代,如何继续发挥java的强大呢.通常是让java作为一个app的服务端,为app客户 ...

  7. Java——单例模式、多线程

    单例模式 单例模式练习 单例模式的分类 懒汉式 懒汉式相关练习 饿汉式 饿汉式相关练习 线程安全 使用双重检测机制实现线程安全的懒汉式 使用静态内部类实现线程安全的单例模式 多线程 多线程的三种方式 ...

  8. Jenkins (1、自动化发布war包、2、自动化发布nodejs)

    1.持续集成javaweb 首先咱们需要安装一个 Jenkins,这个就不必多说了,晚上一搜索一大把,然后安装各种插件,配置各种环境变量, 今天我的实验环境是 使用Jenkins 拉取gitlap上项 ...

  9. 查看Linux用的桌面是GNOME、KDE或者其他(转)

    http://superuser.com/questions/96151/how-do-i-check-whether-i-am-using-kde-or-gnome 1) pgrep -l &quo ...

  10. Python初学者随笔(一)_ 用Python写的第一个游戏“猜数字”

    如标题所写,这篇随笔主要记录下学习Python过程中用Python写的第一个游戏--"猜数字"_跟着"小甲鱼"学Python,链接: https://b23.t ...