照虎画猫写自己的Spring

从细节跳出来

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

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

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

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

Fairy项目

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

大体思路

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

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

项目结构如下:


1119-Fairy项目结构.png

声明配置文件

首先你需要声明一个配置文件,这是一切工作的开始(当然了,更首先是要有一个项目,后面会给出在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();
}
1119-Fairy测试结果.png

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354

推荐阅读更多精彩内容