org.tinygroup.commons.tools

Class ClassLoaderUtil

java.lang.Object

org.tinygroup.commons.tools.ClassLoaderUtil

public class ClassLoaderUtil
extends Object

查找并装入类和资源的辅助类。

ClassLoaderUtil查找类和资源的效果， 相当于ClassLoader.loadClass 方法和ClassLoader.getResource方法。 但ClassLoaderUtil 总是首先尝试从Thread.getContextClassLoader()方法取得 ClassLoader中并装入类和资源。 这种方法避免了在多级ClassLoader 的情况下，找不到类或资源的情况。

假设有如下情况:

• 工具类A是从系统ClassLoader装入的(classpath)
• 类B是Web Application中的一个类，是由servlet引擎的ClassLoader 动态装入的
• 资源文件C.properties也在Web Application中，只有servlet引擎的动态 ClassLoader可以找到它
• 类B调用工具类A的方法，希望通过类A取得资源文件 C.properties

如果类A使用 getClass().getClassLoader().getResource("C.properties") ， 就会失败，因为系统ClassLoader不能找到此资源。 但类A可以使用ClassLoaderUtil.getResource("C.properties")，就可以找到这个资源， 因为ClassLoaderUtil调用Thread.currentThead().getContextClassLoader() 取得了servlet引擎的ClassLoader， 从而找到了这个资源文件。

Author:

renhui

Constructor Summary

Constructors

Constructor and Description
ClassLoaderUtil()

Method Summary

Modifier and Type	Method and Description
static ClassLoader	getContextClassLoader() 取得当前线程的ClassLoader。这个功能需要JDK1.2或更高版本的JDK的支持。
static URL	getResource(String resourceName) 从ClassLoader取得resource URL。按如下顺序查找:
static URL	getResource(String resourceName, Class<?> referrer) 从指定调用者所属的ClassLoader取得resource URL。
static URL	getResource(String resourceName, ClassLoader classLoader) 从指定的ClassLoader取得resource URL。
static InputStream	getResourceAsStream(String resourceName) 从ClassLoader取得resource的输入流。 相当于 getResource(resourceName).openStream()。
static InputStream	getResourceAsStream(String resourceName, Class<?> referrer) 从ClassLoader取得resource的输入流。 相当于 getResource(resourceName, referrer).openStream()。
static InputStream	getResourceAsStream(String resourceName, ClassLoader classLoader) 从ClassLoader取得resource的输入流。 相当于 getResource(resourceName, classLoader).openStream()。
static URL[]	getResources(String resourceName) 从ClassLoader取得所有resource URL。按如下顺序查找: 在当前线程的ClassLoader中查找。 在装入自己的ClassLoader中查找。 通过ClassLoader.getSystemResource方法查找。
static URL[]	getResources(String resourceName, Class<?> referrer) 从指定调用者所属的ClassLoader取得所有resource URL。
static URL[]	getResources(String resourceName, ClassLoader classLoader) 从指定的ClassLoader中取得所有resource URL。如果未指定 ClassLoader， 则从装载ClassLoaderUtil的 ClassLoader中取得所有resource URL。
static Class<?>	loadClass(String className) 从当前线程的ClassLoader装入类。对于JDK1.2以下，则相当于 Class.forName。
static Class<?>	loadClass(String className, Class<?> referrer) 从指定的调用者的ClassLoader装入类。
static Class<?>	loadClass(String className, ClassLoader classLoader) 从指定的ClassLoader中装入类。如果未指定ClassLoader， 则从装载 ClassLoaderUtil的ClassLoader中装入。
static Object	newInstance(String className) 从当前线程的ClassLoader装入类并实例化之。
static Object	newInstance(String className, Class<?> referrer) 从指定的调用者的ClassLoader装入类并实例化之。
static Object	newInstance(String className, ClassLoader classLoader) 从指定的ClassLoader中装入类并实例化之。如果未指定ClassLoader， 则从装载 ClassLoaderUtil的ClassLoader中装入。
static URL	whichClass(String className) 从当前线程的ClassLoader中查找指定名称的类。
static URL	whichClass(String className, Class<?> referrer) 从当前线程的ClassLoader中查找指定名称的类。
static URL	whichClass(String className, ClassLoader classLoader) 从当前线程的ClassLoader中查找指定名称的类。
static URL[]	whichClasses(String className) 从当前线程的ClassLoader中查找指定名称的类。
static URL[]	whichClasses(String className, Class<?> referrer) 从当前线程的ClassLoader中查找指定名称的类。
static URL[]	whichClasses(String className, ClassLoader classLoader) 从当前线程的ClassLoader中查找指定名称的类。

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassLoaderUtil

public ClassLoaderUtil()

Method Detail

getContextClassLoader

public static ClassLoader getContextClassLoader()

取得当前线程的ClassLoader。这个功能需要JDK1.2或更高版本的JDK的支持。

Returns:

当前线程的ClassLoader

loadClass

public static Class<?> loadClass(String className)
                          throws ClassNotFoundException

从当前线程的ClassLoader装入类。对于JDK1.2以下，则相当于 Class.forName。

Parameters:

className - 要装入的类名

Returns:

已装入的类

Throws:

ClassNotFoundException - 如果类没找到

loadClass

public static Class<?> loadClass(String className,
                                 Class<?> referrer)
                          throws ClassNotFoundException

从指定的调用者的ClassLoader装入类。

Parameters:

className - 要装入的类名

referrer - 调用者类，如果为null，则该方法相当于 Class.forName

Returns:

已装入的类

Throws:

ClassNotFoundException - 如果类没找到

loadClass

public static Class<?> loadClass(String className,
                                 ClassLoader classLoader)
                          throws ClassNotFoundException

从指定的ClassLoader中装入类。如果未指定ClassLoader， 则从装载 ClassLoaderUtil的ClassLoader中装入。

Parameters:

className - 要装入的类名

classLoader - 从指定的ClassLoader中装入类，如果为null ，表示从ClassLoaderUtil所在的class loader中装载

Returns:

已装入的类

Throws:

ClassNotFoundException - 如果类没找到

newInstance

public static Object newInstance(String className)
                          throws ClassNotFoundException,
                                 ClassInstantiationException

从当前线程的ClassLoader装入类并实例化之。

Parameters:

className - 要实例化的类名

Returns:

指定类名的实例

Throws:

ClassNotFoundException - 如果类没找到

ClassInstantiationException - 如果实例化失败

newInstance

public static Object newInstance(String className,
                                 Class<?> referrer)
                          throws ClassNotFoundException,
                                 ClassInstantiationException

从指定的调用者的ClassLoader装入类并实例化之。

Parameters:

className - 要实例化的类名

referrer - 调用者类，如果为null，则从ClassLoaderUtil 所在的class loader装载

Returns:

指定类名的实例

Throws:

ClassNotFoundException - 如果类没找到

ClassInstantiationException - 如果实例化失败

newInstance

public static Object newInstance(String className,
                                 ClassLoader classLoader)
                          throws ClassNotFoundException,
                                 ClassInstantiationException

从指定的ClassLoader中装入类并实例化之。如果未指定ClassLoader， 则从装载 ClassLoaderUtil的ClassLoader中装入。

Parameters:

className - 要实例化的类名

classLoader - 从指定的ClassLoader中装入类，如果为null ，表示从ClassLoaderUtil所在的class loader中装载

Returns:

指定类名的实例

Throws:

ClassNotFoundException - 如果类没找到

ClassInstantiationException - 如果实例化失败

getResources

public static URL[] getResources(String resourceName)

从ClassLoader取得所有resource URL。按如下顺序查找:

1. 在当前线程的ClassLoader中查找。
2. 在装入自己的ClassLoader中查找。
3. 通过ClassLoader.getSystemResource方法查找。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

Returns:

resource的URL数组，如果没找到，则返回空数组。数组中保证不包含重复的URL。

getResources

public static URL[] getResources(String resourceName,
                                 Class<?> referrer)

从指定调用者所属的ClassLoader取得所有resource URL。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

referrer - 调用者类，如果为null，表示在ClassLoaderUtil 的class loader中找

Returns:

resource的URL数组，如果没找到，则返回空数组。数组中保证不包含重复的URL。

getResources

public static URL[] getResources(String resourceName,
                                 ClassLoader classLoader)

从指定的ClassLoader中取得所有resource URL。如果未指定 ClassLoader， 则从装载ClassLoaderUtil的 ClassLoader中取得所有resource URL。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

classLoader - 从指定的ClassLoader中查找

Returns:

resource的URL数组，如果没找到，则返回空数组。数组中保证不包含重复的URL。

getResource

public static URL getResource(String resourceName)

从ClassLoader取得resource URL。按如下顺序查找:

1. 在当前线程的ClassLoader中查找。
2. 在装入自己的ClassLoader中查找。
3. 通过ClassLoader.getSystemResource方法查找。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

Returns:

resource的URL

getResource

public static URL getResource(String resourceName,
                              Class<?> referrer)

从指定调用者所属的ClassLoader取得resource URL。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

referrer - 调用者类，如果为null，表示在ClassLoaderUtil 的class loader中找。

Returns:

resource URL，如果没找到，则返回null

getResource

public static URL getResource(String resourceName,
                              ClassLoader classLoader)

从指定的ClassLoader取得resource URL。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

classLoader - 在指定classLoader中查找，如果为null，表示在 ClassLoaderUtil的class loader中找。

Returns:

resource URL，如果没找到，则返回null

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName)

从ClassLoader取得resource的输入流。 相当于 getResource(resourceName).openStream()。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

Returns:

resource的输入流

getResourceAsStream

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

从ClassLoader取得resource的输入流。 相当于 getResource(resourceName, referrer).openStream()。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

referrer - 调用者类，如果为null，表示在ClassLoaderUtil 的class loader中找。

Returns:

resource的输入流

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName,
                                              ClassLoader classLoader)

从ClassLoader取得resource的输入流。 相当于 getResource(resourceName, classLoader).openStream()。

Parameters:

resourceName - 要查找的资源名，就是以"/"分隔的标识符字符串

classLoader - 在指定classLoader中查找，如果为null，表示在 ClassLoaderUtil的class loader中找。

Returns:

resource的输入流

whichClasses

public static URL[] whichClasses(String className)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

Returns:

URL数组，列举了系统中所有可找到的同名类，如果未找到，则返回一个空数组

whichClasses

public static URL[] whichClasses(String className,
                                 Class<?> referrer)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

referrer - 调用者类，如果为null，表示在ClassLoaderUtil 的class loader中找。

Returns:

URL数组，列举了系统中所有可找到的同名类，如果未找到，则返回一个空数组

whichClasses

public static URL[] whichClasses(String className,
                                 ClassLoader classLoader)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

classLoader - 在指定classLoader中查找，如果为null，表示在 ClassLoaderUtil的class loader中找。

Returns:

URL数组，列举了系统中所有可找到的同名类，如果未找到，则返回一个空数组

whichClass

public static URL whichClass(String className)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

Returns:

类文件的URL，如果未找到，则返回null

whichClass

public static URL whichClass(String className,
                             Class<?> referrer)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

referrer - 调用者类，如果为null，表示在ClassLoaderUtil 的class loader中找。

Returns:

类文件的URL，如果未找到，则返回null

whichClass

public static URL whichClass(String className,
                             ClassLoader classLoader)

从当前线程的ClassLoader中查找指定名称的类。

Parameters:

className - 要查找的类名

classLoader - 在指定classLoader中查找，如果为null，表示在 ClassLoaderUtil的class loader中找。

Returns:

类文件的URL，如果未找到，则返回null