从jar包中读取资源文件(原理深究)
作者:互联网
1 从jar包中读取资源文件
1.1 问题引入
在代码中读取一些资源文件(比如图片,音乐,文本等等)。在单独运行的时候这些简单的处理当然不会有问题。但是,如果我们把代码打成一个jar包以后,即,使将资源文件一并打包,这些东西也找不出来了。看看下面的代码:
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包)
- src/
src/edu/hxraid/Resource.java - 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
字节码:bin/resource/res.txt
将无法定位到jar包中的res.txt位置上。就算把bin/目录去掉:String "resource/res.txt
仍然无法定位到jar
包中res.txt
上
这主要是因为jar包是一个单独的文件而非文件夹,绝对不可能通过file:/e:/.../ResourceJar.jar/resource /res.txt
这种形式的文件URL
来定位res.txt
。
所以即使是相对路径,也无法定位到jar文件
内的txt文件
1.2 问题分析及解决
那么把资源打入jar
包,无论ResourceJar.jar
在系统的什么路径下,jar包中的字节码程序都可以找到该包中的资源。这会是幻想吗?
当然不是,我们可以用类装载器(ClassLoader
)来做到这一点:
ClassLoader
是类加载器的抽象类。它可以在运行时动态的获取加载类的运行信息。 可以这样说,当我们调用ResourceJar.jar
中的Resource
类时,JVM
加载进Resource
类,并记录下Resource
运行时信息(包括Resource
所在jar
包的路径信息)。而ClassLoader
类中的方法可以帮助我们动态的获取这些信息:
public URL getResource(String name)
查找具有给定名称的资源。资源是可以通过类代码以与代码无关的方式访问的一些数据(图像、声音、文本等)。并返回资源的URL对象。
public InputStream getResourceAsStream(String name);
返回读取指定资源的输入流。这个方法很重要,可以直接获得jar包中文件的内容。ClassLoader
是abstract
的,不可能实例化对象,更加不可能通过ClassLoader
调用上面两个方法。所以我们真正写代码的时候,是通过Class
类中的getResource()
和getResourceAsStream()
方法,这两个方法会委托ClassLoader
中的getResource()
和getResourceAsStream()
方法 。现在我们重新写一段Resource
代码,来看看上面那段费解的话是什么意思了:
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
类的测试代码:
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
我们成功的在运行时动态获得了res.txt的位置。然而,问题来了,是否可以通过下面这样的代码来得到res.txt
文件?
File f=new File("C:/ResourceJar.jar!/resource/res.txt");
当然不可能,因为.../ResourceJar.jar!/resource/....
并不是文件资源定位符的格式 (jar
中资源有其专门的URL
形式: jar:File f=new File(相对路径);
的形式,是不可能定位到文件资源的。这也是为什么源代码打包成jar
文件后,调用jar
包时会报出FileNotFoundException
的症结所在了。
- 我们不能用常规操作文件的方法来读取
ResourceJar.jar
中的资源文件res.txt
,但可以通过Class
类的getResourceAsStream()
方法来获取 ,这种方法是如何读取jar
中的资源文件的,这一点对于我们来说是透明的。我们将Resource.java
改写成:
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文件了
标签:包中,Resource,深究,res,jar,ResourceJar,resource,txt 来源: https://www.cnblogs.com/jingzh/p/15552730.html