美文网首页应用开发与调优
SpringBoot核心原理-自动配置

SpringBoot核心原理-自动配置

作者: 沉沦2014 | 来源:发表于2018-08-06 17:25 被阅读11次

    概念:

    Spring Boot是由Pivotal团队提供的全新框架,属于spring旗下的一个项目,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,它使用“习惯优于配置”的理念。得益于“习惯优于配置”这个理念,再也没有繁琐的配置、难以集成的内容(大多数流行第三方技术都被集成在内)。

    Spring boot关于自动配置的源码在spring-boot-autoconfigure-x.x.x.x.jar中

    运行原理:

    入口注解@SpringBootApplication注解是一个组合注解,有了它马上就能够让整个应用跑起来。实际上它只是一个组合注解,包含@Configuration、@EnableAutoConfiguration、@ComponentScan这三个注解。

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @Configuration
    @EnableAutoConfiguration
    @ComponentScan
    public @interface SpringBootApplication {
        Class<?>[] exclude() default {};
        String[] excludeName() default {};
        @AliasFor(
            annotation = ComponentScan.class,
            attribute = "basePackages"
        )
        String[] scanBasePackages() default {};
        @AliasFor(
            annotation = ComponentScan.class,
            attribute = "basePackageClasses"
        )
        Class<?>[] scanBasePackageClasses() default {};
    

    它的核心功能是由@EnableAutoConfiguration这个注解提供的,@EnableAutoConfiguration的源代码:

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import({EnableAutoConfigurationImportSelector.class})
    public @interface EnableAutoConfiguration {
        Class<?>[] exclude() default {};
        String[] excludeName() default {};
    

    这里的关键功能是@Import注解导入的配置功能,EnableAutoConfigurationImportSelector使用SpringFactoriesLoader.loadFactoryNames方法来扫描具有META-INF/spring.factories文件的所有jar包,spring-boot-autoconfigure-x.x.x.x.jar里就有一个spring.factories文件,这个文件中声明了有哪些要自动配置。

    下面分析一下spring boot autoconfigure里面的MongoAutoConfiguration(mongodb的自动配置),就会明白这套自动配置机制到底是怎么回事:

    //
    // Source code recreated from a .class file by IntelliJ IDEA
    // (powered by Fernflower decompiler)
    //
    package org.springframework.boot.autoconfigure.mongo;
    import com.mongodb.MongoClient;
    import com.mongodb.MongoClientOptions;
    import java.net.UnknownHostException;
    import javax.annotation.PreDestroy;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.boot.autoconfigure.mongo.MongoProperties;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.env.Environment;
    @Configuration
    @ConditionalOnClass({MongoClient.class})  
    @EnableConfigurationProperties({MongoProperties.class}) //开启属性注入。
    @ConditionalOnMissingBean(
        type = {"org.springframework.data.mongodb.MongoDbFactory"}
    ) 
    public class MongoAutoConfiguration {
        @Autowired
        private MongoProperties properties;
        @Autowired(
            required = false
        )
        private MongoClientOptions options;
        @Autowired
        private Environment environment;
        private MongoClient mongo;
        public MongoAutoConfiguration() {
        }
        @PreDestroy
        public void close() {
            if(this.mongo != null) {
                this.mongo.close();
            }
        }
        @Bean //使用java配置,当容器中没有这个bean的时候执行初始化
        @ConditionalOnMissingBean
        public MongoClient mongo() throws UnknownHostException {
            this.mongo = this.properties.createMongoClient(this.options, this.environment);
            return this.mongo;
        }
    

    首先类MongoAutoConfiguration被 @Configuration注解了,是一个配置类,当满足以下条件这个bean被装配:

    • 当MongoClient在类路径下。
    • 当容器中没有org.springframework.data.mongodb.MongoDbFactory这类bean的时候。

    此外,我们可以看一下通过@EnableConfigurationProperties({MongoProperties.class}) 自动注入的属性(这是习惯优于配置的最终落地点):

    @ConfigurationProperties(
        prefix = "spring.data.mongodb"
    )
    public class MongoProperties {
        public static final int DEFAULT_PORT = 27017;
        private String host;
        private Integer port = null;
        private String uri = "mongodb://localhost/test";
        private String database;
        private String authenticationDatabase;
        private String gridFsDatabase;
        private String username;
        private char[] password;
        private Class<?> fieldNamingStrategy;
    

    所以在我们什么都不干的情况下,只需要引入spring-data-mongodb这个依赖再加上默认的MongoDB server我们就能够快速集成MongoDB,用MongodbTemplate访问数据库。

    同时我们可以通过在application.yaml中修改spring.data.mongodb相关的参数就能够修改连接配置,如:

    spring:
        data:
            mongodb:
                host: localhost
                port: 27017
                username: user
                password: 123
                database: testdatabase
    

    利用这套原理,我们也可以轻松地把目前spring boot还未集成的、我们自己要使用的第三方技术自动集成起来。

    附:常见org.springframework.boot.autoconfigure.condition包下的条件注解意思

    @ConditionalOnBean:当容器里有指定的bean的条件下。

    @ConditionalOnMissingBean:当容器里不存在指定bean的条件下。

    @ConditionalOnClass:当类路径下有指定类的条件下。

    @ConditionalOnMissingClass:当类路径下不存在指定类的条件下。

    @ConditionalOnProperty:指定的属性是否有指定的值,比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true),代表当xxx.xxx为enable时条件的布尔值为true,如果没有设置的情况下也为true。

    总结

    @EnableAutoConfiguration 作用
    从classpath中搜索所有META-INF/spring.factories配置文件然后,将其中org.springframework.boot.autoconfigure.EnableAutoConfiguration key对应的配置项加载到spring容器
    只有spring.boot.enableautoconfiguration为true(默认为true)的时候,才启用自动配置
    @EnableAutoConfiguration还可以进行排除,排除方式有2中,一是根据class来排除(exclude),二是根据class name(excludeName)来排除
    其内部实现的关键点有
    1)ImportSelector 该接口的方法的返回值都会被纳入到spring容器管理中
    2)SpringFactoriesLoader 该类可以从classpath中搜索所有META-INF/spring.factories配置文件,并读取配置

    相关文章

      网友评论

        本文标题:SpringBoot核心原理-自动配置

        本文链接:https://www.haomeiwen.com/subject/qkugvftx.html