Gradle構建多模塊項目

通常我在使用Maven構建項目的時候是將應用項目劃分爲多個更小的模塊。

Gradle 項目也擁有多於一個組件，我們也將其稱之爲多項目構建（multi-project build）。

我們首先創建一個多項目構建：

mkdir cmdGradleProj && cd cmdGradleProj

gradle init

這時候

D:\cmdGradleProj> 目錄下執行：

tree /f

的項目結構如下：

│  build.gradle
│  gradlew
│  gradlew.bat
│  settings.gradle
│  
├─.gradle
│  └─3.0
│      └─taskArtifacts
│              cache.properties
│              cache.properties.lock
│              fileHashes.bin
│              fileSnapshots.bin
│              fileSnapshotsToTreeSnapshotsIndex.bin
│              taskArtifacts.bin
│              
└─gradle
    └─wrapper
            gradle-wrapper.jar
            gradle-wrapper.properties

 

然後，創建多個模塊，這裏以 core 和 web 模塊爲例，先創建四個目錄（test 文件夾用於編寫測試類）：

　　

mkdir core\src\main\java
mkdir core\src\main\test
mkdir web\src\main\java
mkdir web\src\main\resources

 

　　 core模塊 ：包含一些通用的組件，它們能夠被程序的其他模塊使用。例子中，只包含一個類：MessageService類返回 ‘Hello World!’ 字符串。該模塊有兩個依賴：Junit 4.11與commons-lang3。
 　　web模塊：模塊包含HelloWorld類，是程序的開端，它從MessageService對象中獲取信息，並將接收到的信息寫入一個日誌文件中。該模塊擁有兩個依賴：它需要core模塊，還使用Log4j作爲日誌。

 

現在，我們已經創建了所需的目錄，下一步是配置Gradle構建，先對包含在多項目構建中的項目進行配置。

我們可以通過以下步驟，對包含在多項目構建中的項目進行配置：

1. 在根項目的根目錄下創建 settings.gradle 文件，一個多項目Gradle構建必須含有這個文件，因爲它指明瞭那些包含在多項目構建中的項目。
2. 確保 web 和 core 項目包含在我們的多項目構建中。

我們的 settings.gradle 文件如下：

include 'core'
include 'web'
簡寫：include 'core','web' 

 

修改根目錄下的 build.gradle：

// 所有子項目的通用配置
subprojects {
    apply plugin: 'java'
    // apply plugin: 'eclipse'
    apply plugin: 'idea'

    version = '1.0'

    // JVM 版本號要求
    sourceCompatibility = 1.8
    targetCompatibility = 1.8

    // java編譯的時候缺省狀態下會因爲中文字符而失敗
    [compileJava,compileTestJava,javadoc]*.options*.encoding = 'UTF-8'

    //定義版本號
    ext {
        springVersion = '4.3.3.RELEASE'
        hibernateVersion='5.2.2.Final'
    }

    repositories {
        mavenCentral()
    }

    jar {
        manifest {
            attributes("Implementation-Title": "Gradle")
        }
    }

    configurations {
        // 所有需要忽略的包定義在此
        all*.exclude group: 'commons-httpclient'
        all*.exclude group: 'commons-logging'
        all*.exclude group: 'commons-beanutils', module: 'commons-beanutils'
    }

    dependencies {
        // 通用依賴
        compile(
                "org.springframework:spring-context:$springVersion",
                "org.springframework:spring-orm:$springVersion",
                "org.springframework:spring-tx:$springVersion",
                "org.springframework.data:spring-data-jpa:1.10.3.RELEASE",
                "org.hibernate:hibernate-entitymanager:$hibernateVersion",
                "c3p0:c3p0:0.9.1.2",
                "mysql:mysql-connector-java:6.0.4",
                "org.slf4j:slf4j-nop:1.7.21",
                "commons-fileupload:commons-fileupload:1.3.2",
                "com.fasterxml.jackson.core:jackson-databind:2.8.2"
        )

        // 依賴maven中不存在的jar
        ext.jarTree = fileTree(dir: 'libs', include: '**/*.jar')
        ext.rootProjectLibs = new File(rootProject.rootDir, 'libs').getAbsolutePath()
        ext.jarTree += fileTree(dir: rootProjectLibs, include: '**/*.jar')

        compile jarTree

        // 測試依賴
        testCompile(
                "org.springframework:spring-test:$springVersion",
                "junit:junit:4.12"
        )
    }

    // 顯示當前項目下所有用於 compile 的 jar.
    task listJars(description: 'Display all compile jars.') << {
        configurations.compile.each { File file -> println file.name }
    }
}

接下來可以修改 core/build.gradle 來定義 core 模塊的依賴：

// jar包的名字
archivesBaseName = 'core'

// 還可以定義其他配置，這裏直接繼承父模塊中的配置

web 模塊需要依賴 core 模塊，故定義 web/build.gradle 如下：

apply plugin:"war"  

dependencies{  
    // 依賴 core 模塊
    compile project(":core")  
    compile(  
            "org.springframework:spring-webmvc:$springVersion",  
            "org.apache.taglibs:taglibs-standard-impl:1.2.1"  
    )  
    //系統提供的依賴
    providedCompile(  
            "javax.servlet:javax.servlet-api:3.1.0",  
            "javax.servlet.jsp:jsp-api:2.2.1-b03",  
            "javax.servlet.jsp.jstl:javax.servlet.jsp.jstl-api:1.2.1"  
    )  
}  

task jarWithoutResources(type: Jar) {  
    baseName project.name  
    from("$buildDir/classes/main")  
}  

war{  
    dependsOn jarWithoutResources  
    from("$projectDir/src/main/resources") {  
        include "*.properties"  
        into("WEB-INF/classes")  
    }  
    classpath=classpath - sourceSets.main.output  
    classpath fileTree(dir:libsDir, include:"${project.name}-${version}.jar")  
}  
task('jarPath')<<{  
    configurations.runtime.resolve().each {  
        print it.toString()+";"  
    }  
    println();  
}  

 

3. 編譯項目

查看所有 jar：

> gradle listJars

// 查看各個模塊的依賴：

> gradle :core:dependencies
> gradle :web:dependencies


//編譯所有模塊：

> gradle build

 

對比一下，這時候的目錄如下：

 

│   build.gradle
│   gradlew
│   gradlew.bat
│   settings.gradle
│   
├───.gradle
│   └───3.0
│       └───taskArtifacts
│               cache.properties
│               cache.properties.lock
│               fileHashes.bin
│               fileSnapshots.bin
│               fileSnapshotsToTreeSnapshotsIndex.bin
│               taskArtifacts.bin
│               
├───core
│   │   build.gradle
│   │   
│   ├───build
│   │   ├───libs
│   │   │       core-1.0.jar
│   │   │       
│   │   └───tmp
│   │       └───jar
│   │               MANIFEST.MF
│   │               
│   └───src
│       ├───main
│       │   └───java
│       └───test
│           └───java
├───gradle
│   └───wrapper
│           gradle-wrapper.jar
│           gradle-wrapper.properties
│           
└───web
    │   build.gradle
    │   
    ├───build
    │   ├───libs
    │   │       web-1.0.jar
    │   │       web-1.0.war
    │   │       
    │   └───tmp
    │       ├───jarWithoutResources
    │       │       MANIFEST.MF
    │       │       
    │       └───war
    │               MANIFEST.MF
    │               
    └───src
        └───main
            ├───java
            └───resources