Gradle之恋(6)-命令行详解

虽然很多童鞋都必须要用IDE,但有些命令是IDE很难表现出来的,反而是命令行返璞归真。本文就带你来剖析Gradle的命令行。

本文不包括试验性(incubating)的选项,如–configure-on-demand、–parallel、–max-workers等。因为他们的变更可能性和频率很大,感兴趣的童鞋可自行研究。

Gradle

Gradle命令格式

Gradle命令行格式

gradle [option…] [task…]

option表示选项,task表示任务,省略号可以是多个,其实options和task是顺序并非严格按上面的排列。

-a(–no-rebuild)

-a(–no-rebuild) -a是短格式,–no-rebuild是长格式,此选项的作用是不重新构建依赖的项目,如你构建的是多项目应用,如下面的构建脚本所示,user依赖uitls

// build.gradle

subprojects{
apply plugin: 'java'
}

project(':user'){
dependencies {
compile project(':utils')
}
}

如你构建user,则utils也会构建

$ gradle user:build

输出
no-rebuild
如果加上-a选项,则不会构建utils,输出中不会打印utils的信息(红框中的)。

-b, -c, -p

Gradle默认的构建脚本文件名是build.gradle,配置的文件名是settings.gradle,但你可以通过-b(–build-file)来指定构建脚本,-c(–settings-file)来指定配置文件,这种比较适合多种开发场景如测试、开发等。

// cmd/build-setting/test-build.gradle
apply plugin: 'java'

task hello {
doLast {
println "using build file '$buildFile.name' in '$buildFile.parentFile.name'."
}
}

执行gradle -q hello -b cmd/build-setting/test-build.gradle输出

using build file ‘test-build.gradle’ in ‘build-setting’.

其实使用-b选项并非是把build script用于当前的位置的项目,其含义是构建build script所在的项目,比如如果执行gradle -q build -b cmd/build-setting/test-build.gradle你会发现构建的build在cmd/build-setting/目录里生成。

使用-p(–project-dir)选项也是类似的效果,把test-build.gradle重命名为默认的build.gradle,执行gradle -q hello -p cmd/build-setting/输出

using build file ‘build.gradle’ in ‘build-setting’.

还有个特殊情况,当使用-b的时候,Gradle会忽略配置文件settings.gradle,即使使用-c来指定也不行,当然单项目可以没有settings.gradle文件,下面来看看多项目的.

// settings.gradle
rootProject.name = 'blog'

include 'user'

// test-build.gradle
project(':user'){
task hello {
doLast {
println "using build file '$buildFile.name' in '$buildFile.parentFile.name'."
}
}
}

进入test-build.gradle目录并执行gradle -q :user:hello -b test-build.gradle输出

FAILURE: Build failed with an exception.

……..

* What went wrong:
A problem occurred evaluating root project ‘build-setting’.
> Project with path ‘:user’ could not be found in root project ‘build-setting’.

由此可见settings.gradle被忽略,不仅root project没有被设置,而且找不到项目user。可见-b和-c不能共存,构建脚本和配置文件两者必须有一个是默认文件名。

其实我们还可以在settings.gradle中通过设置rootProject.buildFileName属性来指定build script

// settings.gradle

rootProject.name = 'blog'
rootProject.buildFileName = 'test-build.gradle'

include 'user'

现在你可以执行gradle -q :user:hello,当然你也可以使用-c 指定配置文件如gradle -q :user:hello -c settings.gradle

–console

指定控制台输出类型,可选值有 ‘plain’, ‘auto’ (默认) , ‘rich’。

  • plain 是生成普通的文本,该选项禁止所有颜色和富文本输出;
  • auto (默认)当构建程序与控制台相关联时启动 颜色和富文本输出,或者不关联时生成普通文本;
  • rich 启动颜色和富文本输出,忽略构建程序是否关联了控制台,如果没有关联构建输出将输出 ANSI 控制字符来生产富文本输出;

执行“gradle -q build –console=rich”输出
console-rich
执行“gradle -q build –console=plain”输出
console-plain

–continue

Gradle默认的任务执行模式尽快呈现异常即任务失败立即终止并抛出异常信息,比如编译失败,不会执行单元测试。而选项–continue的作用:任务队列中即使某个任务失败,不会终止执行,而是会继续执行下一个任务。

-P, -D

-D 在Gradle和Java命令行一样的作用,都是给当前的JVM提供参数,但也可以给Gradle设置额外的属性;而-P是Gradle专用的,提供额外的属性,如

// build.gradle
task printProps {
doLast {
println cmdPname
println cmdDname
}
}

执行“gradle -q -PcmdPname=zhai -Dorg.gradle.project.cmdDname=qianfeng printProps”输出

zhai
qianfeng

-q, -i, -d, -s, -S

Gradle有主要是靠日志和做交互,它有6种日志级别,由高到低是

  • ERROR - 错误消息
  • QUIET - 重要的信息消息
  • WARNING - 警告消息
  • LIFECYCLE - 进度信息消息
  • INFO - 信息性消息
  • DEBUG - 调试消息

-q -i -d 主要是用于设置日志级别,默认是LIFECYCLE级别:

  • -q(–quite)只记录Error错误,也就是把日志级别设置为ERROR;
  • -i(–info)把日志级别设置为INFO;
  • -d(–debug)把日志级别设置为最低的debug,并跟踪正常的堆栈信息;

而-s 和-S主要是为了跟踪堆栈信息的:

  • -s(–stacktrace)打印堆栈信息;
  • -S(–full-stacktrace)打印全部堆栈信息;

与daemon相关

  • –daemon 使用Gradle的守护进程构建,能够提高构建效率,如果守护进程没启动或现有的都处于忙碌状态,就启动一个;
  • –no-daemon 如果你已经配置为使用守护进程构建,可以使用该选项本次不用守护进程构建;
  • –stop 停止正在运行的守护进程;
  • –status 查看正在运行和最近停止的守护进程;

-g, -I

-g(–gradle-user-home)设置Gradle的user home,默认是USER_HOME/.gradle。
我们知道maven有setting.xml用于设置maven的一些和项目无关的公用的配置,而在Gradle就是利用init.gradle来做到,而如果inti.gradle没有放在约定的位置,则就需要使用-I(–init-script)来指定了。

-m, -x

-m(–dry-run) 有时你可能只是想验证下build script是否正确执行比如哪些任务执行,是否按照预期的顺序执行等,并不想真正执行任务的动作或行为,那么这时就要用到-m选项。
-x(–exclude-task) 当任务有依赖时,并不想执行依赖中的任务可以使用-x选项来排除改任务。
由于两个选项简单而且容易理解,这里合在一起给一个实例,如验证构建,但跳过单元测试的命令行

gradle -m build -x test

–offline, –refresh-dependencies

–offline 选项的作用是让Gradle只使用本地cache里的依赖,如果cache中没有也不会更新依赖,而是失败。
–refresh-dependencies 选项的作用是检查依赖是否有更新比如动态版本、SHA1进行本地cache和远程仓库散列码的对比等,有更行则下载更新进行构建。使用这种方式免去了手动删除cache的麻烦。

–profile

该选项将在项目的根目录build/reports/profile生成一个以构建时间为名称的html文件,其中记录一些有用的信息比如执行任务花费的时间以及任务的状态等。
Gradle Profile

–project-cache-dir

用于指定project-specific缓存目录,默认是在项目的.gradle目录里。project-specific是用于项目的增量编译等,放在.gradle中的好处是gradle wrapper也可以使用,请根据需要使用。

–rerun-tasks

该选项会忽略所有任务执行的优化如增量构建,强制重新执行任务。

–recompile-scripts

绕开缓存,重新编译script。

-u

-u(–no-search-upwards)禁止向父目录搜索setting.gradle文件。

翟前锋 wechat
欢迎订阅我的微信公众号:zhaiqianfeng!