廢話不多說,直接進入主題。
1. 創建項目
首先創建項目,名稱為 test:
mkdir test && cd test gradle init
這時候的項目結構如下:
➜ test tree
.
├── build.gradle
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
└── settings.gradle
2 directories, 6 files
然后,創建多個模塊,這里以 core 和 web 模塊為例,先創建兩個目錄:
mkdir -p core/src/main/java
mkdir -p core/src/test/java
mkdir -p web/src/main/java
mkdir -p web/src/test/java
這時候的項目結構如下:
➜ test tree
.
├── build.gradle
├── core
│ └── src
│ ├── main
│ │ └── java
│ └── test
│ └── java
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── web
└── src
├── main
│ └── java
└── test
└── java
14 directories, 6 files
2. 修改配置
接下來修改根目錄下的 settings.gradle 文件,引入子模塊:
include 'core','web'
修改根目錄下的 build.gradle:
// 所有子項目的通用配置 subprojects { apply plugin: 'java' apply plugin: 'eclipse' apply plugin: 'idea' version = '1.0' // JVM 版本號要求 sourceCompatibility = 1.7 targetCompatibility = 1.7 // java編譯的時候缺省狀態下會因為中文字符而失敗 [compileJava,compileTestJava,javadoc]*.options*.encoding = 'UTF-8' //定義版本號 ext { springVersion = '3.2.11.RELEASE' hibernateVersion='4.3.1.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.5.2.RELEASE", "org.hibernate:hibernate-entitymanager:$hibernateVersion", "c3p0:c3p0:0.9.1.2", "mysql:mysql-connector-java:5.1.26", "org.slf4j:slf4j-nop:1.7.6", "commons-fileupload:commons-fileupload:1.3.1", "com.fasterxml.jackson.core:jackson-databind:2.3.1" ) // 依賴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.11" ) } // 顯示當前項目下所有用於 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
對比一下,這時候的目錄如下:
➜ test tree
.
├── build.gradle
├── core
│ ├── build
│ │ ├── libs
│ │ │ └── core-1.0.jar
│ │ └── tmp
│ │ └── jar
│ │ └── MANIFEST.MF
│ └── src
│ ├── main
│ │ └── java
│ └── test
│ └── java
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── web
├── build
│ ├── libs
│ │ ├── web-1.0.jar
│ │ └── web-1.0.war
│ └── tmp
│ ├── jarWithoutResources
│ │ └── MANIFEST.MF
│ └── war
│ └── MANIFEST.MF
├── build.gradle
└── src
├── main
│ └── java
└── test
└── java
23 directories, 13 files
4. 一些小技巧
1. 善用 gradle dependencies
gradle dependencies > depend.log
2. java 編譯時候報編碼錯誤
[compileJava,compileTestJava,javadoc]*.options*.encoding = 'UTF-8'
3. 忽略掉 .gradle 目錄
修改 .gitignore 忽略該目錄:
*.sw?
.#*
*#
*~
.classpath
.project
.settings
bin
build
target
dependency-reduced-pom.xml
*.sublime-*
/scratch
.gradle
README.html
.idea
*.iml
4. Maven 庫中沒有的 jar 該怎么管理
在頂級目錄增加一個 libs 文件夾,這個文件夾里面的 jar 是對所有項目都起作用的。
如果是某個項目自用的,則可以在該項目的 source 下面創建個 libs,具體實現是在頂級目錄下的 build.gradle 中:
ext.jarTree = fileTree(dir: 'libs', include: '**/*.jar') ext.rootProjectLibs = new File(rootProject.rootDir, 'libs').getAbsolutePath() ext.jarTree += fileTree(dir: rootProjectLibs, include: '**/*.jar') compile jarTree
5. jar 包定義外移
暫時還沒有這樣的需求,詳細說明請參考 jar 包定義外移
6. 如何指定 build 輸出目錄和版本號
buildDir = "target"
version = '1.0'
7. 在執行 Gradle 命令時如何指定參數
gradle task -P profile=development
8. Gradle 和 idea 集成時如何不自動下載依賴源碼和javadoc
idea { module { downloadJavadoc = false downloadSources = false } }
5. 參考文章
http://blog.javachen.com/2015/01/07/build-multi-module-project-with-gradle.html