在創建了一個實用的應用程序之后,我們可能想將其與他人分享。其中一種方式就是創建一個可以從網站上下載的二進制文件。
這篇教程描述了如何創建一個二進制發布版本,滿足以下需求:
二進制發布一定不能使用所謂的“fat jar”方式。換句話說,我們應用程序中的所有依賴一定不能被打包到該程序相同的jar包中。
二進制發布必須包含針對*nix和Windows操作系統的啟動副本。
二進制發布的根目錄必須包含許可證。
我們開始吧。
創建二進制發布文件
Application插件是一種Gradle插件,讓我們可以運行、安裝應用程序并用非“fat jar”方式創建二進制發布版本。
還記得我們在上篇教程中提到的一個例子嗎?在它的build.gradle文件中做一些相應的更改,就可以進行二進制發布了。
移除jar任務的配置。
為項目應用application插件。
對應用程序的主類進行配置,設置mainClassName屬性。
在build.gradle文件中作出以上更改后,結果如下(相關部分已經高亮):
apply plugin: 'application'
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
compile 'log4j:log4j:1.2.17'
testCompile 'junit:junit:4.11'
}
mainClassName = 'net.petrikainulainen.gradle.HelloWorld'
Application插件在項目中添加了5個任務:
run任務用以啟動應用程序。
startScripts任務會在build/scripts目錄中創建啟動腳本,這個任務所創建的啟動腳本適用于Windows和*nix操作系統。
installApp任務會在build/install/[project name]目錄中安裝應用程序。
distZip任務用以創建二進制發布并將其打包為一個zip文件。可以在build/distributions目錄下找到。
distTar任務用以創建二進制發布并將其打包為一個tar文件。可以在build/distributions目錄下找到。
我們可以通過在項目根目錄下運行以下命令:gradle distZip或gradle distTar 創建二進制文件。假設我們創建了一個打包為zip文件的二進制文件,輸出如下:
> gradle distZip
:compileJava
:processResources
:classes
:jar
:startScripts
:distZip
BUILD SUCCESSFUL
Total time: 4.679 secs
如果將application插件創建的二進制文件解壓縮,可以得到以下目錄結構:
bin目錄:包括啟動腳本。
lib目錄:包括應用程序的jar文件以及它的依賴。
你可以閱讀Gradle Application插件用戶指南(第45章)了解更多關于Application插件信息。
現在,我們可以創建一個幾乎能滿足所有需求的二進制發布了。不過,我們仍然需要在我們二進制發布的根目錄下添加應用程序的許可證。下面我就來看一下,如何做到這一點。
在二進制發布版本中添加應用程序許可證
我們可以通過以下步驟,在二進制發布中添加應用程序許可證:
創建一個任務,將許可證從項目的根目錄復制到build目錄下。
將許可證加入到所創建的二進制發布的根目錄下。
我們來仔細看一下這些步驟的詳情。
將許可證文件復制到build目錄下
LICENSE文件包含了我們應用程序的許可信息,可以在項目的根目錄下找到它。
可以通過以下步驟將許可證文件復制到build目錄下:
創建一個新的Copy任務,名為copyLicense。
使用CopySpec接口中的from()方法配置源文件,將“LICENSE”作為參數調用。
使用CopySpec接口中into()方法配置target目錄,將$buildDir屬性作為參數調用。
在完成這些步驟以后,build.gradle文件如下(相關部分已高亮):
apply plugin: 'application'
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
compile 'log4j:log4j:1.2.17'
testCompile 'junit:junit:4.11'
}
mainClassName = 'net.petrikainulainen.gradle.HelloWorld'
task copyLicense(type: Copy) {
from "LICENSE"
into "$buildDir"
}
現在,我們已經創建了一個任務,將LICENSE文件從項目的根目錄復制到build目錄下。然而,當我們在項目根目錄下運行命令:gradle distZip,會看到以下輸出:
> gradle distZip
:compileJava
:processResources
:classes
:jar
:startScripts
:distZip
BUILD SUCCESSFUL
Total time: 4.679 secs
換句話說,我們新的任務還沒有被引入。所以理所當然的,二進制發布中也沒有包含許可證。讓我們來修復這個問題。
將許可證文件加入到二進制發布文件中
我們可以通過以下步驟將許可證文件加入到二進制發布文件中:
將copyLicense任務從一個Copy任務改為正常的Gradle任務,只需在它的聲明中移除“(type: Copy)”字符串。
按照以下步驟修改copyLicense任務
配置copyLicense任務輸出。創建一個新的文件對象,指向build目錄的許可證文件,并將其設置為outputs.file屬性值。
將許可證文件從項目的根目錄復制到build目錄下。
Application插件在項目中設置了一個CopySpec屬性,名為applicationDistribution。我們可以使用這個屬性在已創建的二進制文件中加入許可證文件,步驟如下:
使用CopySpec接口中的from()方法配置許可證文件的位置,將copyLicense任務的輸出作為方法參數。
使用CopySpec接口中into()方法配置target目錄,將一個空的字符串作為參數調用方法。
在實現了這些步驟以后,build.gradle文件如下(相關部分已高亮):
apply plugin: 'application'
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
compile 'log4j:log4j:1.2.17'
testCompile 'junit:junit:4.11'
}
mainClassName = 'net.petrikainulainen.gradle.HelloWorld'
task copyLicense {
outputs.file new File("$buildDir/LICENSE")
doLast {
copy {
from "LICENSE"
into "$buildDir"
}
}
}
applicationDistribution.from(copyLicense) {
into ""
}
在項目根目錄下運行命令gradle distZip時,會看到以下輸出:
> gradle distZip
:copyLicense
:compileJava
:processResources
:classes
:jar
:startScripts
:distZip
BUILD SUCCESSFUL
Total time: 5.594 secs
可以看到,copyLicense任務現在已經被引入了。我們可以對二進制文件解壓縮,在根目錄下就能發現LICENSE文件了。
最后,我們對這篇教程中所學到的東西進行總結。
總結
這篇教程為我們教授了三方面內容:
學會使用application插件創建一個二進制發布。
學會使用Copy任務將一個文件從源目錄復制到目標目錄。
學會如果將文件加入到由Application插件創建的二進制發布文件中。
如果你想運行本教程中的示例程序,請從Github中獲取。
https://github.com/pkainulainen/gradle-examples/tree/master/runnable-binary-distribution