【SpringBoot2 从0开始】实现自动配置的过程

简介: 【SpringBoot2 从0开始】实现自动配置的过程

在之前的 helloworld 示例中,已经初步体会到 springboot 自动导入依赖、完成配置的爽快了。


那么,springboot 是如何实现的呢?


一、依赖管理特性


先看下上一篇内容示例中的pom.xml


<!--导入父工程-->
  <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.3.4.RELEASE</version>
  </parent>
  <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
  </dependencies>


这里添加了一个父项目,另外只导入了一个依赖spring-boot-starter-web,最后我们所有相关的包就进来了。


1268169-20210827203303046-437490856.png


整个过程中,无需关心导包问题。


1. 父项目


每一个 springboot 工程都有一个父项目,一般都是用来做依赖管理的。


父项目中可能会申明很多的依赖,那么子项目只要继承了父项目,后续在添加依赖的时候就不需要添加版本号了。


以上述为例,父项目使用的是2.3.4.RELEASE的 springboot 版本,所以下面添加的依赖,就无需再写版本号。


(1)父项目如何管理版本


可以按住ctrl,然后单击这个父项目进入一探究竟。


1268169-20210827204232153-634264264.png


进来后发现他也有一个父项目spring-boot-dependencies


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


继续进入到spring-boot-dependencies,在下面可以看到一个properties标签:


1268169-20210827204611959-2120587303.png


这里几乎声明了全部我们在开发中可能会用到的 jar 包的版本。


继续往下可以看到具体的依赖管理dependencyManagement,这里引用的就是properties里申明的版本。


1268169-20210827205004314-1672685154.png


举个例子:


左侧我看到有个包是logback,那么就在里面搜索下,发现这里定义好的版本就是1.2.3


1268169-20210827205135156-1219726423.png


所以说,父项目的主要功能就是依赖管理,几乎声明了开发中常用的依赖的版本号


(2)使用指定的版本


如果不要使用自动仲裁出的版本,而使用指定版本也是可以的。


比如 mysql 版本,自动仲裁的结果是8.0.21,但是我只想用5.1.43的版本。


1268169-20210827210218476-1677317287.png


添加一个properties标签,在里面申明版本即可。


<properties>
      <mysql.version>5.1.43</mysql.version>
  </properties>


再看下导入的依赖,就已经变成指定的版本了。


1268169-20210827210328133-1025710252.png


2. 场景启动器


再来看下最开始导入的一个依赖spring-boot-starter-web:


<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>


后续会见到更多的以spring-boot-starter命名的启动器。在官方文档里也有详细的说明


1268169-20210827211339967-1548275324.png


什么是 starter?


starter 一组需要依赖的集合描述,也就是通常我们只需要引入一个 starter,那么对应的整个开发场景就会引入了。


比如想开始使用 Spring 和 JPA 进行数据库访问,那么就在项目中引入spring-boot-starter-data-jpa依赖项。


另外,注意这里spring-boot-starter-*开头的是官方的启动器命名方式。


这么说还有非官方的?是的,如果你觉得官方给你的 starter 场景还是不能满足你的使用需要,那么你可以自定义 starter。


但是官方推荐自定义的命名方式使用thirdpartyproject-spring-boot-starter

至于为什么只导入一个 starter 就可以导入整个场景的依赖,其实还是跟上面父项目一样,maven 的依赖特性。


进入到spring-boot-starter-web,往下翻,就可以看到开发 web 场景所用到的依赖了。


1268169-20210827212356711-1915960915.png


所以,以后需要开发哪个场景,只要参考官方文档导入对应的启动器即可。


二、自动配置


这里再回顾一下之前的 helloworld 项目中,springboot 自动配置好了哪些东西:


  • 自动配好 tomcat
  • 自动配好 springMVC
  • 自动配好 web 常见功能,比如:字符编码问题
  • 默认的包结构:主程序所在包以及下面所有子包里的组件都会被默认扫描
  • 各种配置拥有默认值
  • 按需加载所有自动配置项
  • ......


1. 自动配置组件


不管自动配置好什么,步骤都是:先引入、再配置


比如 tomcat,那么前提是先引入了 tomcat 依赖,这就由上面第一部分内容所讲的依赖管理完成,在引入了 web starter 后,自动引入场景。


自动引入了场景,也就引入了这个场景下所用到的各种 jar 包,接下来就是要配置这些内容,比如 tomcat、springMVC 等等。


拿 springMVC 举例,在之前要使用 springMVC,肯定要配置DispatcherServlet,帮我们拦截所有请求。


<servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>


现在看下之前的 helloworld 应用中,springboot 是在哪里帮我们做好配置的。

先看主程序类:


// 标记这是一个 springboot应用,这个类是主程序类,所有启动的入口
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}


可以创建个本地变量(alt+enter),可以看到这个是个ConfigurableApplicationContext类型。


1268169-20210828085442417-76741580.png


@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
    }
}


可以使用getBeanDefinitionNames()方法,查看里面包含了哪些容器,遍历打印出来。


@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        // 返回IOC容器
        final ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        // 查看容器里的组件
        final String[] beanDefinitionNames = run.getBeanDefinitionNames();
        for (String name: beanDefinitionNames) {
            System.out.println(name);
        }
    }
}


接下来启动应用,看下控制台输出。


1268169-20210828090144416-1946986780.png


在控制台输出里ctrl+F搜索下DispatcherServlet


1268169-20210828090305308-61863662.png


发现 IOC 容器中已经有了对应的组件。


2. 默认的包结构


主程序所在包以及下面所有子包里的组件都会被默认扫描,所以我们不需要配置开启组件扫描,也可以正常使用。


但是要注意这里的范围:


1268169-20210828091223862-1810626469.png



示例中就是com.pingguo.boot包下以及所有子包都可以自动扫描。


如果你就是要放到外面,还希望被扫描到,怎么办?


那么可以使用主程序类中@SpringBootApplication注解中的一个属性scanBasePackages,扩大包的范围即可:


@SpringBootApplication(scanBasePackages = "com.pingguo")
public class MainApplication {
    public static void main(String[] args) {
... ...


3. 各种配置拥有默认值


比如 tomcat端口,在application.properties配置文件里使用 idea 输入的时候,就可以看到带有默认值8080:


1268169-20210828092641254-1194879855.png


点击进去可看到后面都是绑定了对应的 java 类。


1268169-20210828093029792-378296443.png


配置文件的值最终会绑定在对应的类上,这个类会在容器中创建对象。


4. 按需加载所有自动配置项


比如应用中只引入了spring-boot-starter-web,那么就只有web场景的自动配置才会开启。


springboot 中的所有自动配置,都在这里:


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


点击spring-boot-starter-web可以找到spring-boot-starter,再进入其中就可以看到spring-boot-autoconfigure


三、小结


经过上面的步骤,我们开发应用就基本可以做到 0 配置,既方便又快捷。


我理解是,springboot 通过各种巧妙的封装,把你可能要用到的场景下的一切都准备好,你需要用直接申明一下(引入场景)就好。


帮助我们彻底摆脱配置地狱,专注于业务。

相关文章
|
Java Spring
springboot的自动配置原理
springboot的自动配置原理
|
2月前
|
Java 容器
springboot自动配置原理
启动类@SpringbootApplication注解下,有三个关键注解 (1)@springbootConfiguration:表示启动类是一个自动配置类 (2)@CompontScan:扫描启动类所在包外的组件到容器中 (3)@EnableConfigutarion:最关键的一个注解,他拥有两个子注解,其中@AutoConfigurationpackageu会将启动类所在包下的所有组件到容器中,@Import会导入一个自动配置文件选择器,他会去加载META_INF目录下的spring.factories文件,这个文件中存放很大自动配置类的全类名,这些类会根据元注解的装配条件生效,生效
|
8月前
|
Java Spring 容器
SpringBoot的自动配置原理(一)
SpringBoot的自动配置原理(一)
|
8月前
|
Java 容器 Spring
Springboot自动配置原理
Springboot自动配置原理
|
8月前
|
Java 数据库连接 容器
[Springboot 源码系列] 浅析自动配置原理
[Springboot 源码系列] 浅析自动配置原理
|
Java
SpringBoot自动配置原理解析(四)
SpringBoot自动配置原理解析(四)
70 1
|
8月前
|
Java
SpringBoot自动配置原理解析(五)
SpringBoot自动配置原理解析(五)
42 0
|
NoSQL Java Redis
SpringBoot自动配置原理解析(一)
SpringBoot自动配置原理解析(一)
86 0
|
Java 容器 Spring
10 SpringBoot自动配置原理
10 SpringBoot自动配置原理
66 0
|
NoSQL 安全 Java
SpringBoot 自动配置的原理|学习笔记
快速学习 SpringBoot 自动配置的原理
187 0
SpringBoot 自动配置的原理|学习笔记