手写简易版Spring框架（四）：设计与实现资源加载器，从Spring.xml解析和注册Bean对象

最新推荐文章于 2024-07-12 11:38:30 发布

原创

最新推荐文章于 2024-07-12 11:38:30 发布 · 381 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring

本文档介绍了如何在Spring框架中通过配置文件加载Bean对象，实现了ResourceLoader接口，支持ClassPath、FileSystem和URL资源加载。接着，通过BeanDefinitionReader接口和其实现类XmlBeanDefinitionReader解析XML配置，注册Bean到Spring容器。测试用例展示了如何使用配置文件启动应用并调用方法。代码已上传至GitHub。

目标

在完成 Spring 的框架雏形后，现在我们可以通过单元测试进行手动操作 Bean 对象的定义、注册和属性填充，以及最终获取对象调用方法。但这里会有一个问题，就是如果实际使用这个 Spring 框架，是不太可能让用户通过手动方式创建的，而是最好能通过配置文件的方式简化创建过程。需要完成如下操作：
在这里插入图片描述
如图中我们需要把步骤：2、3、4整合到Spring框架中，通过 Spring 配置文件的方式将 Bean 对象实例化。接下来我们就需要在现有的 Spring 框架中，添加能解决 Spring 配置的读取、解析、注册Bean的操作。

设计

依照本章节的需求背景，我们需要在现有的 Spring 框架雏形中添加一个资源解析器，也就是能读取classpath、本地文件和云文件的配置内容。这些配置内容就是像使用 Spring 时配置的 Spring.xml 一样，里面会包括 Bean 对象的描述和属性信息。在读取配置文件信息后，接下来就是对配置文件中的 Bean 描述信息解析后进行注册操作，把 Bean 对象注册到 Spring 容器中。整体设计结构如下图：
在这里插入图片描述

资源加载器属于相对独立的部分，它位于 Spring 框架核心包下的IO实现内容，主要用于处理Class、本地和云环境中的文件信息。
当资源可以加载后，接下来就是解析和注册 Bean 到 Spring 中的操作，这部分实现需要和
DefaultListableBeanFactory 核心类结合起来，因为你所有的解析后的注册动作，都会把 Bean
定义信息放入到这个类中。
那么在实现的时候就设计好接口的实现层级关系，包括我们需要定义出 Bean 定义的读取接口 BeanDefinitionReader以及做好对应的实现类，在实现类中完成对 Bean 对象的解析和注册。

实现

本章涉及到的类的结构图

在这里插入图片描述

本章节为了能把 Bean 的定义、注册和初始化交给 Spring.xml配置化处理，那么就需要实现两大块内容，分别是：资源加载器、xml资源处理类，实现过程主要以对接口Resource、ResourceLoader 的实现，而另外 BeanDefinitionReader接口则是对资源的具体使用，将配置信息注册到 Spring 容器中去。
在 Resource 的资源加载器的实现中包括了，ClassPath、系统文件、云配置文件，这三部分与 Spring源码中的设计和实现保持一致，最终在 DefaultResourceLoader 中做具体的调用。
接口：BeanDefinitionReader、抽象类：AbstractBeanDefinitionReader、实现类:XmlBeanDefinitionReader，这三部分内容主要是合理清晰的处理了资源读取后的注册Bean 容器操作。接口管定义，抽象类处理非接口功能外的注册Bean组件填充，最终实现类即可只关心具体的业务实现。

另外本章节还参考 Spring 源码，做了相应接口的集成和实现的关系，虽然这些接口目前还并没有太大的作用，但随着框架的逐步完善，它们也会发挥作用：

在这里插入图片描述

BeanFactory，已经存在的 Bean 工厂接口用于获取 Bean 对象，这次新增加了按照类型获取 Bean 的方法： T getBean(String name, Class requiredType)
ListableBeanFactory，是一个扩展 Bean 工厂接口的接口，新增加了 getBeansOfType、getBeanDefinitionNames() 方法，在 Spring 源码中还有其他扩展方法。
HierarchicalBeanFactory，在 Spring 源码中它提供了可以获取父类 BeanFactory方法，属于是一种扩展工厂的层次子接口。
AutowireCapableBeanFactory，是一个自动化处理Bean工厂配置的接口，目前案例工程中还没有做相应的实现，后续逐步完善。
ConfigurableBeanFactory，可获取BeanPostProcessor、BeanClassLoader等的一个配置化接口。
ConfigurableListableBeanFactory，提供分析和修改Bean以及预先实例化的操作接口，不过目前只有一个getBeanDefinition 方法。

资源加载接口定义和实现

package com.qingyun.springframework.core.io;

import java.io.IOException;
import java.io.InputStream;

/**
 * @description： 有着Bean定义的资源以及相关操作
 * @author: 張青云
 * @create: 2021-08-20 10:06
 **/
public interface Resource {
   
   
    /**
     * 从资源中获取输入流
     * @return 输入流
     * @throws IOException IO异常
     */
    InputStream getInputStream() throws IOException;
}

在 Spring 框架下创建 core.io 核心包，在这个包中主要用于处理资源加载流。定义 Resource 接口，提供获取 InputStream 流的方法，接下来再分别实现三种不同的流文件操作：classPath、FileSystem、URL。

package com.qingyun.springframework.core.io;

import cn.hutool.core.lang.Assert;
import com.qingyun.springframework.util.ClassUtils;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;

/**
 * @description： 资源存放在类路径下
 * @author: 張青云
 * @create: 2021-08-20 10:08
 **/
public class ClassPathResource implements Resource {
   
   

    private final String path;

    private final ClassLoader classLoader;

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

    public ClassPathResource(String path, ClassLoader classLoader) {
   
   
        Assert.notNull(path, "Path must not be null");
        this.path = path;
        this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader());
    }

    @Override
    public InputStream getInputStream() throws IOException {
   
   
        //  使用类加载器获取输入流
        InputStream is = classLoader.getResourceAsStream(path);
        if (is == null) {
   
   
            throw new FileNotFoundException(
                    this.path + " cannot be opened because it does not exist");
        }
        return is;
    }
}

这一部分的实现是用于通过 ClassLoader 读取ClassPath 下的文件信息，具体的读取过程主要是：classLoader.getResourceAsStream(path)。

package com.qingyun.springframework.core.io;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

/**
 * @description： 资源存放在文件当中
 * @author: 張青云
 * @create: 2021-08-20 10:14
 **/
public class FileSystemResource implements Resource {
   
   

    private final File file;

    private final String path;

    public FileSystemResource(File file) {
   
   
        this.file = file;
        this.path = file.getPath();
    }

    public FileSystemResource(String path) {
   
   
        this.file = new File(path);
        this.path = path;
    }

    @Override
    public InputStream getInputStream() throws IOException {
   
   
        return new FileInputStream(this.file