Java教程

springboot起步依赖和自动配置源码解析

本文主要是介绍springboot起步依赖和自动配置源码解析，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

springboot起步依赖和自动配置原理分析

一、springboot起步依赖
1、首先springboot项目创建成功之后我们会看到在pom文件中会继承一个依赖，如下图所示：
在这里插入图片描述
此时我们进入spring-boot-starter-parent依赖包，会发现在此pom文件中又会继承一个依赖包spring-boot-dependencies，如图所示：
在这里插入图片描述
我们先看一下spring-boot-starter-parent依赖包中的内容，在pom.xml中我们会看到这些配置（只叠取到重要部分）,在项目工程中找到src下面的main下面的resources会引入三种类型的配置文件，.yml、.yaml、.properties三种配置文件，我们任选其中的一种类型的配置，在配置文件中配置我们项目中需要的一些配置即可，默认不配置也是可以的。
注意：配置文件的加载顺序是先加载yml文件，然后yaml，最后properties，所以如果存在覆盖（即有相同属性的配置），properties文件的配置会覆盖前两者。
在这里插入图片描述
继续看下面spring-boot-starter-dependencies依赖包中的内容，在pom.xml中我们会看到这些配置（只叠取到重要部分）,我们可以很清晰的看到在这个pom文件中主要管理的是一些依赖组件的相关版本号。即解决了原有项目spring中可能存在依赖版本冲突的问题，也体现了springboot的优点，（解决原有版本冲突问题、配置简单，可以让开发人员不必在配置与逻辑业务之间进行思维的切换，全身心的投入到逻辑业务的代码编写中，从而大大提高了开发效率，也可以缩短项目周期。）
在这里插入图片描述
在继承spring-boot-starter-parent的同时，还需要导入相应的spring-boot-starter-web依赖，我么进入看一下里面的内容如下：

 <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.5.5</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-json</artifactId>
      <version>2.5.5</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-tomcat</artifactId>
      <version>2.5.5</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.3.10</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.3.10</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>

它帮我们导入了web模块正常运行所依赖的组件，这些依赖的版本则有父类进行管理。
总结：在起步依赖上，spring boot帮我们管理了各个依赖的版本，使各个依赖不会出现版本冲突，不需要导入大量的依赖组件，只要引入起步依赖的坐标就可以进行web开发了，大大提高了开发效率。
二、springboot的自动配置
1、springboott每一个启动类上都需要加上解@SpringBootApplication的注解，所以来看下它的源码。
在这里插入图片描述
源码中有一个@SpringBootApplication的注解，我们可以继续进入源码看一下此注解：
在这里插入图片描述
我们可以清除的看到@Configuration注解，这个注解就是我们之前学spring时候的一个注解，该注解的意思就是标志着该类就是一个spring的配置类，所以在这里@SpringBootApplication和@Configuration是等价的。
2、@EnableAutoConfiguration注解 ，根据字面意思可以得出就是启用自动配置，是自动装配的核心注解。
首先我们研究一下@AutoConfigurationPackage注解：
在这里插入图片描述
该注解导入了一个AutoConfigurationPackages.Registrar.class组件，下面就是AutoConfigurationPackages.Registrar.class的源码：
在这里插入图片描述
通过查看源码可以得到@AutoConfigurationPackage的作用：Registrar方法会扫描启动类所在包及其子包下的组件，并注入到IOC的容器中。
然后我们继续看下一个@Import(AutoConfigurationImportSelector.class)。
首先继续查看AutoConfigurationImportSelector源码，主要关注的方法getCandidateConfigurations，下面就是getCandidateConfigurations方法的源码：

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
				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;
	}

在源码中可以看到loadFactoryNames方法，我们继续进入这个方法进行查看，下面是和loadFactoryNames相关的方法源码：

public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
        ClassLoader classLoaderToUse = classLoader;
        if (classLoader == null) {
            classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
        }

        String factoryTypeName = factoryType.getName();
        return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
    }

    private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
        Map<String, List<String>> result = (Map)cache.get(classLoader);
        if (result != null) {
            return result;
        } else {
            HashMap result = new HashMap();

            try {
                Enumeration urls = classLoader.getResources("META-INF/spring.factories");

                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 factoryTypeName = ((String)entry.getKey()).trim();
                        String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                        String[] var10 = factoryImplementationNames;
                        int var11 = factoryImplementationNames.length;

                        for(int var12 = 0; var12 < var11; ++var12) {
                            String factoryImplementationName = var10[var12];
                            ((List)result.computeIfAbsent(factoryTypeName, (key) -> {
                                return new ArrayList();
                            })).add(factoryImplementationName.trim());
                        }
                    }
                }

                result.replaceAll((factoryType, implementations) -> {
                    return (List)implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));
                });
                cache.put(classLoader, result);
                return result;
            } catch (IOException var14) {
                throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var14);
            }
        }
    }

看完此方法方法后，就很容易发现，首先读取类路径下的配置文件，然后循环遍历URL集合，并将URL加载为resource后读取成propertis对象，最后将键和值存入HashMap中并返回。
根据类的配置文件：META-INF/spring.factories这个文件中有一些自动配置信息的类，此文件（META-INF/spring.factories）的路径就是当前类（org.springframework.boot.autoconfigure）所在的位置下面有该自动配置信息类的一些文件。如图所示：
在这里插入图片描述
在上图有一个spring-configuration-metadata.json文件，这些就是springboot默认自动配置的一些信息，比如以springboot嵌入式服务器端口为例，下图就是默认的端口号信息：
在这里插入图片描述
我们知道创建好的springboot项目在启动之后默认的服务器端口后为8080，如果需要修改自定义的端口号，我们只需要在.yml、.yaml、.properties三种配置文件中配置我们自己定义的端口号即可覆盖默认的端口号：这里我以我的.yml文件举例：
在这里插入图片描述
3、@ComponentScan注解，该注解的意思就是主键扫描，因为springboot是基于约定的，所以会扫描springboot启动类所在包及所有子包都会进行扫描。
希望这篇博客对大家能有所帮助。如果各位大佬看到有什么不合适的地方希望能给我指点指点！！！！

这篇关于springboot起步依赖和自动配置源码解析的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！
您可能喜欢
栏目导航