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目录:

  1. $ mkdir gradle-test
  2. $ cd gradle-test

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

  1. gradle init
  2. Starting a Gradle Daemon (subsequent builds will be faster)
  3. Select type of project to generate:
  4. 1: basic
  5. 2: application
  6. 3: library
  7. 4: Gradle plugin
  8. Enter selection (default: basic) [1..4] 2
  9. Select implementation language:
  10. 1: C++
  11. 2: Groovy
  12. 3: Java
  13. 4: Kotlin
  14. 5: Scala
  15. 6: Swift
  16. Enter selection (default: Java) [1..6] 3
  17. Split functionality across multiple subprojects?:
  18. 1: no - only one application project
  19. 2: yes - application and library projects
  20. Enter selection (default: no - only one application project) [1..2] 1
  21. Select build script DSL:
  22. 1: Groovy
  23. 2: Kotlin
  24. Enter selection (default: Groovy) [1..2] 1
  25. Select test framework:
  26. 1: JUnit 4
  27. 2: TestNG
  28. 3: Spock
  29. 4: JUnit Jupiter
  30. Enter selection (default: JUnit 4) [1..4] 1
  31. Project name (default: gradle-test):
  32. Source package (default: gradle.test):
  33. > Task :init
  34. Get more help with your project: https://docs.gradle.org/6.7/samples/sample_building_java_applications.html
  35. BUILD SUCCESSFUL in 45s
  36. 2 actionable tasks: 2 executed

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

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

  1. .
  2. ├── app
  3.    ├── build.gradle
  4.    └── src
  5.    ├── main
  6.       ├── java
  7.          └── gradle
  8.          └── test
  9.          └── App.java
  10.       └── resources
  11.    └── test
  12.    ├── java
  13.       └── gradle
  14.       └── test
  15.       └── AppTest.java
  16.    └── resources
  17. ├── gradle
  18.    └── wrapper
  19.    ├── gradle-wrapper.jar
  20.    └── gradle-wrapper.properties
  21. ├── gradlew
  22. ├── gradlew.bat
  23. └── settings.gradle
  24. 14 directories, 8 files

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

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

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

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

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

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

  1. plugins {
  2. // Apply the application plugin to add support for building a CLI application in Java.
  3. id 'application'
  4. }
  5. repositories {
  6. // Use JCenter for resolving dependencies.
  7. jcenter()
  8. }
  9. dependencies {
  10. // Use JUnit test framework.
  11. testImplementation 'junit:junit:4.13'
  12. // This dependency is used by the application.
  13. implementation 'com.google.guava:guava:29.0-jre'
  14. }
  15. application {
  16. // Define the main class for the application.
  17. mainClass = 'gradle.test.App'
  18. }

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

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

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

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

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

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

task详细讲解

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

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

task脚本

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

  1. task hello {
  2. doLast {
  3. println 'Hello www.flydean.com!'
  4. }
  5. }

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

我们这样运行:

  1. gradle -q hello
  2. Hello www.flydean.com!

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

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

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

  1. task upper {
  2. doLast {
  3. String someString = 'www.flydean.com'
  4. println "Original: $someString"
  5. println "Upper case: ${someString.toUpperCase()}"
  6. }
  7. }

运行结果:

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

或者执行times操作:

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

task依赖

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

  1. task hello {
  2. doLast {
  3. println 'Hello www.flydean.com!'
  4. }
  5. }
  6. task intro {
  7. dependsOn hello
  8. doLast {
  9. println "I'm flydean"
  10. }
  11. }

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

动态task

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

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

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

  1. 4.times { counter ->
  2. task "task$counter" {
  3. doLast {
  4. println "I'm task number $counter"
  5. }
  6. }
  7. }
  8. task0.dependsOn task2, task3

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

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

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

  1. task myTask {
  2. ext.myProperty = "www.flydean.com"
  3. }
  4. task printTaskProperties {
  5. doLast {
  6. println myTask.myProperty
  7. }
  8. }

默认task

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

  1. defaultTasks 'clean', 'run'
  2. task clean {
  3. doLast {
  4. println 'Default Cleaning!'
  5. }
  6. }
  7. task run {
  8. doLast {
  9. println 'Default Running!'
  10. }
  11. }
  12. task other {
  13. doLast {
  14. println "I'm not a default task!"
  15. }
  16. }

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

build script的外部依赖

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

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

  1. import org.apache.commons.codec.binary.Base64
  2. buildscript {
  3. repositories {
  4. mavenCentral()
  5. }
  6. dependencies {
  7. classpath group: 'commons-codec', name: 'commons-codec', version: '1.2'
  8. }
  9. }
  10. task encode {
  11. doLast {
  12. def byte[] encodedString = new Base64().encode('hello world\n'.getBytes())
  13. println new String(encodedString)
  14. }
  15. }

上面的例子中,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. MYSQL(将数据加载到表中)

    1. 创建和选择数据库 mysql> CREATE DATABASE menagerie; mysql> USE menagerie Database changed 2. 创建表 mys ...

  2. DSL是什么?Elasticsearch的Query DSL又是什么?

    1.DSL简介 DSL 其实是 Domain Specific Language 的缩写,中文翻译为领域特定语言.而与 DSL 相对的就是 GPL,这里的 GPL 并不是我们知道的开源许可证(备注:G ...

  3. 给HTML页面设置自己的icon

    原因: 不知道为什么,SpringBoot中自动设置icon失效了. 解决方法: 在head标签中添加自己想要使用的icon图片.后缀使用图片格式,不要使用.ico. <link href=&q ...

  4. 前端工程构建之谈:gulp3要不要升级到Gulp4

    关于升级还是不升级,这是一个哲学问题. gulp4的语法更加现代,支持ES6的大部分写法,使用exports的方式去暴露任务组合,更加灵活和便捷. gulp4同时也提供了很多强大的API,例如para ...

  5. 它真正的父进程在fork出子进程后就先于子进程exit退出了,所以它是一个由init继承的孤儿进程

    [Linux编程]守护进程(daemon)详解与创建_mick_seu的博客-CSDN博客_linux daemon https://blog.csdn.net/woxiaohahaa/article ...

  6. 函数式编程 偏函数 生成器 yield

    高阶函数 # 高阶函数def f(x): return x * x# map()函数接收两个参数,一个是函数,一个是Iterable,map将传入的函数依次作用到序列的每个元素,并把结果作为新的Ite ...

  7. loj黑暗城堡

    黑暗城堡 题目描述 你知道黑暗城堡有\(N\)个房间,M 条可以制造的双向通道,以及每条通道的长度. 城堡是树形的并且满足下面的条件: 设\(D_i\)为如果所有的通道都被修建,第i号房间与第1号房间 ...

  8. 六:SpringBoot-集成Druid连接池,配置监控界面

    SpringBoot-集成Druid连接池,配置监控界面 1.Druid连接池 1.1 Druid特点 2.SpringBoot整合Druid 2.1 引入核心依赖 2.2 数据源配置文件 2.3 核 ...

  9. 封装SpringJdbcTemplate

    package com.jy.modules.cms.query; import java.util.List; import java.util.Map; public interface quer ...

  10. 从官方文档中探索MySQL分页的几种方式及分页优化

    概览 相比于Oracle,SQL Server 等数据库,MySQL分页的方式简单得多了,官方自带了分页语法 limit 语句: select * from test_t LIMIT {[offset ...