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

背景

前面实现了java包的扫描，扫描之后自然就到了bean的加载，以及spring mvc的一大特性 IoC依赖注入的实现；

这里则将在之前的基础上，实现bean的加载和依赖注入的实现

设计

我们模仿的轮子就是spring mvc，简化一些复杂的场景，这里只实现注解的形式

1. 依赖spring-mvc的使用姿势，我们需要先定义几个注解

类上注解 Service, Component, Repository, Bean

所有类上有上面注解的，都表示需要实例的bean

属性注解 Autowired

表示该属性用一个bean对象来实例化

2. 实例化bean

通过Class创建Bean对象

3. 加载依赖

扫描每个Bean的属性，若包含 @Autowired 注解，则用bean进行赋值

4. 提供获取bean的各种方式

最常见的根据beanName，bean类型来获取Bean

5. 提供动态注册bean

比如业务方依赖第三方的jar包中的某个类，想将它也注册为一个bean，因为不能修改第三方类，所以可以用动态注册的方式来加载bean

实现

1. 注解定义

这个比较简单，直接贴一下几个相关的注解

几个声明类为Bean的注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Bean {
    String value() default "";
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Bean
public @interface Component {
    String value() default "";
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Bean
public @interface Service {
    String value() default "";
}


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Bean
public @interface Repository {
    String value() default "";
}

Autowired.java, value对应的是业务方定义的beanName

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Autowired {
    String value() default "";
}

2. 扫描包，类加载，Bean创建

我们定义一个 BeanFactory 对象，来管理class的加载，bean的创建

扫描包基本上就是之前一篇博文的内容，不做多说，直接看Bean的实例化

实现思路比较清晰，大致流程如下；

遍历Class集合
判断class上是否有几个定义为Bean的注解
确定为bean，则实例化

为了避免每次使用时都扫描一遍，所以这个扫描的结果会保存下来，放在内存中

/**
 * 所有自动实例化的bean的映射表，
 * key为bean name
 * - (如果注解中有指定value值，则bean name就是value值；若没有指定，则是首字母小写的简单类名）
 * - bean name 区分大小写
 * <p>
 * 为了避免bean name相同的问题，将value也保存为一个Map映射表
 */
private Map<String, Map<Class, Object>> nameBeanMap;


/**
 * class到bean的映射表
 */
private Map<Class, Object> clzBeanMap;

实际加载过程如下

/**
 * 实例化自动加载的bean
 *
 * @return
 */
private Map<String, Map<Class, Object>> instanceBean() throws IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {
    nameBeanMap = new ConcurrentHashMap<>();
    clzBeanMap = new ConcurrentHashMap<>();


    Annotation[] typeAnos;
    String tmpBeanName;
    Method tmpMethod;
    Object tmpBean;
    Map<Class, Object> tmpClzMap;
    for (Class clz : beanClasses) {
        if (clz.isInterface()) {
            continue;
        }


        // 获取类上注解
        typeAnos = clz.getAnnotations();
        if (typeAnos.length == 0) {
            continue;
        }


        for (Annotation ano : typeAnos) {
            if (ano instanceof Bean || ano.annotationType().isAnnotationPresent(Bean.class)) { // 需要加载bean
                tmpMethod = ano.annotationType().getMethod("value", null);
                if (tmpMethod != null) {
                    tmpBeanName = (String) tmpMethod.invoke(ano, null);
                } else {
                    tmpBeanName = null;
                }

                if (StringUtils.isEmpty(tmpBeanName)) {
                    tmpBeanName = StrUtil.lowerFirstChar(clz.getSimpleName());
                }


                if (nameBeanMap.containsKey(tmpBeanName)) {
                    tmpClzMap = nameBeanMap.get(tmpBeanName);
                } else {
                    tmpClzMap = new ConcurrentHashMap<>();
                }

                if (tmpClzMap.containsKey(clz)) {
                    throw new BeanAlreadyDefinedException("bean " + tmpBeanName + " class: " + clz.getName() + " has already defined!");
                }


                tmpBean = clz.newInstance();
                tmpClzMap.put(clz, tmpBean);
                clzBeanMap.put(clz, tmpBean);
                nameBeanMap.put(tmpBeanName, tmpClzMap);
                break;
            }
        }
    }

    return nameBeanMap;
}

上面的实现比较简单，唯一需要注意下的是判断是否包含我们期待的几个注解, 不知道是否有更优雅的写法，下面这种对于自定义一个注解，上面加上 @Service的情况时，将不太适用

if(ano instanceof Bean || ano.annotationType().isAnnotationPresent(Bean.class)) {
  // xxx
}

其次就是BeanName的生成规则

当注解的value属性有被指定，则beanName即为指定的值；
否则，根据class名，首字母小写即可

3. IoC依赖注入

这个也比较简单，扫描每个bean的属性，将拥有 @Autowired 注解的拎出来, 然后查对应的Bean，赋值即可

/**
 * 依赖注入
 */
private void ioc() throws IllegalAccessException {

    Field[] fields;
    String beanName;
    Object bean;
    for (Object obj : nameBeanMap.values()) {
        fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (!field.isAnnotationPresent(Autowired.class)) {
                continue;
            }

            Autowired autowired = field.getAnnotation(Autowired.class);
            beanName = StringUtils.isBlank(autowired.value()) ?
                    StrUtil.lowerFirstChar(field.getName()) : autowired.value();
            bean = nameBeanMap.get(beanName);

            if (bean == null) {
                throw new BeanNotFoundException("bean: " + beanName + " not found! bean class: " + field.getClass().getName());
            }

            field.setAccessible(true);
            field.set(obj, nameBeanMap.get(beanName));
        }
    }
}

属性赋值，关注下两行代码即可

// 强制设置可访问，这样私有的变量也可以修改其内容了
field.setAccessible(true);
field.set(obj, nameBeanMap.get(beanName));

4. 查询bean & 动态注册

查询的几个接口就比较简单了，单纯的从Map中获取对象; 注册也就是向Map中塞对象

其他

源码地址: https://github.com/liuyueyi/quick-mvc