详解Spring Boot自动装配的方法步骤

2023-08-22 12:42:05 164

在《SpringBootHelloWorld》中介绍了一个简单的springboot例子，体验了springboot中的诸多特性，其中的自动配置特性极大的简化了程序开发中的工作(不用写一行XML)。本文我们就来看一下springboot是如何做到自动配置的。
首先阐明，springboot的自动配置是基于springframework提供的特性实现的，所以在本文中，我们先介绍springframework的相关特性，在了解了这些基础知识后，我们再来看springboot的自动配置是如何实现的。

基于Java代码对Spring进行配置

在以往使用springframework进行程序开发时，相信大家也只是使用XML搭配注解的方式对spring容器进行配置，例如在XML文件中使用指定spring需要扫描package的根路径。

除了使用XML对spring进行配置，还可以使用Java代码执行完全相同的配置。下面我们详细看一下如何使用Java代码对spring容器进行配置，详细内容可参考这里。

使用Java代码进行spring配置，有两个核心注解@Configuration和@Bean：

@Configuration
publicclassAppConfig{

@Bean
publicSampleServicesampleService(){
returnnewSampleServiceImpl();
}
}

@Bean注解用于修饰方法，方法的返回值会作为一个bean装载到spring容器中。bean的id就是方法的名字。

@Configuration注解用于修饰一个类，它表明这个类的作用是用来对spring容器进行配置的。

上面的Java代码相当于下面的XML配置：

使用AnnotationConfigApplicationContext类构建一个spring容器，从容器中取出对应的bean的测试代码如下：

publicstaticvoidmain(String[]args){
ApplicationContextctx=newAnnotationConfigApplicationContext(AppConfig.class);
SampleServicemyService=ctx.getBean("sampleService",SampleService.class);
myService.doService();
}

Java代码配置ComponentScan

使用@ComponentScan注解指定需要扫描package的根路径：

@Configuration
@ComponentScan(basePackages="com.**.service.impl")
publicclassAppConfig{

}

上面的Java代码相当于下面的XML配置：

此外，AnnotationConfigApplicationContext类还提供了scan方法用于指定要扫描的包路径。我们可以删除AppConfig类上的@ComponentScan注解，在构造spring容器时使用下面代码：

publicstaticvoidmain(String[]args){
AnnotationConfigApplicationContextctx=newAnnotationConfigApplicationContext();
ctx.scan("com.**.service.impl");
ctx.refresh();
SampleServicemyService=ctx.getBean("sampleService",SampleService.class);
myService.doService();
}

使用@Import组合多个配置

将所有的spring配置全部放在同一个类中肯定是不合适的，这会导致那个配置类非常复杂。通常会创建多个配置类，再借助@Import将多个配置类组合成一个。@Import的功能类似于XML中的。

@Configuration
publicclassConfigA{

@Bean
publicAa(){
returnnewA();
}
}

@Configuration
@Import(ConfigA.class)
publicclassConfigB{

@Bean
publicBb(){
returnnewB();
}
}

上面的代码分别创建了两个配置类ConfigA和ConfigB，它们分别定义了a和b两个Bean。在ConfigB上使用@Import注解导入ConfigA的配置，此时应用代码如果加载ConfigB的配置，就自动也加载了ConfigA的配置。如下代码所示：

publicstaticvoidmain(String[]args){
//只加载ConfigB一个配置类，但同时也包含了ConfigA的配置
ApplicationContextctx=newAnnotationConfigApplicationContext(ConfigB.class);

Aa=ctx.getBean(A.class);
Bb=ctx.getBean(B.class);

System.out.println(a);
System.out.println(b);
}

@Import还可以同时导入多个配置类。当有多个配置类需要同时导入时，示意代码如下：

@Configuration
@Import({ServiceConfig.class,RepositoryConfig.class})
publicclassSystemTestConfig{

@Bean
publicDataSourcedataSource(){
//returnnewDataSource
}
}

条件注解@Conditional

@Conditional注解根据某一个条件是否成立来判断是否构建Bean。借助Condition接口可以表示一个特定条件。例如下面代码实现了一个条件，当然这个条件始终成立：

publicclassSampleConditionimplementsCondition{

@Override
publicbooleanmatches(ConditionContextconditionContext,AnnotatedTypeMetadataannotatedTypeMetadata){
//如果条件成立返回true，反之返回false
returntrue;
}
}

有了表达条件的类SampleCondition，接下来我们就可以通过@Conditional注解对创建bean的函数进行配置：

请输入代码@Configuration

publicclassConditionConfig{

//只有当满足SampleCondition指定的条件时，参会构造id时sampleBean这个bean。当然这里的条件始终成立
@Conditional(SampleCondition.class)
@Bean
publicSampleBeansampleBean(){
returnnewSampleBean();
}
}

由于SampleCondition的matches方法返回true，表示创建bean的条件成立，所以sampleBean会被创建。如果matches返回false，sampleBean就不会被构建。

在springboot中，根据这个原理提供了很多@ConditionOnXXX的注解，这些注解都在包org.springframework.boot.autoconfigure.condition下面。例如比较常见的@ConditionalOnClass注解，这个注解的判断逻辑是只有指定的某个类在classpath上存在时，判断条件才成立。@ConditionalOnClass的具体代码如下：

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public@interfaceConditionalOnClass{

Class[]value()default{};

String[]name()default{};
}

@ConditionalOnClass具体的判断逻辑可参看OnClassCondition类。

@SpringBootApplication注解

介绍完前面这些基础的知识后，我们来看SpringBoot是如何实现自动装配的。
《SpringBoot官方文档第14章》推荐在程序的mainclass上使用注解@SpringBootApplication对Spring应用进行自动配置，我们就从分析这个注解开始。下面是@SpringBootApplication主要代码：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters={
@Filter(type=FilterType.CUSTOM,classes=TypeExcludeFilter.class),
@Filter(type=FilterType.CUSTOM,
classes=AutoConfigurationExcludeFilter.class)})
public@interfaceSpringBootApplication{
//...

@SpringBootApplication是一个组合注解，主要由@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan三个注解构成。

@SpringBootConfiguration表明被标注的类提供了SpringBoot应用的配置，其实这个注解与@Configuration注解的功能类似。
@ComponentScan指定需要扫描package的路径，@SpringBootApplication也提供了相应属性，指定需要扫描哪些package或不扫描哪些package。《SpringBoot官方文档》建议将应用的mainclass放置于整个工程的根路径，并用@SpringBootApplication注解修饰mainclass，这样整个项目的子package就都会被自动扫描包含。建议的工程结构如下所示，其中Application就是应用的mainclass。

com
+-example
+-myapplication
+-Application.java
|
+-customer
|+-Customer.java
|+-CustomerController.java
|+-CustomerService.java
|+-CustomerRepository.java
|
+-order
+-Order.java
+-OrderController.java
+-OrderService.java
+-OrderRepository.java

@EnableAutoConfiguration是这里最重要的注解，它实现了对SpringBoot应用自动装配的功能。@EnableAutoConfiguration是利用SpringFactoriesLoader机制加载自动装配配置的，它的配置数据在META-INF/spring.factories中，我们打开spring-boot-autoconfigurejar中的该文件，发现EnableAutoConfiguration对应着N多XXXAutoConfiguration配置类，我们截取几个重要的配置类如下(已经删除了很多)：

#AutoConfigure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudServiceConnectorsAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jdbc.JdbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.rest.RestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,\
org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,\
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,\
org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration,\
org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration,\
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,\
org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,\
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,\
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,\
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\

可以看到SpringBoot提供了N多XXXAutoConfiguration类，有SpringFramework的、Web的、redis的、JDBC的等等。
我们从其中选择HttpEncodingAutoConfiguration这个类来看下它是如何实现自动配置的：

@Configuration
@EnableConfigurationProperties(HttpProperties.class)
@ConditionalOnWebApplication(type=ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix="spring.http.encoding",value="enabled",
matchIfMissing=true)
publicclassHttpEncodingAutoConfiguration{

privatefinalHttpProperties.Encodingproperties;

publicHttpEncodingAutoConfiguration(HttpPropertiesproperties){
this.properties=properties.getEncoding();
}

@Bean
@ConditionalOnMissingBean
publicCharacterEncodingFiltercharacterEncodingFilter(){
CharacterEncodingFilterfilter=newOrderedCharacterEncodingFilter();
filter.setEncoding(this.properties.getCharset().name());
filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
returnfilter;
}

上面代码表示，只有在满足如下条件时，才会注入characterEncodingFilter这个bean：

只有在WebApplication的情况
classpath上必须存在CharacterEncodingFilter类
配置文件中配置了spring.http.encoding.enabled为true或者没有配置
Spring容器中不存在类型为CharacterEncodingFilter的bean

总结

SpringBoot自动装配的原理并不是非常复杂，其实背后的主要原理就是条件注解。

当我们使用@EnableAutoConfiguration注解激活自动装配时，实质对应着很多XXXAutoConfiguration类在执行装配工作，这些XXXAutoConfiguration类是在spring-boot-autoconfigurejar中的META-INF/spring.factories文件中配置好的，@EnableAutoConfiguration通过SpringFactoriesLoader机制创建XXXAutoConfiguration这些bean。XXXAutoConfiguration的bean会依次执行并判断是否需要创建对应的bean注入到Spring容器中。

在每个XXXAutoConfiguration类中，都会利用多种类型的条件注解@ConditionOnXXX对当前的应用环境做判断，如应用程序是否为Web应用、classpath路径上是否包含对应的类、Spring容器中是否已经包含了对应类型的bean。如果判断条件都成立，XXXAutoConfiguration就会认为需要向Spring容器中注入这个bean，否则就忽略。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

详解Spring Boot自动装配的方法步骤

热门推荐

随机推荐