Spring Boot（03）——自动配置

阅读更多

Spring Boot 自动配置

Spring Boot的自动配置功能会根据Classpath中的Class为我们自动创建相应的bean。比如当classpath下存在MongoClient.class和MongoTemplate.class时就会进行Spring Data MongoDB的配置。这是通过MongoDataAutoConfiguration类配置的。下面是MongoDataAutoConfiguration类的定义，可以看到上面使用了@Configuration注解定义，且通过@ConditionalOnClass注解指定了只有在存在MongoClient.class和MongoTemplate.class时才会生效。@EnableConfigurationProperties指定了可以使用的配置属性类，Spring Boot会自动生成对应类型的bean，以供我们在自动配置类中进行依赖注入。@AutoConfigureAfter定义了该自动配置类生效的位置，下面代码指定了将在MongoAutoConfiguration配置类之后生效。

@Configuration
@ConditionalOnClass({ MongoClient.class, MongoTemplate.class })
@EnableConfigurationProperties(MongoProperties.class)
@AutoConfigureAfter(MongoAutoConfiguration.class)
public class MongoDataAutoConfiguration {
    //...省略
}

上面的配置类又定义了很多的bean，如下是简单的两个示例。其中通过 @ConditionalOnMissingBean(MongoDbFactory.class)指定了在没有定义MongoDbFactory类型的bean时将通过mongoDbFactory()创建一个类型为SimpleMongoDbFactory的bean。指定了在不存在MongoTemplate类型的bean时将通过mongoTemplate()创建一个MongoTemplate类型的bean（@ConditionalOnMissingBean不指定类型时，默认取方法返回类型）。

@Configuration
@ConditionalOnClass({ MongoClient.class, MongoTemplate.class })
@EnableConfigurationProperties(MongoProperties.class)
@AutoConfigureAfter(MongoAutoConfiguration.class)
public class MongoDataAutoConfiguration {
    private final ApplicationContext applicationContext;

    private final MongoProperties properties;

    public MongoDataAutoConfiguration(ApplicationContext applicationContext,
            MongoProperties properties) {
        this.applicationContext = applicationContext;
        this.properties = properties;
    }

    @Bean
    @ConditionalOnMissingBean(MongoDbFactory.class)
    public SimpleMongoDbFactory mongoDbFactory(MongoClient mongo) {
        String database = this.properties.getMongoClientDatabase();
        return new SimpleMongoDbFactory(mongo, database);
    }

    @Bean
    @ConditionalOnMissingBean
    public MongoTemplate mongoTemplate(MongoDbFactory mongoDbFactory,
            MongoConverter converter) {
        return new MongoTemplate(mongoDbFactory, converter);
    }
    //...省略
}

@ConditionalOnMissingBean除了可以通过类型指定缺失的bean外，还可以通过bean名称指定缺失的bean。 除了上面提到的Conditional注解外，Spring Boot还提供了很多Conditional注解，它们都定义在org.springframework.boot.autoconfigure.condition包中，详情可以参考对应的API文档。

上面是基于MongoDataAutoConfiguration自动配置类举的一个例子，其它自动配置类也是采用类似的形式进行定义的，它们都定义在spring-boot-autoconfigure-xxx.jar中。通过上面的介绍我们知道，如果我们不想使用自动配置的bean，则可以定义自己的bean。这样自动配置的bean就不会生效了。自动配置的bean生效的条件是多种多样的，具体可以参考对应的AutoConfiguration类。

如果不想使用某个自动配置，则可以通过@SpringBootApplication的exclude属性指定需要排除的自动配置类。如下代码就指定了将排除MongoDataAutoConfiguration自动配置类。

@SpringBootApplication(exclude = { MongoDataAutoConfiguration.class })
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

也可以通过excludeName指定需要排除的自动配置类的全路径名称。

@SpringBootApplication(excludeName = { "org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration" })
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

如果期望看到哪些自动配置类进行了自动配置，可以在启动参数中添加--debug，则日志中会输出自动配置结果，类似于下面这样的。

============================
CONDITIONS EVALUATION REPORT
============================


Positive matches:
-----------------

   AopAutoConfiguration matched:
      - @ConditionalOnClass found required classes 'org.springframework.context.annotation.EnableAspectJAutoProxy', 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice', 'org.aspectj.weaver.AnnotatedElement'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnProperty (spring.aop.auto=true) matched (OnPropertyCondition)

   AopAutoConfiguration.CglibAutoProxyConfiguration matched:
      - @ConditionalOnProperty (spring.aop.proxy-target-class=true) matched (OnPropertyCondition)

   CodecsAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.http.codec.CodecConfigurer'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)

   CodecsAutoConfiguration.JacksonCodecConfiguration matched:
      - @ConditionalOnClass found required class 'com.fasterxml.jackson.databind.ObjectMapper'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)

Spring Boot提供的自动配置的配置类都在spring-boot-autoconfigure-xxx.jar的META-INF/spring.factories文件中配置，对应的配置Key是org.springframework.boot.autoconfigure.EnableAutoConfiguration。如果需要实现自己的自动配置类，也需要在Classpath下的META-INF/spring.factories文件中做相同的配置。

（注：本文是基于Spring Boot 2.0.3所写）