Spring注解驱动开发——IOC的常用注解

一、用于注解驱动的注解

@Configuration

(一) 作用

它是在spring3.0版本之后加入的。此注解是spring支持注解驱动开发的一个标志。表明当前类是spring的一个配置类，作用是替代spring的applicationContext.xml。但其本质就是@Component注解，被此注解修饰的类，也会被存入spring的ioc容器。

(二) 属性

value:用于存入spring的Ioc容器中Bean的id。

(三) 本质

就是@Component注解，被此注解修饰的类，也会被存入spring的ioc容器。

(四) 使用场景

在注解驱动开发时，用于编写配置的类，通常可以使用此注解。一般情况下，我们的配置也会分为主从配置，@Configuration一般出现在主配置类上。

如果我们在注解驱动开发时，构建ioc容器使用的是传入字节码的构造函数，此注解可以省略。

如果传入的是一个包，此注解则不能省略。

@ComponentScan

(一) 作用

用于指定创建容器时要扫描的包。该注解在指定扫描的位置时，可以指定包名，也可以指定扫描的类。同时支持定义扫描规则，例如包含哪些或者排除哪些。同时，它还支持自定义Bean的命名规则

(二) 属性

(1) value

用于指定要扫描的包。当指定了包的名称之后，spring会扫描指定的包及其子包下的所有类。

(2) basePackages

它和value作用是一样的。

(3) basePackageClasses

指定具体要扫描的类的字节码。该类所在的包及其子包都会被扫描。

(4) nameGenrator

指定扫描bean对象存入容器时的命名规则，及bean命名规则生成器。

默认规则
当value属性未赋值时，bean的默认id值为首字母小写的类名

自定义BeanGenerator生成规则

public class CustomerBeanNameGenerator implements BeanNameGenerator {

    private static final String COMPONENT_ANNOTATION_CLASSNAME = "org.springframework.stereotype.Component";

    @Override
    public String generateBeanName(BeanDefinition beanDefinition, BeanDefinitionRegistry beanDefinitionRegistry) {
        String beanName = null;
        //1.判断当前bean的定义信息是否时注解的
        if (beanDefinition instanceof AnnotatedBeanDefinition) {
            //2.把beanDefinition转成注解的bean定义信息
            AnnotatedBeanDefinition annotatedBeanDefinition = (AnnotatedBeanDefinition) beanDefinition;
            //3.获取注解bean的元信息
            AnnotationMetadata annotationMetadata = annotatedBeanDefinition.getMetadata();
            //4.获取定义信息中的所有注解
            Set<String> types = annotationMetadata.getAnnotationTypes();
            //5.遍历types集合
            for (String type : types) {
                //6.得到注解的属性
                AnnotationAttributes attributes = AnnotationAttributes.fromMap(annotationMetadata.getAnnotationAttributes(type, false));
                //7.判断attributes是否为null，同时必须是@Component及其衍生注解
                if (attributes != null && isStereotypeWithNameValue(type, annotationMetadata.getMetaAnnotationTypes(type), attributes)) {
                    //8.获取value属性的值
                    Object value = attributes.get("value");
                    //9.判断value属性是否为String类型
                    if (value instanceof String) {
                        String strVal = (String) value;
                        //10.判断value属性是否有值
                        if (StringUtils.hasLength(strVal)) {
                            if (beanName != null && !strVal.equals(beanName)) {
                                throw new IllegalStateException("Stereotype annotations suggest inconsistent component names: '" + beanName + "' versus '" + strVal + "'");
                            }
                            beanName = strVal;
                        }
                    }
                }
            }
        }
        return beanName != null ? "my" +beanName : "my" + buildDefaultBeanName(beanDefinition);
    }

    private boolean isStereotypeWithNameValue(String annotationType, Set<String> metaAnnotationTypes, @Nullable Map<String, Object> attributes) {
        boolean isStereotype = annotationType.equals("org.springframework.stereotype.Component") || metaAnnotationTypes.contains("org.springframework.stereotype.Component") || annotationType.equals("javax.annotation.ManagedBean") || annotationType.equals("javax.inject.Named");
        return isStereotype && attributes != null && attributes.containsKey("value");
    }

    private String buildDefaultBeanName(BeanDefinition definition) {
        String beanClassName = definition.getBeanClassName();
        Assert.state(beanClassName != null, "No bean class name set");
        String shortClassName = ClassUtils.getShortName(beanClassName);
        return Introspector.decapitalize(shortClassName);
    }
}

(5) scopeResolver

用于处理并转换检测到的Bean的作用范围。

(6) soperdProxy

用于指定bean生成时的代理方式。默认是Default，则不使用代理。

(7) resourcePattern

用于指定符合组件检测条件的类文件，默认是包扫描下的 **/*.class

(8) useDefaultFilters

是否对带有@Component @Repository @Service @Controller注解的类开启检测,默认是开启的。

(9) includeFilters

自定义组件扫描的过滤规则，用以扫描组件。
FilterType有5种类型：

ANNOTATION, 注解类型 默认
ASSIGNABLE_TYPE,指定固定类
ASPECTJ， ASPECTJ类型
REGEX,正则表达式
CUSTOM,自定义类型

(10) excludeFilters:

自定义组件扫描的排除规则。

(11) lazyInit

组件扫描时是否采用懒加载 ，默认不开启。

(三) 细节

(1) 当@ComponentScan未配置相关属性时，默认扫描SpringConfiguration配置类所在包及子包

(四) 自定义过滤规则

match方法：扫描器在扫描时，若bean的条件符合自定义过滤规则，则返回true，否则返回false。

@Bean

(一) 使用场景

通常情况下，在基于注解的配置中，我们用于把一个类存入spring的ioc容器中，首先考虑的是使用@Component以及他的衍生注解。但是如果遇到要存入容器的Bean对象不是我们写的类，此时无法在类上添加@Component注解，这时就需要此注解了。简单来说，，该注解常用来导入第三方包里面的组件。

(二) 作用

写在方法上，表示把当前方法的返回值存入spring的ioc容器。
例如，在我们配置JdbcTemplate使用Spring内置数据源DriverManagerDataSource时，数据源类是spring-jdbc这个jar包中类，此时我们无法编辑，在上面加注解，此时就可以使用@Bean注解配置。

同时还可以出现在注解上，作为元注解来使用。

此时的运行效果和@Bean相同

(三) 属性

(1) name:

用于指定存入spring容器中bean的标识。支持指定多个标识。当不指定该属性时，默认值是当前方法的名称。

(2) value

此属性是在4.3.3版本之后加入的。它和name属性的作用是一样的。

(4) autowireCandidate:

用于指定是否支持自动按类型注入到其他bean中。只影响@Autowired注解的使用。不影响@Resource注解注入。默认值为true，意为允许使用自动按类型注入。

(5) initMethod:

用于指定初始化方法。在实际开发中常常采用编程的方式进行初始化操作。

(6) destroyMethod:

用于指定销毁方法。

@Import

(一) 使用场景

当在使用注解驱动开发时，由于配置项过多，如果都写在一个类里面，配置结构和内容将杂乱不堪，此时使用此注解可以把配置项进行分门别类进行配置。

(二) 作用

该注解是写在类上的，通常都是和注解驱动的配置类一起使用的。其作用是引入其他的配置类。使用了此注解之后，可以使我们的注解驱动开发和早期xml配置一样，分别配置不同的内容，使配置更加清晰。同时指定了此注解之后，被引入的类上可以不再使用@Configuration,@Component等注解。

(三) 属性

value
用于指定其他配置类的字节码。它支持指定多个配置类。

使用SpringConfiguration做为主配置类，而连接数据库相关的配置被分配到了JdbcConfig配置类中，此时使用在SpringConfiguration类上使用@Import注解把JdbcConfig导入进来就可以了。

(四) 细节

在上面的例子中，JdbcConfig这个配置类并未配置@Configuration注解，则此时JdbcConfig这个配置类的唯一标识为config.JdbcConfig，即全限定类名

(五) 高级分析

(1) ImportSelector和ImportBeanDefinitionRegistrar介绍

共同点：他们都是用于动态注册bean对象到容器中的。并且支持大批量的bean导入
区别：
ImportSelector是一个接口，我们在使用时需要自己提供实现类。实现类中返回要注册的bean的全限定类名数组，然后执行ConfigurationClassParser类中中的processImports方法注册bean对象的。
ImportBeanDefinitionRegistrar也是一个接口，需要我们自己编写实现类，在实现类中手动注册bean到容器中。
注意事项：
实现了ImportSelector接口或者ImportBeanDefinitionRegistrar接口的类不会被解析成一个Bean注册到容器中。同时，在注册到容器中时bean的唯一标识是全限定类名，而非短类名。

(2) ImportSelector：返回需要导入的组件的全类名数组

(3) ImportBeanDefinitionRegistrar：手动注册bean到容器中

FactoryBean 工厂bean

细节
(1) 默认获取到的是工厂bean调用getObject方法创建的对象
(2) 要获取工厂bean本身，需要给id前面加上一个&

@PropertySource

(一) 作用

用于指定读取资源文件的位置。注意，它不仅支持properties，也支持xml文件，并且通过YAML解析器，配合自定义PropertySourceFactory实现解析yml配置文件（详情请参考第五章第8小节自定义PropertySourceFactory实现YAML文件解析）。

(二) 属性

(1) name

指定资源的名称。如果没有指定，将根据基础资源描述生成。

(2) value

指定资源的位置。可以是类路径，也可以是文件路径。

(3) ignoreResourceNotFound

指定是否忽略资源文件有没有，默认是false,也就是说当资源文件不存在时spring启动将会报错。

(4) encoding

指定解析资源文件使用的字符集。当有中文的时候，需要指定中文的字符集。

(5) factory

指定读取对应资源文件的工厂类，默认的是PropertySourceFactory。

(三) 使用场景

我们实际开发中，使用注解驱动后，xml配置文件就没有了，此时一些配置如果直接写在类中，会造成和java源码的紧密耦合，修改起来不方法。此时一些配置可以使用properties或者yml来配置就变得很灵活方便。

(四) 自定义PropertySourceFactory解析yaml文件

(1) yaml文件

Yet Another Markup Language 另一种标记语言
规则：同一级的顶头写。描述从属关系，另起一行，通常空两个书写。只要同一级从属，空格数相同即可，键和值之间用冒号和空格分隔

(2) 分析

通过分析@PropertySource源码，得知默认情况下此注解只能解析properties文件和xml文件，而遇到yaml（yml）文件，解析就会报错。此时就需要自己编写一个PropertySourceFactory的实现类，借助yaml解析器，实现yml文件的解析。

(3) 实现

导入yaml解析工厂

注意导入的版本是否与使用的spring版本匹配，否则会报错

nested exception is java.lang.NoSuchMethodError: org.yaml.snakeyaml.constructor.Constructor.< init >(Lorg/yaml/snakeyaml/LoaderOptions;)V

编写自定义工厂

public class YamlPropertiesFactory implements PropertySourceFactory {

    public YamlPropertiesFactory() {
    }

    /**
     * 自定义解析规则，引入了第三方yaml文件解析器
     * @param name
     * @param resource
     * @return
     * @throws IOException
     */
    @Override
    public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {

        //1.创建yaml文件解析工厂
        YamlPropertiesFactoryBean factoryBean = new YamlPropertiesFactoryBean();
        //2.设置要解析的资源内容
        factoryBean.setResources(resource.getResource());
        //3.把资源解析成properties
        Properties properties = factoryBean.getObject();
        /**
         * 返回PropertySource对象
         */
        return name != null ? new PropertiesPropertySource(name, properties)
                            : new PropertiesPropertySource(resource.getResource().getFilename()  ,properties);
    }
}

二、注入时机和设定注入条件的注解

@DependsOn

(1) 作用

用于指定某个类的创建依赖的bean对象先创建。spring中没有特定bean的加载顺序，使用此注解则可指定bean的加载顺序。(在基于注解配置中，是按照类中方法的书写顺序决定的)

(2) 属性

value： 用于指定bean的唯一标识。被指定的bean会在当前bean创建之前加载。

(3) 使用场景

在观察者模式中，分为事件，事件源和监听器。一般情况下，我们的监听器负责监听事件源，当事件源触发了事件之后，监听器就要捕获，并且做出相应的处理。以此为前提，我们肯定希望监听器的创建时间在事件源之前，此时就可以使用此注解。

@Lazy

(一) 作用：只对单例bean有效

用于指定单例bean对象的创建时机。在没有使用此注解时，单例bean的生命周期与容器相同。但是当使用了此注解之后，单例对象的创建时机变成了第一次使用时创建。注意：这不是延迟加载思想（因为不是每次使用时都创建，只是第一次创建的时机改变了）。

(二) 使用场景：

在实际开发中，当我们的Bean是单例对象时，并不是每个都需要一开始都加载到ioc容器之中，有些对象可以在真正使用的时候再加载，当有此需求时，即可使用此注解。值得注意的是，此注解只对单例bean对象起作用，当指定了@Scope注解的prototype取值后，此注解不起作用。
属性：

(三) value:

指定是否采用延迟加载。默认值为true，表示开启。

@Condition

(1) 作用

根据条件选择注入的bean对象。

(2) 属性

value:用于提供一个Condition接口的实现类，实现类中需要编写具体代码实现注入的条件。

(3) 使用场景

开发时，可能会使用多平台来测试，例如我们的测试数据库分别部署到了linux和windows两个操作系统上面，现在根据我们的工程运行环境选择连接的数据库。此时就可以使用此注解。同时基于此注解引出的@Profile注解，就是根据不同的环境，加载不同的配置信息。

@Profile

(1) 使用场景分析

@Profile注解是spring提供的一个用来标明当前运行环境的注解。我们正常开发的过程中经常遇到的问题是，开发环境是一套环境，测试是一套环境，线上部署又是一套环境。这样从开发到测试再到部署，会对程序中的配置修改多次，尤其是从测试到上线这个环节，让测试的也不敢保证改了哪个配置之后能不能在线上运行。为了解决上面的问题，我们一般会使用一种方法，就是针对不同的环境进行不同的配置，从而在不同的场景中跑我们的程序。而spring中的@Profile注解的作用就体现在这里。在spring使用DI来注入的时候，能够根据当前制定的运行环境来注入相应的bean。最常见的就是使用不同的DataSource了。

(2) 案例实现

三、用于创建对象的注解

@Component @Controller @Service @Repository

(一) 作用

这四个注解都是用于修饰类的。是用于把当前类创建一个对象，存入spring的ioc容器中。在实例化时，首选默认无参构造函数。同时支持带参构造，前提是构造函数的参数依赖必须要有值。否则抛异常

(二) 属性

value:用于指定存入容器时bean的id。当不指定时，默认值为当前类的名称。

(三) 使用场景：

当我们需要把自己编写的类注入到Ioc容器中，就可以使用以上四个注解实现。以上四个注解中@Component注解通常用在非三层对象中。而@Controller，@Service，@Repository三个注解一般是针对三层对象使用的，提供更加精确的语义化配置。
需要注意的是，spring在注解驱动开发时，要求必须先接管类对象，然后会处理类中的属性和方法。如果类没有被spring接管，那么里面的属性和方法上的注解都不会被解析。

四、用于注入数据的注解

@Autowired

(一) 作用

自动按照类型注入。当ioc容器中有且只有一个类型匹配时可以直接注入成功。当有超过一个匹配时，则使用变量名称（写在方法上就是方法名称）作为bean的id，在符合类型的bean中再次匹配，能匹配上就可以注入成功。当匹配不上时，是否报错要看required属性的取值。

(二) 属性

required：是否必须注入成功。默认值是true，表示必须注入成功。当取值为true的时候，注入不成功会报错。

(三) 使用场景

此注解的使用场景非常之多，在实际开发中应用广泛。通常情况下我们自己写的类中注入依赖bean对象时，都可以采用此注解。

(四) 细节

在使用注解注入时，set方法就不是必须的。此时会在SpringIOC容器中进行按数据类型查找。

如果IOC容器中有多个类型匹配时
首先先按照类型圈定出匹配的对象，接下来使用变量名称作为bean的id在圈定出来的对象中继续查找，如果有相同的则查找成功，否则查找失败

查找失败

@Qualifier

(一) 作用

当使用自动按类型注入时，遇到有多个类型匹配的时候，就可以使用此注解来明确注入哪个bean对象。注意它通常情况下都必须配置@Autowired注解一起使用

(二) 属性

value：用于指定bean的唯一标识。

(三) 使用场景：

在我们的项目开发中，很多时候都会用到消息队列，我们一ActiveMQ为例。当和spring整合之后，Spring框架提供了一个JmsTemplate对象，它既可以用于发送点对点模型消息也可以发送主题模型消息。如果项目中两种消息模型都用上了，那么针对不同的代码，将会注入不同的JmsTemplate，而容器中出现两个之后，就可以使用此注解注入。当然不用也可以，我们只需要把要注入的变量名称改为和要注入的bean的id一致即可。

@Resource

(一) 作用

此注解来源于JSR规范（Java Specification Requests）,其作用是找到依赖的组件注入到应用来，它利用了JNDI（Java Naming and Directory Interface Java命名目录接口 J2EE规范之一）技术查找所需的资源。
默认情况下，即所有属性都不指定，它默认按照byType的方式装配bean对象。如果指定了name，没有指定type，则采用byName。如果没有指定name，而是指定了type，则按照byType装配bean对象。当byName和byType都指定了，两个都会校验，有任何一个不符合条件就会报错。

(二) 属性

name：资源的JNDI名称。在spring的注入时，指定bean的唯一标识。
type：指定bean的类型。
lookup:引用指向的资源的名称。它可以使用全局JNDI名称链接到任何兼容的资源。
authenticationType:指定资源的身份验证类型。它只能为任何受支持类型的连接工厂的资源指定此选项，而不能为其他类型的资源指定此选项。
shareable：指定此资源是否可以在此组件和其他组件之间共享。
mappedName：指定资源的映射名称。
description：指定资源的描述。

(三) 使用场景

当我们某个类的依赖bean在ioc容器中存在多个的时候，可以使用此注解指定特定的bean对象注入。当然我们也可以使用@Autowired配合@Qualifier注入。

@Inject

(一) 作用

它也是用于建立依赖关系的。和@Resource和@Autowired的作用是一样。在使用之前需要先导入坐标：

(三) 使用场景

在使用@Autowired注解的地方，都可以替换成@Inject。它也可以出现在方法上，构造函数上和字段上，但是需要注意的是：因为JRE无法决定构造方法注入的优先级，所以规范中规定类中只能有一个构造方法带@Inject注解。

(四) 细节

三者区别

@Primary

(一) 作用

用于指定bean的注入优先级。被@Primary修饰的bean对象优先注入

(二) 使用场景

当我们的依赖对象，有多个存在时，@Autowired注解已经无法完成功能，此时我们首先想到的是@Qualifier注解指定依赖bean的id。但是此时就产生了，无论有多少个bean，每次都会使用指定的bean注入。但是当我们使用@Primary，表示优先使用被@Primary注解的bean，但是当不存在时还会使用其他的。

@Value

(一) 作用

用于注入基本类型和String类型的数据。它支持spring的EL表达式，可以通过${} 的方式获取配置文件中的数据。配置文件支持properties,xml和yml文件。

(二) 属性

value:指定注入的数据或者spring的el表达式。

使用场景

在实际开发中，像连接数据库的配置，发送邮件的配置等等，都可以使用配置文件配置起来。此时读取配置文件就可以借助spring的el表达式读取。

五、和生命周期以及作用范围相关的注解

@Scope

(一) 作用

用于指定bean对象的作用范围。

(二) 属性

value: 
	指定作用范围的取值。常用取值：singleton,prototype。默认取值singleton
	但是在spring初始化容器时，会借助ConfigurableBeanFactory接口中的类成员：
	String SCOPE_SINGLETON = "singleton";
scopeName:
	它和value的作用是一样的。
proxyMode:
	它是指定bean对象的代理方式的。指定的是ScopedProxyMode枚举的值
        DEFAULT：默认值。（就是NO）
        NO：不使用代理。
        INTERFACES：使用JDK官方的基于接口的代理。
        TARGET_CLASS：使用CGLIB基于目标类的子类创建代理对象。

(三) 使用场景

在实际开发中，我们的bean对象默认都是单例的。通常情况下，被spring管理的bean都使用单例模式来创建。但是也有例外，例如Struts2框架中的Action，由于有模型驱动和OGNL表达式的原因，就必须配置成多例的。

@PostConstruct

(一) 作用

用于指定bean对象的初始化方法。

(二) 使用场景

在bean对象创建完成后，需要对bean中的成员进行一些初始化的操作时，就可以使用此注解配置一个初始化方法，完成一些初始化的操作。

@PreDestroy

(一) 作用

用于指定bean对象的销毁方法。

(三) 使用场景

在bean对象销毁之前，可以进行一些清理操作。