JAR包中的MANIFEST.MF檔案詳解以及編寫規範
JAR包中的MANIFEST.MF檔案詳解以及編寫規範
參考百度百科的解釋如下:
http://baike.baidu.com/item/MANIFEST.MF
MANIFEST.MF:這個 manifest 檔案定義了與擴充套件和包相關的資料。單詞“manifest”的意思是“顯示”
開啟Java的JAR檔案我們經常可以看到檔案中包含著一個META-INF目錄,這個目錄下會有一些檔案,其中必有一個MANIFEST.MF,這個檔案描述了該Jar檔案的很多資訊,下面將詳細介紹MANIFEST.MF檔案的內容,先來看struts.jar中包含的MANIFEST.MF檔案內容:
Manifest-Version: 1.0
Created-By: Apache Ant 1.5.1
Extension-Name: Struts Framework
Specification-Title: Struts Framework
Specification-Vendor: Apache Software Foundation
Specification-Version: 1.1
Implementation-Title: Struts Framework
Implementation-Vendor: Apache Software Foundation
Implementation-Vendor-Id: org.apache
Implementation-Version: 1.1
Class-Path: commons-beanutils.jar commons-collections.jar commons-digester.jar commons-logging.jar commons-validator.jar jakarta-oro.jar struts-legacy.jar
如果我們把MANIFEST中的配置資訊進行分類,可以歸納出下面幾個大類:
一. 一般屬性
- Manifest-Version
用來定義manifest檔案的版本,例如:Manifest-Version: 1.0
- Created-By
宣告該檔案的生成者,一般該屬性是由jar命令列工具生成的,例如:Created-By: Apache Ant 1.5.1
- Signature-Version
定義jar檔案的簽名版本
- Class-Path
應用程式或者類裝載器使用該值來構建內部的類搜尋路徑
二. 應用程式相關屬性
- Main-Class
定義jar檔案的入口類,該類必須是一個可執行的類,一旦定義了該屬性即可通過 java -jar x.jar來執行該jar檔案。
三. 小程式(Applet)相關屬性
- Extendsion-List
該屬性指定了小程式需要的擴充套件資訊列表,列表中的每個名字對應以下的屬性
-
-Extension-Name
-
-Specification-Version
-
-Implementation-Version
-
-Implementation-Vendor-Id
-
-Implementation-URL
四. 擴充套件標識屬性
- Extension-Name
該屬性定義了jar檔案的標識,例如Extension-Name: Struts Framework
五. 包擴充套件屬性
-
Implementation-Title 定義了擴充套件實現的標題
-
Implementation-Version 定義擴充套件實現的版本
-
Implementation-Vendor 定義擴充套件實現的組織
-
Implementation-Vendor-Id 定義擴充套件實現的組織的標識
-
Implementation-URL : 定義該擴充套件包的下載地址(URL)
-
Specification-Title 定義擴充套件規範的標題
-
Specification-Version 定義擴充套件規範的版本
-
Specification-Vendor 聲明瞭維護該規範的組織
-
Sealed 定義jar檔案是否封存,值可以是true或者false (這點我還不是很理解)
六. 簽名相關屬性
簽名方面的屬性我們可以來參照JavaMail所提供的mail.jar中的一段
Name: javax/mail/Address.class
Digest-Algorithms: SHA MD5
SHA-Digest: AjR7RqnN//cdYGouxbd06mSVfI4=
MD5-Digest: ZnTIQ2aQAtSNIOWXI1pQpw==
這段內容定義類簽名的類名、計算摘要的演算法名以及對應的摘要內容(使用BASE64方法進行編碼)
七.自定義屬性
除了前面提到的一些屬性外,你也可以在MANIFEST.MF中增加自己的屬性以及響應的值,例如J2ME程式jar包中就可能包含著如下資訊
MicroEdition-Configuration: CLDC-1.0
MIDlet-Name: J2ME_MOBBER Midlet Suite
MIDlet-Info-URL: http://www.javayou.com/
MIDlet-Icon: /icon.png
MIDlet-Vendor: Midlet Suite Vendor
MIDlet-1: mobber,/icon.png,mobber
MIDlet-Version: 1.0.0
MicroEdition-Profile: MIDP-1.0
MIDlet-Description: Communicator
關鍵在於我們怎麼來讀取這些資訊呢?其實很簡單,JDK給我們提供了用於處理這些資訊的API,詳細的資訊請見java.util.jar包中,我們可以通過給JarFile傳遞一個jar檔案的路徑,然後呼叫JarFile的getManifest方法來獲取Manifest資訊。
備註:更詳細的說明,參考oracle提供的文件:http://docs.oracle.com/javase/1.5.0/docs/guide/jar/jar.html(這個地址其實是有規律的,試下後面的版本號更新到特定的)
編寫MANIFEST.MF檔案時的注意事項:
說明:一般編寫MANIFEST.MF檔案只需要用到Manifest-Version(MF檔案版本號)、Main-Class(包含main方法的類)、Class-Path(執行這個jar包時的ClassPath,第三方依賴)
比如以下的例子:
Manifest-Version: 1.0
Main-Class: test.Main
Class-Path: ./ ./lib/commons-collections-3.2.jar ./lib/commons-dbcp-1.2.2.jar ./lib/commons-lang-2.3.jar ./lib/commons-logging-1.1.jar
以下是需要注意的各個要點:
-
最後一樣一定要回車,空一行,不然無法識別最後一行的配置。
-
Manifest-Version、Main-Class和Class-Path後面跟著一個英文的冒號,冒號後面必須跟著一個空格,然後才是版本號、類和ClassPath。
-
Class-Path中的各項應使用空格分隔,不是逗號或分號。
-
Class-Path中如果有很多項,寫成一行打包的時候會報錯line too long,這時需要把Class-Path分多行寫。注意:從第二行開始,必須以兩個空格開頭,三個以上我沒試過,不過不用空格開頭和一個空格開頭都是不行的,我已經試過了。
-
Class-Path寫完之後最後一定要有一個空行。
-
jar包內有些配置檔案想放在jar包外面,比如檔案config.properties:如果這個檔案是以路徑方式載入的,比如new file("./config/config.properties"),那麼將config.properties放在jar包相同目錄下的config目錄下即可,也就是說“./”路徑等價於jar包所在目錄;如果這個檔案是以ClassPath下的檔案這種方式載入的,比如在Spring中載入classpath:config.properties,則在MF檔案的配置檔案的ClassPath中新增“./”,然後將這個配置檔案與jar包放在同一個目錄即可,當然也可以在MF檔案的配置檔案的ClassPath中新增“./config/”,然後把配置檔案都放在jar包相同目錄下的config目錄下。