Spring Boot 2 原理简介

Spring Boot 2 原理

springboot帮我们做了什么

通常搭建一个基于spring的web应用，我们需要做以下工作：

1. pom文件中引入相关jar包，包括spring、springmvc、redis、mybaits、log4j、mysql-connector-java 等等相关jar ...

2. 配置web.xml，Listener配置、Filter配置、Servlet配置、log4j配置、error配置 ...

3. 配置数据库连接、配置spring事务

4. 配置视图解析器

5. 开启注解、自动扫描功能

6. 配置完成后部署tomcat、启动调试

7. ......

• 搭个初始项目不一会就一个小时甚至半天过去了。而用springboot后，一切都变得很简便快速。下来我们来一步步分析springboot的起步依赖与自动配置这两个核心原理。

起步依赖

1. 引入jar

        org.springframework.boot

        spring-boot-starter-parent

        2.0.3.RELEASE

         







        org.mybatis.spring.boot

        mybatis-spring-boot-starter

        1.3.1







        org.springframework.boot

        spring-boot-starter-web





        mysql

        mysql-connector-java

        runtime







        com.alibaba

        druid

        1.0.31

• spring-boot-starter-web包自动帮我们引入了web模块开发需要的相关jar包，

• mybatis-spring-boot-starter帮我们引入了dao开发相关的jar包。

• spring-boot-starter-xxx是官方提供的starter，xxx-spring-boot-starter是第三方提供的starter。

image

• 可以看出在这个mybatis-spring-boot-starter 中，并没有任何源码，只有一个pom文件，它的作用就是帮我们引入了相关jar包。

2. 配置数据源

spring:

        datasource:

                url: jdbc:mysql://127.0.0.1:3306/mybatis_test

                username: root

                password: root

                driver-class-name: com.mysql.jdbc.Driver

                type: com.alibaba.druid.pool.DruidDataSource

                dbcp2:

                        min-idle: 5

                        initial-size: 5

                        max-total: 5

                        max-wait-millis: 200

• stater机制帮我们完成了项目起步所需要的的相关jar包。那问题又来了，传统的spring应用中不是要在application.xml中配置很多bean的吗，比如dataSource的配置，transactionManager的配置 ... springboot是如何帮我们完成这些bean的配置的？下面我们来分析这个过程

自动配置

基于java代码的bean配置

• 以mybatis为例，在上面的截图中，我们发下mybatis-spring-boot-starter这个包帮我们引入了mybatis-spring-boot-autoconfigure这个包，如下图：

image

image

image

• 熟悉@Configuration&@Bean这两个bean的同学或许已经知道了。这两个注解一起使用就可以创建一个基于java代码的配置类，可以用来替代相应的xml配置文件。

• @Configuration注解的类可以看作是能生产让Spring IoC容器管理的Bean实例的工厂。

• @Bean注解告诉Spring，一个带有@Bean的注解方法将返回一个对象，该对象应该被注册到spring容器中。

• 传统的基于xml的bean配置方法如下：

• 相当于用基于java代码的配置方式：

@Configuration  

public class Conf {  

        @Bean  

        public Car car() {  

                Car car = new Car();  

                car.setWheel(wheel());  

                return car;  

        }  

        @Bean   

        public Wheel wheel() {  

                return new Wheel();  

        }  

}

• 所以上面的MybatisAutoConfiguration这个类，自动帮我们生成了SqlSessionFactory这些Mybatis的重要实例并交给spring容器管理，从而完成bean的自动注册。

自动配置条件依赖

• 从MybatisAutoConfiguration这个类中使用的注解可以看出，要完成自动配置是有依赖条件的。

@Configuration

@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})

@ConditionalOnBean({DataSource.class})

@EnableConfigurationProperties({MybatisProperties.class})

@AutoConfigureAfter({DataSourceAutoConfiguration.class})

public class MybatisAutoConfiguration {

//....

}

• 这些是springboot特有的，常见的条件依赖注解有：

• @ConditionalOnBean，仅在当前上下文中存在某个bean时，才会实例化这个Bean。

• @ConditionalOnClass，某个class位于类路径上，才会实例化这个Bean。

• @ConditionalOnExpression，当表达式为true的时候，才会实例化这个Bean。

• @ConditionalOnMissingBean，仅在当前上下文中不存在某个bean时，才会实例化这个Bean。

• @ConditionalOnMissingClass，某个class在类路径上不存在的时候，才会实例化这个Bean。

• @ConditionalOnNotWebApplication，不是web应用时才会实例化这个Bean。

• @AutoConfigureAfter，在某个bean完成自动配置后实例化这个bean。

• @AutoConfigureBefore，在某个bean完成自动配置前实例化这个bean。

• 所以要完成Mybatis的自动配置，需要在类路径中存在SqlSessionFactory.class、SqlSessionFactoryBean.class这两个类，需要存在DataSource这个bean且这个bean完成自动注册。

• 进入DataSourceAutoConfiguration这个类，可以看到这个类属于这个包：

• org.springframework.boot.autoconfigure.jdbc

• 这个包又属于spring-boot-autoconfigure-2.0.3.RELEASE.jar这个包，自动配置这个包帮们引入了jdbc、kafka、logging、mail、mongo等包。很多包需要我们引入相应jar后自动配置才生效。

springbootautoconfig.png

jars.png

bean参数获取

• 到此我们已经知道了bean的配置过程，但是还没有看到springboot是如何读取yml或者properites配置文件的的属性来创建数据源的？

• 在DataSourceAutoConfiguration类里面，我们注意到使用了EnableConfigurationProperties这个注解。

@Configuration

@ConditionalOnClass({DataSource.class, EmbeddedDatabaseType.class})

@EnableConfigurationProperties({DataSourceProperties.class})

@Import({DataSourcePoolMetadataProvidersConfiguration.class, DataSourceInitializationConfiguration.class})

public class DataSourceAutoConfiguration {

...

}

• DataSourceProperties中封装了数据源的各个属性，且使用了注解ConfigurationProperties指定了配置文件的前缀。

@ConfigurationProperties(

        prefix = "spring.datasource"

)

public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {

        private ClassLoader classLoader;

        private String name;

        private boolean generateUniqueName;

        private Class type;

        private String driverClassName;

        private String url;

        private String username;

        private String password;

        private String jndiName;

        ...

}

• @EnableConfigurationProperties与@ConfigurationProperties这两个注解有什么用呢？

• @ConfigurationProperties注解的作用是把yml或者properties配置文件转化为bean。

• @EnableConfigurationProperties注解的作用是使@ConfigurationProperties注解生效。如果只配置@ConfigurationProperties注解，在spring容器中是获取不到yml或者properties配置文件转化的bean的。

bean发现

• springboot默认扫描启动类所在的包下的主类与子类的所有组件，但并没有包括依赖包的中的类，那么依赖包中的bean是如何被发现和加载的？

• 我们通常在启动类中加@SpringBootApplication这个注解，点进去看

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Inherited

@SpringBootConfiguration

@EnableAutoConfiguration

@ComponentScan(

        excludeFilters = {@Filter(

        type = FilterType.CUSTOM,

        classes = {TypeExcludeFilter.class}

), @Filter(

        type = FilterType.CUSTOM,

        classes = {AutoConfigurationExcludeFilter.class}

)}

)

public @interface SpringBootApplication {

...

}

• 实际上重要的只有三个Annotation：

• @Configuration（@SpringBootConfiguration里面还是应用了@Configuration）

• @EnableAutoConfiguration

• @ComponentScan

• @Configuration的作用上面我们已经知道了，被注解的类将成为一个bean配置类。

• @ComponentScan的作用就是自动扫描并加载符合条件的组件，比如@Component和@Repository等，最终将这些bean定义加载到spring容器中。

• @EnableAutoConfiguration 这个注解的功能很重要，借助@Import的支持，收集和注册依赖包中相关的bean定义。

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Inherited

@AutoConfigurationPackage

@Import({AutoConfigurationImportSelector.class})

public @interface EnableAutoConfiguration {

        String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

        Class[] exclude() default {};

        String[] excludeName() default {};

}

• 如上源码，@EnableAutoConfiguration注解引入了@AutoConfigurationPackage和@Import这两个注解。@AutoConfigurationPackage的作用就是自动配置的包，@Import导入需要自动配置的组件。

• 进入@AutoConfigurationPackage，发现也是引入了@Import注解

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Inherited

@Import({Registrar.class})

public @interface AutoConfigurationPackage {

}

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

        Registrar() {

        }

        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {

                 AutoConfigurationPackages.register(registry, new String[]{(new AutoConfigurationPackages.PackageImport(metadata)).getPackageName()});

        }

        public Set