在創(chuàng)建了一個實用的應(yīng)用程序之后,我們可能想將其與他人分享幸逆。其中一種方式就是創(chuàng)建一個可以從網(wǎng)站上下載的二進制文件棍辕。
這篇教程描述了如何創(chuàng)建一個二進制發(fā)布版本,滿足以下需求:
二進制發(fā)布一定不能使用所謂的“fat jar”方式还绘。換句話說楚昭,我們應(yīng)用程序中的所有依賴一定不能被打包到該程序相同的jar包中。
二進制發(fā)布必須包含針對*nix和Windows操作系統(tǒng)的啟動副本拍顷。
二進制發(fā)布的根目錄必須包含許可證抚太。
我們開始吧。
創(chuàng)建二進制發(fā)布文件
Application插件是一種Gradle插件昔案,讓我們可以運行尿贫、安裝應(yīng)用程序并用非“fat jar”方式創(chuàng)建二進制發(fā)布版本。
還記得我們在上篇教程中提到的一個例子嗎踏揣?在它的build.gradle文件中做一些相應(yīng)的更改庆亡,就可以進行二進制發(fā)布了。
移除jar任務(wù)的配置捞稿。
為項目應(yīng)用application插件又谋。
對應(yīng)用程序的主類進行配置拼缝,設(shè)置mainClassName屬性。
在build.gradle文件中作出以上更改后彰亥,結(jié)果如下(相關(guān)部分已經(jīng)高亮):
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個任務(wù):
run任務(wù)用以啟動應(yīng)用程序咧七。
startScripts任務(wù)會在build/scripts目錄中創(chuàng)建啟動腳本,這個任務(wù)所創(chuàng)建的啟動腳本適用于Windows和*nix操作系統(tǒng)剩愧。
installApp任務(wù)會在build/install/[project name]目錄中安裝應(yīng)用程序猪叙。
distZip任務(wù)用以創(chuàng)建二進制發(fā)布并將其打包為一個zip文件娇斩∪示恚可以在build/distributions目錄下找到。
distTar任務(wù)用以創(chuàng)建二進制發(fā)布并將其打包為一個tar文件犬第〗趸可以在build/distributions目錄下找到。
我們可以通過在項目根目錄下運行以下命令:gradle distZip或gradle distTar 創(chuàng)建二進制文件歉嗓。假設(shè)我們創(chuàng)建了一個打包為zip文件的二進制文件丰介,輸出如下:
> gradle distZip
:compileJava
:processResources
:classes
:jar
:startScripts
:distZip
BUILD SUCCESSFUL
Total time: 4.679 secs
如果將application插件創(chuàng)建的二進制文件解壓縮,可以得到以下目錄結(jié)構(gòu):
bin目錄:包括啟動腳本鉴分。
lib目錄:包括應(yīng)用程序的jar文件以及它的依賴哮幢。
你可以閱讀Gradle Application插件用戶指南(第45章)了解更多關(guān)于Application插件信息。
現(xiàn)在志珍,我們可以創(chuàng)建一個幾乎能滿足所有需求的二進制發(fā)布了橙垢。不過,我們?nèi)匀恍枰谖覀兌M制發(fā)布的根目錄下添加應(yīng)用程序的許可證伦糯。下面我就來看一下柜某,如何做到這一點。
在二進制發(fā)布版本中添加應(yīng)用程序許可證
我們可以通過以下步驟敛纲,在二進制發(fā)布中添加應(yīng)用程序許可證:
創(chuàng)建一個任務(wù)喂击,將許可證從項目的根目錄復(fù)制到build目錄下。
將許可證加入到所創(chuàng)建的二進制發(fā)布的根目錄下淤翔。
我們來仔細(xì)看一下這些步驟的詳情翰绊。
將許可證文件復(fù)制到build目錄下
LICENSE文件包含了我們應(yīng)用程序的許可信息,可以在項目的根目錄下找到它旁壮。
可以通過以下步驟將許可證文件復(fù)制到build目錄下:
創(chuàng)建一個新的Copy任務(wù)监嗜,名為copyLicense。
使用CopySpec接口中的from()方法配置源文件寡具,將“LICENSE”作為參數(shù)調(diào)用秤茅。
使用CopySpec接口中into()方法配置target目錄,將$buildDir屬性作為參數(shù)調(diào)用童叠。
在完成這些步驟以后框喳,build.gradle文件如下(相關(guān)部分已高亮):
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"
}
現(xiàn)在课幕,我們已經(jīng)創(chuàng)建了一個任務(wù),將LICENSE文件從項目的根目錄復(fù)制到build目錄下五垮。然而乍惊,當(dāng)我們在項目根目錄下運行命令:gradle distZip,會看到以下輸出:
> gradle distZip
:compileJava
:processResources
:classes
:jar
:startScripts
:distZip
BUILD SUCCESSFUL
Total time: 4.679 secs
換句話說放仗,我們新的任務(wù)還沒有被引入润绎。所以理所當(dāng)然的,二進制發(fā)布中也沒有包含許可證诞挨。讓我們來修復(fù)這個問題莉撇。
將許可證文件加入到二進制發(fā)布文件中
我們可以通過以下步驟將許可證文件加入到二進制發(fā)布文件中:
將copyLicense任務(wù)從一個Copy任務(wù)改為正常的Gradle任務(wù),只需在它的聲明中移除“(type: Copy)”字符串惶傻。
按照以下步驟修改copyLicense任務(wù)
配置copyLicense任務(wù)輸出棍郎。創(chuàng)建一個新的文件對象,指向build目錄的許可證文件银室,并將其設(shè)置為outputs.file屬性值涂佃。
將許可證文件從項目的根目錄復(fù)制到build目錄下斟赚。
Application插件在項目中設(shè)置了一個CopySpec屬性闲先,名為applicationDistribution。我們可以使用這個屬性在已創(chuàng)建的二進制文件中加入許可證文件政冻,步驟如下:
使用CopySpec接口中的from()方法配置許可證文件的位置抓狭,將copyLicense任務(wù)的輸出作為方法參數(shù)伯病。
使用CopySpec接口中into()方法配置target目錄,將一個空的字符串作為參數(shù)調(diào)用方法辐宾。
在實現(xiàn)了這些步驟以后狱从,build.gradle文件如下(相關(guān)部分已高亮):
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任務(wù)現(xiàn)在已經(jīng)被引入了季研。我們可以對二進制文件解壓縮,在根目錄下就能發(fā)現(xiàn)LICENSE文件了誉察。
最后与涡,我們對這篇教程中所學(xué)到的東西進行總結(jié)。
總結(jié)
這篇教程為我們教授了三方面內(nèi)容:
學(xué)會使用application插件創(chuàng)建一個二進制發(fā)布持偏。
學(xué)會使用Copy任務(wù)將一個文件從源目錄復(fù)制到目標(biāo)目錄驼卖。
學(xué)會如果將文件加入到由Application插件創(chuàng)建的二進制發(fā)布文件中。
如果你想運行本教程中的示例程序鸿秆,請從Github中獲取酌畜。
https://github.com/pkainulainen/gradle-examples/tree/master/runnable-binary-distribution