Gradle学习之使用java plugin
请通过下面方式下载本系列文章的Github演示样例代码:
git clone https://github.com/davenkin/gradle-learning.git
Gradle最经常使用的Plugin便是java Plugin了。和其它Plugin一样,java Plugin并没有什么特别的地方,仅仅是向Project中引入了多个Task和Property。当然,java Plugin也有比較与众不同的地方,当中之中的一个便是它在项目中引入了构建生命周期的概念,就像Maven一样。可是,和Maven不同的是,Gradle的项目构建生命周期并非Gradle的内建机制,而是由Plugin自己引入的。
(1)java Plugin引入的主要Task
运行“gradle build”,我们已经能够看到java Plugin所引入的主要Task:
:compileJava
:processResources
:classes
:jar
:assemble
:compileTestJava
:processTestResources
:testClasses
:test
:check
:build
BUILD SUCCESSFUL
Total time: 4.813 secs
build也是java Plugin所引入的一个Task,它依赖于其它Task,其它Task又依赖于另外的Task,所以有了以上Task运行列表。以上Task运行列表基本上描写叙述了java Plugin向项目中所引入的构建生命周期概念。
除了定义众多的Task外,java Plugin还向Project中增加了一些额外的Property。比方,sourceCompatibility用于指定在编译Java源文件时所使用的Java版本号,archivesBaseName用于指定打包成Jar文件时的文件名。
(2)Java项目的文件夹结构
在默认情况下,Gradle採用了与Maven同样的Java项目文件夹结构:
关于Maven标准文件夹结构,请參考Maven官网。当然,跟Maven一样,以上仅仅是默认的文件夹结构,我们能够通过配置来改动这些文件夹结构。
(3)配置已有source set
Gradle在採用了Maven文件夹结构的同一时候,还融入了自己的一些概念,即source set。对于上图中的文件夹结构,Gradle实际上为我们创建了2个source set,一个名为main,一个名为test。
请注意,这里的source set的名字main与上图文件夹结构中的main文件夹并无必定的联系,仅仅是在默认情况下,Gradle为了source set概念到文件系统文件夹结构的映射方便,才採用了同样的名字。对于test, 也是如此。我们全然能够在build.gradle文件里又一次配置这些source set所相应的文件夹结构,同一时候,我们还能够创建新的source set。
从本质上讲,Gradle的每一个source set都包括有一个名字,而且包括有一个名为java的Property和一个名为resources的Property,他们分别用于表示该source set所包括的Java源文件集合和资源文件集合。在实际应用时,我们能够将他们设置成不论什么文件夹值。比方,我们能够又一次设置main的文件夹结构:
sourceSets {
main {
java {
srcDir 'java-sources'
}
resources {
srcDir 'resources'
}
}
}
此时所相应的项目文件夹结构例如以下:
我们又一次设置了main的文件夹结构,而对于test,我们保留了Gradle默认的文件夹结构。
(4)创建新的source set
要创建一个新的source set也是很easy的,比方,我们能够创建一个名为api的source set来存放程序中的接口类:
sourceSets { api}
当然,以上配置也能够与main放在一起。在默认情况下,该api所相应的Java源文件文件夹被Gradle设置为${path-to-project}/src/api/java,而资源文件文件夹则被设置成了${path-to-project}/src/api/resources。我们也能够像上面的main一样又一次对api的文件夹结构进行配置。
Gradle会自己主动地为每个新创建的source set创建对应的Task,创建规律为:对于名为mySourceSet的source set,Gradle将为其创建compile<mySourceSet>Java、process<mySourceSet>Resources和<mySourceSet>Classes这3个Task。对于这里api而言,Gradle会为其创建名为compileApiJava、processApiResource和apiClasses Task。我们能够在命令行中运行"gradle apiClasses"。
你可能会注意到,对于main而言,Gradle并没有对应的compileMainJava,原因在于:因为main是Gradle默认创建的source set,而且又是及其重要的source set,Gradle便省略掉了当中的“Main”,而是直接使用了compileJava作为main的编译Task。对于test来说,Gradle依旧採用了compileTestJava。
通常的情况是,我们自己创建的名为api的source set会被其它source set所依赖,比方main中的类须要实现api中的某个接口等。此时我们须要做两件事情。第一,我们须要在编译main之前对api进行编译,即编译main中Java源文件的Task应该依赖于api中的Task:
classes.dependsOn apiClasses
第二,在编译main时,我们须要将api编译生成的class文件放在main的classpath下。此时,我们能够对main和test做下面配置:
sourceSets {
main {
compileClasspath = compileClasspath + files(api.output.classesDir)
}
test {
runtimeClasspath = runtimeClasspath + files(api.output.classesDir)
}
}
之所以须要对test的runtimeClasspath进行设置,是由于在执行測试时我们也须要载入api中的类。
git clone https://github.com/davenkin/gradle-learning.git
Gradle最经常使用的Plugin便是java Plugin了。和其它Plugin一样,java Plugin并没有什么特别的地方,仅仅是向Project中引入了多个Task和Property。当然,java Plugin也有比較与众不同的地方,当中之中的一个便是它在项目中引入了构建生命周期的概念,就像Maven一样。可是,和Maven不同的是,Gradle的项目构建生命周期并非Gradle的内建机制,而是由Plugin自己引入的。
(1)java Plugin引入的主要Task
运行“gradle build”,我们已经能够看到java Plugin所引入的主要Task:
:compileJava
:processResources
:classes
:jar
:assemble
:compileTestJava
:processTestResources
:testClasses
:test
:check
:build
BUILD SUCCESSFUL
Total time: 4.813 secs
build也是java Plugin所引入的一个Task,它依赖于其它Task,其它Task又依赖于另外的Task,所以有了以上Task运行列表。以上Task运行列表基本上描写叙述了java Plugin向项目中所引入的构建生命周期概念。
除了定义众多的Task外,java Plugin还向Project中增加了一些额外的Property。比方,sourceCompatibility用于指定在编译Java源文件时所使用的Java版本号,archivesBaseName用于指定打包成Jar文件时的文件名。
(2)Java项目的文件夹结构
在默认情况下,Gradle採用了与Maven同样的Java项目文件夹结构:
关于Maven标准文件夹结构,请參考Maven官网。当然,跟Maven一样,以上仅仅是默认的文件夹结构,我们能够通过配置来改动这些文件夹结构。
(3)配置已有source set
Gradle在採用了Maven文件夹结构的同一时候,还融入了自己的一些概念,即source set。对于上图中的文件夹结构,Gradle实际上为我们创建了2个source set,一个名为main,一个名为test。
请注意,这里的source set的名字main与上图文件夹结构中的main文件夹并无必定的联系,仅仅是在默认情况下,Gradle为了source set概念到文件系统文件夹结构的映射方便,才採用了同样的名字。对于test, 也是如此。我们全然能够在build.gradle文件里又一次配置这些source set所相应的文件夹结构,同一时候,我们还能够创建新的source set。
从本质上讲,Gradle的每一个source set都包括有一个名字,而且包括有一个名为java的Property和一个名为resources的Property,他们分别用于表示该source set所包括的Java源文件集合和资源文件集合。在实际应用时,我们能够将他们设置成不论什么文件夹值。比方,我们能够又一次设置main的文件夹结构:
sourceSets {
main {
java {
srcDir 'java-sources'
}
resources {
srcDir 'resources'
}
}
}
此时所相应的项目文件夹结构例如以下:
我们又一次设置了main的文件夹结构,而对于test,我们保留了Gradle默认的文件夹结构。
(4)创建新的source set
要创建一个新的source set也是很easy的,比方,我们能够创建一个名为api的source set来存放程序中的接口类:
sourceSets { api}
当然,以上配置也能够与main放在一起。在默认情况下,该api所相应的Java源文件文件夹被Gradle设置为${path-to-project}/src/api/java,而资源文件文件夹则被设置成了${path-to-project}/src/api/resources。我们也能够像上面的main一样又一次对api的文件夹结构进行配置。
Gradle会自己主动地为每个新创建的source set创建对应的Task,创建规律为:对于名为mySourceSet的source set,Gradle将为其创建compile<mySourceSet>Java、process<mySourceSet>Resources和<mySourceSet>Classes这3个Task。对于这里api而言,Gradle会为其创建名为compileApiJava、processApiResource和apiClasses Task。我们能够在命令行中运行"gradle apiClasses"。
你可能会注意到,对于main而言,Gradle并没有对应的compileMainJava,原因在于:因为main是Gradle默认创建的source set,而且又是及其重要的source set,Gradle便省略掉了当中的“Main”,而是直接使用了compileJava作为main的编译Task。对于test来说,Gradle依旧採用了compileTestJava。
通常的情况是,我们自己创建的名为api的source set会被其它source set所依赖,比方main中的类须要实现api中的某个接口等。此时我们须要做两件事情。第一,我们须要在编译main之前对api进行编译,即编译main中Java源文件的Task应该依赖于api中的Task:
classes.dependsOn apiClasses
第二,在编译main时,我们须要将api编译生成的class文件放在main的classpath下。此时,我们能够对main和test做下面配置:
sourceSets {
main {
compileClasspath = compileClasspath + files(api.output.classesDir)
}
test {
runtimeClasspath = runtimeClasspath + files(api.output.classesDir)
}
}
之所以须要对test的runtimeClasspath进行设置,是由于在执行測试时我们也须要载入api中的类。