Spring/SpringBoot 注解学习总结

作者：一字马胡

使用注解开发应用是一种非常赞的开发体验，仅仅使用一个注解就可以完成大量的工作以满足我们的需求，这是何等的奇妙啊。比如lombok就是一个非常棒的注解工具，仅仅一个@Setter注解就可以为类的所有成员添加set方法，如果没有lombok，比如对于一个有100个字段的domain类，我们需要写100个set方法，就算是IDE有自动生成set代码功能，但是100个set方法的代码量还是很可观的，而且一个domain不仅需要有set方法，还需要get方法，以及一些必须的构造方法等等，这样下来，这个类就会有200多个看起来“没用”的方法了，这个类无论如何都会很“臃肿”，而使用lombok，仅仅需要几行代码，简单明了。

本文主要总结一些在Spring/SpringBoot项目中使用到的常用注解，会对一些注解进行深入分析，包括注解的含义，使用方法，一些使用建议以及一些高端用法探索，如果你正在使用Spring进行项目开发，那么使用XML无可厚非，但是如果你正在使用SpringBoot来部署你的应用，还是建议抛弃XML的配置方式，使用注解可以让你的应用看起来更加轻便易懂。

@Import 注解

这个注解是非常厉害的注解，它可以将一些bean加载到IOC容器中来，很多其他的注解比如@EnableAutoConfiguration、@EnableScheduling等都用到了这个注解来实现他们各自的功能。和这个注解类似的注解还有@ImportResource，但是@ImportResource注解是将一个xml资源文件中的bean加载到IOC容器中来，而@Import 则是从注解中解析具体的bean然后加载到IOC容器中来，但是这两个注解的本质都是一样的。

@Import可以使用三种方式来加载bean，下面分别介绍一下这三种bean的使用：

（1）直接在@Import的value参数中填写需要加载进来的实例类，比如有一个类A需要被加载进来，就使用@Import(value = A.class)，如果有多个需要加载的实例类，就使用@Import(value = {A.class, B.class, C.class ...})即可。
（2）在@Import中填写一个自定义的ImportSelector类，然后在selectImports方法中返回所有需要加载的类的全限定名即可。
（3）在@Import中填写一个自定义的ImportBeanDefinitionRegistrar类，然后在registerBeanDefinitions方法中注册你需要加载的bean。一般情况下，你只需要做两个步骤即可：

        // new一个RootBeanDefinition
        RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(${BeanClass});
        // 注册一个bean
        registry.registerBeanDefinition(${beanName}, rootBeanDefinition);

${BeanClass}替换为具体的bean的类型，$ {beanName}则替换为bean的具体id即可。

@ImportResource

这个注解的功能和注解@Import类似，但是它是用来加载一些xml文件里面的bean的，用法也是很简单的，直接在@ImportResource中填写具体的xml路径即可，比如：


@ImportResource(locations = "classpath:/spring/applicationContext.xml")

一般情况下，使用这个注解代表你必须使用xml来配置你的bean，如果在SpringBoot项目中，建议去掉xml文件配置bean的方式，取而代之的是使用注解来配置你的bean，你可以使用@Configuration注解标记一个类是一个配置bean的类，然后在该类里面的具体方法上使用@Bean配置标记这个方法返回的实例将作为一个bean加载到IOC容器中去，当然这些注解的使用以及含义将在后文中介绍。

@AutoConfigurationPackage注解

@EnableAutoConfiguration注解

首先来看一下这个注解的定义：


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    Class<?>[] exclude() default {};

    /**
     * Exclude specific auto-configuration class names such that they will never be
     * applied.
     * @return the class names to exclude
     * @since 1.3.0
     */
    String[] excludeName() default {};

}

这里面有几个关键的地方需要注意：

（1）使用了@AutoConfigurationPackage注解
（2）使用了@Import注解并且加载了AutoConfigurationImportSelector.class