4. 分析 SpringBoot 底层机制

【Tomcat 启动分析 + Spring 容器初始化+Tomcat 如何关联 Spring 容器 】

4.1 Tomcat启动分析

第一步、修改pom.xml文件，指定我们自己的tomcat

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xjz</groupId>
    <artifactId>xjz-springboot</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
    </parent>

    <!-- 导入 web 项目场景启动器,会自动导入和 web 开发相关依赖,非常方便 -->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            
            <!-- 在 spring-boot-starter-web 排除内嵌的starter-tomcat -->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
            </exclusions>
            
        </dependency>

        <!--用我们指定 tomcat 版本来完, 可以到 mvn 去获取依赖坐标. 老韩解读：
            1. 使用指定的 tomcat 才会验证效果 高版本的 tomcat 默认不会真正监听
            2. 使用了指定 tomcat , 需要在 spring-boot-starter-web 排除内嵌的starter-tomcat
            3. 否则会出现包冲突, 提示 GenericServlet Not Found 类似错误
        -->
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-core</artifactId>
            <version>8.5.75</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.tomcat/tomcat-jasper -->
        <dependency>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>tomcat-jasper</artifactId>
            <version>8.5.75</version>
        </dependency>
    </dependencies>


</project>

第二步、创建一个新包，在包下创建我们自己定义的SpringApplication

public class XjzSpringApplication {

    public static void run(){

        try {
            Tomcat tomcat = new Tomcat();
            tomcat.setPort(9090);
            //启动Tomcat
            tomcat.start();
            //等待请求接入
            System.out.println("=====9090=====等待请求");
            tomcat.getServer().await();
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

第三步、创建一个启动类

public class XjzMainApp {

    public static void main(String[] args) {
        //调用XjzSpringApplication的run()方法
        XjzSpringApplication.run();
    }
}

第四步、测试看一下控制台结果

查看浏览器请求,http://localhost:9090/，这是没有返回信息

4.2 创建Spring 容器

第一步、创建一个测试Bean

package com.xjz.xjzspringboot.bean;

public class Monster {
}

第二步、创建一个Controller

package com.xjz.xjzspringboot.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class XjzHiController {

    @RequestMapping("/xjzhi")
    public String hi(){
        System.out.println("hi,XjzController");
        return "hi,XjzController";
    }
}

第三步、创建Spring的配置文件

package com.xjz.xjzspringboot.config;

import com.xjz.xjzspringboot.bean.Monster;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("com.xjz.xjzspringboot")
public class XjzConfig {

    /**
     * 1. 通过@Bean 的方式, 将 new 出来的 Bean 对象, 放入到 Spring 容器
     * 2. 该 bean 在 Spring 容器的 name 就是 方法名
     * 3. 通过方法名, 可以得到 new Monster() * @return
     */
    @Bean
    public Monster monster(){
        System.out.println("monster...");
        return new Monster();
    }
}

第四步、创建XjzWebApplicationInitializer.java , 作为 Spring 的容器

package com.xjz.xjzspringboot;

import com.xjz.xjzspringboot.config.XjzConfig;
import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

public class XjzWebApplicationInitializer implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {

        System.out.println("startup....");
        //加载 spring web application configuration
        AnnotationConfigWebApplicationContext ac =
                new AnnotationConfigWebApplicationContext();
        ac.register(XjzConfig.class);
        ac.refresh();//完成bean的创建、和配置

        //创建注册非常重要的分发器 DispatcherServlet
        //注意, 把 spring 容器给到 DispatcherServlet
        //这样就可以做映射分发, 回忆一下我们实现 SpringMVC
        DispatcherServlet dispatcherServlet = new DispatcherServlet(ac);
        ServletRegistration.Dynamic registration =
                servletContext.addServlet("app", dispatcherServlet);
        registration.setLoadOnStartup(1);
        registration.addMapping("/");

    }
}

4.3 将Tomcat 和 Spring 容器关联，并启动 Spring 容器

第一步、修改我们的XjzSpringApplication.java

package com.xjz.xjzspringboot;

import org.apache.catalina.startup.Tomcat;

public class XjzSpringApplication {

    public static void run(){

        try {
            Tomcat tomcat = new Tomcat();
            tomcat.setPort(9090);
            //让 tomcat 可以将请求转发到 spring web 容器, 因此需要关联一把
            //1. /hspboot 就是 tomcat 的 applicaton context
            //理解为工程路径, D:\\hsp.... 就是这个工程的路径
            tomcat.addWebapp("/xjzboot","D:\\IDEA\\hspedu_springboot\\xjz-springboot");
            //启动Tomcat
            tomcat.start();
            //等待请求接入
            System.out.println("=====9090=====等待请求");
            tomcat.getServer().await();
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

第二步、运行XjzMainApp测试项目

package com.xjz.xjzspringboot;

public class XjzMainApp {

    public static void main(String[] args) {
        XjzSpringApplication.run();
    }
}

第三步、运行结果

浏览器访问

4.4 扩展-debug查看 ac.refresh()

我们来debug 一下, 看看是否进行 Spring 容器的初始化工作, 可以看到 ac.refresh() 会将HspConfig.class 中配置 Bean 实例化装入到容器中