@Configuration

在一次关于Spring注解的面试中，可能会经历面试官的一段夺命连环问：

@Configuration有什么用？ @Configuration和XML有什么区别？哪种好？ Spring是如何基于来获取Bean的定义的？ @Autowired 、 @Inject、@Resource 之间有什么区别？ @Value、@PropertySource 和 @Configuration？ Spring如何处理带@Configuration @Import的类？ @Profile有什么用？ @Configuration 如何嵌套？ Spring如何对Bean进行延迟初始化？ Spring项目怎么进行单元测试？ @Configuration 使用上有哪些约束？

本文就来尝试回答下以上问题。简单介绍下@Configuration 注解，并且你看一下他的基本用法以及和其他注解产生化学反应。文章内容较长，建议收藏。

@Configuration 基本说明

定义：指示一个类声明一个或者多个@Bean 声明的方法并且由Spring容器统一管理，以便在运行时为这些bean生成bean的定义和服务请求的类。例如：

上述AppConfig 加入@Configuration 注解，表明这就是一个配置类。有一个myBean()的方法，返回一个MyBean()的实例，并用@Bean 进行注释，表明这个方法是需要被Spring进行管理的bean。@Bean 如果不指定名称的话，默认使用myBean名称，也就是小写的名称。

新建一个SpringBoot项目(别问我为什么，因为这样创建项目比较快)。

pom.xml 文件如下：

在config 包下新建一个MyConfiguration环境配置，和上面的示例代码相似，完整的代码如下：

说明MyConfiguration 是一个配置类，能够在此类下面声明管理多个Bean，我们声明了一个MyBean的bean，希望它被容器加载和管理。

在pojo包下新建一个MyBean的类，具体代码如下

新建一个SpringConfigurationApplication类，用来测试MyConfiguration类，具体代码如下：

输出：

从输出的结果可以看到，默认名称为myBean 的bean随着容器的加载而加载，因为myBean方法返回一个myBean的构造方法，所以myBean被初始化了。

可以通过使用XML方式定义的开启基于注解的启动，然后再定义一个MyConfiguration的bean，在<code>/resources</code>目录下新建 application-context.xml 代码如下：

需要引入applicationContext.xml ，在SpringConfigurationApplication 需要进行引入，修改后的SpringConfigurationApplication如下：

必须以类的方式提供(即不是从工厂方法返回的实例)

@Configuration 注解的类必须是非final的

配置类必须是非本地的（即可能不在方法中声明）,native 标注的方法

任何嵌套的@Configuration 都必须是static 的。

@Bean 方法可能不会反过来创建更多配置类

@Configuration注解作用在类上，就和普通类一样能够进行相互嵌套，定义内部类。

在上述代码中，只需要在应用程序的上下文中注册 AppConfig 。由于是嵌套的@Configuration 类，DatabaseConfig 将自动注册。当AppConfig 、DatabaseConfig 之间的关系已经隐含清楚时，这就避免了使用@Import 注解的需要。

<code>@Configuration</code> 通常和<code>Environment</code> 一起使用，通过<code>@Environment</code> 解析的属性驻留在一个或多个"属性源"对象中，<code>@Configuration</code>类可以使用<code>@PropertySource</code>，向Environment 对象提供属性源

为了便于测试，我们引入junit4和spring-test 的依赖，完整的配置文件如下

在config 包下定义一个 EnvironmentConfig 类，注入Environment 属性，完整代码如下：

在<code>/resources</code> 目录下新建beanName.properties 文件，如下：

启动并进行Junit测试，输出如下：

@Configuration 可以和@Value 和@PropertySource 一起使用读取外部配置文件，具体用法如下：

在config 包下新建一个ReadValueFromPropertySource类，代码如下

通过@PropertySource引入的配置文件，使@Value 能够获取到属性值，在给myBean()方法指定了一个名称叫做myTestBean。

修改MyBean类，增加一个name属性和一个构造器，再生成其toString() 方法

在SpringConfigurationApplication中进行测试，如下

使用Applicatio@InConntext 就能够获取myTestBean 这个bean，再生成myBean的实例。

输出：myBean = MyBean{name='bean.name.component'}

@Import的定义(来自于JavaDoc)：表明一个或者多个配置类需要导入，提供与Spring XML中相等的功能，允许导入@Configuration 、@ImportSelector、@ImportBeanDefinitionRegistar的实现，以及常规组件类似于AnnotationConfigApplicationContext。可能用于类级别或者是原注解。

如果XML或者其他非@Configuration标记的Bean资源需要被导入的话，使用@ImportResource。下面是一个示例代码：

在pojo 包下新建两个配置类，分别是CustomerBo, SchedualBo

在config 包下新建一个AppConfig，导入CustomerBo 和 SchedulerBo 。

在config 包下新建一个ImportWithConfiguration ，用于测试@Import 和 @Configuration 的使用

@ImportResource: 这个注解提供了与@Import 功能相似作用，通常与@Configuration 一起使用，通过AnnotationConfigApplicationContext 进行启动，下面以一个示例来看一下具体用法：

在config下新建TestService 类，声明一个构造函数，类初始化时调用

在/resources 目录下新建 importResources.xml ，为了导入TestService

然后在config 下新建一个ImportResourceWithConfiguration， 用于读取配置文件

输出：test @importResource success

@Lazy : 表明一个bean 是否延迟加载，可以作用在方法上，表示这个方法被延迟加载；

可以作用在@Component (或者由@Component 作为原注解) 注释的类上，表明这个类中所有的bean 都被延迟加载。

如果没有@Lazy注释，或者@Lazy 被设置为false，那么该bean 就会急切渴望被加载；除了上面两种作用域，@Lazy 还可以作用在@Autowired和@Inject注释的属性上，在这种情况下，它将为该字段创建一个惰性代理，作为使用ObjectFactory或Provider的默认方法。下面来演示一下：

修改MyConfiguration类，在该类上添加@Lazy 注解，新增一个IfLazyInit()方法，检验是否被初始化。

修改SpringConfigurationApplication 启动类，放开之前MyConfiguration 的启动类

输出你会发现没有关于bean的定义信息，但是当吧@Lazy 注释拿掉，你会发现输出了关于bean的初始化信息：

基于ComponentScan() 来获取Bean的定义

@Configuration 使用@Component 进行原注解，因此@Configuration 类也可以被组件扫描到（特别是使用XML元素）。

在这里认识几个注解: @Controller, @Service, @Repository, @Component

<code>@Controller</code>: 表明一个注解的类是一个"Controller"，也就是控制器，可以把它理解为MVC 模式的Controller 这个角色。这个注解是一个特殊的@Component，允许实现类通过类路径的扫描扫描到。它通常与@RequestMapping 注解一起使用。

<code>@Service</code>: 表明这个带注解的类是一个"Service"，也就是服务层，可以把它理解为MVC 模式中的Service层这个角色，这个注解也是一个特殊的@Component，允许实现类通过类路径的扫描扫描到

<code>@Repository</code>: 表明这个注解的类是一个"Repository",团队实现了JavaEE 模式中像是作为"Data Access Object" 可能作为DAO来使用，当与 PersistenceExceptionTranslationPostProcessor 结合使用时，这样注释的类有资格获得Spring转换的目的。这个注解也是@Component 的一个特殊实现，允许实现类能够被自动扫描到

@Component: 表明这个注释的类是一个组件，当使用基于注释的配置和类路径扫描时，这些类被视为自动检测的候选者。

也就是说，上面四个注解标记的类都能够通过@ComponentScan 扫描到，上面四个注解最大的区别就是使用的场景和语义不一样，比如你定义一个Service类想要被Spring进行管理，你应该把它定义为<code>@Service</code> 而不是<code>@Controller</code>。因为我们从语义上讲，<code>@Service</code>更像是一个服务的类，而不是一个控制器的类，<code>@Component</code>通常被称作组件，它可以标注任何你没有严格予以说明的类，比如说是一个配置类，它不属于MVC模式的任何一层，这个时候你更习惯于把它定义为 <code>@Component</code>。

<code>@Controller</code>，<code>@Service</code>，<code>@Repository</code> 的注解上都有<code>@Component</code>，所以这三个注解都可以用<code>@Component</code>进行替换。

来看一下代码进行理解：

定义五个类，类上分别用<code>@Controller</code>, <code>@Service</code>, <code>@Repository</code>, <code>@Component</code>, <code>@Configuration</code> 进行标注，分别如下

在MyConfiguration上加上@ComponentScan 注解，扫描上面5个类所在的包位置。代码如下：

修改 SpringConfigurationApplication 中的代码，如下：

由输出可以清楚的看到，上述定义的五个类成功被@ComponentScan 扫描到，并在程序启动的时候进行加载。

@Autowired 、 @Inject、@Resource 的区别

@Inject: 这是jsr330 的规范，通过<code>AutowiredAnnotationBeanPostProcessor</code> 类实现的依赖注入。位于javax.inject包内，是Java自带的注解。

不加@Named注解，需要配置与变量名一致即可。

<code>@Autowired</code>: @Autowired 是Spring提供的注解，通过<code>AutowiredAnnotationBeanPostProessor</code> 类实现注入。位于<code>org.springframework.beans.factory.annotation</code> 包内，是Spring 中的注解

默认是通过byType 实现注入

<code>@Resource</code>: @Resource 是jsr250规范的实现，@Resource通过<code>CommonAnnotationBeanPostProcessor</code> 类实现注入。@Resource 一般会指定一个name属性，如下：

<code>@Autowired</code>和<code>@Inject</code>基本是一样的，因为两者都是使用<code>AutowiredAnnotationBeanPostProcessor</code>来处理依赖注入。

但是<code>@Resource</code>是个例外，它使用的是<code>CommonAnnotationBeanPostProcessor</code>来处理依赖注入。当然，两者都是BeanPostProcessor。

在介绍完上述三者的区别之后，可以对Environment的属性以上述注入方式进行改造

@Profile

@Profile: 表示当一个或多个@Value 指定的配置文件处于可用状态时，组件符合注册条件，可以进行注册。

三种设置方式：

可以通过ConfigurableEnvironment.setActiveProfiles()以编程的方式激活

可以通过AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME (spring.profiles.active )属性设置为

JVM属性

作为环境变量，或作为web.xml 应用程序的Servlet 上下文参数。也可以通过@ActiveProfiles 注解在集成测试中以声明方式激活配置文件。

作用域

作为类级别的注释在任意类或者直接与@Component 进行关联，包括@Configuration 类

作为原注解，可以自定义注解

作为方法的注解作用在任何方法

注意:

如果一个配置类使用了Profile 标签或者@Profile 作用在任何类中都必须进行启用才会生效，如果@Profile({"p1","!p2"}) 标识两个属性，那么p1 是启用状态 而p2 是非启用状态的。

@RunWith 和 @ContextConfiguration

Junit4 测试类，用于注解在类上表示通过Junit4 进行测试，可以省略编写启动类代码，是ApplicationContext 等启动类的替换。一般用@RunWith 和 @Configuration 进行单元测试，这是软件开发过程中非常必要而且具有专业性的一部分，上面EnvironmentConfig 类证实了这一点：

@Enable 启动Spring内置功能

详情查阅@EnableAsync，@EnableScheduling，@EnableTransactionManagement，@EnableAspectJAutoProxy，@EnableWebMvc官方文档