照虎画猫写自己的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已经能够处理他们之间的依赖关系并进行注入了。

运行结果

使用在属性上的注解处理

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注解的依赖注入。 项目地址https://github.com/DMinerJackie/fairy

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏从流域到海域

Java Beans

JavaBeans事实上有三层含义。首先,JavaBeans是一种规范,一种在Java(包括JSP)中使用可重复使用的Java组件的技术规范,也可以说成我们常...

1816
来自专栏Spring相关

第11章—使用对象关系映射持久化数据—SpringBoot+SpringData+Jpa进行查询修改数据库

JPA由EJB 3.0软件专家组开发,作为JSR-220实现的一部分。但它又不限于EJB 3.0,你可以在Web应用、甚至桌面应用中使用。JPA的宗旨是为POJ...

1033
来自专栏小灰灰

动手实现MVC: 2. bean加载, IoC依赖注入

背景 前面实现了java包的扫描,扫描之后自然就到了bean的加载,以及spring mvc的一大特性 IoC依赖注入的实现; 这里则将在之前的基础上,实现be...

1917
来自专栏SpringBoot 核心技术

第三十七章:基于SpringBoot架构以及参数装载完成接口安全认证

45310
来自专栏JAVA后端开发

activiti构造属于自己的流程定义

说起actviti,很多人都会说它支持bpmn标准,它的流转都是基于bpmn文件来运行! 但我们在设计流程时,流程定义真的只能是bpmn定义吗?   其实不...

2422
来自专栏技术记录

shiro权限控制(二):分布式架构中shiro的实现

前言: 前段时间在搭建公司游戏框架安全验证的时候,就想到之前web最火的shiro框架,虽然后面实践发现在netty中不太适用,最后自己模仿shiro写了一个缩...

6007
来自专栏Ryan Miao

SpringMVC参数校验(针对`@RequestBody`返回`400`)

SpringMVC参数校验(针对@RequestBody返回400) From https://ryan-miao.github.io/2017/05/20/s...

4894
来自专栏光变

Java使用slf4j输出日志

691
来自专栏Java Web

JavaWeb中使用JSON

2674
来自专栏zhisheng

Spring Boot 2.0(七):SpringApplication 深入探索

对于第一个注解 @SpringBootApplication,我已经在博客 Spring Boot 2.0系列文章(六):Spring Boot 2.0中Spr...

1341

扫码关注云+社区