Java中的类路径不仅用于加载.class文件,而且还可以用于加载资源,例如属性文件,图像,图标,缩略图或任何二进制内容。 Java提供了API来将这些资源读取为InputStream或URL。 假设您在项目的config文件夹中有一个属性文件 ,并且想要加载该属性文件,该怎么做? 同样,您的项目的icons目录中有Web应用程序的图标和缩略图,如何加载它们? 答案是通过使用java.lang.Class'getResource()和getResourceAsStream()方法。 这些方法接受资源的路径为String并分别返回URL和InputStream。 您可以通过调用getClass()方法或使用类literal获取类的引用。 如果有一个对象,则可以调用getClass(),因为它是一个非静态方法,另一方面,如果没有任何对象,则可以简单地将.class与任何类的名称一起使用,例如Sample.class将为您提供java.lang.Class的参考。 JDK 1.1提供了这些方法,您甚至可以在有权访问核心Java库的任何地方使用它们。 如果要创建J2ME游戏或应用程序,则可以使用这些方法为游戏加载图标和图块,并为应用程序加载所有其他资源。
在内部,此方法将资源的加载请求委托给其类加载器。 如果对由BootStrap ClassLoader加载的对象调用getResourceAsStream()方法,则它将把它委托给ClassLoader.getSystemResourceAsStream(java.lang.String)方法。 我们将资源的路径传递给此方法,但是用于搜索与给定类关联的资源的规则是由该类的定义类加载器实现的。 由于您可以将绝对路径和相对路径都传递给Class.getResourceAsStream(),但是ClassLoader.getResourceAsStream()采用绝对路径,因此这就是使用以下算法从给定资源名称构造绝对资源名称的原因:
如果名称以'/'('\ u002f')开头,则资源的绝对名称是名称中'/'之后的部分。 否则,绝对名称的格式如下:
modified_package_name / name,其中modified_package_name是此对象的软件包名称,用“ /”代替“。”。 ('\ u002e')。
这意味着,如果app.properties存储在com.abc.config包中而不是当前类的包中,则传递给该方法的资源名称应类似于/com/abc/config/app.properties。
如果您通过使用快捷键Ctrl + T并键入java.lang.Class来查看Eclipse IDE中java.lang.Class的代码,则可以看到此方法的工作方式:
public InputStream getResourceAsStream(String name) {name = resolveName(name);ClassLoader cl = getClassLoader0();if (cl==null) {// A system class.return ClassLoader.getSystemResourceAsStream(name);}return cl.getResourceAsStream(name);
}
该算法是通过resolveName()方法实现的,如下所示:
/*** Add a package name prefix if the name is not absolute Remove leading "/"* if name is absolute*/private String resolveName(String name) {if (name == null) {return name;}if (!name.startsWith("/")) {Class c = this;while (c.isArray()) {c = c.getComponentType();}String baseName = c.getName();int index = baseName.lastIndexOf('.');if (index != -1) {name = baseName.substring(0, index).replace('.', '/')+"/"+name;}} else {name = name.substring(1);}return name;}
使用getResourceAsStream()方法加载资源时出现的主要问题是NullPointerException ,因为此方法如果找不到资源,则返回null。 在下面的示例中,我们有一个Eclipse项目,并且我在config目录中创建了一个名为app.properties的属性文件。 现在要加载该文件,我只需要传递“ app.properties”,如果传递诸如“ config / app.properties”或“ /config/app.properties”之类的内容,getResourceAsStream()将返回null,随后代码将抛出NullPointerException如下所示:
Exception in thread "main" java.lang.NullPointerExceptionat java.util.Properties$LineReader.readLine(Unknown Source)at java.util.Properties.load0(Unknown Source)at java.util.Properties.load(Unknown Source)at Test.main(Test.java:29)
为了避免此错误,您必须在使用getResourceAsStream()之前检查其输出,由于这种方法,防御性编程就在那里。
这是我们完整的Java程序,可以从Java的classpath加载图像,资源,文本文件或二进制文件,资源可以是任何东西,重要的是必须可访问。
package test;import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;/*** Java Program to demonstrate how to load resources e.g. properties file from* classpath. There are two ways to load resources in Java, one by using* getResourceAsStream() and getResource() method from java.lang.Class. Main* difference between these two methods are that one returns an InputStream* while other returns a URL object.** @author Javin Paul*/
public class ResourceLoader{public static void main(String args[]) {// loading resource using getResource() methodInputStream in = Test.class.getResourceAsStream("app.properties");Properties config = new Properties();try {config.load(in);System.out.println(config.getProperty("name"));System.out.println(config.getProperty("version"));} catch (IOException e1) {e1.printStackTrace();}// loading resource using getResourceAsStream() methodURL resourceURL = Test.class.getResource("app.properties");Properties appConfig = new Properties();try {appConfig.load(resourceURL.openStream());System.out.println(appConfig.getProperty("name"));System.out.println(appConfig.getProperty("version"));} catch (IOException e) {e.printStackTrace();}}}Output:
SampleApp
1.0.0
SampleApp
1.0.0
如果仔细观察,您会发现我们同时使用了getResource()和getResourceAsStream()方法从Java中的类路径加载资源,在这种情况下只是属性文件。 第一个示例看上去比第二个示例更加简洁,因为我们不需要打开显式流,getResourceAsStream()方法将返回一个InputStream ,可以在任何地方使用它。 这就是如何从Java中的类路径加载资源的全部内容。
翻译自: https://www.javacodegeeks.com/2014/08/how-to-load-resources-from-classpath-in-java-with-example.html