Spring源码解析—— ClassPathResource类

一,简单介绍Spring中资源处理相关类

BeanFactory beanFactory=new XmlBeanFactory(new ClassPathResource("applicationContext.xml"));

在Spring中,定义了接口InputStreamSource,这个类中只包含一个方法:

public interface InputStreamSource {

	/**
	 * Return an {@link InputStream}.
	 * <p>It is expected that each call creates a <i>fresh</i> stream.
	 * <p>This requirement is particularly important when you consider an API such
	 * as JavaMail, which needs to be able to read the stream multiple times when
	 * creating mail attachments. For such a use case, it is <i>required</i>
	 * that each {@code getInputStream()} call returns a fresh stream.
	 * @return the input stream for the underlying resource (must not be {@code null})
	 * @throws IOException if the stream could not be opened
	 * @see org.springframework.mail.javamail.MimeMessageHelper#addAttachment(String, InputStreamSource)
	 */
	InputStream getInputStream() throws IOException;

}

用来返回一个基本的InputStream文件。

之后,使用Resource接口来规定对文件的一些基本的操作。对于不同来源的件:classpath,file,url,byte,inputstream...进行处理。在我们的应用程序里面,比较常用的就是对我们classpath下的xml文件进行解析的ClassPathResource。

二,ClassPathResource的构造函数

利用ClassPathResource读取xml配置的基本思路就是通过构造函数传入的文件路径,接着交给class或者classLoader,调用getResourceAsStream获取到InputStream。

所以,我们的private成员变量是这样子定义的:

public class ClassPathResource extends AbstractFileResolvingResource {

	private final String path;

	private ClassLoader classLoader;

	private Class<?> clazz;

主要构造函数(存在多个构造函数,但是都差不多啦):

public ClassPathResource(String path, ClassLoader classLoader) {
		Assert.notNull(path, "Path must not be null");
		String pathToUse = StringUtils.cleanPath(path);
		if (pathToUse.startsWith("/")) {
			pathToUse = pathToUse.substring(1);
		}
		this.path = pathToUse;
		this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader());
	}

Assert类是spring的一个校验类,比如,如果path为空的话,则会抛出一个异常,异常信息为后面的"Path must not be null"。其实就是封装了一个判断是否为null的操作,查看Assert,发现还有很多类似函数,例如,判断为trueorfalse这种。

之后处理你自己传入的路径。。。。因为这里默认使用ClassLoader来加载资源,所以,路径开头要去掉“/”。但是如果你不传入classLoader,则classLoader按照如下规则获取:

public static ClassLoader getDefaultClassLoader() {
		ClassLoader cl = null;
		try {
			cl = Thread.currentThread().getContextClassLoader();
		}
		catch (Throwable ex) {
			// Cannot access thread context ClassLoader - falling back to system class loader...
		}
		if (cl == null) {
			// No thread context class loader -> use class loader of this class.
			cl = ClassUtils.class.getClassLoader();
		}
		return cl;
	}

首选我们安全的从当前线程获取类加载器的方法,但是这个方法在 某些情况下会返回null值(可以百度下Thread.currentThread().getContextClassLoader()获取classloader跟使用**Class.getClassLoader()方法有什么不同,如果懒的话,可以看看下面的代码),这个跟JVM的类加载器的层级关系有关。。。

/* 测试利用class或者classloader读取文件classpath下的文件 */
	public static void getResourceByClassOrClassLoader() {
		/*
		 * Classloader是从classpath中读取资源的一个类,
		 * 一般我们用classloader来加载class,实际上,但凡是处在classpath中的文件,
		 * 我们称之为资源,都可以用classloader来读取。
		 * 注意,使用classloader来加载资源的时候,目录前面不加“/”
		 */
		System.out.println(TestResource.class.getClassLoader().getResource(
				"applicationContext.xml"));

		/* 这个API的起始路径是当前类的路径,如果要正确的读到资源,目标资源必须和当前class在同一级,或子目录里,可以用相对路径读取到。 */
		System.out.println(TestResource.class
				.getResource("/applicationContext.xml"));

		/*安全用法---提倡使用  From:http://www.cnblogs.com/gaoxing/p/4703412.html*/
		System.out.println( Thread.currentThread().getContextClassLoader().getResource(
				"applicationContext.xml"));

		/*读取到InputStream*/
		InputStream inputStream = TestResource.class.getClassLoader()
				.getSystemResourceAsStream("applicationContext.xml");
		System.out.println(inputStream);

	}

区分下使用class 还有classLoader 这两种方式getResource在写法跟实现上有什么不同。

这之后,构造函数完成, XML文件加载完毕。

三,其他方法

1,示例:exists

@Override
	public boolean exists() {
		URL url;
		if (this.clazz != null) {
			url = this.clazz.getResource(this.path);
		}
		else {
			url = this.classLoader.getResource(this.path);
		}
		return (url != null);
	}

在对资源文件文件进行操作的时候,我们的首选还是使用Class类来进行操作,因为资源和我类文件的位置是相对固定的,可能这是一种潜规则+默认的写法吧。如果执行构造函数的时候没有传入class来进行初始化,则使用classLoader来判断文件。最 后return (url != null);写法挺简洁!

这个类里面的getInputStream,getURL,getDescription都是类似的。

希望没丢掉什么重点。求补充!

时间: 2024-11-05 12:13:31

Spring源码解析—— ClassPathResource类的相关文章

Spring源码解析-核心类之XmlBeanDefinitionReader

XmlBeanDefinitionReader XML配置文件的读取是 Spring 中重要的功能,因为 Spring 的大部分功能都是以配置作为切入点的,那么我们可以从 XmlBeanDefinitionReader 中梳理一下资源文件读取.解析及注册的大致脉络,来看下各个类的功能. ResourceLoader: 定义资源加载器,主要用于根据给定的资源文件地址返回对应的 Resource. BeanDefinitionReader: 主要定义资源文件读取并转换为 BeanDefinition

软件开发工程师(JAVA)中级考试大纲--spring源码解析

spring源码解析(1)----IOC 一.IOC容器 在Spring中,IOC容器的重要地位我们就不多说了,对于Spring的使用者而言,IOC容器实际上是什么呢?我们可以说BeanFactory就是我们看到的IoC容器,当然了Spring为我们准备了许多种IoC容器来使用,这样可以方便我们从不同的层面,不同的资源位置,不同的形式的定义信息来建立我们需要的IoC容器. 在Spring中,最基本的IOC容器接口是BeanFactory - 这个接口为具体的IOC容器的实现作了最基本的功能规定 

SPRING源码解析-SPRING 核心-IOC

IoC 和 AOP是Spring的核心, 是Spring系统中其他组件模块和应用开发的基础.透过这两个模块的设计和实现可以了解Spring倡导的对企业应用开发所应秉承的思路: 易用性. POJO开发企业应用, 直接依赖于Java语言,而不是容器和框架. 提升程序的可测试性,提高软件质量. 提供一致性编程模型,面向接口的编程 降低应用的负载和框架的侵入性.IoC和AOP实现. 不作为现有解决方案的替代,而是集成现有. IoC和AOP这两个核心组件,特别是IoC容器,使用户在使用Spring完成PO

Spring 源码解析之HandlerAdapter源码解析(二)

Spring 源码解析之HandlerAdapter源码解析(二) 前言 看这篇之前需要有Spring 源码解析之HandlerMapping源码解析(一)这篇的基础,这篇主要是把请求流程中的调用controller流程单独拿出来了 解决上篇文章遗留的问题 getHandler(processedRequest) 这个方法是如何查找到对应处理的HandlerExecutionChain和HandlerMapping的,比如说静态资源的处理和请求的处理肯定是不同的HandlerMapping ge

Spring 源码解析之ViewResolver源码解析(四)

Spring 源码解析之ViewResolver源码解析(四) 1 ViewResolver类功能解析 1.1 ViewResolver Interface to be implemented by objects that can resolve views by name. View state doesn't change during the running of the application, so implementations are free to cache views. I

Spring 源码解析之DispatcherServlet源码解析(五)

Spring 源码解析之DispatcherServlet源码解析(五) 前言 本文需要有前四篇文章的基础,才能够清晰易懂,有兴趣可以先看看详细的流程,这篇文章可以说是第一篇文章,也可以说是前四篇文章的的汇总,Spring的整个请求流程都是围绕着DispatcherServlet进行的 类结构图 根据类的结构来说DispatcherServlet本身也是继承了HttpServlet的,所有的请求都是根据这一个Servlet来进行转发的,同时解释了为什么需要在web.xml进行如下配置,因为Spr

Spring源码解析-applicationContext

Demo uml类图 ApplicationContext ApplicationListener 源码解析 主流程 obtainFreshBeanFactory prepareBeanFactory invokeBeanFactoryPostProcessors registerBeanPostProcessors registerListeners finishRefresh 总结 在已经有BeanFactory可以完成Ioc功能情况下,spring又提供了ApplicationContex

Spring源码解析和配置文件加载

Spring类的继承结构图: Spring运用了大量的模板方法模式和策略模式,所以各位看源码的时候,务必留意,每一个继承的层次都有不同的作用,然后将相同的地方抽取出来,依赖抽象将不同的处理按照不同的策略去处理. 步骤A. 读取 Resource 文件形成 Document 模型  类图: XmlBeanFactory -> XmlBeanDefinitionReader Spring 使用 XmlBeanDefinitionReader 来读取并解析 xml 文件,XmlBeanDefiniti

Spring源码解析——start from BeanFactory(一)

先来看一下我们学习Spring时候的ABC代码: BeanFactory beanFactory=new ClassPathXmlApplicationContext("applicationContext.xml"); UserManager userManager=(UserManager)beanFactory.getBean("UserManagerImpl"); userManager.add("dd","d");