细说Spring——IoC详解（注解驱动开发之Bean的注入）

一、前言

之前的IoC讲解部分大多是理论内容，感觉缺少一些操作示例，接下来我就会用Spring的注解开发，将一些主要的Spring黑科技展示出来，而所要展示的内容很多，可能一次写不完整，所以分为多篇博客进行讲解。下面我们一起学习一下Spring的注解驱动开发，我是参照尚硅谷的Spring注解驱动开发视频学习的此部分内容，自己实现了所有的代码，而这个视频大家可以在B站看到，也可以去尚硅谷官网下载，个人感觉这个教程和《Spring揭秘》这本书很配套，也非常推荐。

二、通过@Bean注解将Bean注入Spring容器

我们都应该知道使用xml文件来配置bean，在xml中配置的bean会注入到Spring容器中，我们就可以通过ApplicationContext.getBean()方法获取相关的对象，那么我们使用注解怎么实现这个功能呢？下面先给出代码，然后根据代码进行讲解：
Person类

package com.jiayifan.bean;

import org.springframework.beans.factory.annotation.Value;

/**
 * Created by Yifan Jia on 2018/6/12.
 */
public class Person {

    private String name;

    private Integer age;


    public Person() {
    }

    public Person(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Person{" +
            "name='" + name + '\'' +
            ", age=" + age +
            '}';
    }
}

配置类

@Configuration//告诉spring这是一个配置类
public class MainConfig {
    @Bean//给容器中至少一个bean，bean的类型就是返回值得类型，id默认为方法名
    public Person person() {

        return new Person("贾一帆", 20);
    }
}

首先，我们也需要一个像xml一样的配置文件来配置我们想注入容器的bean，这里我们创建了一个配置类，我们就可以把这个配置类当做以前的xml配置文件，在xml中可以配置的东西在配置类中都可以使用相应的注解实现，上面例子中，我们希望将Person类注入到容器中，创建一个配置类后，我们需要使用@Configuration注解来告诉Spring这是一个配置类，然后我们可以通过写一个返回我们需要对象的方法加上@Bean注解，就是：

    @Bean//给容器中至少一个bean，bean的类型就是返回值得类型，id默认为方法名
    public Person person() {
        return new Person("贾一帆", 20);
    }

来实现bean的注入，然后我们就可以测试一下了：

    @Test
    public void test01() {
        //获取容器
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig.class);
        //查看容器中类型是Person类的BeanName
        String[] beanNamesForType = applicationContext.getBeanNamesForType(Person.class);
        for(String name : beanNamesForType) {
            System.out.println(name);
        }
    }

这里我们创建的容器不再是ClassPathXmlApplicationContext而是AnnotationConfigApplicationContext，然后传入的参数也不是xml配置文件，而是配置类，下面看一下测试的结果：

这里写图片描述
这里我们也可以看到容器中的Person类的BeanName（Bean的id）是方法名。我们如果想要指定BeanName，我们可以在@Bean注解中添加属性，比如：@Bean("myPerson")，这样一改上面的测试结果就变成了：
这里写图片描述

三、通过包扫描的方法为容器中注入Bean

我们都知道在xml配置文件中可以通过包扫描的方法批量的将bean注入到容器中，而在配置类中，我们也有这样的功能，下面我们先看一下代码：
这里我创建了其他一些POJO来作为Bean注入到容器中，和上面的Person类相似，下面就显示一个POJO，其他的就不展示了：

@Component//使用包扫描功能时需要添加这个注解
public class Yellow {
}

配置类

@ComponentScan(value = "com.jiayifan.bean"})
@Configuration//告诉spring这是一个配置类
public class MainConfig {
}

上面的代码我们看出来我们并没有使用@Bean注解的方法添加bean到容器中，而是使用了@ComponentScan(value = "com.jiayifan.bean"})注解，扫描com.jiayifan。bean包下有@@Component注解标注的类，自动加入到容器中。下面我们来测试一下这个类：

private void printBeans() {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig.class);
        //获取容器中所有的bean的名字
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for(String name : beanDefinitionNames) {
            System.out.println(name);
        }
}

上面这个方法可以打印容器中所有的bean的名字，我们以后会经常使用这个方法，大家请记住这个方法，后面的讲解中会调用了这个方法。

    @Test
    public void importTest() {
         printBeans();
    }

测试的结果是：

这里写图片描述

我们可以看到除了Spring容器启动时自动加载的一些bean，还加载了mainConfig、yellow、myPerson，这里的mainConfig就是我们的配置类，其他的两个就是com.jiayifan.bean中使用@Component标注了的类，当然我们也可以使用@Controller、@Repository、@Service来标注需要包扫描添加的bean，不过因为不涉及到web，所以使用了@Component。

四、通过@Import将Bean注入到容器

我们也可以通过@Import注解来快速的为容器中注入我们所需要的bean，下面还是先看代码：
导入的POJO类省略
配置类

@Configuration//告诉spring这是一个配置类
@Import(value = {Color.class})//快速导入bean，id默认为全类名
public class MainConfig2 {
}

这时候我们测试一下容器中有哪些bean:

这里写图片描述
这里我换了另外一个配置类当做配置文件，我们可以看到容器中只有com.jiayifan.bean.Color和mainConfig2，这里需要注意，使用@Import注解导入的bean的名称为全类名。
除了使用@Import(value = {Color.class})直接导入bean之外，我们可以通过查看@Import注解的源码，看一下@Import还可以通过其他的方法导入bean：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

    /**
     * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
     * or regular component classes to import.
     */
    Class<?>[] value();

}

我们可以看到value属性除了可以直接添加类之外，还可以添加ImportSelector，其实这个ImportSelector是一个接口，我们可以自定义实现一个ImportSelector：

public class MyImportSelect implements ImportSelector {
    //返回值就是要导入到容器中的bean全类名
    //AnnotationMetadata：当前标注@Import注解的类的所有注解信息
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        
        //可以返回一个空数组，但是不要返回null，会报错
        return new String[]{"com.jiayifan.bean.Blue", "com.jiayifan.bean.Yellow", "com.jiayifan.bean.Red"};
    }
}

通过实现的MyImportSelect我们可以看到，其实这个ImportSelector，就是一个将需要注入容器的bean的信息包装起来的类，我们主要将bean的全类名包装在这个类中，然后在@Import的属性中添加该类，就可以实现将多个bean一起注入到容器，不过这个类的主要作用应该是可以使用importingClassMetadata参数对所需要注入的bean进行筛选。我们看一下使用这种方法怎么将bean注入容器：

@Configuration//告诉spring这是一个配置类
@Import(value = {MyImportSelect.class})
public class MainConfig2 {
}

测试结果：

这里写图片描述
在上面的@Import注解的源码中，我们还发现除了类、ImportSelector之外，还可以添加ImportBeanDefinitionRegister,我们上面两种方法添加到容器中的bean的名称都是全类名，但是如果使用ImportBeanDefinitionRegister，我们就可以自定义bean的名称了。
这里实现一个自己的ImportBeanDefinitionRegister：

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    /**
     *
     * @param importingClassMetadata  当前类的注解信息
     * @param registry bean定义的注册类
     *                 把所有需要注册到容器中的bean：通过BeanDefinitionRegistry注册到容器中
     */
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

            //指定bean和BeanDefinition
            //BeanDefinition自己创建
            RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Yellow.class);
            registry.registerBeanDefinition("yellow", rootBeanDefinition);

    }
}

我们可以发现在这个方法中，我们通过自定义BeanDefinition，手动的将BeanDefinition注册到容器中实现将bean注入容器的功能，这个方法中我们的自由度更大，感觉只是注册一个类有点大材小用的感觉。我们接着测试一下：

@Configuration//告诉spring这是一个配置类
@Import(value = {MyImportBeanDefinitionRegistrar.class})
public class MainConfig2 {
}

测试结果：

这里写图片描述
上我们可以发现bean的名称就是我们在registry.registerBeanDefinition("yellow", rootBeanDefinition);中添加的名称。

五、总结

上面介绍了一下使用注解驱动开发过程中我们怎么将bean注册到容器中，介绍了三种方法，我们比较常用的应该就是包扫描和@Bean注解的方法，其实除了这三个方法还有一种方法也可以实现，并且我们肯定会想在包扫描的时候是不是可以像xml配置那样有一些过滤的功能，其实这些在注解开发中都可以实现，但是限于篇幅，这一篇中就没有讲解相关的内容，这些内容我们将在下一篇博客中进行讲解。