照虎画猫写自己的Spring——自定义注解

Fairy已经实现的功能

  • 读取XML格式配置文件,解析得到Bean

  • 读取JSON格式配置文件,解析得到Bean

  • 基于XML配置的依赖注入

所以,理所当然,今天该实现基于注解的依赖注入了。

基于XML配置文件方式的依赖注入一直是使用依赖注入的标配。使用配置文件让开发变的更加灵活,告别了硬编码和扩展性差的问题。

但是,随着时间的推移以及大量开发人员的深度使用,越发觉得配置文件显得非常臃肿和复杂。Spring也是如此的敏锐和贴心,给我们带了很多的注解,好比我们每天都要用的@Autowired,这样我们不再需要在XML配置文件中在合适的位置小心翼翼的配置注册你的Bean了。

尤其是这两年Spring Boot被越来越多的公司使用,倡导无配置文件开发,大量简单易用的注解呈现在开发者面前,@GetMapping、@ComponentScan、@RestController……


自定义注解

平时开发,我们能用到很多注解@Override、@Service、@Value,这些都是java或者各个框架定义好的,我们自己也可以声明自定义注解。

在定义自定义注解之前,需要用到一些元注解,就是java事先定义好的

  • @Target-定义注解的位置,

表示支持注解的程序元素的种类,

一些可能的值有TYPE, METHOD, CONSTRUCTOR, FIELD等等

  • @Retention-定义注解的时机,

表示注解类型保留时间的长短

它接收RetentionPolicy参数,可能的值有SOURCE, CLASS, 以及RUNTIME。

  • @Documented-

表示使用该注解的元素应被javadoc或类似工具文档化

  • @Inherited-

表示一个注解类型会被自动继承

有了这些知识储备,就可以定义自定义注解JackieAutowired了


@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD, ElementType.FIELD})

public @interface JackieAutowired {

    public String name() default "";

}

  • RetentionPolicy.RUNTIME表示注解在运行时生效

  • Target有两个值,分别表示作用在方法和属性上

  • 声明了一个属性name,default表示默认值,可为空

基于注解实现依赖注入

在FairyApplicationContext中添加对于注解的处理


public FairyApplicationContext(String configLocation, ParseType parseType) {

        // 加载xml并转换为BeanDefinition

        this.loadConfigFile(configLocation, parseType);

        // 实例化BeanDefinition

        this.instanceBeanDefinitions();

        // 基于注解的依赖注入

        this.annotationInject();

        // 实现依赖注入

        this.injectObject();

    }

使用在方法上的注解处理


private void annotationInject() {

        for (String beanName : instanceBeans.keySet()) {

            Object bean = instanceBeans.get(beanName);

            if (bean != null) {

                try {

                    BeanInfo beanInfo = Introspector.getBeanInfo(bean.getClass());

                    PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();

                    for (PropertyDescriptor propertyDescriptor : propertyDescriptors) {

                        // 获取Setter方法

                        Method setter = propertyDescriptor.getWriteMethod();

                        if (setter != null && setter.isAnnotationPresent(JackieAutowired.class)) {

                            JackieAutowired jackieAutowired = setter.getAnnotation(JackieAutowired.class);

                            Object value = null;

                            if (jackieAutowired != null && StringUtils.isNotEmpty(jackieAutowired.name())) {

                                value = instanceBeans.get(jackieAutowired.name());

                            } else {

                                value = instanceBeans.get(propertyDescriptor.getName());

                                if (value == null) {

                                    for (String key : instanceBeans.keySet()) {

                                        if (propertyDescriptor.getPropertyType().isAssignableFrom(instanceBeans.get(key).getClass())) {

                                            value=instanceBeans.get(key);//类型匹配的话就把此相同类型的

                                            break;//找到了类型相同的bean,退出循环

                                        }

                                    }

                                }

                            }

                            setter.setAccessible(true);

                            try {

                                setter.invoke(bean, value);

                            } catch (Exception e) {

                                LOG.error("invoke setter invoke failed", e);

                            }

                        }

                    }

                } catch (Exception e) {

                    LOG.error("invoke getBean failed", e);

                }

            }

        }

    }

  • 通过内省的方式获取Bean的属性和getter setter方法和上篇一致

  • 得到setter方法,通过setter.isAnnotationPresent(JackieAutowired.class)判断该方法上是否有注解JackieAutowired

  • 读取注解JackieAutowired属性name,如果能够取到值,则直接从Bean的上下文map集合中取出

  • 如果属性name值没取到,则读取当前Bean属性的名称,然后依次根据名称或类型进行加载需要注入的Bean

  • 通过反射的方式注入实例化后的Bean,完成依赖注入

添加JackieAutowired注解

这时候只需要在FairyServiceImpl类中的setFairyDao方法上加上注解JackieAutowired即可


public FairyDao getFairyDao() {

        System.out.println("===getFairyDao===: " + fairyDao1.toString());

        return fairyDao1;

    }

    @JackieAutowired

    public void setFairyDao(FairyDao fairyDao1) {

        System.out.println("===setFairyDao===: " + fairyDao1.toString());

        this.fairyDao1 = fairyDao1;

    }

配置文件声明如下


<beans>

    <bean id="fairyService" class="com.jackie.fairy.bean.impl.FairyServiceImpl">

    </bean>

    <bean id="fairyDao" class="com.jackie.fairy.bean.impl.FairyDaoImpl">

    </bean>

</beans>

这时候,我们不再需要在FairyServiceImpl中声明property属性,也不用声明ref指向fairyDao了,因为JackieAutowired已经能够处理他们之间的依赖关系并进行注入了。

运行结果

image.png

使用在属性上的注解处理


private void annotationInject() {

        for (String beanName : instanceBeans.keySet()) {

            Object bean = instanceBeans.get(beanName);

            if (bean != null) {

                try {

                    BeanInfo beanInfo = Introspector.getBeanInfo(bean.getClass());

                    PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();

                    Field[] fields = bean.getClass().getDeclaredFields();

                    for (Field field : fields) {

                        if (field.isAnnotationPresent(JackieAutowired.class)) {

                            JackieAutowired jackieAutowired = field.getAnnotation(JackieAutowired.class);

                            Object value = null;

                            if (jackieAutowired != null && StringUtils.isNotEmpty(jackieAutowired.name())) {

                                value = instanceBeans.get(jackieAutowired.name());

                            } else {

                                value = instanceBeans.get(field.getName());

                                if (value == null) {

                                    for (String key : instanceBeans.keySet()) {

                                        if (field.getType().isAssignableFrom(instanceBeans.get(key).getClass())) {

                                            value = instanceBeans.get(key);

                                            break;

                                        }

                                    }

                                }

                            }

                            field.setAccessible(true);

                            try {

                                field.set(bean, value);

                            } catch (Exception e) {

                                LOG.error("invoke field.set failed", e);

                            }

                        }

                    }

                } catch (Exception e) {

                    LOG.error("invoke getBean failed", e);

                }

            }

        }

    }

  • 通过反射拿到Bean的所有字段Field数组

  • 和上面类似,通过field.isAnnotationPresent(JackieAutowired.class)判断相应的字段上是否有JackieAutowired注解

  • 找到JackieAutowired注解后,读取其name属性,如果有值,则进入上下文map中查找相应的bean实例

  • 如果没有配置name属性,则通过属性的名称进入上下文map中根据名称和类型进行遍历,找到相应的bean实例

  • 通过反射的方式注入实例化后的Bean,完成依赖注入

添加JackieAutowired注解

这时候添加的位置在属性上


@JackieAutowired

private FairyDao fairyDao;

其他配置同上一种情况,最终运行结果正常。

至此,Fairy实现了基于JackieAutowired注解的依赖注入。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容