照虎画猫写自己的Spring

从细节跳出来

看了部分Spring的代码,前面用了四篇内容写了一些读书笔记。
回想起来,论复杂度,Spring够喝上好几壶的。他就像一颗枝繁叶茂的大树,远处看,只是一片绿;走近看,他为你撑起一片小天地,为你遮风避雨;往深了看,他盘根错节,根基夯实。

在看Spring代码的过程中,我几度有些迷糊,因为一行简单的函数调用,你要是一直跟踪下去,从一个函数跳到另一个函数,又从一个类进入到另一个接口或者代理类,可能原本你只想知道函数做了什么,等回过头来,你发现已经找不到回去的路……

所以,每写一篇的时候,我都用一两句话总结该篇主要讲的是Spring干了什么事,实现了什么功能。

这些,我觉得还不够。所以,今天我照虎画猫,写了一个自己的Spring——Fairy项目。

Fairy项目

取名Fairy,意为小精灵,象征着东西不大,但是能量无穷,稍有契合Spring春天生机盎然之意。

大体思路

Spring经过这么多年的发展和补充,已经变成庞然大物,代码中包含了很多可扩展性和抽象的代码和设计。如果想一把抓尽收眼底,还是比较难消化的。这里,就设计一个简洁版的Spring,也算是抽丝剥茧,看看Spring最开始是给我们解决了一个什么问题,大体思路如下:

  • 声明配置文件,用于声明需要加载使用的类
  • 加载配置文件,读取配置文件
  • 解析配置文件,需要将配置文件中声明的标签转换为Fairy能够识别的类
  • 初始化类,提供配置文件中声明的类的实例

项目结构如下:

声明配置文件

首先你需要声明一个配置文件,这是一切工作的开始(当然了,更首先是要有一个项目,后面会给出在GitHub上的项目地址)。所有你想要用到的类,都应该声明在这里。

配置文件的好处就是可扩展性强,耦合度低。当需要声明一个bean的时候,我们只需要打开配置文件,在其中加上一个标签,填充你需要使用的那个类即可,剩下的工作就交个容器。

这里的配置文件application-context.xml很简单

<beans>
    <bean id="fairyBean" class="com.jackie.fairy.bean.impl.FairyBeanImpl">
    </bean>
</beans>

看完配置,我们大概就知道这是一次想得到FairyBeanImpl这个类的实例的征程。按照以往的套路,这些交给Spring去执行就好了,大可以通过这种xml配置的方式,甚至可以通过@Autowired注解的方式。

只是这里,我们不再引入Spring的任何依赖,我们要自己造轮子,完成这次bean的加载。这里的标签其实可以声明任何你想声明的标签名,因为已经跳出Spring的约束了,好比这样

<life>
    <smile id="fairyBean" class="com.jackie.fairy.bean.impl.FairyBeanImpl">
    </smile>
</life>

加载、解析配置文件

从上面的声明可以看出,我们还是使用了XML这种传统的配置文件的方式(后面还会尝试使用JSON的数据格式,详见项目中的JsonParserImpl)。
所以加载首先我们需要加载xml配置文件。其实这里加载xml文件和其他格式的文件并无二致,只是在解析的时候才有差别。
加载

URL xmlPath = XmlReaderUtil.class.getClassLoader().getResource(fileName);

这里只需要传入文件名,剩下的通过getResource得到文件的URL路径,后面的事情就交给xml解析器去做了。

解析
因为配置文件是xml格式,所以需要针对xml进行解析,这里用的是dom4j对xml进行解析。解析的本质就是层层剥开,抽取想要的信息。
我将解析的过程写在工具类中

public class XmlReaderUtil {
    private static final Logger LOG = LoggerFactory.getLogger(XmlReaderUtil.class);

    public static List<BeanDefinition> readXml(String fileName) {
        List<BeanDefinition> beanDefinitions = Lists.newArrayList();

        //创建一个读取器
        SAXReader saxReader = new SAXReader();
        Document document = null;

        try {
            //获取要读取的配置文件的路径
            URL xmlPath = XmlReaderUtil.class.getClassLoader().getResource(fileName);
            //读取文件内容
            document = saxReader.read(xmlPath);
            //获取xml中的根元素
            Element rootElement = document.getRootElement();

            for (Iterator iterator = rootElement.elementIterator(); iterator.hasNext(); ) {
                Element element = (Element)iterator.next();
                String id = element.attributeValue("id");
                String clazz = element.attributeValue("class");
                BeanDefinition beanDefinition = new BeanDefinition(id, clazz);
                beanDefinitions.add(beanDefinition);
            }

        } catch (Exception e) {
            LOG.error("read xml failed", e);
        }

        return beanDefinitions;
    }
}

主要过程

  • 新建一个解析器
  • 加载xml配置文件
  • 找到根元素
  • 遍历各个元素
  • 找到相应的属性
  • 完成解析,将信息存储到集合中

初始化类

完成配置文件的解析后,就需要针对配置文件的信息进行实例化,方便调用者使用。
通过解析后,我们得到了一个List集合,存放了BeanDefinition,每一个BeanDefinition都存放这标签的属性值(这里仅支持id和class属性的解析和存储)。下面就需要针对List集合中解析后的标签进行实例化了。

private void instanceBeanDefinitions() {
    if (CollectionUtils.isNotEmpty(beanDefinitions)) {
        for (BeanDefinition beanDefinition : beanDefinitions) {
            if (StringUtils.isNotEmpty(beanDefinition.getClassName())) {
                try {
                    instanceBeans.put(beanDefinition.getId(),
                            Class.forName(beanDefinition.getClassName()).newInstance());
                    LOG.info("instance beans successfully, instanceBeans: {}", instanceBeans);
                } catch (InstantiationException e) {
                    LOG.error("instantiation failed", e);
                } catch (IllegalAccessException e) {
                    LOG.error("illegalAccessException", e);
                } catch (ClassNotFoundException e) {
                    LOG.error("classNotFoundException", e);
                }
            }
        }
    }
}

主要是通过遍历解析得到的集合,分别对各个元素一一进行实例化,再存储到Map集合中,方便后面根据名称获取(这里还有一些异常情况的处理和参数校验就不做解释,可以直接看代码)。

测试

完成以上简单的几步之后,我们就可以测试成果了,新建测试类FairyTest

@Test
public void testLoadBean() {
    FairyApplicationContext applicationContext = new FairyApplicationContext("application-context.xml", ParseType.XML_PARSER);
    FairyBean fairyBean = (FairyBean) applicationContext.getBean("fairyBean");
    fairyBean.greet();
}

这样,我们就如愿的完成了FairyBean类的加载和实例化,我们没有用到Spring的任何依赖,自己写了个小容器完成了类加载。
项目地址:https://github.com/DMinerJackie/fairy

如果您觉得阅读本文对您有帮助,请点一下“推荐”按钮,您的“推荐”将是我最大的写作动力!如果您想持续关注我的文章,请扫描二维码,关注JackieZheng的微信公众号,我会将我的文章推送给您,并和您一起分享我日常阅读过的优质文章。

时间: 2024-08-04 08:18:11

照虎画猫写自己的Spring的相关文章

照虎画猫写自己的Spring——依赖注入

前言 上篇<照虎画猫写自己的Spring>从无到有讲述并实现了下面几点 声明配置文件,用于声明需要加载使用的类 加载配置文件,读取配置文件 解析配置文件,需要将配置文件中声明的标签转换为Fairy能够识别的类 初始化类,提供配置文件中声明的类的实例 一句话概括:不借助Spring容器,实现了Bean的加载和实例化 要想契合Fairy取名时的初衷(东西不大,但是能量无穷),只有一套加载Bean的机制是远远不够的,所以还是需要照虎画猫,完善这个小精灵. Spring之所以在Java企业级开发的众多

手把手写一个基于Spring Boot框架下的参数校验组件

手把手写一个基于Spring Boot框架下的参数校验组件(JSR-303) 前言 之前参与的新开放平台研发的过程中,由于不同的接口需要对不同的入参进行校验,这就涉及到通用参数的校验封装,如果不进行封装,那么写出来的校验代码将会风格不统一.校验工具类不一致.维护风险高等其它因素,于是我对其公共的校验做了一个封装,达到了通过注解的方式即可实现参数统一校验. 遇到的问题                    在封装的时候就发现了一个问题,我们是开放平台,返回的报文都必须是统一风格,也就是类似于{co

利用反射手写代码实现spring AOP

前言:上一篇博客自己动手编写spring IOC源码受到了大家的热情关注,在这里博客十分感谢.特别是给博主留言建议的@玛丽的竹子等等.本篇博客我们继续,还是在原有的基础上进行改造.下面请先欣赏一下博主画的一张aop简图(没有艺术天分,画的不好莫见怪) 解析:往往在我们的系统的多个核心流程中会有一部分与之关系不大的相同的横切流程,例如权限认证,事务管理.因此我们一般会抽象出这些相同的比较次要的交给spring aop的Handler来统一处理这些横切流程也就是上图中绿色部分.接下来我们看一下本例结

运维笔记{网络改造}来个照虎画猫!

运维笔记{网络改造}之疯言疯语 话说现有网络环境大概是这样的 ---.100MB联通光纤总带宽---. 连接Cisco 2960交换机--.. -.连接H3C5100路由器x4台----.1/2层各两台(ˇˇ) 想-{每台独立的公网IP做NAT转换} -连接Cisco3560三层交换机x4台-..对应每台路由器-..{交换机之间使用Trunk口连接} -.连接接入层杂牌交换机x8台-.每台3560接两台接入层交换机到桌面交换机-工位. 描述完毕!!! 改造完成环境是那样的呢?   Look看吧

手把手写一个基于Spring Boot框架下的参数校验组件(JSR-303)

前言 之前参与的新开放平台研发的过程中,由于不同的接口需要对不同的入参进行校验,这就涉及到通用参数的校验封装,如果不进行封装,那么写出来的校验代码将会风格不统一.校验工具类不一致.维护风险高等其它因素,于是我对其公共的校验做了一个封装,达到了通过注解的方式即可实现参数统一校验. 遇到的问题                     在封装的时候就发现了一个问题,我们是开放平台,返回的报文都必须是统一风格,也就是类似于{code:999,msg:"参数校验失败",data:null} 这种

响应式Spring的道法术器(Spring WebFlux 快速上手 + 全面介绍)

1. Spring WebFlux 2小时快速入门 Spring 5 之使用Spring WebFlux开发响应式应用. lambda与函数式(15min) Reactor 3 响应式编程库(60min) Spring Webflux和Spring Data Reactive开发响应式应用(45min) 通过以上内容相信可以对Spring 5.0 推出的响应式开发有了初步的体会.如果希望有更加深入的了解,欢迎阅读下边的系列文章-- 2. 响应式Spring的道法术器 这个系列的文章是为了记录下自

【转】大数据批处理框架 Spring Batch全面解析

如今微服务架构讨论的如火如荼.但在企业架构里除了大量的OLTP交易外,还存在海量的批处理交易.在诸如银行的金融机构中,每天有3-4万笔的批处理作业需要处理.针对OLTP,业界有大量的开源框架.优秀的架构设计给予支撑:但批处理领域的框架确凤毛麟角.是时候和我们一起来了解下批处理的世界哪些优秀的框架和设计了,今天我将以Spring Batch为例,和大家一起探秘批处理的世界.初识批处理典型场景探秘领域模型及关键架构实现作业健壮性与扩展性批处理框架的不足与增强批处理典型业务场景对账是典型的批处理业务处

Spring Boot 学习笔记1---初体验之3分钟启动你的Web应用

前言 早在去年就简单的使用了一下Spring Boot,当时就被其便捷的功能所震惊.但是那是也没有深入的研究,随着其在业界被应用的越来越广泛,因此决定好好地深入学习一下,将自己的学习心得在此记录,本文主要围绕以下几点进行说明: Spring Boot 简介 使用Spring Boot快速搭建一个Web应用如有不对的地方,请指正. 1. Spring Boot简介 Spring Boot是一个基于Spring的衍生框架,其主要的目的是帮助我们快速构建独立.生产级别的Spring的应用,其崇尚的理念

Spring boot 提高篇

Spring boot 提高篇 上篇文章介绍了Spring boot初级教程:构建微服务:Spring boot 入门篇,方便大家快速入门.了解实践Spring boot特性:本篇文章接着上篇内容继续为大家介绍spring boot的其它特性(有些未必是spring boot体系桟的功能,但是是spring特别推荐的一些开源技术本文也会介绍),对了这里只是一个大概的介绍,特别详细的使用我们会在其它的文章中来展开说明. github博文地址,阅读更佳 web开发 spring boot web开发