發布Java應用程序時你會感到困難?好在Java提供了一系列打包和發布工具,可以顯著的簡化發布過程
該文章提供了打包Java code的幾種方法,我們將會探討Java manifest 文件,給出用於管理JAR文件所依賴文件、估計跨平台發布所需的CLasspath的合適方法.我也會解釋如何使用manifest包版本特性來確認包的兼容性...
什麼是JAR文件?
在開發過程中,我們可以直接使用Java class文件來運行程序,但這並不是一個好方式,好在Java 提供了 JAR(Java Archive)文件來提供發布和運行。
jar 文件實際上是class 文件的ZIP壓縮存檔,這種格式被廣泛使用,因此易與使用,有很多中工具可以操作這種格式的文件。也正是因為這個原因,jar文件本身並不能表達所包含應用程序的標簽信息。
Manifest 因此得以出現
為了要提供存檔的標簽信息,jar 文件指定了一個特定目錄來存放標簽信息:META-INF 目錄,其中我們來關注該目錄中的MANIFEST.MF文件,他就是JAR的manifest文件,他包含了JAR文件的內容描述,並在運行時向JVM提供應用程序的信息,大多數JAR文件含有一個默認生成的manifest 文件,執行JAR命令或使用zip工具,都可以產生它
如果是由jar命令產生的 manifest 文件,形如:
Manifest-Version: 1.0
Created-By:1.4.0-beta
(Sun Microsystems Inc.)
這些信息沒甚麼用,僅僅告訴我們使用的是1.0的manifest文件,第一行定義manifest的格式,第二行說明使用 SUN 的JDK1.4的jar工具生成該文件,如果manifest文件是由其他 (如ant) 創建的,那將會出現 “Created-By: Ant 1.2” 之類的內容,如果你是自己創建manifest文件,你可以加入自己的一些相關信息.
基礎格式
manifest 文件的格式 是很簡單的,每一行都是 名-值 對應的:屬性名開頭,接著是 ":" ,然後是屬性值,每行最多72個字符,如果需要增加,你可以在下一行續行,續行以空格開頭,以空格開頭的行都會被視為前一行的續行。
所有在開頭的屬性都是全局的,你也可以定義特定class 或package的屬性,稍後將介紹這種
把manifest文件插入JAR文件
使用 m 選項,把指定文件名的manifest文件 傳入,例如
jar cvfm myapplication.jar myapplication.mf -C classdir
如果你使用ant來創建時,在ant 的build.XML 加入如下條目
manifest="myapplication.mf">
includes="**/*.class"/>
運行Java程序
現在我們來體驗一下manifest文件的作用,如果現在我們有一個Java 應用程序打包在myapplication.jar中, main class為 com.example.myapp.MyAppMain ,那麼我們可以用以下的命令來運行
Java -classpath myapplication.jar com.example.myapp.MyAppMain
這顯然太麻煩了,現在我們來創建自己的manifest文件,如下:
Manifest-Version: 1.0
Created-By: JDJ example
Main-Class: com.example.myapp.MyAppMain
這樣我們就可以使用如下的命令來運行程序了:(明顯簡單多了,也不會造成無謂的拼寫錯誤)
Java -jar myapplication.jar
管理JAR的依賴資源
很少Java應用會僅僅只有一個jar文件,一般還需要 其他類庫。比如我的應用程序用到了Sun 的 Javamail classes ,在classpath中我需要包含activation.jar 和 mail.jar,這樣在運行程序時,相比上面的例子,我們要增加一些:
Java -classpath mail.jar:activation.jar -jar myapplication.jar
在不同的操作系統中,jar包間的分隔符也不一樣,在UNIX用“:”,在window中使用 “;”,這樣也不方便
同樣,我們改寫我們的manifest文件,如下
Manifest-Version: 1.0
Created-By: JDJ example
Main-Class: com.example.myapp.MyAppMain
Class-Path: mail.jar activation.jar
(加入了Class-Path: mail.jar activation.jar,用空格分隔兩個jar包)
這樣我們仍然可以使用和上例中相同的命令來執行該程序:
Java -jar myapplication.jar
Class-Path屬性中包含了用空格分隔的jar文件,在這些jar文件名中要對特定的字符使用逃逸符,比如空格,要表示成"%20",在路徑的表示中,都采用“/”來分隔目錄,無論是在什麼操作系統中,(即使在window中),而且這裡用的是相對路徑(相對於本身的JAR文件):
Manifest-Version: 1.0
Created-By: JDJ example
Main-Class: com.example.myapp.MyAppMain
Class-Path: ext/mail.jar ext/activation.jar
Multiple Main Classes(多主類)
還有一種Multiple Main Classes情況,如果你的應用程序可能有命令行版本 和GUI版本,或者一些不同的應用卻共享很多相同的代碼,這時你可能有多個Main Class,我們建議你采取這樣的策略:把共享的類打成lib包,然後把不同的應用打成不同的包,分別標志主類:如下
Manifest for myapplicationlib.jar:
Manifest-Version: 1.0
Created-By: JDJ example
Class-Path: mail.jar activation.jar
Manifest for myappconsole.jar:
Manifest-Version: 1.0
Created-By: JDJ example
Class-Path: myapplicationlib.jar
Main-Class: com.example.myapp.MyAppMain
Manifest for myappadmin.jar:
Manifest-Version: 1.0
Created-By: JDJ example
Class-Path: myapplicationlib.jar
Main-Class: com.example.myapp.MyAdminTool
在myappconsole.jar 和 myappadmin.jar的manifest文件中分別注明各自的 Main Class
Package Versioning
完成發布後,如果使用者想了解 ,哪些代碼是誰的?目前是什麼版本?使用什麼版本的類庫?解決的方法很多 ,manifest提供了一個較好的方法,你可以在manifest文件中描述每一個包的信息。
Java 秉承了實現說明與描述分離的原則,package 的描述 定義了package 是什麼,實現說明 定義了誰提供了描述的實現,描述和實現包含 名、版本號和提供者。要得到這些信息,可以查看JVM的系統屬性(使用 Java.lang.System.getProperty() )
在manifest文件中,我可以為每個package定義描述和實現版本,聲明名字,並加入描述屬性和實現屬性,這些屬性是
Specification-Title
Specification-Version
Specification-Vendor
Implementation-Title
Implementation-Version
Implementation-Vendor
當要提供一個類庫或編程接口時,描述信息顯得是很重要,見以下范例:
Manifest-Version: 1.0
Created-By: JDJ example
Class-Path: mail.jar activation.jar
Name: com/example/myapp/
Specification-Title: MyApp
Specification-Version: 2.4
Specification-Vendor: example.com
Implementation-Title: com.example.myapp
Implementation-Version: 2002-03-05-A
Implementation-Vendor: example.com
Package Version 查詢
在manifest文件中加入package描述後,就可以使用Java提供的Java.lang.Package class進行Package 的信息查詢,這裡列舉3個最基本的獲取package object的方法
1.Package.getPackages():返回系統中所有定義的package列表
2.Package.getPackage(String packagename):按名返回package
3.Class.getPackage():返回給定class所在的package
使用者這方法就可以動態的獲取package信息.
需要注意的是如果給定的package中沒有class被加載,則也無法獲得package 對象
Manifest 技巧
總是以Manifest-Version屬性開頭
每行最長72個字符,如果超過的化,采用續行
確認每行都以回車結束,否則改行將會被忽略
如果Class-Path 中的存在路徑,使用"/"分隔目錄,與平台無關
使用空行分隔主屬性和package屬性
使用"/"而不是"."來分隔package 和class ,比如 com/example/myapp/
class 要以.class結尾,package 要以 / 結尾