《设计模式详解》手写简单的 Spring 框架

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
简介: 综合前面学习的各种设计模式的知识,手写一个简单的 Spring 框架
本文中涉及的代码在这个仓库: https://gitee.com/szluyu99/heima_design_pattern/tree/master

自定义 Spring 框架

Spring 使用回顾

  • 数据访问层,定义 UserDao 接口及其子实现类:

    public interface UserDao {
        public void add();
    }
    
    public class UserDaoImpl implements UserDao {
        public void add() {
            System.out.println("userDaoImpl ....");
        }
    }
  • 业务逻辑层,定义 UserService 接口及其子实现类

    public interface UserService {
        public void add();
    }
    
    public class UserServiceImpl implements UserService {
    
        private UserDao userDao;
    
        public void setUserDao(UserDao userDao) {
            this.userDao = userDao;
        }
    
        public void add() {
            System.out.println("userServiceImpl ...");
            userDao.add();
        }
    }
  • 定义 UserController 类,使用 main 方法模拟 controller 层

    public class UserController {
        public static void main(String[] args) {
            // 创建Spring容器对象
            ApplicationContext applicationContext = new 
              ClassPathXmlApplicationContext("applicationContext.xml");
            // 从IOC容器中获取UserService对象
            UserService userService = applicationContext
              .getBean("userService", UserService.class);
            // 调用UserService对象的add方法
            userService.add();
        }
    }
  • 编写配置文件。在类路径下编写一个名为 ApplicationContext.xml 的配置文件

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns="http://www.springframework.org/schema/beans"
           xmlns:context="http://www.springframework.org/schema/context"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">
    
        <bean id="userService" class="com.itheima.service.impl.UserServiceImpl">
            <property name="userDao" ref="userDao"></property>
        </bean>
    
        <bean id="userDao" class="com.itheima.dao.impl.UserDaoImpl"></bean>
    
    </beans>

代码运行结果如下:

在这里插入图片描述

通过上面代码及结果可以看出:

  • userService 对象从 applicationContext 容器对象中获取,也就是 userService 对象交由 Spring 进行管理
  • 结果中调用了 UserDao 对象中的 add 方法,也就是说 UserDao 子实现类对象也交由 Spring 管理
  • UserService 中的 userDao 变量没有手动赋值却可以正常使用,说明由 Spring 进行了赋值

上面三点体现了 Spring 框架的 IOCDI

IOC:Inversion of Control,控制反转

DI:Dependency Injection,依赖注入

Spring 核心功能结构

Spring 大约有 20 个模块,由 1300 多个不同的文件构成。这些模块可以分为:

核心容器、AOP、设备支持、数据访问与集成、Web 组件、通信报文和集成测试等。

下面是 Spring 框架的总体架构图:

在这里插入图片描述

核心容器由 beans、core、context 和 expression (Spring Expression Language, SpEL) 4 个模块组成。

  • spring-beansspring-core 模块是 Spring 框架的核心模块,包含了 IOC 和 DI。BeanFactory 使用控制反转对应用程序的配置和依赖性规范与实际的应用程序代码进行了分离。BeanFactory 属于延时加载,也就是说在实例化容器对象后并不会自动实例化 Bean,只有当 Bean 被使用时,BeanFactory 才会对该 Bean 进行实例化与依赖关系的装配。
  • spring-context 模块构架于核心模块之上,扩展了 BeanFactory,为它添加了 Bean 生命周期控制、框架事件体系及资源加载透明化等功能。此外,该模块还提供了许多企业级支持,如邮件访问、远程访问、任务调度等, ApplicationContext 是该模块的核心接口,它的超类是 BeanFactory。与 BeanFactory 不同,ApplicationContext 实例化后会自动对所有的单实例 Bean 进行实例化与依赖关系的装配,使之处于待用状态。
  • spring-context-support 模块是对 Spring IoC 容器及 IoC 子容器的扩展支持。
  • spring-context-indexer 模块是 Spring 的类管理组件和 Classpath 扫描组件。
  • spring-expression 模块是统一表达式语言 (EL) 的扩展 模块,可以查询、管理运行中的对象,同时也可以方便地调用对象方法,以及操作数组、集合等。它的语法类似于传统EL,但提供了额外的功能,最出色的要数函数调用和简单字符串的模板函数。EL 的特性是基于 Spring 产品的需求而设计的,可以非常方便地同 Spring IoC 进行交互。
我们主要关注 spring-beans、spring-core、spring-context 模块。

bean 概述

Spring 是面向 Bean 的编程 (BOP,Bean Oriented Programming),Bean 在 Spring 中处于核心地位。

Spring IoC 容器通过配置文件或者注解的方式来管理 Bean 对象之间的依赖关系。

Bean 对于 Spring 的意义就像 Object 对于 OOP 的意义一样。

Spring 中 Bean 用于对一个类进行封装,如下面的配置:

<bean id="userService" class="com.itheima.service.impl.UserServiceImpl">
    <property name="userDao" ref="userDao"></property>
</bean>

<bean id="userDao" class="com.itheima.dao.impl.UserDaoImpl"></bean>

为什么 Bean 如此重要呢?

  • Spring 将 Bean 对象交由一个叫 IOC 的容器进行管理。
  • Bean 对象之间的依赖关系在配置文件中体现,并由 Spring 完成。

Spring IOC 相关接口

  • BeanFactory:定义了 IOC 容器的基本功能规范。
  • BeanDefinition: 定义了 Bean 对象与配置文件中元素属性的映射。
  • BeanDefinitionReader:定义对 Spring 配置文件中 Bean 的解析,并封装 BeanDefinition 对象。
  • BeanDefinitionRegistry:注册中心的顶级接口,其子类实现中定义了容器,用来注册 BeanDefinition。

BeanFactory 接口

Spring 中 Bean 的创建是典型的工厂模式(简单工厂 + 配置文件),这一系列的 Bean 工厂,即 IOC 容器。

在 Spring 中有许多 IOC 容器的实现供用户选择,其相互关系如下图所示:

在这里插入图片描述

其中,BeanFactory 作为最顶层的一个接口,定义了 IOC 容器的基本功能规范,它有三个重要接口:

  • ListableBeanFactory 接口表示这些 Bean 可列表化。
  • HierarchicalBeanFactory 接口表示这些 Bean 有继承关系,也就是每个 Bean 可能有父 Bean。
  • AutowireCapableBeanFactory 接口定义 Bean 的自动装配规则。

这三个接口共同定义了 Bean 的集合、Bean 之间的关系及 Bean 行为。

定义这么多接口是为了区分在 Spring 内部操作过程中对象的传递和转化,对对象的数据访问所做的限制。

从类图中可以发现最终的默认实现类是 DefaultListableBeanFactory,它实现了所有的接口。

最基本的 IOC 容器接口是 BeanFactory,看一下它的源码:

public interface BeanFactory {

    String FACTORY_BEAN_PREFIX = "&";

    // 根据bean的名称获取IOC容器中的的bean对象
    Object getBean(String name) throws BeansException;
    // 根据bean的名称获取IOC容器中的的bean对象,并指定获取到的bean对象的类型,这样使用时就不需要类型强转
    <T> T getBean(String name, Class<T> requiredType) throws BeansException;
    Object getBean(String name, Object... args) throws BeansException;
    <T> T getBean(Class<T> requiredType) throws BeansException;
    <T> T getBean(Class<T> requiredType, Object... args) throws BeansException;
    
    <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType);
    <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType);

    // 判断容器中是否包含指定名称的bean对象
    boolean containsBean(String name);
    // 根据bean的名称判断是否是单例
    boolean isSingleton(String name) throws NoSuchBeanDefinitionException;
    boolean isPrototype(String name) throws NoSuchBeanDefinitionException;
    boolean isTypeMatch(String name, ResolvableType typeToMatch) 
    throws NoSuchBeanDefinitionException;
    boolean isTypeMatch(String name, Class<?> typeToMatch) 
    throws NoSuchBeanDefinitionException;
    @Nullable
    Class<?> getType(String name) throws NoSuchBeanDefinitionException;
    String[] getAliases(String name);
}

在 BeanFactory 里只对 IOC 容器的基本行为做了定义,根本不关心 Bean 是如何定义及怎样加载的。

正如我们只关心能从工厂里得到什么产品,不关心工厂是怎么生产这些产品的。

BeanFactory 有一个很重要的子接口 ApplicationContext 接口,该接口主要来规范容器中的 bean 对象是非延时加载,即在创建容器对象的时候就对象 bean 进行初始化,并存储到一个容器中。

在这里插入图片描述

要知道工厂是如何产生对象的,我们需要看具体的 IoC 容器实现,Spring 提供了许多 IOC 容器实现:

  • ClassPathXmlApplicationContext : 根据类路径加载 xml 配置文件,并创建 IOC 容器对象。
  • FileSystemXmlApplicationContext :根据系统路径加载 xml 配置文件,并创建 IOC 容器对象。
  • AnnotationConfigApplicationContext :加载注解类配置,并创建 IOC 容器。

BeanDefinition 接口

Spring IOC 容器管理定义的各种 Bean 对象及其相互关系,而 Bean 对象在 Spring 实现中是以 BeanDefinition 来描述的,如下面配置文件:

即 BeanDefinition 定义了 Spring 中的 Bean 对象与配置文件中元素属性的映射。
<bean id="userDao" class="com.itheima.dao.impl.UserDaoImpl"></bean>
<!-- bean标签还有很多属性:scope、init-method、destory-method等。-->

其继承体系如下图:

在这里插入图片描述

BeanDefinitionReader 接口

Bean 的解析过程非常复杂,功能被分得很细,因为这里需要被扩展的地方很多,必须保证足够的灵活性,以应对可能的变化。Bean 的解析主要就是对 Spring 配置文件的解析。这个解析过程主要通过 BeanDefinitionReader 来完成。Spring 中 BeanDefinitionReader 的类结构图如下图:

在这里插入图片描述

AbstractBeanDefinitionReader 实际上有 3 个子类,我们主要模仿 xml。

在这里插入图片描述

查看 BeanDefinitionReader 接口定义的方法来理解它具体的作用:

public interface BeanDefinitionReader {

    // 获取BeanDefinitionRegistry注册器对象
    BeanDefinitionRegistry getRegistry();
  
    @Nullable
    ResourceLoader getResourceLoader();

    @Nullable
    ClassLoader getBeanClassLoader();

    BeanNameGenerator getBeanNameGenerator();

    /*
     *下面的loadBeanDefinitions都是从指定的资源中加载bean定义
     */
    int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException;
    int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException;
    int loadBeanDefinitions(String location) throws BeanDefinitionStoreException;
    int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException;
}

BeanDefinitionRegistry 接口

BeanDefinitionReader 用来解析 bean 定义,并封装 BeanDefinition 对象。

在配置文件中定义了很多 bean 标签,思考一下,解析的 BeanDefinition 对象存储到哪儿?

答案就是 BeanDefinition 的注册中心,而该注册中心顶层接口就是 BeanDefinitionRegistry。

public interface BeanDefinitionRegistry extends AliasRegistry {

    // 往注册表中注册bean
    void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
    throws BeanDefinitionStoreException;

    // 从注册表中删除指定名称的bean
    void removeBeanDefinition(String beanName) 
    throws NoSuchBeanDefinitionException;

    // 获取注册表中指定名称的bean
    BeanDefinition getBeanDefinition(String beanName) 
    throws NoSuchBeanDefinitionException;
    
    // 判断注册表中是否已经注册了指定名称的bean
    boolean containsBeanDefinition(String beanName);
    
    // 获取注册表中所有的bean的名称
    String[] getBeanDefinitionNames();
    
    int getBeanDefinitionCount();
    boolean isBeanNameInUse(String beanName);
}

继承结构图如下:

在这里插入图片描述

完整的类结构图如下:

在这里插入图片描述

从上图可看到 BeanDefinitionRegistry 接口的子实现类有以下:

  • SimpleBeanDefinitionRegistry:在该类中定义了如下容器,就是用来注册 bean

    // key - beanDefinition名称,value- beanDefinition对象
    private final Map<String, BeanDefinition> beanDefinitionMap = 
      new ConcurrentHashMap<>(64);
  • DefaultListableBeanFactory:在该类中定义了如下容器,就是用来注册 bean

    // key - beanDefinition名称,value- beanDefinition对象
    private final Map<String, BeanDefinition> beanDefinitionMap = 
      new ConcurrentHashMap<>(256);
  • GenericApplicationContext

创建容器

ClassPathXmlApplicationContext 对 Bean 配置资源的载入是从 refresh() 方法开始的。

refresh() 方法是一个模板方法,规定了 IOC 容器的启动流程,有些逻辑要交给其子类实现。它对 Bean 配置资源进行载入,ClassPathXmlApplicationContext 通过调用其父类 AbstractApplicationContext 的 refresh() 方法启动整个 IOC 容器对 Bean 定义的载入过程。

自定义 Spring IOC

现要对下面的配置文件进行解析,并自定义 Spring 框架的 IOC,对涉及到的对象进行管理。

<?xml version="1.0" encoding="UTF-8"?>
<beans>
    <bean id="userService" class="com.itheima.service.impl.UserServiceImpl">
        <property name="userDao" ref="userDao"></property>
    </bean>
    <bean id="userDao" class="com.itheima.dao.impl.UserDaoImpl"></bean>
</beans>

定义 Bean 相关的 POJO

PropertyValue 类

用于封装 Bean 的属性,体现到配置文件中就是封装 <bean> 标签的子标签 <property> 标签的属性。

/**
 * 用来封装bean标签下的property标签的属性
 * name属性
 * ref属性
 * value属性:给基本数据类型及String类型数据赋的值
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class PropertyValue {
    private String name;
    private String ref;
    private String value;
}

MutablePropertyValues 类

一个 <bean> 标签可以有多个 <property> 子标签。

定义一个 MutablePropertyValues 类,用来存储并管理多个 PropertyValue 对象。

/**
 * 存储和管理多个PropertyValue对象
 */
public class MutablePropertyValues implements Iterable<PropertyValue> {

    private final List<PropertyValue> propertyValueList;

    public MutablePropertyValues() {
        this.propertyValueList = new ArrayList<>();
    }

    public MutablePropertyValues(List<PropertyValue> propertyValueList) {
        if (propertyValueList == null) {
            this.propertyValueList = new ArrayList<>();
        } else {
            this.propertyValueList = propertyValueList;
        }
    }

    /**
     * 获取所有的PropertyValue对象
     */
    public PropertyValue[] getPropertyValues() {
        return propertyValueList.toArray(new PropertyValue[0]);
    }

    /**
     * 根据name属性值获取PropertyValue对象
     */
    public PropertyValue getPropertyValue(String propertyName) {
        for (PropertyValue propertyValue : propertyValueList) {
            if (propertyValue.getName().equals(propertyName)) {
                return propertyValue;
            }
        }
        return null;
    }

    /**
     * 判断集合是否为空
     */
    public boolean isEmpty() {
        return propertyValueList.isEmpty();
    }

    /**
     * 添加PropertyValue对象
     * @return this 返回自身实现链式编程
     */
    public MutablePropertyValues addPropertyValue(PropertyValue pv) {
        // 如果集合中已经有对应name的对象,则覆盖它
        for (int i = 0; i < propertyValueList.size(); i++) {
            if (propertyValueList.get(i).getName().equals(pv.getName())) {
                propertyValueList.set(i, pv);
                return this;
            }
        }
        propertyValueList.add(pv);
        return this;
    }

    /**
     * 判断是否有指定name属性值的对象
     */
    public boolean contains(String propertyName) {
        return getPropertyValue(propertyName) != null;
    }

    /**
     * 获取迭代器对象
     */
    @Override
    public Iterator<PropertyValue> iterator() {
        return propertyValueList.iterator();
    }
}

BeanDefinition 类

BeanDefinition 类用来封装 <bean> 标签的属性,主要包含 id、class 及子标签 <property> 数据。

class 属性是需要交由 Spring 管理的类的全类名
/**
 * 用来封装bean标签属性
 * id
 * class
 * property子标签
 */
@Data
public class BeanDefinition {
    private String id;
    private String className;
    private MutablePropertyValues propertyValues;

    public BeanDefinition() {
        propertyValues = new MutablePropertyValues();
    }

}

定义注册表相关类

BeanDefinitionRegistry 接口

BeanDefinitionRegistry 接口定义了注册表的相关操作:

/**
 * 注册表对象
 */
public interface BeanDefinitionRegistry {
    /**
     * 注册 BeanDefinition 对象到注册表中
     */
    void registerBeanDefinition(String beanName, BeanDefinition beanDefinition);

    /**
     * 从注册表中删除指定名称的 BeanDefinition 对象
     */
    void removeBeanDefinition(String beanName) throws Exception;

    /**
     * 根据名称从注册表中获取 BeanDefinition 对象
     */
    BeanDefinition getBeanDefinition(String beanName) throws Exception;

    /**
     * 判断注册表中是否包含指定名称的 BeanDefinition 对象
     */
    boolean containsBeanDefinition(String beanName);

    /**
     * 获取注册表中 BeanDefinition 对象的个数
     */
    int getBeanDefinitionCount();

    /**
     * 获取注册表中所有的 BeanDefinition 的名称
     */
    String[] getBeanDefinitionNames();
}

SimpleBeanDefinitionRegistry 类

该类实现了 BeanDefinitionRegistry 接口,定义了 Map 集合作为注册表容器。

/**
 * 注册表接口的子实现类
 */
public class SimpleBeanDefinitionRegistry implements BeanDefinitionRegistry {
    // 存储BeanDefinition对象的容器
    private Map<String, BeanDefinition> beanDefinitionMap = new HashMap<>();

    @Override
    public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) {
        beanDefinitionMap.put(beanName, beanDefinition);
    }

    @Override
    public void removeBeanDefinition(String beanName) throws Exception {
        beanDefinitionMap.remove(beanName);
    }

    @Override
    public BeanDefinition getBeanDefinition(String beanName) throws Exception {
        return beanDefinitionMap.get(beanName);
    }

    @Override
    public boolean containsBeanDefinition(String beanName) {
        return beanDefinitionMap.containsKey(beanName);
    }

    @Override
    public int getBeanDefinitionCount() {
        return beanDefinitionMap.size();
    }

    @Override
    public String[] getBeanDefinitionNames() {
        return beanDefinitionMap.keySet().toArray(new String[0]);
    }
}

定义解析器相关类

BeanDefinitionReader 接口

BeanDefinitionReader 是用来解析配置文件并在注册表中注册 bean 的信息,定义了两个规范:

  • 获取注册表,外界可以通过该方法获取注册表对象。
  • 加载配置文件,并注册 bean 数据。
/**
 * 解析配置文件的规范,具体由子类实现
 */
public interface BeanDefinitionReader {
    /**
     * 获取注册表对象
     */
    BeanDefinitionRegistry getRegistry();
    /**
     * 加载配置文件并在注册表中进行注册
     */
    void loadBeanDefinitions(String configLocation) throws Exception;
}

XmlBeanDefinitionReader 类

XmlBeanDefinitionReader 类专门用来解析 xml 格式的配置文件,实现 BeanDefinitionReader 接口。

/**
 * 针对xml格式的配置文件进行解析的类
 */
public class XmlBeanDefinitionReader implements BeanDefinitionReader {
    // 声明注册表对象
    private BeanDefinitionRegistry registry;

    public XmlBeanDefinitionReader() {
        registry = new SimpleBeanDefinitionRegistry();
    }

    @Override
    public BeanDefinitionRegistry getRegistry() {
        return registry;
    }

    /**
     * @param configLocation 类路径下配置文件的路径
     */
    @Override
    public void loadBeanDefinitions(String configLocation) throws Exception {
        // 使用dom4j进行xml配置文件的解析
        SAXReader reader = new SAXReader();
        // 获取类路径下的配置文件
        InputStream is = XmlBeanDefinitionReader.class.getClassLoader()
          .getResourceAsStream(configLocation);
        Document document = reader.read(is);
      
        // 根据Document对象获取根标签对象 beans
        Element rootElement = document.getRootElement();
        // 获取根标签下所有的bean标签对象
        List<Element> beanElements = rootElement.elements("bean");

        // 封装BeanDefinition对象, 并添加到注册表中
        for (Element beanElement : beanElements) {
            // 1. 封装BeanDefinition对象
            BeanDefinition beanDefinition = new BeanDefinition();
            String id = beanElement.attributeValue("id");
            String className = beanElement.attributeValue("class");
            beanDefinition.setId(id);
            beanDefinition.setClassName(className);
            // 创建MutablePropertyValues对象
            MutablePropertyValues mutablePropertyValues = new MutablePropertyValues();
            // 获取bean标签下所有的property标签对象
            List<Element> propertyElements = beanElement.elements("property");
            for (Element propertyElement : propertyElements) {
                PropertyValue propertyValue = new PropertyValue(
                        propertyElement.attributeValue("name"),
                        propertyElement.attributeValue("ref"),
                        propertyElement.attributeValue("value")
                );
                mutablePropertyValues.addPropertyValue(propertyValue);
            }
            beanDefinition.setPropertyValues(mutablePropertyValues);

            // 2. 将beanDefinition对象注册到注册表中
            registry.registerBeanDefinition(id, beanDefinition);
        }
    }
}

IOC 容器相关类

BeanFactory 接口

该接口中定义 IOC 容器的统一规范,即获取 bean 对象。

/**
 * IOC 容器父接口
 */
public interface BeanFactory {
    /**
     * 根据bean对象的名称获取bean对象
     */
    Object getBean(String name) throws Exception;
    /**
     * 根据bean对象的名称获取bean对象,并进行类型转换
     */
    <T> T getBean(String name, Class<? extends T> clazz) throws Exception;
}

ApplicationContext 接口

该接口是 BeanFactory 的子接口,它的实现类对 bean 对象的创建都是非延时的。

非延时:创建 Spring 容器对象时,会加载配置文件,并对 bean 进行初始化放到容器中。

在该接口中定义 refresh() 方法,该方法主要完成以下两个功能:

  • 加载配置文件。
  • 根据注册表中的 BeanDefinition 对象封装的数据进行 bean 对象的创建。
/**
 * 定义非延时加载功能
 */
public interface ApplicationContext extends BeanFactory {
    /**
     * 加载配置文件并创建对象
     */
    void refresh() throws Exception;
}

AbstractApplicationContext 类

需要在该类中定义一个 Map 集合,作为 bean 对象存储的容器。

作为 ApplicationContext 接口的子类,所以该类是非延时加载。

声明 BeanDefinitionReader 类型的变量,用来进行 xml 配置文件的解析,符合单一职责原则。BeanDefinitionReader 对象的创建交由子类实现,因为只有子类知道应当创建 BeanDefinitionReader 哪个实现类对象(是 xml 还是 properties)。

/**
 * ApplicationContext接口的子实现类, 用于非延实时加载
 */
public abstract class AbstractApplicationContext implements ApplicationContext {
    // 声明解析器变量, 具体创建交由子类实现
    protected BeanDefinitionReader beanDefinitionReader;
    // 定义用于存储bean对象的map容器
    protected Map<String, Object> singletonObjects = new HashMap<>();
    // 声明配置文件路径的变量
    protected String configLocation;

    @Override
    public void refresh() throws Exception {
        // 加载BeanDefinition对象
        beanDefinitionReader.loadBeanDefinitions(configLocation);
        // 初始化bean
        finishBeanInitialization();
    }

    /**
     * bean的初始化
     */
    private void finishBeanInitialization() throws Exception {
        // 获取注册表对象
        BeanDefinitionRegistry registry = beanDefinitionReader.getRegistry();
        // 获取BeanDefinition对象
        String[] beanNames = registry.getBeanDefinitionNames();
        // bean的初始化
        for (String beanName : beanNames) {
            getBean(beanName);
        }
    }
}
该类 finishBeanInitialization() 方法中调用 getBean() 方法使用了模板方法模式。

ClassPathXmlApplicationContext 类

该类主要是加载类路径下的配置文件,并进行 bean 对象的创建,主要完成以下功能:

  • 在构造方法中,创建 BeanDefinitionReader 对象。
  • 在构造方法中,调用 refresh() 方法,用于进行配置文件加载、创建 bean 对象并存储到容器中。
  • 重写父接口中的 getBean() 方法,并实现依赖注入操作。
/**
 * IOC容器具体的子实现类
 * 用于加载类路径下xml格式的配置文件
 */
public class ClassPathXmlApplicationContext extends AbstractApplicationContext {

    public ClassPathXmlApplicationContext(String configLocation) {
        this.configLocation = configLocation;
        // 构建解释器对象
        beanDefinitionReader = new XmlBeanDefinitionReader();
        try {
            this.refresh();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public Object getBean(String name) throws Exception {
        // 对象容器中有指定名称的bean对象,直接返回即可,不包含则自行创建
        Object obj = singletonObjects.get(name);
        if (obj != null) {
            return obj;
        }
        // 从注册表中获取BeanDefinition对象, 然后拿到类路径创建对象
        BeanDefinitionRegistry registry =  beanDefinitionReader.getRegistry();
        BeanDefinition beanDefinition = registry.getBeanDefinition(name);
        String className = beanDefinition.getClassName();
        // 通过反射创建对象
        Class<?> clazz = Class.forName(className);
        Object beanObj = clazz.newInstance();
        // 进行依赖注入
        MutablePropertyValues propertyValues = beanDefinition.getPropertyValues();
        for (PropertyValue propertyValue : propertyValues) {
            String pName = propertyValue.getName();
            String value = propertyValue.getValue();
            String ref = propertyValue.getRef();
            if (ref != null && !"".equals(ref)) {
                // 获取依赖的bean对象
                Object bean = getBean(ref);
                // 获取到setter方法:userDao ==> setUserDao
                String methodName = StringUtils.getSetterMethodByFieldName(pName);
                // 执行setter方法
                Method[] methods = clazz.getMethods();
                for (Method method : methods) {
                    if (methodName.equals(method.getName())) {
                        method.invoke(beanObj, bean);
                    }
                }
            }
            if (value != null && !"".equals(value)) {
                // 获取到setter方法:age ==> setAge, 并执行
                String methodName = StringUtils.getSetterMethodByFieldName(pName);
                Method method = clazz.getMethod(methodName, String.class);
                method.invoke(beanObj, value);
            }
        }
        // 返回之前将该对象存储到map容器中,下次可以直接取,达到单例效果
        singletonObjects.put(name, beanObj);
        return null;
    }

    @Override
    public <T> T getBean(String name, Class<? extends T> clazz) throws Exception {
        Object bean = getBean(name);
        if (bean == null) {
            return null;
        }
        return clazz.cast(bean);
    }
}
public class StringUtils {
    private StringUtils() {
    }

    // userDao ==> setUserDao
    public static String getSetterMethodByFieldName(String fieldName) {
        return "set" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
    }
}

总结

使用上面自定义的 Spring 框架,可以直接替换前面使用 Spring 的代码(实现 Spring 最简单的功能)。

使用到的设计模式:

  • 工厂模式。这里使用的是简单工厂 + 配置文件。
  • 单例模式。Spring IOC 管理的 bean 对象都是单例的,此处的单例不是通过构造器进行单例的控制的,而是 Spring 框架对每一个 bean 只创建了一个对象(利用 Map 容器控制)。
  • 模板方法模式。AbstractApplicationContext 类中的 finishBeanInitialization() 方法调用了子类的 getBean() 方法,因为 getBean() 的实现和环境息息相关(对不同配置文件解析获取 bean 对象的方式是不同的)。
  • 迭代器模式。对于 MutablePropertyValues 类定义使用到了迭代器模式,因为此类存储并管理 PropertyValue 对象,也属于一个容器,所以给该容器提供一个遍历方式。

真正的 Spring 框架其实使用到了很多设计模式,如 AOP 使用到了代理模式,选择 JDK 代理或者 CGLIB 代理使用到了策略模式,还有适配器模式,装饰者模式,观察者模式等。

注意我们自己写的 Spring 和真实的 Spring 在设计上是有一定的不同的。

Spring 框架底层是很复杂的,进行了很深入的封装,并对外提供了很好的扩展性。

自定义 SpringIOC 有以下几个目的:

  • 了解 Spring 底层对对象的大体管理机制。
  • 了解设计模式在具体的开发中的使用。
  • 为学习 Spring 源码作铺垫。
相关文章
|
1月前
|
XML 安全 Java
|
5天前
|
开发框架 运维 监控
Spring Boot中的日志框架选择
在Spring Boot开发中,日志管理至关重要。常见的日志框架有Logback、Log4j2、Java Util Logging和Slf4j。选择合适的日志框架需考虑性能、灵活性、社区支持及集成配置。本文以Logback为例,演示了如何记录不同级别的日志消息,并强调合理配置日志框架对提升系统可靠性和开发效率的重要性。
|
27天前
|
设计模式 XML Java
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
本文详细介绍了Spring框架的核心功能,并通过手写自定义Spring框架的方式,深入理解了Spring的IOC(控制反转)和DI(依赖注入)功能,并且学会实际运用设计模式到真实开发中。
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
|
22天前
|
Java 开发者 Spring
理解和解决Spring框架中的事务自调用问题
事务自调用问题是由于 Spring AOP 代理机制引起的,当方法在同一个类内部自调用时,事务注解将失效。通过使用代理对象调用、将事务逻辑分离到不同类中或使用 AspectJ 模式,可以有效解决这一问题。理解和解决这一问题,对于保证 Spring 应用中的事务管理正确性至关重要。掌握这些技巧,可以提高开发效率和代码的健壮性。
69 13
|
1月前
|
IDE Java 测试技术
互联网应用主流框架整合之Spring Boot开发
通过本文的介绍,我们详细探讨了Spring Boot开发的核心概念和实践方法,包括项目结构、数据访问层、服务层、控制层、配置管理、单元测试以及部署与运行。Spring Boot通过简化配置和强大的生态系统,使得互联网应用的开发更加高效和可靠。希望本文能够帮助开发者快速掌握Spring Boot,并在实际项目中灵活应用。
53 5
|
1月前
|
缓存 Java 数据库连接
Spring框架中的事件机制:深入理解与实践
Spring框架是一个广泛使用的Java企业级应用框架,提供了依赖注入、面向切面编程(AOP)、事务管理、Web应用程序开发等一系列功能。在Spring框架中,事件机制是一种重要的通信方式,它允许不同组件之间进行松耦合的通信,提高了应用程序的可维护性和可扩展性。本文将深入探讨Spring框架中的事件机制,包括不同类型的事件、底层原理、应用实践以及优缺点。
71 8
|
21天前
|
设计模式 前端开发 搜索推荐
前端必须掌握的设计模式——模板模式
模板模式(Template Pattern)是一种行为型设计模式,父类定义固定流程和步骤顺序,子类通过继承并重写特定方法实现具体步骤。适用于具有固定结构或流程的场景,如组装汽车、包装礼物等。举例来说,公司年会节目征集时,蜘蛛侠定义了歌曲的四个步骤:前奏、主歌、副歌、结尾。金刚狼和绿巨人根据此模板设计各自的表演内容。通过抽象类定义通用逻辑,子类实现个性化行为,从而减少重复代码。模板模式还支持钩子方法,允许跳过某些步骤,增加灵活性。
|
2月前
|
设计模式 安全 Java
Kotlin教程笔记(51) - 改良设计模式 - 构建者模式
Kotlin教程笔记(51) - 改良设计模式 - 构建者模式
|
4月前
|
设计模式 数据库连接 PHP
PHP中的设计模式:提升代码的可维护性与扩展性在软件开发过程中,设计模式是开发者们经常用到的工具之一。它们提供了经过验证的解决方案,可以帮助我们解决常见的软件设计问题。本文将介绍PHP中常用的设计模式,以及如何利用这些模式来提高代码的可维护性和扩展性。我们将从基础的设计模式入手,逐步深入到更复杂的应用场景。通过实际案例分析,读者可以更好地理解如何在PHP开发中应用这些设计模式,从而写出更加高效、灵活和易于维护的代码。
本文探讨了PHP中常用的设计模式及其在实际项目中的应用。内容涵盖设计模式的基本概念、分类和具体使用场景,重点介绍了单例模式、工厂模式和观察者模式等常见模式。通过具体的代码示例,展示了如何在PHP项目中有效利用设计模式来提升代码的可维护性和扩展性。文章还讨论了设计模式的选择原则和注意事项,帮助开发者在不同情境下做出最佳决策。
|
2月前
|
设计模式 开发者 Python
Python编程中的设计模式:工厂方法模式###
本文深入浅出地探讨了Python编程中的一种重要设计模式——工厂方法模式。通过具体案例和代码示例,我们将了解工厂方法模式的定义、应用场景、实现步骤以及其优势与潜在缺点。无论你是Python新手还是有经验的开发者,都能从本文中获得关于如何在实际项目中有效应用工厂方法模式的启发。 ###