Multi-project Build

Gradle provides support for modulized projects. Because every module in Gradle are called project, we can call this multi-project build.

Modularizing a project

Identify and refactor to modules

The former project structure is shown below.

The original project structure

As we can see, there are model, repository and web modules, we can modularize this project into 3 modules.

  • model: Data representation of To-do items
  • repository: Storage and retrieval of To-do items
  • web: Web components to handle HTTP requests


    Multi-project build

Assembling build

By running:

$ gradle projects

in the root path, you can get

 ------------------------------------------------------------
       Root project
       ------------------------------------------------------------
        Root project 'todo'
        No sub-projects

This report shows that you are dealing with a single project build.
We can declare sub-projects by settings.gradle

Introducing settings file

The settings file declares the configuration required to instantiate the project’s hierarchy. By default, this file is named settings.gradle and is created alongside the build.gradle file of the root project.
You can call the include in settings.gradle to add sub-projects.

include 'model'
include 'repository','web'

Settings API

Before Gradle assembles its build, it creates an instance of type settings. The interface Settings is a direct representation of settings.gradle. Its main purpose is to add Project instance that is supposed to participate in the multiproject build.

Settings execution

What phase does the code of the settings file is evaluated and executed? During the initialization before any Project instance is configured.
How to find a settings file? There are two steps.

  1. Gradle searches for a settings file in a directory called master with the same nesting level as the current directory.
  2. If no settings file is found in step 1, Gradle searches for a settings file in the parent directories, starting from the current directory. In the case of subproject2, the search would be suproject1 > root.
    Step2 is useful for a hierarchical project.
Hierachical VS Flat

It is recommended that you use the hierarchical project.

Configuring sub-projects

You can define common behavior for all projects or all sub-projects.
You can define the order of projects while evaluation, whose default order is alphanumeric.
You can declare project-specific code.

Define specific behavior

Project-specific behavior is defined with the project.

ext.projectIds = ['group': 'com.manning.gia', 'version': '0.1']
// Declaration of extra property projectIds as a map that holds the key-value pairs for group and version; property can be used in subprojects
group = projectIds.group
version = projectIds.version
project(':model') {
   group = projectIds.group
   version = projectIds.version
   apply plugin: 'java'
}
project(':repository') {
   group = projectIds.group
   version = projectIds.version
   apply plugin: 'java'
}
project(':web') {
   group = projectIds.group
   version = projectIds.version
   apply plugin: 'java'
   apply plugin: 'war'
   apply plugin: 'jetty'
   repositories {
      mavenCentral()
}
// Configures each subproject by project path; actual configuration happens in the closure
   dependencies {
      providedCompile 'javax.servlet:servlet-api:2.5'
      runtime 'javax.servlet:jstl:1.1.2'
   } 
}

If you run gradle build for repository, you will end up with a compile error, for repository project depends on model project. You need to declare the dependation between them.

Define project dependencies

project(':model') {
   ...
}
project(':repository') {
   ...
   dependencies {
     compile project(':model')
   }
}
project(':web') {
   ...
   dependencies {
      compile project(':repository')
      providedCompile 'javax.servlet:servlet-api:2.5'
      runtime 'javax.servlet:jstl:1.1.2'
} }

Partial builds

If you execute a task from the root project, it will run all the build code.
If you want to run a partial build, you can use a command-line option -a or --no-rebuild. With the parameter -a, you will avoid the cost of checking dependency projects.
There are some other arguments.

Declare cross-project task dependencies

Default task execution order: the task on the root level of the multi projects build is always executed first. For the subprojects, the execution order is solely determined by the alphanumeric order of the names of the projects: model comes before repository.
You can use dependsOn to change the order.

Define common behaviors

You can use all projects method to define common behaviors for all projects, you can use subprojects to define behaviors for all sub projects.
/ROOT_PATH/build.gradle

allprojects {
   group = 'com.manning.gia'
   version = '0.1'
}
subprojects {
   apply plugin: 'java'
}
project(':repository') {
   dependencies {
      compile project(':model')
   }
}
project(':web') {
   apply plugin: 'war'
   apply plugin: 'jetty'
   repositories {
      mavenCentral()
}
   dependencies {
      compile project(':repository')
      providedCompile 'javax.servlet:servlet-api:2.5'
      runtime 'javax.servlet:jstl:1.1.2'
} }

You can also add specific project configurations in the project's own build.gradle file.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容