com.feilong.core.lang

Class ClassLoaderUtil

java.lang.Object

com.feilong.core.lang.ClassLoaderUtil

public final class ClassLoaderUtil
extends Object

ClassLoader工具类.

关于查找资源:

• getResource(String)
• getResourceInAllClassLoader(String, Class)

关于 Class#getResourceAsStream(String) VS ClassLoader#getResourceAsStream(String)

基本上,两个都可以用于从 classpath 里面进行资源读取,classpath包含classpath中的路径和classpath中的jar

假设配置文件在 src/main/resources下面,比如 messages/feilong-core-message_en_US.properties,

1. Class#getResourceAsStream(String) 需要这么写 "/messages/feilong-core-message_en_US.properties",
   路径可以写成相对路径或者绝对路径; 以 / 开头,则这样的路径是指定绝对路径, 如果不以 / 开头, 则路径是相对与这个class所在的包的
2. ClassLoader#getResourceAsStream(String) 需要这么写 "messages/feilong-core-message_en_US.properties",
   ClassLoader JVM会使用BootstrapLoader去加载资源文件.
   所以路径还是这种相对于工程的根目录即"messages/feilong-core-message_en_US.properties" 不需要"/"
3. 如果你的项目使用了spring,建议条件允许的话,使用 org.springframework.core.io.ClassPathResource,这个类是基于ClassLoader的,同时会 org.springframework.util.StringUtils#cleanPath(String),并且如果发现首字符是/斜杆, 会去掉,这样使用起来很方便

Since:

1.0.0

Author:

feilong

See Also:

ClassLoader, URLClassLoader, "org.springframework.core.io.ClassPathResource#ClassPathResource(String, ClassLoader)"

Method Summary

Methods

Modifier and Type	Method and Description
static URL	getResource(String resourceName) 获得给定名称 resourceName 的资源.
static InputStream	getResourceAsStream(String resourceName, Class<?> callingClass) 加载资源 resourceName为 InputStream.
static URL	getResourceInAllClassLoader(String resourceName, Class<?> callingClass) Load a given resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getResource

public static URL getResource(String resourceName)

获得给定名称 resourceName 的资源.

示例:

比如,在 src/test/resources 目录下面有 messages/feilong-core-test.properties 资源文件,编译之后,地址会出现在 target/test-classes/messages/feilong-core-test.properties

 ClassLoaderUtil.getResource("/messages/feilong-core-test.properties") 
 或者 ClassLoaderUtil.getResource("messages/feilong-core-test.properties")
 

返回相同的结果

 file:/E:/Workspaces/feilong/feilong-core/target/test-classes/messages/feilong-core-test.properties
 

注意:

1. 如果 resourceName 是以斜杆 "/" 开头,那么会被截取,因为 ClassLoader 解析方式不需要开头的斜杆, 请参见 org.springframework.core.io.ClassPathResource#ClassPathResource(String, ClassLoader)
2. "",表示classes 的根目录

不同环境结果不一样:

示例	(maven)测试	在web环境中,(即使打成jar的情形)
getResource("")	file:/E:/Workspaces/feilong/feilong-platform/feilong-core/target/test-classes/	file:/E:/Workspaces/feilong/feilong-platform/feilong-web-test/src/main/webapp/WEB-INF/classes/
getResource("com")	file:/E:/Workspaces/feilong/feilong-platform/feilong-core/target/test-classes/com	file:/E:/Workspaces/feilong/feilong-platform/feilong-web-test/src/main/webapp/WEB-INF/classes/com/

Parameters:

resourceName - the resource name

Returns:

如果 resourceName 是null,抛出 NullPointerException
如果找不到该资源,或者调用者没有足够的权限获取该资源,则返回 null

See Also:

ClassPathUtils.toFullyQualifiedPath(Package, String), getResource(ClassLoader, String), getClassLoaderByClass(Class)

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName,
                              Class<?> callingClass)

加载资源 resourceName为 InputStream.

注意:

1. 如果 resourceName 是以 斜杆 "/" 开头,那么会被截取, 因为 ClassLoader解析方式不需要 开头的斜杆, 请参见 org.springframework.core.io.ClassPathResource#ClassPathResource(String, ClassLoader)
2. "",表示classes 的根目录

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

如果 resourceName 是null,抛出 NullPointerException
如果查找不到资源,那么返回 null

See Also:

getResourceInAllClassLoader(String, Class), "org.apache.velocity.util.ClassUtils#getResourceAsStream(Class, String)"

getResourceInAllClassLoader

public static URL getResourceInAllClassLoader(String resourceName,
                              Class<?> callingClass)

Load a given resource.

注意:

1. 如果 resourceName 是以 斜杆 "/" 开头,那么会被截取,因为 ClassLoader解析方式不需要开头的斜杆, 请参见 org.springframework.core.io.ClassPathResource#ClassPathResource(String, ClassLoader)
2. "",表示classes 的根目录

3. This method will try to load the resource using the following methods (in order):

   • From Thread.currentThread().getContextClassLoader()
   • From ClassLoaderUtil.class.getClassLoader()
   • From callingClass.getClassLoader() (如果 callingClass 不是null)

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

如果 resourceName 是null,抛出 NullPointerException
如果 callingClass 是null,将会忽略此参数
如果在所有的ClassLoader里面都查不到资源,那么返回null

Since:

1.6.2