实战：自定义简易版SpringBoot

实战：自定义简易版SpringBoot

---

一、功能要求

自定义简易版SpringBoot，实现SpringBoot MVC及内嵌Tomcat启动、DispatcherServlet注册和组件扫描功能

程序通过main方法启动，可以自动启动tomcat服务器

可以自动创建和加载DispatcherServlet组件到ServletContext中

可以自动通过@ComponentScan扫描Controller等组件

Controller组件可以处理浏览器请求，返回响应结果

二、实现思路分析

传统SpringMVC框架web.xml的配置内容:

<web-app>
   <!-- 初始化Spring上下文 -->
   <listener>
       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
   </listener>
   <!-- 指定Spring的配置文件 -->
   <context-param>
       <param-name>contextConfigLocation</param-name>
       <param-value>/WEB-INF/app-context.xml</param-value>
   </context-param>
   <!-- 初始化DispatcherServlet -->
   <servlet>
       <servlet-name>app</servlet-name>
       <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
       <init-param>
           <param-name>contextConfigLocation</param-name>
           <param-value></param-value>
       </init-param>
       <load-on-startup>1</load-on-startup>
   </servlet>
   <servlet-mapping>
       <servlet-name>app</servlet-name>
       <url-pattern>/app/*</url-pattern>
   </servlet-mapping>
</web-app>

Spring官方文档中给出了基于Servlet3.0规范如何使用Java代码实现web.xml配置的example

public class MyWebApplicationInitializer implements WebApplicationInitializer {
   
   

   @Override
   public void onStartup(ServletContext servletCxt) {
   
   

       // Load Spring web application configuration
       //通过注解的方式初始化Spring的上下文
       AnnotationConfigWebApplicationContext ac = new AnnotationConfigWebApplicationContext();
       //注册spring的配置类（替代传统项目中xml的configuration）
       ac.register(AppConfig.class);
       ac.refresh();

       // Create and register the DispatcherServlet
       //基于java代码的方式初始化DispatcherServlet
       DispatcherServlet servlet = new DispatcherServlet(ac);
       ServletRegistration.Dynamic registration = servletContext.addServlet("app", servlet);
       registration.setLoadOnStartup(1);
       registration.addMapping("/app/*");
   }
}

1. 当实现了Servlet3.0规范的容器（比如Tomcat7及以上版本）启动时

   • 会通过SPI扩展机制自动扫描所有jar包里META-INF/services/javax.servlet.ServletContainerInitializer文件中指定的全路径类（该类需实现ServletContainerInitializer接口）

   • Servlet3.0+容器启动时将自动扫描类路径，以查找Spring的WebApplicationInitializer接口的所有实现类

   • 将实现类放置到一个set集合中，提供给ServletContainerInitializer中onStartup的第一个参数使用

2. 实例化ServletContainerInitializer实现类
3. 回调类中的onStartup方法
4. 在onStartup方法中（形参webAppInitializerClasses 已经封装了WebApplicationInitializer接口的所有实现类），可以回调WebApplicaitonInitializer的onStartup方法
5. 在WebApplicaitonInitializer的onStartup方法中 进行传统SpringMVC框架web.xml的 内容配置

三、编码（实现方式一：使用框架的SpringServletContainerInitializer）

（1）创建maven工程，导入以下依赖：

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>sprin