从JavaConfig到SpringBoot启动源码的原理解析

一、故事起源

Spring Boot实现了无xml配置化的SpringMVC启动，替代并实现了Spring MVC、Spring、MyBatis的架构，那么它的底层原理是如何实现的呢？Spring Boot如何实现自动装配，本文将做一个解析。

二、Java Config技术

自从Spring MVC3.0技术推出以来，Spring MVC新增了很多Java Config注解，简化了配置，初步构建了无xml启动。

@Configuration

在类上打上这一标签，表示这个类是配置类

@ComponentScan

相当于Spring MVC中的Component-Scan包扫描Package技术

@EnableWebMvc

相当于Spring MVC xml配置中的<mvc:annotation-driven>

@ImportResource

相当于导入配置文件<import bean-class=""/>

@PropertySource

用于读取properties属性文件

2.1使用方法

@Configuration

public class AutoConfiguration {

@Bean

public JText button() {

return new JText("Hello World");

}

@Bean

public JButton anotherButton(Icon icon) {

return new JButton(icon);

}

@Bean

public Image autoLogo() throws URLException {

URL url = new URL(

"http://luowei.com/assets/images/luowei_icon.png");

return new ImageIcon(url);

}

}

用法非常简单：

1.用@Configuration注解JavaConfig类，

2.用每个方法来表示Bean并使用@Bean注解方法。

3.每个方法名代表XML配置文件中的name

三、使用JavaConfig代替Spring MVC

创建一个类实现 这个类： WebApplicationInitializer

官方示例代码：

public class MyWebApplicationInitializer implements WebApplicationInitializer {

@Override

public void onStartup(ServletContext servletCxt) {

// Load Spring web application configuration

AnnotationConfigWebApplicationContext ac = new AnnotationConfigWebApplicationContext();

ac.register(AppConfig.class);

ac.refresh();

// Create and register the DispatcherServlet

DispatcherServlet servlet = new DispatcherServlet(ac);

ServletRegistration.Dynamic registration = servletCxt.addServlet("app", servlet);

registration.setLoadOnStartup(1);

registration.addMapping("/app/*");

}

}

这样就能够在Tomcat中启动DispatcherServlet，从而简化了Spring MVC XML中常化的配置。

3.1自我实现

//相当于web.xml

public class WebInitializer implements WebApplicationInitializer {

public void onStartup(ServletContext servletContext) throws ServletException {

AnnotationConfigWebApplicationContext ownerCtx = new AnnotationConfigWebApplicationContext();

ownerCtx .register(Config.class);//注册mvc的配置类

ownerCtx .setServletContext(servletContext);

/**

* 注册DispatcherServlet(调度工作,控制流程)

*/

Dynamic servlet = servletContext.addServlet("dispatcher", new DispatcherServlet(ownerCtx ));//配置DispatcherServlet

servlet.addMapping("/");//url-pattern路径

servlet.setLoadOnStartup(1);//启动顺序

// 设置编码格式

CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();

characterEncodingFilter.setEncoding("UTF-8");// 国际化

characterEncodingFilter.setForceEncoding(true);

javax.servlet.FilterRegistration.Dynamic filter = servletContext.addFilter("encoding", characterEncodingFilter);

filter.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class),true,"*");

}

}

实现JavaConfig:

@Configuration//相当于配置文件

@ComponentScan("com.hdicloud")//配置包扫描

@EnableWebMvc//启用mvc支持 annotation-driven

@MapperScan(value="com.base.lc.mapper",sqlSessionFactoryRef = "sqlSessionFactory")//mapper扫描器

@EnableTransactionManagement//开启事务

public class SpringConfig extends WebMvcConfigurerAdapter {

/**

* jsp视图解析器的bean

*/

@Bean

public UrlBasedViewResolver setupViewResolver() {

UrlBasedViewResolver resolver = new UrlBasedViewResolver();

resolver.setPrefix("/");

resolver.setSuffix(".jsp");

resolver.setViewClass(JstlView.class);

return resolver;

}

/**

* 配置数据源

*/

@Bean(name = "dataSource")

public DriverManagerDataSource getDataSource() {

try {

DriverManagerDataSource dataSource = new DriverManagerDataSource();

dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");

dataSource.setUrl("jdbc:mysql://192.168.7.9:3306/config?useAffectedRows=true");

dataSource.setUsername("root");

dataSource.setPassword("123456");

return dataSource;

} catch (Exception e) {

return null;

}

}

/**

* 创建事务管理 用来指定数据源

*/

@Bean

public DataSourceTransactionManager transactionManager() {

return new DataSourceTransactionManager(getDataSource());

}

/**

* 配置SqlSessionFactory，给MapperScan调用

*/

@Bean

public SqlSessionFactory sqlSessionFactory() throws Exception {

SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();

sessionFactory.setDataSource(getDataSource());

return sessionFactory.getObject();

}

// 设置utf-8编码

@Override

public void configureMessageConverters(List<HttpMessageConverter<?>> msgConverters) {

StringHttpMessageConverter shmc = new StringHttpMessageConverter(Charset.forName("utf-8"));

msgConverters.add(shmc);

msgConverters.add(new MappingJackson2HttpMessageConverter());

}

/**

* mvc资源路径配置

*/

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

//后面根据路径自己配置

registry.addResourceHandler("/**").addResourceLocations("/");

}

完成这2步之后，就实现了无Spring MVC XML自启化。

四、Spring Boot底层源码解析

4.1@EnableAutoConfiguration

@EnableAutoConfiguration借助@Import的支持，收集和注册特定场景相关的bean定义。

例如:(1)@EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器。

(2)@EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器。

EnableAutoConfiguration借助@Import的帮助，将所有符合自动配置条件的bean定义加载到IoC容器。

@EnableAutoConfiguration作为一个复合Annotation，其自身定义关键信息如下：

@SuppressWarnings("deprecation")

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Inherited

@AutoConfigurationPackage

@Import(EnableAutoConfigurationImportSelector.class)

public @interface EnableAutoConfiguration {

...

}

4.2SpringFactoriesLoader

SpringFactoriesLoader属于Spring框架私有的一种扩展方案，其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。

public abstract class SpringFactoriesLoader {

//...

public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {

...

}

public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {

....

}

}

配合@EnableAutoConfiguration使用的话，它更多是提供一种配置查找的功能支持，即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key，获取对应的一组@Configuration类。如图

通过META-INF目录下的spring.factories将开启自动配置的类加载初始化。

4.3SpringApplication执行流程

该方法的主要流程大体可以归纳如下：

这一切都是借助Java SPI机制，读者可自行了解Java SPI机制原理，后面会出文章讲解

(1)根据classpath里面是否存在某个特征类（org.springframework.web.context.ConfigurableWebApplicationContext）来决定是否应该创建一个为Web应用使用的ApplicationContext类型。

(2)使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。

(3)使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。

(4)推断并设置main方法的定义类。

(5)SpringApplication实例初始化完成并且完成设置后，遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener。调用它们的started()方法，开始依次执行程序。

(6)创建并配置当前Spring Boot应用将要使用的Environment

(7)遍历调用所有SpringApplicationRunListener的environmentPrepared()的方法.

(8)根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果，决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成，然后根据条件决定是否添加ShutdownHook，决定是否使用自定义的BeanNameGenerator，决定是否使用自定义的ResourceLoader

(9)ApplicationContext创建好之后，SpringApplication会再次借助Spring-FactoriesLoader，查找并加载classpath中所有可用的ApplicationContext-Initializer，然后遍历调用这些ApplicationContextInitializer的initialize（applicationContext）方法来对已经创建好的ApplicationContext进行进一步的处理。

(10)遍历调用所有SpringApplicationRunListener的contextPrepared()方法。

(11)通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext。

(12)遍历调用所有SpringApplicationRunListener的contextLoaded()方法。

(13)调用ApplicationContext的refresh()方法，完成IoC容器可用的最后一道工序。

(14)遍历执行SpringApplicationRunListener的finished()方法

以上都是基于Java SPI装配机制实现的。

五、总结

Spring Boot借助Java Config实现了无XML化配置，借助Java SPI实现自动装配AutoConfiguration，将设计模式运用的无比精妙。后面会继续深挖Spring Boot实现细节，及微服务技术文章。