【解惑】深入jar包:从jar包中读取资源文件
来源:百度文库 编辑:神马文学网 时间:2024/04/28 02:40:21
- //源代码1:
- package edu.hxraid;
- import java.io.*;
- public class Resource {
- public void getResource() throws IOException{
- File file=new File("bin/resource/res.txt");
- BufferedReader br=new BufferedReader(new FileReader(file));
- String s="";
- while((s=br.readLine())!=null)
- System.out.println(s);
- }
- }
//源代码1:package edu.hxraid;import java.io.*;public class Resource {public void getResource() throws IOException{File file=new File("bin/resource/res.txt");BufferedReader br=new BufferedReader(new FileReader(file));String s="";while((s=br.readLine())!=null)System.out.println(s);}}
这段代码写在Eclipse建立的java Project中,其目录为:(其中将资源文件res.txt放在了bin目录下,以便打成jar包)
1、src/
src/edu/hxraid/Resource.java
2、bin/
bin/resource/res.txt
bin/edu/hxraid/Resource.class
很显然运行源代码1是能够找到资源文件res.txt。但当我们把整个工程打成jar包以后(ResourceJar.jar),这个jar包内的目录为:
edu/hxraid/Resource.class
resource/res.txt
而这时jar包中Resource.class字节码:ldc
这主要是因为jar包是一个单独的文件而非文件夹,绝对不可能通过"file:/e:/.../ResourceJar.jar/resource /res.txt"这种形式的文件URL来定位res.txt。所以即使是相对路径,也无法定位到jar文件内的txt文件(读者也许对这段原因解释有些费解,在下面我们会用一段代码运行的结果来进一步阐述)。
那么把资源打入jar包,无论ResourceJar.jar在系统的什么路径下,jar包中的字节码程序都可以找到该包中的资源。这会是幻想吗?
当然不是,我们可以用类装载器(ClassLoader)来做到这一点:
(1) ClassLoader 是类加载器的抽象类。它可以在运行时动态的获取加载类的运行信息。 可以这样说,当我们调用ResourceJar.jar中的Resource类时,JVM加载进Resource类,并记录下Resource运行时信息(包括Resource所在jar包的路径信息)。而ClassLoader类中的方法可以帮助我们动态的获取这些信息:
● public URL getResource(String name)
查找具有给定名称的资源。资源是可以通过类代码以与代码基无关的方式访问的一些数据(图像、声音、文本等)。并返回资源的URL对象。
● public InputStream getResourceAsStream(String name);
返回读取指定资源的输入流。这个方法很重要,可以直接获得jar包中文件的内容。
(2) ClassLoader是abstract的,不可能实例化对象,更加不可能通过ClassLoader调用上面两个方法。所以我们真正写代码的时候,是通过Class类中的getResource()和getResourceAsStream()方法,这两个方法会委托ClassLoader中的getResource()和getResourceAsStream()方法 。好了,现在我们重新写一段Resource代码,来看看上面那段费解的话是什么意思了:
Java代码- //源代码2:
- package edu.hxraid;
- import java.io.*;
- import java.net.URL;
- public class Resource {
- public void getResource() throws IOException{
- //查找指定资源的URL,其中res.txt仍然开始的bin目录下
- URL fileURL=this.getClass().getResource("/resource/res.txt");
- System.out.println(fileURL.getFile());
- }
- public static void main(String[] args) throws IOException {
- Resource res=new Resource();
- res.getResource();
- }
- }
//源代码2:package edu.hxraid;import java.io.*;import java.net.URL;public class Resource {public void getResource() throws IOException{//查找指定资源的URL,其中res.txt仍然开始的bin目录下URL fileURL=this.getClass().getResource("/resource/res.txt");System.out.println(fileURL.getFile());}public static void main(String[] args) throws IOException {Resource res=new Resource();res.getResource();}}
运行这段源代码结果:/E:/Code_Factory/WANWAN/bin/resource/res.txt (../ Code_Factory/WANWAN/.. 是java project所在的路径)
我们将这段代码打包成ResourceJar.jar ,并将ResourceJar.jar放在其他路径下(比如 c:\ResourceJar.jar)。然后另外创建一个java project并导入ResourceJar.jar,写一段调用jar包中Resource类的测试代码:
Java代码- import java.io.IOException;
- import edu.hxraid.Resource;
- public class TEST {
- public static void main(String[] args) throws IOException {
- Resource res=new Resource();
- res.getResource();
- }
- }
import java.io.IOException;import edu.hxraid.Resource;public class TEST {public static void main(String[] args) throws IOException {Resource res=new Resource();res.getResource();}}
这时的运行结果是:file:/C:/ResourceJar.jar!/resource/res.txt
普通文件的URL.getFile 路径: 【/E:/Code_Factory/WANWAN/bin/resource/res.txt】
jar中文件的URL.getFile 路径:【file:/E:/Code_Factory/WANWAN/bin/resource/res.txt】 //特殊之处在这里
我们成功的在运行时动态获得了res.txt的位置。然而,问题来了,你是否可以通过下面这样的代码来得到res.txt文件?
File f=new File("C:/ResourceJar.jar!/resource/res.txt");
当然不可能,因为".../ResourceJar.jar!/resource/...."并不是文件资源定位符的格式 (jar中资源有其专门的URL形式: jar:
(3) 我们不能用常规操作文件的方法来读取ResourceJar.jar中的资源文件res.txt,但可以通过Class类的getResourceAsStream()方法来获取 ,这种方法是如何读取jar中的资源文件的,这一点对于我们来说是透明的。我们将Resource.java改写成:
Java代码- //源代码3:
- package edu.hxraid;
- import java.io.*;
- public class Resource {
- public void getResource() throws IOException{
- //返回读取指定资源的输入流
- InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");
- BufferedReader br=new BufferedReader(new InputStreamReader(is));
- String s="";
- while((s=br.readLine())!=null)
- System.out.println(s);
- }
- }
//源代码3:package edu.hxraid;import java.io.*;public class Resource {public void getResource() throws IOException{//返回读取指定资源的输入流InputStream is=this.getClass().getResourceAsStream("/resource/res.txt");BufferedReader br=new BufferedReader(new InputStreamReader(is));String s="";while((s=br.readLine())!=null)System.out.println(s);}}我们将java工程下/bin目录中的edu/hxraid/Resource.class和资源文件resource/res.txt一并打包进ResourceJar.jar中,不管jar包在系统的任何目录下,调用jar包中的Resource类都可以获得jar包中的res.txt资源,再也不会找不到res.txt文件了。 ----------------------XWork中有个工具类,叫做ClassLoaderUtil,可以深入读取jar包中的资源文件。Struts2就是用这个工具类读取所有的plugin中的struts-default.xml的。
原理应该和楼主的一样。所以不得不赞叹很多前人的工作,当我们碰到难题时,其实很多前人已经总结了很多最佳实践了。 ----------------------jar包中文件URL有专用格式的:jar:
例如:jar:file:/.../.../xxx.jar!/.../.../zzz.class ---------------------jar包中文件URL有专用格式的:jar:
确实是这样,当时这个格式不同于file的URL格式,所以我们不能通过File f=new File(jarURL);来获取jar中的资源,只能通过专门的方法来定位jar包中专门的URL格式。这个方法就是ClassLoader的getResourceAsStream()方法,至于是如何做到的,我就不知道了,这个方法是透明的。----------------------读取jar文件中的文件,用类加载器,亦可以读取到文件。URL中有一个getFile()方法。
File f = new File(URL.getFile());
这样就可以了。但是带来的问题是URL的路径中不支持文件夹包含空格(用%20代替了),如果要使用,需要再次转义。
虽然新的URI支持空格。但是URL.toURI().getPath()却不能够作为参数new出一个File对象。 -----------------------getClass().getResource("/a.txt").getPath().replaceAll("%20", " ") //从当前类的最外层包的父目录搜索资源;
getClass().getResource("a.txt").getPath().replaceAll("%20", " ") //从当前类所在目录搜索资源
第一种从根目录(当前类的最外层包的父目录)搜索资源;
第二种从当前类所在目录搜索资源。
就可以搞定了。。。
类加载器加载的资源文件都要在classpath下 ---------------------忘记补充一点了。URL是不支持中文的。URI才支持。 --------------------- 这个jar包搞死我了,昨天搞清楚jar包中资源URL的形式以及读法。今天写了个程序突然发现源代码可以读,但打入jar包后就不行了。最后花了我2个多小时才搞明白为什么:
原来我的资源文件名是 BigramDict.dct
但是我在源代码里面写成了:/ICTCLAS_DICT/bigramDict.dct (首字母小写了)
本来这是个小问题,但是源代码
InputStream is=this.getClass().getResourceAsStream("/ICTCLAS_DICT/bigramDict.dct");
运行的时候是可以找到BigramDict.dct的。一旦把 BigramDict.dct打入jar包,就找不到了。
jar包里面的文件要分大小写的,但找外面的文件名可以不分,哭死我了。
------------------------这个类一下就可以搞定:java.util.jar.JarFile ------------------------我也碰到过,不过new File(url.getFile()); 改成new File(url.toURI())很完美,File的构造函数支持以URI作为参数的,哈哈 ------------------------mallon 写道 admires 写道 读取jar文件中的文件,用类加载器,亦可以读取到文件。URL中有一个getFile()方法。
File f = new File(URL.getFile());
这样就可以了。但是带来的问题是URL的路径中不支持文件夹包含空格(用%20代替了),如果要使用,需要再次转义。
虽然新的URI支持空格。但是URL.toURI().getPath()却不能够作为参数new出一个File对象。
我也碰到过,不过new File(url.getFile()); 改成new File(url.toURI())很完美,File的构造函数支持以URI作为参数的,哈哈
后来也有尝试过用URI作为参数构造File对象。但如果这个文件是存在于jar包中,也是不可以的。
在数次尝试之后发现可以用url.toURI().getSchemeSpecificPart()作为参数来构造File对象。
这样可以避免路径文件夹中有空格,或者汉字。
官方文档中对于getSchemeSpecificPart()方法的说明是:
Returns the decoded scheme-specific part of this URI
而对于getPath()
Returns the decoded path component of this URI
以上为人肉测试结果。 ---------------------------------------这样的方式,在动态热部署中,依然无法读取jar类的东西。
并且错误很怪异。
上半年遇到的问题。
最后改用zip流读入了 ---------------------------------这个问题我遇到过,后来看了一下 java security才明白,jvm 在加载了jar包后,所有的资源访问都是通过java的安全机制的,就像你在本地pc上启动了一个虚拟系统,然后在虚拟系统中要来访问你本地pc的文件是不行的。所有只能通过java 类加载机制来寻找文件。 -----------------------------