约定优于配置设计范式及Spring Boot源码剖析

依赖管理

在Spring Boot入门程序中,项目pom.xml文件中有两个核心依赖,分别是spring-boot-starter-parent和spring-boot-starter-web,关于这两个依赖的相关介绍具体如下:

为何导入dependency时不需要指定版本号呢?首先在父依赖中指定了实际开发所依赖的版本号,当然是可以修改的。



    org.springframework.boot
    spring-boot-starter-parent
    2.3.1.RELEASE
     

按住"ctrl+鼠标左键"进入spring-boot-starter-parent底层源文件,会进入到下面图示的文件中。

约定优于配置设计范式及Spring Boot源码剖析_第1张图片

可以看到这个文件中依然有一个父依赖spring-boot-dependencies,其他配置信息并不是我们想找的,再继续追踪这个父依赖。 

约定优于配置设计范式及Spring Boot源码剖析_第2张图片

 至此,我们可以看到,该文件通过properties标签对一些常用技术框架的依赖文件进行了统一版本号管理,这里的版本都与我们引入的Spring Boot父项目依赖的版本相匹配。帮助我们解决了整合技术框架的版本不兼容问题。

现在我们知道了spring-boot-starter-parent父依赖的主要作用是进行版本统一管理,那么项目运行依赖的jar包是从何而来的呢?在Spring Boot入门程序中,还有另外一个核心依赖spring-boot-starter-web。


    org.springframework.boot
    spring-boot-starter-web

我们还是追踪进它的底层源文件

约定优于配置设计范式及Spring Boot源码剖析_第3张图片

从上述代码中可以发现, spring-boot-starter-web依赖的主要作用是提供web开发场景所需的底层所有依赖。正是如此,在pom.xml中引入spring-boot-starter-web依赖后,就可以实现web场景开发,而不需要额外导入tomcat服务器等其他依赖文件。当然这些引入的依赖的版本号还是由spring-boot-starter-parent父依赖进行统一管理的。 

Spring Boot除了提供上述介绍的web依赖启动器外,还提供了其他许多开发场景的相关依赖,我们可以查看Spring Boot官方文档
https://spring.io/projects/spring-boot#learn

约定优于配置设计范式及Spring Boot源码剖析_第4张图片

约定优于配置设计范式及Spring Boot源码剖析_第5张图片

约定优于配置设计范式及Spring Boot源码剖析_第6张图片以上就可以查看到Spring Boot官方提供的部分场景依赖启动器,我么在开发中按需导入依赖即可。

需要说明的是,Spring Boot官方并不是针对所有场景开发的技术框架都提供了启动依赖,例如持久层框架MyBatis、阿里巴巴的Druid数据源等。但是我们可以自定义starter(后面会讲到)主动与Spring Boot框架进行整合,充分利用Spring Boot框架的优势。例如:mybatis-spring-boot-starter、druid-spring-boot-starter等。我们在pom.xml引入这些第三方的依赖启动器时,要注意配置对应的版本号哦!!!

自动配置(启动流程)

Spring Boot到底是如何进行自动配置的,都把哪些组件进行了自动配置呢?我们从项目启动类上的注解@SpringBootApplication去一探究竟。点击进入这个注解类的源码中,体贴的我已经做好了注释。

约定优于配置设计范式及Spring Boot源码剖析_第7张图片从上述源码中可以看出,@SpringBootApplication注解是一个组合注解,前面四个注解是注解的元数据信息,我们主要看后面三个核心注解,我们再继续追踪探究其作用。

约定优于配置设计范式及Spring Boot源码剖析_第8张图片

@SpringBootConfiguration注解中只有一个@Configuration注解,由此可见,这个注解的作用与@Configuration注解相同,都是标识当前类是一个可以被组件扫描器扫描的配置类,是Spring Boot重新封装命名而已。 


@EnableAutoConfiguration注解也是一个组合注解,Spring中有很多Enable开头的注解,起作用就是借助@Import来收集并注册特定场景相关的bean,并加载到IoC容器。 

约定优于配置设计范式及Spring Boot源码剖析_第9张图片

我们先来看@EnableAutoConfiguration注解中的第一个注解@AutoConfigurationPackage。

约定优于配置设计范式及Spring Boot源码剖析_第10张图片

@AutoConfigurationPackage注解的功能是由@Import注解实现的,它是Spring框架的底层注解,作用是给容器导入某个组件类。当前就是导入Registrar这个组件类。我们再继续追踪进这个组件类,看看做了什么事情。

约定优于配置设计范式及Spring Boot源码剖析_第11张图片

从源码中可以看出,在Registrar类中有一个registerBeanDefinitions方法,使用Debug模式启动项目,可以看到方法中
new PackageImport(metadata).getPackageName()就是@springbootApplication注解标注的类所在包名。继续追踪源码

约定优于配置设计范式及Spring Boot源码剖析_第12张图片

会将上面扫描到的目录中的类进行注册。就是说@AutoConfigurationPackage注解的主要作用就是将@springbootApplication注解标注的类所在包及所有子包下的组件扫描到Spring容器中。所以我们也能因此知道为何项目启动类要定义在最外层的根目录下。

我们再继续看@EnableAutoConfiguration注解中的第二个注解@Import(AutoConfigurationImportSelector.class)。

约定优于配置设计范式及Spring Boot源码剖析_第13张图片

可以看到这个类中,有一个selectImports方法,该方法中下面又调用了其他方法。保持耐心,我们再分别继续追踪。
1、先看AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader)这个方法做了哪些事情。

约定优于配置设计范式及Spring Boot源码剖析_第14张图片

 loadMetadata方法又调用了一个重载方法,并且传入了参数PATH,那么我们先来看下这个PATH目录对应的文件。

约定优于配置设计范式及Spring Boot源码剖析_第15张图片

这个配置文件中配置的格式是:自动配置的类全名.条件=值。意思是当找到了满足条件的值,Spring才会自动装配自动配置的类。在这个重载方法中,执行的步骤,大家可以看下注释,我们直接来看最后return loadMetadata(properties)这个方法:

2、再看getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata)这个方法做了哪些事情。调用了本类中的一个方法,如下图(方法比较长分别截了两张图)

约定优于配置设计范式及Spring Boot源码剖析_第16张图片

约定优于配置设计范式及Spring Boot源码剖析_第17张图片

在这个方法中,我们重点关注,注释的第三步的那个方法getCandidateConfigurations(annotationMetadata, attributes);依然是调用了本类中的一个方法,如下图:

约定优于配置设计范式及Spring Boot源码剖析_第18张图片

继续追踪SpringFactoriesLoader.loadFactoryNames这个方法,如下图

约定优于配置设计范式及Spring Boot源码剖析_第19张图片

这个方法中又去加载了一个常量,这个常量是什么呢,如下图

 我们再找到这个配置文件,一探究竟

约定优于配置设计范式及Spring Boot源码剖析_第20张图片

到这里,我们就知道了,就是将配置文件中配置的类封装成了List configurations集合并返回。我们需要再继续回到上面的方法中,继续看第三步后面的步骤,进行了去重和排除不希望自动配置的类,我们重点追踪第五步configurations = filter(configurations, autoConfigurationMetadata);这个方法。这一步是对configurations进一步过滤。

约定优于配置设计范式及Spring Boot源码剖析_第21张图片

我们先不着急看这个方法,回到配置文件中,随便进入一个配置类里面,都会看到@Conditional开头的注解,也就是这些自动配置类都有生效条件,在满足条件下才进行装配,这个方法中就是做了这件事情。具体的条件我也在第五步中做了注释。后面的步骤就是真正要开始自动装配了。


小结:以刚刚的项目为例,在项目中加入了web环境依赖启动器,对应的WebMvcAutoConfiguration自动配置类就会生效,打开该自动配置类会发现,在该配置类中通过全注解配置类的方式对Spring MVC运行所需环境进行了默认配置,包括默认前缀、默认后缀、视图解析器、MVC校验器等。而这些自动配置类的本质就是传统Spring MVC框架中对应的XML配置文件,只不过在Spring Boot中以自动配置类的形式进行了预先配置。因此,在Spring Boot项目中加入相关依赖启动器后,基本上不需要任何配置就可以运行程序,当然我们也可以对这些自动配置类中默认的配置进行更改。


最后再来看@SpringBootApplication中的最后一个注解@ComponentScan,这个注解具体扫描的包的根路径是有Spring Boot项目主程序启动类所在的包位置决定,在扫描过程中由前面介绍的@AutoConfigurationPackage注解进行解析,从而得到Spring Boot项目主程序启动类所在包的具体位置。


因此Spring Boot底层实现自动配置的步骤是:
(上面得整体流程确实太多了,没必要都去记住,为了便于记忆和面试中能回答上来,可以适当结合图文,按照如下记忆,
组合注解中包含哪些注解,每个注解的作用。)

1、Spring Boot启动类启动。
2、@SpringBootApplication起作用(是一个组合注解)。
3、@SpringBootConfiguration进一步封装了@Configuration作用是声明是配置类
4、@EnableAutoConfiguration中的@AutoConfigurationPackage中的@Import(AutoConfigurationPackages.Registrar.class),
通过将Registrar类导入到容器中,扫描启动类所在包目录及所有子包,并将相应的组件加载到IoC容器中
5、@EnableAutoConfiguration中的@Import(AutoConfigurationImportSelector.class),
通过将AutoConfigurationImportSelector类导入到容器中,通过selectImports方法执行的过程中,会使用内部工具类SpringFactoriesLoader,查找classpath中所有jar包中的META-INF/spring.factories进行加载,实现将配置类信息交给SpringFactory加载器进行一系列的容器创建过程。

约定优于配置设计范式及Spring Boot源码剖析_第22张图片

自定义starter 

SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建议自定义的starter使用xxx-spring-boot-starter命名规则。以区分SpringBoot生态提供的starter。下面我们来实现自定义starter。

1、新建maven jar工程,工程名为zdy-spring-boot-starter,导入依赖


	org.springframework.boot
	spring-boot-autoconfigure
	2.2.6.RELEASE

2、编写javaBean

@EnableConfigurationProperties(SimpleBean.class)
@ConfigurationProperties(prefix = "simplebean")
public class SimpleBean {

    private int id;
    private String name;

    @Override
    public String toString() {
        return "SimpleBean{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

 3、编写自定义配置类MyAutoConfiguration

@Configuration
@ConditionalOnClass
public class MyAutoConfiguration {

    static {
        System.out.println("MyAutoConfiguration static代码块");
    }

    @Bean
    public SimpleBean simpleBean(){
        return new SimpleBean();
    }
}

4、在resources下创建META-INF/spring.factories,并在该配置文件中添加刚才自定义的配置类 MyAutoConfiguration全类名

约定优于配置设计范式及Spring Boot源码剖析_第23张图片

以上就自定义好了。下面来使用自定义的starter。

1、导入自定义starter依赖


	ki.fanxuebo
	zdy-spring-boot-starter
	1.0-SNAPSHOT

 2、在配置文件中配置属性(我们自定义starter中定义的javaBean)

simplebean.id=1
simplebean.name=自定义starter

3、编写测试方法

@Autowired
private SimpleBean simpleBean;

@Test
public void zdyStarterTest(){
 System.out.println(simpleBean);
}

以上就是自定义starter的过程。

你可能感兴趣的:(学习内容输出,Spring,Boot,依赖管理,自动配置(启动流程),自定义starter)