jar包中读取资源文件

      今天写代码的时候发现一个有趣的问题，就是在代码中读取一些资源文件(txt,gif等等)时候，单独运行的时候，当然没问题，但是当我们将项目打包成jar后，尽管资源文件在jar包内，但我们却怎么也访问不到它了。

代码结构如下：

src|---com
                ---cn
                       ---ChineseUtil.java
src|---pinyin.txt

 ChineseUtil.java

package com.cn;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;

public class ChineseUtil {
	private Properties properties;

	public ChineseUtil() {
		this.properties=loadProperties("pinyin.txt");
	}

	
	/**
	 * 加载资源文件
	 * @param file
	 * @return
	 */
	private Properties loadProperties(String file) {
		Properties p = new Properties();
		URL url=this.getClass().getResource("/"+file);
		System.out.println(url.getPath());//输出文件路径
		try {
			p.load(new FileInputStream(url.getFile()));
		} catch (FileNotFoundException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
		return p;
	}	
}

 在本工程下，测试代码如下：

public class PinyinTest {
	public static void main(String[] args) {
         ChineseUtil util=new ChineseUtil();
	}
}

 测试一切正常，没有抛出异常，但是当我们将该项目打包成jar，新建一个java工程，并仍然采用上面的java代码进行测试时，却发现代码抛出异常：

file:/D:/frame/pinyin.jar!/pinyin.txt
java.io.FileNotFoundException: file:\D:\frame\pinyin.jar!\pinyin.txt (文件名、目录名或卷标语法不正确。)

 

 抛出异常了，找不到资源文件了！让我们注意一下输出的文件的路径，file:\D:\frame\pinyin.jar!\pinyin.txt,和一般的文件路径相比，多了一个！，你不仔细观察，是看不出来的！查阅了相关资料，原来jar包中文件URL有专用格式的：jar:<url>!/{entry},而我们是不能以这种形式来new一个File的，那该怎么做呢，我们把 loadProperties方法修改如下：

 

 

private Properties loadProperties(String file) {
		Properties p = new Properties();
		//注意加载资源文件的写法  /表示从根目录开始  否则就表示从当前类所在的路径下开始
		InputStream is=this.getClass().getResourceAsStream("/"+file);  
		try {
			p.load(is);
		} catch (FileNotFoundException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
		return p;
	}

 即通过通过Class类的getResourceAsStream()方法来获取文件，这个方法是透明的，你可以像普通的File一样去定位jar包中的资源文件（不管你是jar文件还是普通的文件夹）。另外还有一个比较让人纠结的方式是使用java.util.jar.JarFile类才访问，不过使用起来非常的不习惯，具体大家可以参考API试试。

PS：接下来该看看底层是怎么实现了，有经验的朋友不妨说说

 

 

 

评论

11 楼 zhangcong170 2010-12-26  

angel243fly 写道

资源文件必须打进jar包吗？如果不是必须的话，那就可以放在工程中直接实用

我只是在试验   比如像struts2之类的  本身也带了资源文件  就想看看试试它们是怎么做的

10 楼 angel243fly 2010-12-26  

资源文件必须打进jar包吗？如果不是必须的话，那就可以放在工程中直接实用

9 楼 lfrick 2010-12-25  

生成jar文件的时候，勾上Add directory entries

8 楼 zhangcong170 2010-12-25  

yunchow 写道

this.getClass().getResourceAsStream("/"+file); 

这种方法是有缺陷的,JRE会对读入的文件进行缓存,应用启动后,无法刷新

那应该怎么处理呢？请指教  谢谢

7 楼 mp_juan 2010-12-25  

Thread.currentThread.getClassLoader().getResourceAsStream(file);

6 楼 yunchow 2010-12-25  

this.getClass().getResourceAsStream("/"+file); 

这种方法是有缺陷的,JRE会对读入的文件进行缓存,应用启动后,无法刷新

5 楼 lfp001 2010-12-24  

<p>直接用this.getClass().getResource方法是可以读取资源文件的，但要求集成环境和JAR包运行时资源文件放入不同的的路径。也就是说pinyin.txt在两种情况下应该放入不同的位置。</p>
<p>在这两条语句前</p>
<div class="quote_div">Properties p = new Properties(); <br>URL url=this.getClass().getResource("/"+file);</div>
<p> </p>
<p>前加入：</p>
<p>System.out.println(this.getClass().getProtectionDomain().getCodeSource().getLocation().getPath());<br>System.out.println(this.getClass().getResource("/"));</p>
<p>System.out.println(this.getClass().getResource(""));</p>
<p>第一个语句是打印classpath的绝对路径。在集成环境和JAR包运行时打印的结果不同，根据打印的结果就应该知道资源文件就放入JAR包什么位置，在集成环境时应该放入到哪才行。</p>
<p> </p>
<p>getResource方法的参数以斜杠开头表示url相对于根classpath的路径。</p>

4 楼 fuzao 2010-12-24  

this.properties=loadProperties("pinyin.txt");  
pinyin.txt跟jar包平级,可以读的

3 楼 gloomyd 2010-12-24  

哦。忘记了要不是那个"/"了。

2 楼 gloomyd 2010-12-24  

this.getClass().getClassLoader().getResourceAsStream("/"+file);
用这个try try。

1 楼 苍山洱海 2010-12-24  

对，读取配置文件就是要用getResourceAsStream（）比较靠谱的。
别的或多或少都回出一些问题。