SpringBoot2自动装配与原理

最新推荐文章于 2024-06-21 22:23:19 发布

mimiboss

最新推荐文章于 2024-06-21 22:23:19 发布

阅读量733

点赞数 27

文章标签： java 开发语言 springboot 源代码管理

本文链接：https://blog.csdn.net/Cw_Herry/article/details/139688803

版权

1. 自动装配

自动装配通过xxxProperties.class来进行
由父包提供的autoconfigure依赖进行自动装配

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-autoconfigure</artifactId>
  <version>2.3.4.RELEASE</version>
</dependency>

1.1 自定义配置组件(Full、Lite)

通过自定义Bean，将Bean注入到Spring组件中。
自定义注册后，容器中组件名称默认以方法名为组件ID，所以可以在容器中看到已经注册的getTom组件
通过getBeanDefinitionNames方法打印所有组件，可以看到已经存在getTom
容器默认单例对象（singleton）

@Configuration
public class SpringConsumerBean {
    @Bean
    public Tom getTom() {
        return new Tom();
    }
}

配置类自身也是组件，通过proxyBeanMethods来确定当前配置类是否被容器代理。
通过获取配置类组件，来对组件的调用。
proxyBeanMethods：
1. true（Full mode）： com.mimiboss.springbootx.SpringbootxApplication$$EnhancerBySpringCGLIB$$f1fdc31@72889280 ，配置类被CGLIB所代理。生成的对象都将是单例的。
2. false（Lite mode）： com.mimiboss.springbootx.SpringbootxApplication@7cc9ce8 ，配置类为JDK创建的实例。通过配置类Bean获取内部Bean时是多例的。
单例：在容器不管获取多少次Bean，equals都是true。
多例：获取两次Bean，equals为false。
应用场景：可以解决Bean依赖。
1. 当配置类中存在依赖时，使用Full mode，产生的依赖都是单例的。
2. 当配置类中不存在依赖时，使用Lite mode，可以更快的创建容器，减少判断。

@SpringBootApplication(proxyBeanMethods = true)
public class SpringbootxApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootxApplication.class, args);
        String[] beanDefinitionNames = run.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println(beanDefinitionName);
        }
        System.out.println(run.getBean("springbootxApplication"));
    }

    @Bean
    public Tom getTom() {
        return new Tom();
    }

}

1.2 @Import

自定组件进行导入，默认组件名为该组件的全限定。

@Import({Tom.class, DBHelper.class})
@SpringBootApplication(proxyBeanMethods = true)
public class SpringbootxApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootxApplication.class, args);
        String[] beanNamesForType = run.getBeanNamesForType(Tom.class);
        for (String s : beanNamesForType) {
            System.out.println(s);
        }
        System.out.println(run.getBean(DBHelper.class));
    }

    @Bean
    public Tom getTom() {
        return new Tom();
    }

}
/**
 * com.mimiboss.springbootx.eneity.Tom
 * getTom
 * ch.qos.logback.core.db.DBHelper@6c000e0c
 */

1.3 Conditional

满足Conditional指定的条件，则进行组件注入

@Import({Tom.class, DBHelper.class})
@SpringBootApplication
public class SpringbootxApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootxApplication.class, args);
        // true  如果容器中不存在DBHelper则为 false
        System.out.println("getTom = " + run.containsBean("getTom"));
    }

    /**
     * 当DBHelper在容器中存在时，对Tom进行装配
     **/
    @ConditionalOnBean(value = {DBHelper.class})
    @Bean
    public Tom getTom() {
        return new Tom();
    }

}

1.4 ImportResource

从外部引入配置文件、配置类

@Import({Tom.class, DBHelper.class})
@SpringBootApplication
// 从外部导入配置
@ImportResource("classpath:bean.xml")
public class SpringbootxApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootxApplication.class, args);
        System.out.println("xmlbean = " + run.containsBean("xmlbean"));
    }

    @ConditionalOnBean(value = {DBHelper.class})
    @Bean
    public Tom getTom() {
        return new Tom();
    }

}

1.5 ConfigurationProperties

自动装配属性，将当前类的所有属性进行自动装配，与application.yaml、application.properties中声明的属性值进行绑定。
添加自动装配类到容器：

1. 自动装配的类，添加Component注解。
2. 在启动类上添加EnableConfigurationProperties注解指定某个类为自动装配类

/**
 * @author 小猫儿老板
 * @version 1.0
 * @date 2024-6-12 11:21
 */
@Component
@ConfigurationProperties(prefix = "consumer")
public class ConsumerProperties {

    private String active;

    private String activeTime;

}

@SpringBootApplication
@EnableConfigurationProperties(ConsumerProperties.class)
public class SpringbootxApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootxApplication.class, args);
    }
}

2. 自动装配原理

分析SpringBootApplication注解

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
        type = FilterType.CUSTOM,
        classes = {TypeExcludeFilter.class}
    ), @Filter(
        type = FilterType.CUSTOM,
        classes = {AutoConfigurationExcludeFilter.class}
    )}
)
public class SpringbootxApplication{
    
}

2.1. SpringBootConfiguration

表示当前类是一个注解类

2.2. ComponentScan

扫描组件

2.3. EnableAutoConfiguration

开启自动配置注解

@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {

2.3.1. AutoConfigurationPackage

只加载当前项目的所有组件。@Import({Registrar.class})导入Registrar类。不只是引入了Registrar类，而是引入了(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames()，也就是当前启动类所在的包。这也就说明了为什么SpringBoot的所有需要加载的类需要写在启动类包下或者子包下。

2.3.2. Import({AutoConfigurationImportSelector.class})

完成所需依赖的组件注册以及配置加载。

1. 用于加载所需依赖的配置， AutoConfigurationImportSelector.selectImports(){ this.getAutoConfigurationEntry(annotationMetadata); }
2. 获取所有依赖的自动装配全限定名称， List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
3. 工厂加载器加载全限定名称， SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
4. 最终得到需要加载的全限定类名的列表， (List)loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
5. 加载依赖下的spring.factories配置文件，ClassLoader.getSystemResources("META-INF/spring.factories")
6. 通过Spring的按需加载（Conditional）进行装配，@Conditionalxx注解

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
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.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration,\
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.cassandra.CassandraReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRestClientAutoConfiguration,\
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.neo4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcTransactionManagerAutoConfiguration,\
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.rest.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
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.JndiDataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,\
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.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration,\
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.r2dbc.R2dbcAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketRequesterAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketServerAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketStrategiesAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveUserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.rsocket.RSocketSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.saml2.Saml2RelyingPartyAutoConfiguration,\
org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.servlet.OAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.reactive.ReactiveOAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.reactive.ReactiveOAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,\
org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,\
org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
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,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAutoConfiguration

最后为我们筛选了127个需要装载的类，最后通过按需加载进行过滤，得到真正需要装配的类。

2.3.3. 按需加载

通过Conditionalxxx等注解来表示当前的xxxAutoConfiguration自动装配类是否生效。
xxxAutoConfiguration -> xxxProperties -> xxxx.properties配置文件

// 在容器中有DispatcherServlet时才会去自动装配
@ConditionalOnClass({DispatcherServlet.class})
// 在ServletWebServerFactoryAutoConfiguration配置之后进行
@AutoConfigureAfter({ServletWebServerFactoryAutoConfiguration.class})
public class DispatcherServletAutoConfiguration {
    // dispatcherServlet 默认名称   规定的
    public static final String DEFAULT_DISPATCHER_SERVLET_BEAN_NAME = "dispatcherServlet";
    public static final String DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME = "dispatcherServletRegistration";

    @Configuration(proxyBeanMethods = false)
    @Conditional({DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition.class})
    @ConditionalOnClass({ServletRegistration.class})
    @EnableConfigurationProperties({WebMvcProperties.class})
    protected static class DispatcherServletConfiguration {
        protected DispatcherServletConfiguration() {
        }

        // 将DispatcherServlet加到容器中  通过WebMvcProperties中的配置属性去加载
        @Bean(name = {"dispatcherServlet"})
        public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
            DispatcherServlet dispatcherServlet = new DispatcherServlet();
            dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
            dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
            dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
            dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
            dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
            return dispatcherServlet;
        }

        // 文件上传解析器  防止用户注册文件上传解析器时的空间限定名称不正确 
        // MultipartResolver 在容器中的全限定名称必须是 multipartResolver, 当用户需要注册是 直接传递MultipartResolver即可
        // SpringBoot会自动将传递的MultipartResolver注入到容器中  且空间限定名称为 multipartResolver
        @Bean
        @ConditionalOnBean({MultipartResolver.class})
        @ConditionalOnMissingBean(
            name = {"multipartResolver"}
        )
        public MultipartResolver multipartResolver(MultipartResolver resolver) {
            return resolver;
        }
    }
}

2.3.4. debug

通过设置debug配置来看SPRINGboot中那些加载了那些没加载。

Negative（未加载）
Positive（加载）

debug: true

mimiboss

关注

27
点赞
踩
19

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot2自动装配与原理

通过自定义Bean，将Bean注入到Spring组件中。自定义注册后，容器中组件名称默认以方法名为组件ID，所以可以在容器中看到已经注册的getTom组件通过getBeanDefinitionNames方法打印所有组件，可以看到已经存在getTom容器默认单例对象（singleton）@Bean配置类自身也是组件，通过proxyBeanMethods来确定当前配置类是否被容器代理。通过获取配置类组件，来对组件的调用。
复制链接

扫一扫