Skip to content

Commit d4d01ac

Browse files
committed
更新文件内容
1 parent 74da492 commit d4d01ac

15 files changed

Lines changed: 1107 additions & 113 deletions

File tree

Lines changed: 283 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,283 @@
1+
# Java 应用构建
2+
3+
一个Plugin就是一个定义了一系列Properties与Tasks的集合。
4+
# Java
5+
> [java_plugin](https://docs.gradle.org/current/userguide/java_plugin.html)
6+
使用Java plugin,只需要在build.gradle中加入这句话:
7+
```
8+
apply plugin: 'java'
9+
```
10+
### Built-in Tasks
11+
Gradle和Maven一样,采用了“约定优于配置”的方式对Java project布局,并且布局方式是和Maven一样的,此外,Gradle还可以方便的自定义布局。在Gradle中,一般把这些目录叫做source set。看下官方的答案:
12+
![gradle source set](http://tech.meituan.com/img/gradle/source_set.png)。
13+
这里要注意,每个plugin的source set可能都不一样。同样的,Java plugin还定义好了一堆task,让我们可以直接使用,比如:clean、test、build等等。这些task都是围绕着Java plugin的构建生命周期的:
14+
![](http://tech.meituan.com/img/gradle/javaPluginTasks.png)
15+
图中每一块都是一个task,箭头表示task执行顺序/依赖,比如执行task jar,那么必须先执行task compileJava和task processResources。另外可以看到,Gradle的Java plugin构建生命周期比较复杂,但是也表明了更加灵活,而且,在项目中,一般只使用其中常用的几个:clean test check build 等等。
16+
17+
gradle构建过程中,所有的依赖都表现为配置,比如说系统运行时的依赖是runtime,gradle里有一个依赖配置叫runtime,那么系统运行时会加载这个依赖配置以及它的相关依赖。这里说的有点绕,可以简单理解依赖和maven类似,只不过gradle用configuration实现,所以更灵活,有更多选择。下图是依赖配置关系图以及和task调用的关系图:
18+
![javaPluginConfigurations](http://tech.meituan.com/img/gradle/javaPluginConfigurations.png)
19+
可以看到,基本和Maven是一样的。其实Gradle里面这些依赖(scope)都是通过configuration来实现的,这里就不细说,有兴趣的可以研究一下官方资料。
20+
21+
### Project Structure
22+
![](https://lippiouyang.gitbooks.io/gradle-in-action-cn/content/images/dag12.png)
23+
现在你可以构建你的项目了,java插件添加了一个build任务到你项目中,build任务编译你的代码、运行测试然后打包成jar文件,所有都是按序执行的。运行gradle build之后你的输出应该是类似这样的:
24+
25+
```
26+
$ gradle build
27+
:compileJava
28+
:processResources UP-TO-DATE
29+
:classes
30+
:jar
31+
:assemble
32+
:compileTestJava UP-TO-DATE
33+
:processTestResources UP-TO-DATE
34+
:testClasses UP-TO-DATE
35+
:test
36+
:check
37+
:build
38+
39+
```
40+
41+
输出的每一行都表示一个可执行的任务,你可能注意到有一些任务标记为UP_TO-DATE,这意味着这些任务被跳过了,gradle能够自动检查哪些部分没有发生改变,就把这部分标记下来,省的重复执行。在大型的企业项目中可以节省不少时间。执行完gradle build之后项目结构应该是类似这样的:
42+
43+
![](https://lippiouyang.gitbooks.io/gradle-in-action-cn/content/images/dag13.png)![](https://lippiouyang.gitbooks.io/gradle-in-action-cn/content/images/dag14.png)
44+
45+
在项目的根目录你可以找到一个build目录,这里包含了所有的输出,包含class文件,测试报告,打包的jar文件,以及一些用来归档的临时文件。如果你之前使用过maven,它的标准输出是target,这两个结构应该很类似。jar文件目录build/libs下可以直接运行,jar文件的名称直接由项目名称得来的,这里是todo-app。
46+
### 自定义属性
47+
Java插件是一个非常固执的框架,对于项目很多的方面它都假定有默认值,比如项目布局,如果你看待世界的方法是不一样的,Gradle给你提供了一个自定义约定的选项。想知道哪些东西是可以配置的?可以参考这个手册:http://www.gradle.org/docs/current/dsl/,之前提到过,运行命令行gradle properties可以列出可配置的标准和插件属性以及他们的默认值。
48+
#### 修改项目与插件属性
49+
```
50+
//Identifies project’sversion through a number scheme
51+
version = 0.1
52+
53+
//Sets Java version compilation compatibility to 1.6
54+
sourceCompatibility = 1.6
55+
56+
//Adds Main-Class header to JAR file’s manifest
57+
58+
jar {
59+
manifest {
60+
attributes 'Main-Class': 'com.manning.gia.todo.ToDoApp'
61+
}
62+
}
63+
```
64+
打包成JAR之后,你会发现JAR文件的名称变成了todo-app-0.1.jar,这个jar包含了main-class首部,你就可以通过命令java -jar build/libs/todo-app-0.1.jar运行了。
65+
#### 项目布局
66+
```
67+
//Replaces conventional source code directory with list of different directories
68+
69+
sourceSets {
70+
main {
71+
java {
72+
srcDirs = ['src']
73+
}
74+
}
75+
//Replaces conventional test source code directory with list of different directories
76+
77+
test {
78+
java {
79+
srcDirs = ['test']
80+
}
81+
}
82+
}
83+
84+
//Changes project output property to directory out
85+
86+
buildDir = 'out'
87+
```
88+
89+
90+
## Web Application
91+
92+
# publish(发布)
93+
## Maven Central
94+
Gradle构建的项目,发布到仓库中,也非常容易:
95+
96+
```
97+
apply plugin: 'maven'
98+
99+
uploadArchives {
100+
repositories {
101+
ivy {
102+
credentials {
103+
username "username"
104+
password "pw"
105+
}
106+
url "http://repo.mycompany.com"
107+
}
108+
}
109+
}
110+
```
111+
112+
# 多项目结构
113+
114+
115+
每一个活跃的项目会随着时间慢慢增长的,一开始可能只是个很小的项目到后面可能包含很多包和类。为了提高可维护性和解藕的目的,你可能想把项目根据逻辑和功能来划分成一个个模块。模块通常按照等级来组织,相互之间可以定义依赖。Gradle给项目模块化提供了强大的支持,在Gradle中每个模块都是一个项目,我们称之为多项目构建。
116+
117+
# Multiple Projects Structure
118+
在Gradle中,使用文件settings.gradle定义当前项目的子项目,格式如下所示:
119+
```
120+
include 'sub-project1', 'sub-project2', 'sub-project3',
121+
```
122+
它表示在当前的项目下建立三个子项目,分别为'sub-project1', 'sub-project2', 'sub-project3'。默认情况下,每个子项目的名称对应着当前操作系统目录下的一个子目录。
123+
124+
当Gradle运行时,会根据settings.gradle的配置情况,构建一个单根节点的项目树。其中的每个子节点代表一个项目(Project),每个项目都有一个唯一的路径表示它在当前树中的位置,路径的定义方式类似:
125+
```
126+
Root:<Level1-子节点>:<Level2-子节点>:<Level3-子节点>
127+
```
128+
也可以简写成“:<Level1-子节点>:<Level2-子节点>:<Level3-子节点>”。借助这种路径的定义方式,我们可以在build.gradle去访问不同的子项目。另外,对于单项目,实际上是一种特殊的、只存在根节点,没有子节点的项目树。
129+
130+
例如,我们有个产品A,包括以下几个组件core,web,mobile。分别代表"核心逻辑"、"网站"、“手机客户端”。 因为每个组件是独立的部分,这个时候最好我们能定义多个子项目,让每个子项目分别管理自己的构建。于是我们可以这样定义A/settings.gradle
131+
```
132+
include 'core', 'web', 'mobile'
133+
```
134+
按照之前描述的,core组件对应A/core目录,web组件对应A/web目录,mobile组件对应A/mobile目录。接下来,我们就可以在每个组件内部,定义build.gradle负责管理当前组件的构建。
135+
136+
Gradle提供了一个内建的task 'gradle projects',可以 帮助我们查看当前项目所包含的子项目,下面让我们看看gradle projects的输出结果:
137+
```
138+
$ gradle projects
139+
:projects
140+
------------------------------------------------------------
141+
Root project
142+
------------------------------------------------------------
143+
Root project 'A'
144+
+--- Project ':core'
145+
+--- Project ':mobile'
146+
\--- Project ':web
147+
```
148+
结果一目了然,首先是Root级别的项目A,然后是A下面的子项目'core', 'mobile', 'mobile'
149+
150+
最终的文件以及目录结构如下所示:
151+
```
152+
A
153+
--settings.gradle
154+
--build.gradle
155+
--core
156+
--build.gradle
157+
--web
158+
--build.gradle
159+
--mobile
160+
--build.gradle
161+
```
162+
如果你不喜欢这种默认的结构,也可以按照如下方式定义子项目的名称和物理目录结构:
163+
include(':core)
164+
project(':core').projectDir = new File(settingsDir, 'core-xxx')
165+
166+
include(':web)
167+
project(':web').projectDir = new File(settingsDir, 'web-xxx')
168+
169+
include(':mobile)
170+
project(':mobile').projectDir = new File(settingsDir, 'mobile-xxx')
171+
172+
在这个例子中,子项目core实际上对应的物理目录为A/core-xxx,web实际上对应的是A/web-xxx,mobile也类似。
173+
174+
虽然我们更改了子项目的物理目录结构,不过由于我们在build.gradle中使用的是类似 “ :<SubProject>”的方式访问对应的子项目,所以目录结构的改变,对我们Gradle的构建脚本并不会产生影响。
175+
176+
接下来,考虑一个更复杂的情况,随着产品的发展,mobile这个组件慢慢的划分成了Android和IOS两个部分,这时我们只需要在目录A/mobile下定义新的settings.gradle,并加入如下部分:
177+
include 'android', 'ios'
178+
179+
现在,mobile组件下将存在两个新的子项目 "android"和"ios"
180+
181+
于是,这时候'gradle projects'的目录结构就变成
182+
A
183+
--settings.gradle
184+
--core
185+
--build.gradle
186+
--web
187+
--build.gradle
188+
--mobile
189+
--settings.gradle
190+
--ios
191+
--build.gradle
192+
--android
193+
--build.gradle
194+
195+
196+
197+
## Inherited properties and methods
198+
任何定义在顶层项目中的方法或者属性自动地对于子项目是可见的,可以通过这种方式来定义一些公共的配置
199+
200+
## Intellij-Idea Support
201+
笔者一直用Intellij作为J2EE的开发工具,在配置Gradle多项目结构的情况下,为了方便能够动态的导入,譬如在如下项目中:
202+
![](http://i.stack.imgur.com/t4cWT.png)
203+
如果希望在子项目里直接用`import`导入其他依赖项目的类包,可以先为每一个项目添加`idea`插件,譬如:
204+
```
205+
allprojects { apply plugin: "idea" }
206+
```
207+
然后再运行:
208+
```
209+
gradle (cleanIdea) idea
210+
```
211+
最后再打开生成好的IDEA的项目。
212+
213+
# Tasks
214+
对于大多数构建工具,对于子项目的配置,都是基于继承的方式。Gradle除了提供继承的方式来设置子项目,还提供了另外一种集中的配置方式,方便我们统一管理子项目的信息。下面看一个例子,打开A/build.gradle,输入如下部分:
215+
216+
allprojects {
217+
218+
allprojects {
219+
task hello << {task -> println "I'm $task.project.name" }
220+
221+
allprojects {
222+
task hello << {task -> println "I'm $task.project.name" }
223+
}
224+
225+
allprojects {
226+
task hello << {task -> println "I'm $task.project.name" }
227+
}
228+
subprojects {
229+
230+
allprojects {
231+
task hello << {task -> println "I'm $task.project.name" }
232+
}
233+
subprojects {
234+
hello << {println "- I am the sub project of A"}
235+
236+
allprojects {
237+
task hello << {task -> println "I'm $task.project.name" }
238+
}
239+
subprojects {
240+
hello << {println "- I am the sub project of A"}
241+
}
242+
243+
allprojects {
244+
task hello << {task -> println "I'm $task.project.name" }
245+
}
246+
subprojects {
247+
hello << {println "- I am the sub project of A"}
248+
}
249+
project(':core').hello << {
250+
251+
allprojects {
252+
task hello << {task -> println "I'm $task.project.name" }
253+
}
254+
subprojects {
255+
hello << {println "- I am the sub project of A"}
256+
}
257+
project(':core').hello << {
258+
println "- I'm the core component and provide service for other parts."
259+
260+
allprojects {
261+
task hello << {task -> println "I'm $task.project.name" }
262+
}
263+
subprojects {
264+
hello << {println "- I am the sub project of A"}
265+
}
266+
project(':core').hello << {
267+
println "- I'm the core component and provide service for other parts."
268+
}
269+
270+
对于上面所示的代码,已经很表意了:
271+
272+
allprojects{xxx} 这段代码表示,对于所有的project,Gradle都将定义一个名称是hello的Task { println "I'm $task.[project.name](http://project.name/)"} 。
273+
274+
subprojects{xxxx}的这段代码表示,对于所有的子project,将在名称为hello的Task上追加Action {println "- I am the sub project of A"}
275+
276+
注意:关于Task和Action的关系,请看我之前写的本系列的第一部分。
277+
278+
project(':core')的这段代码表示,对于名称为core的project,将在名称为hello的Task上追加Action { println "- I'm the core component and provide service for other parts." }
279+
280+
## Task Runner
281+
之前我们已经了解了多项目的结构以及如何通过路径去访问子项目。现在让我们看看如何使用Gradle来执行多项目。
282+
在Gradle 中,当在当前项目上执行gradle <Task>时,gradle会遍历当前项目以及其所有的子项目,依次执行所有的同名Task,注意:子项目的遍历顺序并不是按照 setting.gradle中的定义顺序,而是按照子项目的首字母排列顺序。
283+
基于刚才的例子,如果我们在根目录下,执行gradle hello,那么所有子项目的“hello” Task都会被执行。如果我们在mobile目录下执行gradle hello,那么mobile、android以及IOS的“hello” Task都会被执行。关于该例子的运行结果,这里就不贴出来了。大家如果有兴 趣的话可以试试。

0 commit comments

Comments
 (0)