Java獲取jar包以外資源的方法

小編給大家分享一下Java獲取jar包以外資源的方法，希望大家閱讀完這篇文章后大所收獲，下面讓我們一起去探討吧！

在使用 jar 執行 java 代碼時,有一個需求是從 jar 包所在目錄的同級目錄下讀取配置文件的需求,從網上找了很多方法感覺都挺復雜的,

在這里總結一下.

以classpath 開頭的 URL 表示該文件為jar包內文件的路徑.

如:classpath://config/app.config表示jar包根路徑config文件夾下的app.config文件

以file開頭的URL表示該文件為jar 包外文件的路徑

如:file://./config/app.config表示

摘要

// 當前我想從jar包的同級目錄下讀取一個名為 'config.txt'的文件的話,我需要指定目錄為.

File file = new File(".","config.txt")

說明

File file = new File("config.txt")

當只包含文件名稱時,java程序會默認嘗試從jar包的根路徑去讀取文件,當嘗試使用 file.getCanonicalPath() 方法讀取時,便會得到該文件在jar包內的路徑.

示例

我當前的工程的路徑為D:\WorkSpace\path_demo01\

在工程執行以下java代碼:

當指定parent時:

會從parent下查找path資源.

log(FileUtil.file(".", "/config/app.config").getCanonicalPath());
log(FileUtil.file(".", "config/app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\config\app.config

//加載與當前jar包同級目錄下的文件
log(FileUtil.file(".", "app.config").getCanonicalPath());

當沒有指定parent:

如果path為絕對路徑時,會從絕對路徑下查找

如果path為相對路徑時,會從classpath的根路徑下開始查找

log(FileUtil.file("/config/app.config").getCanonicalPath());
// D:\config\app.config

log(FileUtil.file("config/app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\target\classes\config\app.config

通過當前類加載資源:

如果path為相對路徑會指定要加載的資源路徑與當前類所在包的路徑一致

如果path為絕對路徑,那么就會從classpath的根路徑下開始查找

log(App.class.getResource("/config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/config/app.config

log(App.class.getResource("config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/top/ghimi/config/app.config

通過類加載器加載資源:

默認是從ClassPath根下獲取,path不能以/開頭,最終是由ClassLoader獲取資源.

log(App.class.getClassLoader().getResource("/config/app.config"));
// null

log(App.class.getClassLoader().getResource("config/app.config"));
// file:/D:/WorkSpace/path_demo01/target/classes/config/app.config

加載jar包內的資源

當代碼打包成jar包的形式后,是無法通過new File()的形式加載jar包內的資源的.此時有可能拋出

FileNotFoundException異常,是由于將path當成jar包外的目錄查找不到資源導致的.

URI is not hierarchical異常,是由于無法直接讀取jar包中資源(透明)而拋出的異常.

解決方法:

使用 getResourceAsStream()方法直接獲取資源的流而不是getResource()獲取資源文件對象的方式讀取資源.

//修改前,未打包成jar包時能夠正常執行,打包后會拋出異常
log(App.class.getClassLoader().getResource("config/app.config"));

// 修改后,打成jar包后也可以正常加載資源
log(App.class.getClassLoader().getResourceAsStream("config/app.config"));

加載jar包外的資源

會從parent目錄下查找path資源.

//加載與當前jar包同級目錄下的文件
log(FileUtil.file(".", "app.config").getCanonicalPath());
// D:\WorkSpace\path_demo01\app.config

//加載與當前jar包的上一級目錄下的文件
log(FileUtil.file("..", "app.config").getCanonicalPath());
// D:\WorkSpace\app.config

借用工具hutool:

<dependency>
  <groupId>cn.hutool</groupId>
  <artifactId>hutool-all</artifactId>
  <version>4.5.6</version>
</dependency>

補充知識：java中jar包內的類訪問jar包內部的資源文件的路徑問題

在本地項目中，若我們要訪問項目中的資源文件，則一般使用相對路徑或者用System.getProperities("user.dir")得到項目根目錄，然后再訪問資源文件，但是在將該工程和資源文件打包為jar包，運行該jar文件時，會顯示找不到資源文件的錯誤。

在如下項目結構樹中，項目根目錄為nlpir，如果我們要在src下的某個package的某個java文件中訪問blackWhite文件夾中的文件，則相對路徑為"blackWhite/....."即可。但是在打包為jar包時，即使我們把blackWhite文件夾同樣加入到打包的文件行列，在運行該jar包時，會出錯：找不到blackWhite中某文件的路徑。

解決方法：

使用Class.getResource或者是ClassLoader.getResourceAsStream()將文件內容放到InputStream中，具體使用如下：

String s1 = this.getClass().getResource("/library.properties").getPath();

或者為：

String s1 = CodeTest.class.getResource("/library.properties").getPath();

注意，使用class的getRescource時，要注意路徑前要加"/"，即根目錄，此處的根目錄是src

若像如下使用：

String class_str = this.getClass().getResource("logback.xml").getPath();

則會出錯如下：

使用ClassLoader時，如下：

this.getClass().getClassLoader().getResource()

在使用ClassLoader時，路徑前面不能加"/",使用相對路徑。

如下示例：

@Test
 public void test4(){
 String class_str = this.getClass().getResource("/logback.xml").getPath();
 String class_str2 = TempTest.class.getResource("/logback.xml").getPath();
   String classLoader_str = this.getClass().getClassLoader().getResource("logback.xml").getPath();
   InputStream is = this.getClass().getClassLoader().getResourceAsStream("logback.xml");
 System.out.println(class_str);
   System.out.println(class_str2);
 System.out.println(classLoader_str);
   System.out.println(is == null );
 }

結果如下：

String ss = TempTest.class.getResource("/").getPath();

上述該代碼得到的是項目的根目錄，即nlpir的根目錄，結果如下：

/C:/eclipse/eclipse/workspace/nlpir/out/production/nlpir/

如下代碼：

@Test
 public void readProperties(){
 String ss = TempTest.class.getResource("/").getPath();
 System.out.println(ss);
 String s = new File(ss).getParentFile().getPath();
 System.out.println(s);
 String system_str = System.getProperty("user.dir");
 System.out.println(system_str);
 }</span>

運行結果如下：

其中，File.getParentFile()可用于求父目錄

將上述readProperties函數打包為jar包在命令行使用java -jar TempTest.jar運行時，結果如下：

由此可見，打包成jar包時和在ide中直接運行的結果并不一樣，所以在jar包中的class類要訪問自己jar包中的資源文件時，應該使用Class.getResource或者是getResourceAsStream放在InputStream中，再進行訪問。但是該方法只能訪問到src下的資源文件，因為其根目錄對應的就是src，無法訪問到項目根目錄下src外的文件，如上述項目結構圖中的blackWhite中的文件無法訪問到，解決方法還木有找到。。。。。。

當jar包外部的類需要訪問某個jar包的資源文件時，使用JarFile類，

具體使用方法如下：

如果你對于常用的ZIP格式比較熟悉的話，JAR文件也就差不多。JAR文件提供一種將多個文件打包到一個文件中的方法，其中每一個文件可能獨立地被壓縮。JAR文件所增加的內容是manifest，它允許開發者可以提供附加的關于內容的信息。例如，manifest表明JAR文件中的哪個文件是用來運行一個程序的，或者庫的版本號等。

J2SEDK提供了一個JAR工具，你可以用它從控制臺讀寫JAR文件。然而，如果你需要在程序中代碼讀寫JAR文件，可能需要一點時間（本文只包含如何在程序中讀寫JAR文件）。好消息是你可以做到這一點，而且你不用擔心解壓的事，因為類庫將幫助你完成這些。

首先，通過把將JAR文件位置傳給構造函數，創建一個JarFile的實例，位置可能是String或File的形式，如下：

JarFile jf = new JarFile("C:/jxl.jar");

或者為：

File file = new File("C:/jxl.jar");

JarFile jarFile = new JarFile(file);

你可能注意到當文件不在class path中時，JarFile類對于從JAR中讀取文件文件是很有用的。當你想指定目標JAR文件時，JarFile類對于從JAR中讀取文件同樣也很有用。

當然，如果JAR文件在class path中，從其中讀取文件的方法比較簡單，你可以用下面的方法：

URL url = ClassLoader.getSystemResource(name);

或者為：

InputStream stream =

ClassLoader.getSystemResourceAsStream("javax/servlet/LocalStrings_fr.properties");

當你有了該JAR文件的一個引用之后，你就可以讀取其文件內容中的目錄信息了。JarFile的entries方法返回所有entries的枚舉集合 (Enumeration)。通過每一個entry，你可以從它的manifest文件得到它的屬性，任何認證信息，以及其他任何該entry的信息，如它的名字或者大小等。

Enumeration enu = jf.entries();
while (enu.hasMoreElements()) {
JarEntry element = (JarEntry) enu.nextElement();
        String name = element.getName();
        Long size = element.getSize();
        Long time = element.getTime();
        Long compressedSize = element.getCompressedSize();
        
        System.out.print(name+"/t");
        System.out.print(size+"/t");
        System.out.print(compressedSize+"/t");
        System.out.println(new SimpleDateFormat("yyyy-MM-dd").format(new Date(time)));
}

為了從JAR文件中真正讀取一個指定的文件，你必須到其entry的InputStream。這和JarEntry不一樣。這是因為JarEntry只是包含該entry的有關信息，但是并不實際包含該entry的內容。這和File和FileInputStream的區別有點兒相似。訪問文件沒有打開文件，它只是從目錄中讀取了該文件的信息。

下面是如何得到entry的InputStream：

InputStream input = jarFile.getInputStream(entry);

當你有了輸入流，你就可以像讀取其他流一樣讀取它。在文本流中(text stream)，記得使用讀取器(Reader)從流中取得字符。對于面向字節的流，如圖片文件，直接讀取就行了。

示例：

下面的程序演示如何從JAR文件中讀取文件。指定JAR文件的名稱，要讀取的文件的名稱（打包JAR文件中的某一個文件）作為參數來調用該程序。要讀取的文件應該有一個文本類型的。

import java.io.*; 
　　　import java.util.jar.*; 
　　
　　　public class JarRead { 
　　　　public static void main (String args[]) 
　　　　　　throws IOException { 
　　　　　if (args.length != 2) { 
　　　　　　System.out.println( 
　　　　　　　"Please provide a JAR filename and file to read"); 
　　　　　　System.exit(-1); 
　　　　　} 
　　　　　JarFile jarFile = new JarFile(args[0]); 
　　　　　JarEntry entry = jarFile.getJarEntry(args[1]); 
　　　　　InputStream input = jarFile.getInputStream(entry); 
　　　　　process(input); 
　　　　　jarFile.close(); 
　　　　} 
　　
　　　　private static void process(InputStream input) 
　　　　　　throws IOException { 
　　　　　InputStreamReader isr = 
　　　　 new InputStreamReader(input); 
　　　　　BufferedReader reader = new BufferedReader(isr); 
　　　　　String line; 
　　　　　while ((line = reader.readLine()) != null) { 
　　　　　　System.out.println(line); 
　　　　　} 
　　　　　reader.close(); 
　　　　} 
　　　}

假設在myfiles.jar文件中有一個spider.txt文件，spider文件的內容如下：

The itsy bitsy spider
　　　Ran up the water spout
　　　Down came the rain and
　　　Washed the spider out 

可以通過下面的命令在命令行來顯示該文本文件的內容：

java JarRead myfiles.jar spider.txt

看完了這篇文章，相信你對Java獲取jar包以外資源的方法有了一定的了解，想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！