zoukankan      html  css  js  c++  java
  • SpringBoot自动装配原理

    SpringBoot自动装配原理

    SpringBoot如果问到的话就说说

    1. 自动装配(最主要的)
    2. run方法(次要)

    pom.xml

    pom.xml主要有四个部分:
    项目元数据信息:创建时候输入的Project Metadata部分,也就是Maven项目的基本元素,包括:groupId、artifactId、version、name、description等
    parent:继承spring-boot-starter-parent的依赖管理,控制版本与打包等内容
    dependencies:项目具体依赖,这里包含了spring-boot-starter-web用于实现HTTP接口(该依赖中包含了Spring MVC),官网对它的描述是:使用Spring MVC构建Web(包括RESTful)应用程序的入门者,使用Tomcat作为默认嵌入式容器。;spring-boot-starter-test用于编写单元测试的依赖包。更多功能模块的使用我们将在后面逐步展开。
    build:构建配置部分。默认使用了spring-boot-maven-plugin,配合spring-boot-starter-parent就可以把Spring Boot应用打包成JAR来直接运行。

    • spring-boot-dependencies: 核心工程在父工程中
      也就是说我们的项目主要是依赖一个父项目
    <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.1.9.RELEASE</version>
       <relativePath/> <!-- lookup parent from repository -->
    </parent>
    

    进入父项目

    <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-dependencies</artifactId>
      <version>2.1.9.RELEASE</version>
      <relativePath>../../spring-boot-dependencies</relativePath>
    </parent>
    

    这里才是真正管理SpringBoot应用里面所有依赖版本的地方,SpringBoot的版本控制中心;

    以后我们导入依赖默认是不需要写版本;但是如果导入的包没有在依赖中管理着就需要手动配置版本了;

    • 我们在写或者引入一些springboot依赖的时候,不需要指定版本,因为在父工程中有了那些版本仓库

    启动器

    •   <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
      
    • 启动器实际上就是SpringBoot的启动场景。
    • 比如spring-boot-starter-web, 就会帮助项目自动导入Web环境所有的依赖。
    • SpringBoot会将所有的功能场景都变成一个个的启动器。
    • SpringBoot将所有的功能场景都抽取出来,做成一个个的starter (启动器),只需要在项目中引入这些starter即可,所有相关的依赖都会导入进来 , 我们要用什么功能就导入什么样的场景启动器即可 。官网Starters

    主程序

    // @SpringBootApplication 标注下面的这个类是一个SpringBoot的应用
    @SpringBootApplication
    public class HalftownApplication {
        public static void main(String[] args) {
                // 将SpringBoot 应用启动
    	    SpringApplication.run(HalftownApplication.class, args);
        }
    }
    

    注解

    @SpringBootConfiguration : SpringBoot的配置类,标注在某个类上, 表示这是一个SpringBoot的配置类
        @Configuration: Spring配置类,配置类上来标注这个注解,说明这是一个配置类 ,配置类---即----配置文件;
        @Componet: 说明这是一个Spring的组件,启动类本身也是Spring中的一个组件而已,负责启动应用
        
    @EnableAutoConfiguration:开启自动配置功能,以前我们需要自己配置的东西,而现在SpringBoot可以自动帮我们配置,@EnableAutoConfiguration告诉SpringBoot开启自动配置功能,这样自动配置才能生效
        @AutoConfigurationPackage: 自动配置包
            @Import({Registrar.class}): 自动配置包注册器
        @Import({AutoConfigurationImportSelector.class}): 自动配置导入选择器
        (@import :Spring底层注解@import , 给容器中导入一个组件)
        Registrar.class 将主配置类 【即@SpringBootApplication标注的类】的所在包及包下面所有子包里面的所有组件扫描到Spring容器 ;
    
    @ComponentScan:这个注解在Spring中很重要 , 它对应XML配置中的元素。@ComponentScan的功能就是自动扫描并加载符合条件的组件或者bean , 将这个bean定义加载到IOC容器中 ;
    

    最终所有的资源都会加载到配置类中
    Properties properties=PropertiesLoaderUtils. LoadProperties(resource);

    1、@SpringBootApplication
    意义:SpringBoot应用标注在某个类上说明这个类是SpringBoot的主配置类 , SpringBoot就应该运行这个类的main方法来启动SpringBoot应用;

    进入这个注解:可以看到上面还有很多其他注解!

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

    2、@ComponentScan
    ​ 这个注解在Spring中很重要 , 它对应XML配置中的元素。@ComponentScan的功能就是自动扫描并加载符合条件的组件或者bean , 将这个bean定义加载到IOC容器中 ;

    3、@SpringBootConfiguration
    意义:SpringBoot的配置类 ;标注在某个类上 , 表示这是一个SpringBoot的配置类;

    我们继续进去这个注解查看

    @Configuration //点进去得到下面的 @Component
    public @interface SpringBootConfiguration {
    }
    @Component
    public @interface Configuration {
    }
    

    @Configuration:配置类上来标注这个注解,说明这是一个配置类 ,配置类---即----配置文件;

    我们继续点进去,发现配置类也是容器中的一个组件。@Component 。这就说明,启动类本身也是Spring中的一个组件而已,负责启动应用!

    4、@EnableAutoConfiguration
    我们回到 SpringBootApplication 注解中继续看。

    @EnableAutoConfiguration :开启自动配置功能

    ​ 以前我们需要自己配置的东西,而现在SpringBoot可以自动帮我们配置 ; @EnableAutoConfiguration告诉SpringBoot开启自动配置功能,这样自动配置才能生效;

    我们点击去查看。发现注解@AutoConfigurationPackage : 自动配置包

    @AutoConfigurationPackage //自动配置包
    @Import({AutoConfigurationImportSelector.class}) //导入哪些组件的选择器
    public @interface EnableAutoConfiguration {
    }
    

    再点进去看到一个 @Import({Registrar.class})

    @Import({Registrar.class})
    public @interface AutoConfigurationPackage {
    }
    

    @import :Spring底层注解@import , 给容器中导入一个组件

    Registrar.class 将主配置类 【即@SpringBootApplication标注的类】的所在包及包下面所有子包里面的所有组件扫描到Spring容器 ;

    退到上一步,继续看:@Import({AutoConfigurationImportSelector.class}) :给容器导入组件 ;

    AutoConfigurationImportSelector : 自动配置导入选择器,那么它会导入哪些组件的选择器呢? ;

    我们点击去这个类看源码:

    这个类中有一个这样的方法

    // 获得候选的配置
    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        //这里的getSpringFactoriesLoaderFactoryClass()方法
        //返回的就是我们最开始看的启动自动导入配置文件的注解类;EnableAutoConfiguration
        List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
        Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
        return configurations;
    }
    

    这个方法又调用了 SpringFactoriesLoader 类的静态方法!我们进入SpringFactoriesLoader类loadFactoryNames() 方法

    public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
        String factoryClassName = factoryClass.getName();
        //这里它又调用了 loadSpringFactories 方法
        return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
    }
    

    我们继续点击查看 loadSpringFactories 方法

    private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        //获得classLoader , 我们返回可以看到这里得到的就是EnableAutoConfiguration标注的类本身
        MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
        if (result != null) {
            return result;
        } else {
            try {
                //去获取一个资源 "META-INF/spring.factories"
                Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
                LinkedMultiValueMap result = new LinkedMultiValueMap();
    
                //将读取到的资源遍历,封装成为一个Properties
                while(urls.hasMoreElements()) {
                    URL url = (URL)urls.nextElement();
                    UrlResource resource = new UrlResource(url);
                    Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                    Iterator var6 = properties.entrySet().iterator();
    
                    while(var6.hasNext()) {
                        Entry<?, ?> entry = (Entry)var6.next();
                        String factoryClassName = ((String)entry.getKey()).trim();
                        String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                        int var10 = var9.length;
    
                        for(int var11 = 0; var11 < var10; ++var11) {
                            String factoryName = var9[var11];
                            result.add(factoryClassName, factoryName.trim());
                        }
                    }
                }
    
                cache.put(classLoader, result);
                return result;
            } catch (IOException var13) {
                throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
            }
        }
    }
    

    我们根据源头打开spring.factories的配置文件 , 看到了很多自动配置的文件;这就是自动配置根源所在!

    WebMvcAutoConfiguration

    我们在上面的自动配置类随便找一个打开看看,比如 : WebMvcAutoConfiguration


    可以看到这些一个个的都是JavaConfig配置类,而且都注入了一些Bean,可以找一些自己认识的类,看着熟悉一下!

    所以,
    META-INF/spring.factories: 自动配置的的核心文件

    springboot所有自动配置都是在启动的时候扫描并加载:spring.factories所有的自动配置类都在这里面,但是不一定生效,要判断条件是否成立,只要导入了对应的start,就有对应的启动器了,有了启动器,我们自动装配就会生效,然后就配置成功!

    所以,自动配置真正实现是从classpath中搜寻所有的META-INF/spring.factories配置文件 ,并将其中对应的 org.springframework.boot.autoconfigure. 包下的配置项,通过反射实例化为对应标注了 @Configuration的JavaConfig形式的IOC容器配置类 , 然后将这些都汇总成为一个实例并加载到IOC容器中。

    下图请放大认真食用

    结论:

    1. SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值
    2. 将这些值作为自动配置类导入容器 , 自动配置类就生效 , 帮我们进行自动配置工作;
    3. 以前我们需要自己配置的东西 , 自动配置类都帮我们解决了
    4. 整个J2EE的整体解决方案和自动配置都在springboot-autoconfigure的jar包中;
    5. 它将所有需要导入的组件以全类名的方式返回 , 这些组件就会被添加到容器中 ;
    6. 它会给容器中导入非常多的自动配置类 (xxxAutoConfiguration), 就是给容器中导入这个场景需要的所有组件 , 并配置好这些组件 ;
    7. 有了自动配置类 , 免去了我们手动编写配置注入功能组件等的工作;

    Run
    我最初以为就是运行了一个main方法,没想到却开启了一个服务;

    @SpringBootApplication
    public class SpringbootDemo02Application {

    public static void main(String[] args) {
        //该方法返回一个ConfigurableApplicationContext对象
        //参数一:应用入口的类     参数类:命令行参数
        SpringApplication.run(SpringbootDemo02Application.class, args);
    }
    

    }

    SpringApplication.run分析

    分析该方法主要分两部分:

    • 一是SpringApplication的实例化,
    • 二是run方法的执行;

    SpringApplication
    这个类主要做了以下四件事情

    • 推断应用的类型是普通的项目还是Web项目
    • 查找并加载所有可用初始化器 , 设置到initializers属性中
    • 找出所有的应用程序监听器,设置到listeners属性中
    • 推断并设置main方法的定义类,找到运行的主类

    查看构造器

    public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
        this.sources = new LinkedHashSet();
        this.bannerMode = Mode.CONSOLE;
        this.logStartupInfo = true;
        this.addCommandLineProperties = true;
        this.addConversionService = true;
        this.headless = true;
        this.registerShutdownHook = true;
        this.additionalProfiles = new HashSet();
        this.isCustomEnvironment = false;
        this.resourceLoader = resourceLoader;
        Assert.notNull(primarySources, "PrimarySources must not be null");
        this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
        this.webApplicationType = WebApplicationType.deduceFromClasspath();
        this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
        this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
        this.mainApplicationClass = this.deduceMainApplicationClass();
    }
    

    run方法

    部分内容来自于秦疆のJava世界

  • 相关阅读:
    老树新芽,在ES6下使用Express
    Swift3翻天覆地的改变
    NodeJs回调操作Promise化
    Node的关系型数据库ORM库:bookshelf
    基于Node的PetShop,RESTful API以及认证
    基于Node的PetShop,oauth2认证RESTful API
    Mongoose轻松搞定MongoDB,不要回调!
    Thymeleaf常用语法:表达式语法之运算符
    Thymeleaf对象的使用:日期对象
    Thymeleaf对象的使用:字符串对象
  • 原文地址:https://www.cnblogs.com/lskreno/p/12221241.html
Copyright © 2011-2022 走看看