【Spring源码】ClassPathResource 资源文件源码分析

上一篇文章我们主要介绍了开发 Spring 应用涉及到的一些核心组件，在文章的最后搭建了开发环境。那么接下来我们开始分析 Spring 源码部分，本篇文章首先分析 Spring 是如何封装资源文件的。

Spring 框架内部使用 Resource 接口作为所有资源的抽象和访问接口，在上一篇文章的示例代码中的配置文件是通过ClassPathResource 进行封装的，ClassPathResource 是 Resource 的一个特定类型的实现，代表的是位于 classpath 中的资源。

对不同来源的资源文件 Spring 都提供了相应的实现：文件（FileSystemResource ）、ClassPath资源（ClassPathResource）、URL资源（UrlResource）、InputStream资源（InputStreamResource）、ByteArray资源（ByteArrayResource）等。

接下来我们重点关注 ClassPathResource 完成的功能。

Resource resource = new ClassPathResource("applicationContext.xml");

通过调用 ClassPathResource 类的构造方法，实现对资源的封装，ClassPathResource 内部帮我们做了很多繁琐的工作。首先看下 ClassPathResource 类的继承关系：

public class ClassPathResource extends AbstractFileResolvingResource {

   private final String path;

   @Nullable
   private ClassLoader classLoader;

   @Nullable
   private Class<?> clazz;
   
   ...
}   

成员变量

ClassPathResource 类内部 定义了三个成员变量：

1、final 类型的变量path，用于存储构造方法传入的path参数，表示资源路径；

2、成员变量 classLoader，用于获取资源（调用 ClassLoader 类的 getResourceAsStream(String name)方法）的 classLoader 对象；

3、成员变量 clazz，用于获取资源（调用 Class 类的 getResourceAsStream(String name)方法）的 class 对象；

ClassPathResource 类就是通过 classLoader 或 clazz 提供的底层方法来获取资源的，具体的使用继续看下面关于核心方法 getInputStream() 的分析。

构造函数

public ClassPathResource(String path) {
   this(path, (ClassLoader) null);
}

第一次看到 this(path, (ClassLoader) null); 这行代码的时候，有点懵的。一般我们使用 this()方法调用重载的构造方法时，参数少的调用参数多的构造方法，其他参数传默认值就行了，这里为什么要将null 强制转换成ClassLoader类型呢？

继续跟踪会发现 ClassPathResource 类提供了两个参数类型不同的构造方法 ClassPathResource(String, ClassLoader) 和 ClassPathResource(String, Class)，第二个参数类型不同。这种方式在我们的日常开发中可以尝试去使用。

public ClassPathResource(String path, @Nullable 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());
}

public ClassPathResource(String path, @Nullable Class<?> clazz) {
   Assert.notNull(path, "Path must not be null");
   this.path = StringUtils.cleanPath(path);
   this.clazz = clazz;
}

对比上面两个构造方法的实现，可以发现它们对path 路径的处理方式上存在差异，classLoader 方式去除开头的字符 / ，clazz 则不需要。根本原因还是由于 Class 类中的 getResourceAsStream() 方法 与 ClassLoader 类中的 getResourceAsStream() 对资源路径的处理方式不同，具体可以具体的实现源码，也可以参考这篇文章去实践下https://www.cnblogs.com/yejg1212/p/3270152.html，这里不再扩展。

ClassPathResource 还提供了三个参数的构造方法，不过在 Spring 的 4.3.13 版本中已经不推荐使用了。

@Deprecated
protected ClassPathResource(String path, @Nullable ClassLoader classLoader, @Nullable Class<?> clazz) {
   this.path = StringUtils.cleanPath(path);
   this.classLoader = classLoader;
   this.clazz = clazz;
}

Deprecated as of 4.3.13, in favor of selective use of ClassPathResource(String, ClassLoader) vs ClassPathResource(String, Class)

默认类加载器

ClassUtils.getDefaultClassLoader() 使用 Spring 提供的工具类 ClassUtils 获取默认的类加载器。

public static ClassLoader getDefaultClassLoader() {
   ClassLoader cl = null;
   try {
      cl = Thread.currentThread().getContextClassLoader();
   }
   catch (Throwable ex) {
      // Cannot access thread context ClassLoader - falling back...
   }
   if (cl == null) {
      // No thread context class loader -> use class loader of this class.
      cl = ClassUtils.class.getClassLoader();
      if (cl == null) {
         // getClassLoader() returning null indicates the bootstrap ClassLoader
         try {
            cl = ClassLoader.getSystemClassLoader();
         }
         catch (Throwable ex) {
            // Cannot access system ClassLoader - oh well, maybe the caller can live with null...
         }
      }
   }
   return cl;
}

首先获取线程上线文类加载器，如果获取失败，则获取加载 ClassUtils 类的类加载器，如果返回null（加载 ClassUtils 类的类加载器是启动类加载器），则获取系统类加载器。

核心方法

ClassPathResource 类中实现了 InputStreamSource 接口中的 getInputStream() 方法，这里可以看到成员变量 clazz 和 classLoader 实际用于加载资源的地方。

@Override
public InputStream getInputStream() throws IOException {
   InputStream is;
   if (this.clazz != null) {
      is = this.clazz.getResourceAsStream(this.path);
   }
   else if (this.classLoader != null) {
      is = this.classLoader.getResourceAsStream(this.path);
   }
   else {
      is = ClassLoader.getSystemResourceAsStream(this.path);
   }
   if (is == null) {
      throw new FileNotFoundException(getDescription() + " cannot be opened because it does not exist");
   }
   return is;
}

至此，ClassPathResource 类的功能基本分析完毕。留个问题，ClassPathResource 类的 getInputStream() 方法在什么地方被执行的呢？我们下篇文章见。

更多精彩内容请关注公众号 geekymv，喜欢请分享给更多的朋友哦」