1 简介

  • 使用 SpringBoot 步骤：
    • ① 创建 SpringBoot 应用，选中我们需要的模块。
    • ② SpringBoot 已经默认将这些场景配置好了，只需要在配置文件指定少量配置就可以运行起来。
    • ③ 自己编写业务逻辑代码。
  • 自动配置原理：这个场景 SpringBoot 帮我们配置了什么？能不能修改？能修改哪些配置？能不能扩展？
  1. xxxAutoConfiguration：帮我们在容器中自动配置组件。
  2. xxxProperties：配置类封装配置文件的内容。

2 SpringBoot 对静态资源的映射规则

  • WebMvcAutoConfiguration 的部分源码如下：
  1. @Configuration
  2. @ConditionalOnWebApplication
  3. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
  4.         WebMvcConfigurerAdapter.class })
  5. @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
  6. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
  7. @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
  8.         ValidationAutoConfiguration.class })
  9. public class WebMvcAutoConfiguration {
  11.     @Configuration
  12.     @Import(EnableWebMvcConfiguration.class)
  13.     @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
  14.     public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {
  15.         //静态资源处理器
  16.         @Override
  17.         public void addResourceHandlers(ResourceHandlerRegistry registry) {
  18.             if (!this.resourceProperties.isAddMappings()) {
  19.                 logger.debug("Default resource handling disabled");
  20.                 return;
  21.             }
  22.             Integer cachePeriod = this.resourceProperties.getCachePeriod();
  23.             if (!registry.hasMappingForPattern("/webjars/**")) {
  24.                 customizeResourceHandlerRegistration(
  25.                     registry.addResourceHandler("/webjars/**")
  26.                     .addResourceLocations(
  27.                         "classpath:/META-INF/resources/webjars/")
  28.                     .setCachePeriod(cachePeriod));
  29.             }
  30.             String staticPathPattern = this.mvcProperties.getStaticPathPattern();
  31.             if (!registry.hasMappingForPattern(staticPathPattern)) {
  32.                 customizeResourceHandlerRegistration(
  33.                     registry.addResourceHandler(staticPathPattern)
  34.                     .addResourceLocations(
  35.                         this.resourceProperties.getStaticLocations())
  36.                     .setCachePeriod(cachePeriod));
  37.             }
  38.         }
  40.         //欢迎页
  41.         @Bean
  42.         public WelcomePageHandlerMapping welcomePageHandlerMapping(
  43.             ResourceProperties resourceProperties) {
  44.             return new WelcomePageHandlerMapping(resourceProperties.getWelcomePage(),
  45.                                                  this.mvcProperties.getStaticPathPattern());
  46.         }
  48.         //配置喜欢的图标
  49.         @Configuration
  50.         @ConditionalOnProperty(value = "spring.mvc.favicon.enabled", matchIfMissing = true)
  51.         public static class FaviconConfiguration {
  53.             private final ResourceProperties resourceProperties;
  55.             public FaviconConfiguration(ResourceProperties resourceProperties) {
  56.                 this.resourceProperties = resourceProperties;
  57.             }
  59.             @Bean
  60.             public SimpleUrlHandlerMapping faviconHandlerMapping() {
  61.                 SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
  62.                 mapping.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
  63.                 //所有**/favicon.ico
  64.                 mapping.setUrlMap(Collections.singletonMap("**/favicon.ico",
  65.                                                            faviconRequestHandler()));
  66.                 return mapping;
  67.             }
  69.             @Bean
  70.             public ResourceHttpRequestHandler faviconRequestHandler() {
  71.                 ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
  72.                 requestHandler
  73.                     .setLocations(this.resourceProperties.getFaviconLocations());
  74.                 return requestHandler;
  75.             }
  77.         }
  80.     }    
  83. }

  • ① 所有 /webjars/** ，都去 classpath:/META-INF/resources/webjars/ 找静态资源。

    • webjars：以 jar 包的形式引入静态资源。
    • 官网。
    • 比如：浏览器发送 http://localhost:8080/webjars/jquery/3.5.1/jquery.js 请求，SpringBoot 就会到 classpath:/META-INF/resources/webjars/jquery/3.5.1/jquery.js 这个路径查找 jquery.js 文件。
      1. <dependency>
      2. <groupId>org.webjars</groupId>
      3. <artifactId>jquery</artifactId>
      4. <version>3.5.1</version>
      5. </dependency>
      webjars.png

  • ② /** 访问当前项目的任何资源(静态资源的文件夹)：

    1. "classpath:/META-INF/resources/"
    2. "classpath:/resources/"
    3. "classpath:/static/"
    4. "classpath:/public/"
    5. "/"
    • 比如：浏览器发送 http://localhost:8080/asserts/css/bootstrap.min.css 请求，SpringBoot 就会到静态资源文件夹中寻找 /asserts/css/bootstrap.min.css 的路径去寻找 bootstrap.min.css 文件。

访问当前项目的任何资源.png

  • ③ 欢迎页，静态资源文件夹下的 index.html 页面，被 /** 映射。
  • 比如：浏览器发送 http://localhost:8080 请求，默认情况下，会去静态资源文件夹下找 index.html 页面。
  • ④ 所有的 **/favicon.ico 都是在静态资源文件夹下寻找。

3 模板引擎

3.1 简介

  • JSP 、Velocity 、Freemarker 、Thymeleaf……都是模板引擎。
  • 模板引擎的原理：

模板引擎.jpg

3.2 Thymeleaf

3.2.1 Thymeleaf 概述

  • SpringBoot 推荐 Thymeleaf 。
  • Thymeleaf 语法更简单，功能更强大。

3.2.2 Thymeleaf 准备

  • 导入 thymeleaf 相关 jar 包的 Maven 坐标：
  1. <properties>
  2.     <thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
  3.     <thymeleaf-layout-dialect.version>2.3.0</thymeleaf-layout-dialect.version>
  4. </properties>
  5. <dependency>
  6.     <groupId>org.springframework.boot</groupId>
  7.     <artifactId>spring-boot-starter-thymeleaf</artifactId>
  8. </dependency>
  • ThymeleafProperties：
  1. @ConfigurationProperties(prefix = "spring.thymeleaf")
  2. public class ThymeleafProperties {
  4.     private static final Charset DEFAULT_ENCODING = Charset.forName("UTF-8");
  6.     private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
  8.     public static final String DEFAULT_PREFIX = "classpath:/templates/";
  10.     public static final String DEFAULT_SUFFIX = ".html";
  12.     //略
  13. }
  • 从 ThymeleafProperties 的源码可知：我们只要将 HTML 页面放在 classpath:/templates/ ，Thymeleaf 就能自动渲染。

3.2.3 Thymeleaf 使用

  • 导入 thymeleaf 的名称空间：
  1. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  • 使用 thymeleaf 语法：
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Title</title>
  6. </head>
  7. <body>
  9.     <div th:text="helloworld">哇，好(*^▽^*)</div>
  11. </body>
  12. </html>

3.2.4 Thymeleaf 语法规则

文本

  • th:text：改变当前元素里面的文本内容。
  • th:任意html属性：来替换原生属性的值。
  • th:insert、th:replace：片段包含。
  • th:each：遍历。
  • th:if、th:unless、th:case：条件判断。
  • th:object、th:with：声明变量。
  • th:attr、th:attrprepend、th:attrappend：任意属性修改。
  • th:value、th:href、th:src：修改指定属性默认值。
  • th:fragment：声明片段。
  • th"remove：移除。

表达式

  1. Simple expressions:（表达式语法）
  2.     Variable Expressions: ${...}：获取变量值；OGNL；
  3.             1）、获取对象的属性、调用方法
  4.             2）、使用内置的基本对象：
  5.                 #ctx : the context object.
  6.                 #vars: the context variables.
  7.                 #locale : the context locale.
  8.                 #request : (only in Web Contexts) the HttpServletRequest object.
  9.                 #response : (only in Web Contexts) the HttpServletResponse object.
  10.                 #session : (only in Web Contexts) the HttpSession object.
  11.                 #servletContext : (only in Web Contexts) the ServletContext object.
  13.                 ${session.foo}
  14.             3）、内置的一些工具对象：
  15. #execInfo : information about the template being processed.
  16. #messages : methods for obtaining externalized messages inside variables expressions, in the same way as they would be obtained using #{…} syntax.
  17. #uris : methods for escaping parts of URLs/URIs
  18. #conversions : methods for executing the configured conversion service (if any).
  19. #dates : methods for java.util.Date objects: formatting, component extraction, etc.
  20. #calendars : analogous to #dates , but for java.util.Calendar objects.
  21. #numbers : methods for formatting numeric objects.
  22. #strings : methods for String objects: contains, startsWith, prepending/appending, etc.
  23. #objects : methods for objects in general.
  24. #bools : methods for boolean evaluation.
  25. #arrays : methods for arrays.
  26. #lists : methods for lists.
  27. #sets : methods for sets.
  28. #maps : methods for maps.
  29. #aggregates : methods for creating aggregates on arrays or collections.
  30. #ids : methods for dealing with id attributes that might be repeated (for example, as a result of an iteration).
  32.     Selection Variable Expressions: *{...}：选择表达式：和${}在功能上是一样；
  33.         补充：配合 th:object="${session.user}：
  34.    <div th:object="${session.user}">
  35.     <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
  36.     <p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
  37.     <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
  38.     </div>
  40.     Message Expressions: #{...}：获取国际化内容
  41.     Link URL Expressions: @{...}：定义URL；
  42.             @{/order/process(execId=${execId},execType='FAST')}
  43.     Fragment Expressions: ~{...}：片段引用表达式
  44.             <div th:insert="~{commons :: main}">...</div>
  46. Literals（字面量）
  47.       Text literals: 'one text' , 'Another one!' ,…
  48.       Number literals: 0 , 34 , 3.0 , 12.3 ,…
  49.       Boolean literals: true , false
  50.       Null literal: null
  51.       Literal tokens: one , sometext , main ,…
  52. Text operations:（文本操作）
  53.     String concatenation: +
  54.     Literal substitutions: |The name is ${name}|
  55. Arithmetic operations:（数学运算）
  56.     Binary operators: + , - , * , / , %
  57.     Minus sign (unary operator): -
  58. Boolean operations:（布尔运算）
  59.     Binary operators: and , or
  60.     Boolean negation (unary operator): ! , not
  61. Comparisons and equality:（比较运算）
  62.     Comparators: > , < , >= , <= ( gt , lt , ge , le )
  63.     Equality operators: == , != ( eq , ne )
  64. Conditional operators:条件运算（三元运算符）
  65.     If-then: (if) ? (then)
  66.     If-then-else: (if) ? (then) : (else)
  67.     Default: (value) ?: (defaultvalue)
  68. Special tokens:
  69.     No-Operation: _

4 SpringMVC 自动配置

4.1 SpringMVC 自动配置

  • SpringBoot 自动配置好了 SpringMVC ，下面 SpringBoot 对 SpringMVC 的默认配置（ WebMvcAutoConfiguration ）：

    • ① Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans。
      • 自动配置了 ViewResolver（视图解析器，根据方法的返回值得到视图对象（View），视图对象决定如何渲染（转发？重定向？））。
      • ContentNegotiatingViewResolver ：组合所有的视图解析器。
      • 如何定制？我们可以自己给容器中添加一个视图解析器，自动将其组合进来。
    • ② Support for serving static resources, including support for WebJars (see below)。
      • 支持静态资源文件夹路径和 webjars 。
    • ③ Static index.html support.。
      • 首页访问。
    • ④ Custom Favicon support (see below)。
      • favicon.ico。

    • ⑤ 自动注册了 of Converter, GenericConverter, Formatter beans。

      • Converter：转换器。

      • Formatter ：格式化器。

        1. @Bean
        2. @ConditionalOnProperty(prefix = "spring.mvc", name = "date-format") //在配置文件中配置日期格式化的规则
        3. public Formatter<Date> dateFormatter() {
        4. return new DateFormatter(this.mvcProperties.getDateFormat()); //日期格式化组件
        5. }

      • 我们自己添加的格式化器、转换器只需要放在容器中即可。

        1. @Override
        2. public void addFormatters(FormatterRegistry registry) {
        3. for (Converter<?, ?> converter : getBeansOfType(Converter.class)) {
        4. registry.addConverter(converter);
        5. }
        6. for (GenericConverter converter : getBeansOfType(GenericConverter.class)) {
        7. registry.addConverter(converter);
        8. }
        9. for (Formatter<?> formatter : getBeansOfType(Formatter.class)) {
        10. registry.addFormatter(formatter);
        11. }
        12. }

    • ⑥ Support for HttpMessageConverters (see below)。

      • HttpMessageConverter：SpringMVC 用来转换 Http 的请求和响应的。比如 JavaBean 和 JSON 之间的转换。
      • HttpMessageConverters 是从容器中获取的，并且获取所有的 HttpMessageConverter 。
      • 自己给容器中添加 HttpMessageConverter ，只需要自己将组件注册到容器中。
    • ⑦ Automatic registration of MessageCodesResolver (see below)。
      • 定义错误代码生成规则。
    • ⑧ Automatic use of a ConfigurableWebBindingInitializer bean (see below)。
      • 我们可以配置一个 ConfigurableWebBindingInitializer 来替换默认的。
    • ConfigurableWebBindingInitializer的作用就是初始化所有的WebDataBinder，而WebDataBinder的作用就是请求数据—>JavaBean。
  • ⑨ If you want to keep Spring Boot MVC features, and you just want to add additional MVC configuration (interceptors, formatters, view controllers etc.) you can add your own @Configuration class of type WebMvcConfigurerAdapter, but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter or ExceptionHandlerExceptionResolver you can declare a WebMvcRegistrationsAdapter instance providing such components.
    If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.

4.2 扩展 SpringMVC

  • 以前的 springmvc.xml 中配置拦截器等：
  1. <mvc:view-controller path="/hello" view-name="success"/>
  2. <mvc:interceptors>
  3.     <mvc:interceptor>
  4.         <mvc:mapping path="/hello"/>
  5.         <bean></bean>
  6.     </mvc:interceptor>
  7. </mvc:interceptors>
  • 现在在 SpringBoot中 ，编写一个配置类（用 @Configuration 注解标注的类），并且继承 WebMvcConfigurerAdapter，但是 不要标注@EnableWebMvc注解 。这样既可以保留自动配置功能，又能使用我们自己扩展的配置。
  1. package com.sunxiaping.springboot.config;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
  5. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
  7. @Configuration
  8. public class SpringMvcConfig extends WebMvcConfigurerAdapter {
  10.     @Override
  11.     public void addViewControllers(ViewControllerRegistry registry) {
  12.         registry.addViewController("/index").setViewName("index");
  13.         registry.addViewController("/").setViewName("index");
  14.         registry.addViewController("/index.html").setViewName("index");
  15.         registry.addViewController("/index.htm").setViewName("index");
  16.     }
  17. }

  • 原理：

    • ① WebMvcAutoConfiguration 是 SpringMVC 的自动配置类。

    • ② 在做其他自动配置的时候，会导入 @Import(EnableWebMvcConfiguration.class) 。

      1. @Configuration
      2. @ConditionalOnWebApplication
      3. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
      4.    WebMvcConfigurerAdapter.class })
      5. @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
      6. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
      7. @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
      8.    ValidationAutoConfiguration.class })
      9. public class WebMvcAutoConfiguration {
      11. @Configuration
      12. @Import(EnableWebMvcConfiguration.class)
      13. @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
      14. public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {
      15.   //其他略
      16. }
      18. @Configuration
      19. public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration {
      21. }    
      23. //其他略
      24. }

    • ③ DelegatingWebMvcConfiguration 的部分源码如下： ```java @Configuration public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {

      private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();

      //会将所有的WebMvcConfigurer都导入到容器中 @Autowired(required = false) public void setConfigurers(List configurers) { if (!CollectionUtils.isEmpty(configurers)) {

      1.    this.configurers.addWebMvcConfigurers(configurers);

      } }

      //循环遍历所有的WebMvcConfigurer，并将每个WebMvcConfigurer配置的ViewController加入到容器中 //这样就可以将所有的WebMvcConfigurer的相关配置一起作用 @Override protected void addViewControllers(ViewControllerRegistry registry) { this.configurers.addViewControllers(registry); }

      //其他略

}

  2.    - ④ 容器中的所有 WebMvcConfigurer 都会一起起作用。
  3.    - ⑤ 我们自己配置类也会被调用。
  4. <a name="ebd444af"></a>
  5. ## 4.3 全面接管 SpringMVC
  7.    - SpringBoot 对 SpringMVC 的自动配置不需要了，所有的都需要我们配置。
  8.    - 只需要在配置类中加 `@EnableWebMvc` 注解即可。
  9. ```java
  10. package com.sunxiaping.springboot.config;
  12. import org.springframework.context.annotation.Configuration;
  13. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  14. import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
  15. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
  17. @Configuration
  18. @EnableWebMvc
  19. public class SpringMvcConfig extends WebMvcConfigurerAdapter {
  21.     @Override
  22.     public void addViewControllers(ViewControllerRegistry registry) {
  23.         registry.addViewController("/index").setViewName("index");
  24.         registry.addViewController("/").setViewName("index");
  25.         registry.addViewController("/index.html").setViewName("index");
  26.         registry.addViewController("/index.htm").setViewName("index");
  27.     }
  28. }

  • 原理如下：

    • @EnableWebMvc 注解源码如下：

      1. @Retention(RetentionPolicy.RUNTIME)
      2. @Target(ElementType.TYPE)
      3. @Documented
      4. @Import(DelegatingWebMvcConfiguration.class) //会向容器中导入DelegatingWebMvcConfiguration组件
      5. public @interface EnableWebMvc {
      6. }

    • DelegatingWebMvcConfiguration 的部分源码如下：

      1. @Configuration
      2. public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
      3. //其他略
      4. }

    • WebMvcAutoConfiguration 的部分源码如下：

      1. @Configuration
      2. @ConditionalOnWebApplication
      3. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class,
      4. WebMvcConfigurerAdapter.class })
      5. @ConditionalOnMissingBean(WebMvcConfigurationSupport.class) //只有在容器中没有WebMvcConfigurationSupport组件的时候，WebMvcAutoConfiguration才会起效,而@EnableWebMvc会将WebMvcConfigurationSupport组件导入到容器中
      6. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
      7. @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class,
      8. ValidationAutoConfiguration.class })
      9. public class WebMvcAutoConfiguration {
      10. //其他略   
      11. }

5 如何修改 SpringBoot 的默认配置

  • ① SpringBoot 在自动配置很多组件的时候，先看容器中有没有用户自己配置（@Bean 、@Component ），如果有，就使用用户自己配置的；如果没有，才自动配置；如果有些组件可以有多个（比如 ViewResolver ），就将用户配置的和自己默认的组合起来。
  • ② 在 SpringBoot 中会有非常多的 xxxConfigurer 帮助我们进行扩展配置。
  • ③ 在 SpringBoot 中会有非常多的 xxxCustomizer 帮助我们进行定制配置。

6 错误处理机制

6.1 SpringBoot 错误的默认效果

  • 如果是浏览器：返回一个默认的错误页面：

返回一个默认的错误页面.png

  • 如果是其他客户端：返回一个默认的 JSON 数据。

返回一个默认的JSON数据.png

  • 原理：可以参照 ErrorMvcAutoConfiguration（错误处理的自动配置）。

    • ErrorMvcAutoConfiguration 的部分源码如下： ```java @Configuration @ConditionalOnWebApplication @ConditionalOnClass({ Servlet.class, DispatcherServlet.class }) // Load before the main WebMvcAutoConfiguration so that the error View is available @AutoConfigureBefore(WebMvcAutoConfiguration.class) @EnableConfigurationProperties(ResourceProperties.class) public class ErrorMvcAutoConfiguration { //给容器中添加DefaultErrorAttributes组件 @Bean @ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT) public DefaultErrorAttributes errorAttributes() { return new DefaultErrorAttributes(); } //给容器中添加BasicErrorController组件 @Bean @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT) public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) { return new BasicErrorController(errorAttributes, this.serverProperties.getError(),

      1.        this.errorViewResolvers);

      } //给容器中添加ErrorPageCustomizer组件 @Bean public ErrorPageCustomizer errorPageCustomizer() { return new ErrorPageCustomizer(this.serverProperties); }

      @Configuration static class DefaultErrorViewResolverConfiguration {

      private final ApplicationContext applicationContext;

      private final ResourceProperties resourceProperties;

      DefaultErrorViewResolverConfiguration(ApplicationContext applicationContext,

      1.        ResourceProperties resourceProperties) {
      2.    this.applicationContext = applicationContext;
      3.    this.resourceProperties = resourceProperties;

      }

      1. //给容器中添加DefaultErrorViewResolver组件

      @Bean @ConditionalOnBean(DispatcherServlet.class) @ConditionalOnMissingBean public DefaultErrorViewResolver conventionErrorViewResolver() {

      1.    return new DefaultErrorViewResolver(this.applicationContext,
      2.            this.resourceProperties);

      } } //其他略

}

  2.    - ErrorPageCustomizer：
  3. ```java
  4. @Configuration
  5. @ConditionalOnWebApplication
  6. @ConditionalOnClass({ Servlet.class, DispatcherServlet.class })
  7. // Load before the main WebMvcAutoConfiguration so that the error View is available
  8. @AutoConfigureBefore(WebMvcAutoConfiguration.class)
  9. @EnableConfigurationProperties(ResourceProperties.class)
  10. public class ErrorMvcAutoConfiguration {
  11.     /**
  12.      * {@link EmbeddedServletContainerCustomizer} that configures the container's error
  13.      * pages.
  14.      */
  15.     private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {
  17.         private final ServerProperties properties;
  19.         protected ErrorPageCustomizer(ServerProperties properties) {
  20.             this.properties = properties;
  21.         }
  23.          //            @Value("${error.path:/error}")  
  24.          //getPath() = private String path = "/error";
  25.          //系统出现错误以后会来到error请求进行处理。就如同在web.xml中配置错误页面规则
  26.         @Override
  27.         public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
  28.             ErrorPage errorPage = new ErrorPage(this.properties.getServletPrefix()
  29.                     + this.properties.getError().getPath());
  30.             errorPageRegistry.addErrorPages(errorPage);
  31.         }
  33.         @Override
  34.         public int getOrder() {
  35.             return 0;
  36.         }
  38.     }
  39.     //其他略
  40. }

  • BasicErrorController：处理默认的 /error 请求。

    1. @Controller
    2. @RequestMapping("${server.error.path:${error.path:/error}}")
    3. public class BasicErrorController extends AbstractErrorController {
    4. //产生HTML类型的数据，浏览器发送的请求来到这个方法处理
    5. @RequestMapping(produces = "text/html")
    6. public ModelAndView errorHtml(HttpServletRequest request,
    7.        HttpServletResponse response) {
    8.    HttpStatus status = getStatus(request);
    9.     //getErrorAttributes其实就是调用的DefaultErrorAttributes的getErrorAttributes方法，而DefaultErrorAttributes是从容器中获取的。
    10.    Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
    11.            request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
    12.    response.setStatus(status.value());
    13.    ModelAndView modelAndView = resolveErrorView(request, response, status, model);
    14.    return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
    15. }
    17. //产生JSON数据，其他客户端来到这个方法处理
    18. @RequestMapping
    19. @ResponseBody
    20. public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
    21.    Map<String, Object> body = getErrorAttributes(request,
    22.            isIncludeStackTrace(request, MediaType.ALL));
    23.    HttpStatus status = getStatus(request);
    24.    return new ResponseEntity<Map<String, Object>>(body, status);
    25. }
    27. //略   
    28. }

  • DefaultErrorViewResolver： ```java public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered { private static final Map SERIES_VIEWS;

    static { Map views = new HashMap(); views.put(Series.CLIENT_ERROR, “4xx”); views.put(Series.SERVER_ERROR, “5xx”); SERIES_VIEWS = Collections.unmodifiableMap(views); } @Override public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,

    1.    Map<String, Object> model) {

    ModelAndView modelAndView = resolve(String.valueOf(status), model); if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {

    1.    modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);

    } return modelAndView; }

    private ModelAndView resolve(String viewName, Map model) { //默认SpringBoot可以去找到一个页面 比如：/error/404 String errorViewName = “error/“ + viewName; //模板引擎可以解析这个页面地址就用模板引擎解析 TemplateAvailabilityProvider provider = this.templateAvailabilityProviders

    1.        .getProvider(errorViewName, this.applicationContext);

    if (provider != null) {

    1.     //模板引擎可用的情况下返回errorViewName指定的视图地址
    2.    return new ModelAndView(errorViewName, model);

    } //模板引擎不可用，就在静态资源文件夹下找errorViewName对象的页面 return resolveResource(errorViewName, model); }

    private ModelAndView resolveResource(String viewName, Map model) { for (String location : this.resourceProperties.getStaticLocations()) {

    1.    try {
    2.        Resource resource = this.applicationContext.getResource(location);
    3.        resource = resource.createRelative(viewName + ".html");
    4.        if (resource.exists()) {
    5.            return new ModelAndView(new HtmlResourceView(resource), model);
    6.        }
    7.    }
    8.    catch (Exception ex) {
    9.    }

    } return null; }
    //其他略

}

  2.    - DefaultErrorAttributes：
  3. ```java
  4. @Order(Ordered.HIGHEST_PRECEDENCE)
  5. public class DefaultErrorAttributes{
  6.     //帮助我们在页面中共享信息
  7.     @Override
  8.     public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
  9.             boolean includeStackTrace) {
  10.         Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
  11.         errorAttributes.put("timestamp", new Date());
  12.         addStatus(errorAttributes, requestAttributes);
  13.         addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
  14.         addPath(errorAttributes, requestAttributes);
  15.         return errorAttributes;
  16.     }
  17. }
  • 步骤：
    • 一旦系统出现 4xx 或者 5xx 之类的错误，ErrorPageCustomizer 就会生效（定制错误的响应规则），就会来到 /error 请求，就会被 BasicErrorController 处理。
    • 响应页面：去哪个页面是由 DefaultErrorViewResolver 解析得到的。
      1. public abstract class AbstractErrorController implements ErrorController {
      2. /**
      3. * Resolve any specific error views. By default this method delegates to
      4. * {@link ErrorViewResolver ErrorViewResolvers}.
      5. * @param request the request
      6. * @param response the response
      7. * @param status the HTTP status
      8. * @param model the suggested model
      9. * @return a specific {@link ModelAndView} or {@code null} if the default should be
      10. * used
      11. * @since 1.4.0
      12. */
      13. protected ModelAndView resolveErrorView(HttpServletRequest request,
      14.     HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
      15. for (ErrorViewResolver resolver : this.errorViewResolvers) {
      16.     ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
      17.     if (modelAndView != null) {
      18.         return modelAndView;
      19.     }
      20. }
      21. return null;
      22. }
      23. //其他略
      24. }

6.2 如果定制错误响应

6.2.1 如何定制错误页面

  • ① 如果有模板引擎的情况下，默认请求 error/状态码 ，并且返回 error/状态码的视图地址 ，那么我们只需要将错误页面命名为 错误状态码.html 并放在模板引擎文件夹（默认是 classpath:/template ）里面的 error 文件夹下。
    • 我们可以使用 4xx 和 5xx 作为错误页面的文件名来匹配这种类型的所有错误，精确优先（比如同时存在 404.html 和 4xx.html ，那么当发生 404 的错误的时候，会优先寻找 404.html，一旦匹配到了，就响应 404.html）。
    • 页面能获取的信息：
      • timestamp：时间戳。
      • status：状态码。
      • error：错误提示。
      • exception：异常对象。
      • errors：JSR303错误校验的信息。
      • path：错误路径。
  • ② 如果没有模板引擎（模板引擎找不多对应的错误页面），就去静态资源文件夹下寻找。
  • ③ 以上都没有错误页面，就来到 SpringBoot 默认的错误提示页面。

6.2.2 如何定制错误的 JSON 数据

  • ① 自定义异常处理&返回定义 JSON 数据：
  1. package com.sunxiaping.springboot.config;
  3. import org.springframework.web.bind.annotation.ControllerAdvice;
  4. import org.springframework.web.bind.annotation.ExceptionHandler;
  5. import org.springframework.web.bind.annotation.ResponseBody;
  7. import java.util.HashMap;
  8. import java.util.Map;
  10. /**
  11.  * @ControllerAdvice标注的类：就是对控制器进行增强，在这个类中，可以使用@InitBinder、@InitBinder和@ModelAttribute，这些功能都可以被所有的控制器共享
  12.  */
  13. @ControllerAdvice
  14. public class SelfExceptionHandler {
  15.     //浏览器客户端返回的都是JSON
  16.     @ExceptionHandler(value = SelfException.class)
  17.     @ResponseBody
  18.     public Map<String,Object> handleException(SelfException e){
  19.         Map<String,Object> map = new HashMap<>();
  20.         map.put("code",1);
  21.         map.put("msg",e.getMessage());
  22.         return map;
  23.     }   
  24. }
  • ② 转发到 /error 进行自适应响应效果处理：
  1. package com.sunxiaping.springboot.config;
  3. import org.springframework.web.bind.annotation.ControllerAdvice;
  4. import org.springframework.web.bind.annotation.ExceptionHandler;
  6. import javax.servlet.http.HttpServletRequest;
  7. import javax.servlet.http.HttpServletResponse;
  8. import java.util.HashMap;
  9. import java.util.Map;
  11. /**
  12.  * @ControllerAdvice标注的类：就是对控制器进行增强，在这个类中，可以使用@InitBinder、@InitBinder和@ModelAttribute，这些功能都可以被所有的控制器共享
  13.  */
  14. @ControllerAdvice
  15. public class SelfExceptionHandler {
  17.     @ExceptionHandler(value = SelfException.class)
  18.     public String handleException(HttpServletRequest request, HttpServletResponse response, SelfException e) {
  19.         Map<String, Object> map = new HashMap<>();
  20.         //传入我们自己的错误状态码，否则就不会进入定制的错误页面的解析流程
  21.         request.setAttribute("javax.servlet.error.status_code", 500);
  22.         map.put("code", 1);
  23.         map.put("msg", e.getMessage());
  24.         return "forward:/error";
  25.     }
  27. }
  • ③ 将我们的定制数据携带出去：
    • 出现错误以后，会来到 /error 请求，会被 BasicErrorController 处理，响应出去可以获取的数据是由 getErrorAttributes 得到的（是 AbstractErrorController 中规定的方法），所以我们可以编写一个 ErrorController 的实现类或 AbstractErrorController 的子类，放在容器中。
    • 页面上能用的数据或者是 JSON 返回能用的数据都是通过 errorAttributes.getErrorAttributes() 方法得到的，容器中的 DefaultErrorAttributes.getErrorAttributes() 方法是默认进行数据处理的。 ```java package com.sunxiaping.springboot.config;

import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler;

import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.util.HashMap; import java.util.Map;

/**

  • @ControllerAdvice标注的类：就是对控制器进行增强，在这个类中，可以使用@InitBinder、@InitBinder和@ModelAttribute，这些功能都可以被所有的控制器共享 */ @ControllerAdvice public class SelfExceptionHandler {

    @ExceptionHandler(value = SelfException.class) public String handleException(HttpServletRequest request, HttpServletResponse response, SelfException e) {

    1.  Map<String, Object> map = new HashMap<>();
    2.  //传入我们自己的错误状态码
    3.  request.setAttribute("javax.servlet.error.status_code", 500);
    4.  map.put("code", 1);
    5.  map.put("msg", e.getMessage());
    7.  request.setAttribute("ext", map);
    8.  return "forward:/error";

    }

}

  1. ```java
  2. package com.sunxiaping.springboot.config;
  4. import org.springframework.boot.autoconfigure.web.DefaultErrorAttributes;
  5. import org.springframework.stereotype.Component;
  6. import org.springframework.web.context.request.RequestAttributes;
  8. import java.util.Map;
  10. @Component
  11. public class SelfErrorAttributes extends DefaultErrorAttributes {
  12.     @Override
  13.     public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
  14.         Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
  15.         Object ext = requestAttributes.getAttribute("ext", RequestAttributes.SCOPE_REQUEST);
  16.         map.put("ext", ext);
  17.         return map;
  18.     }
  19. }

7 配置嵌入式 Servlet 容器

7.1 如何定制和修改 Servlet 容器的相关配置

7.1.1 修改和 server 有关的配置( ServerProperties )

  1. server:
  2.   port: 8081
  3.   context-path: /spring
  4.   tomcat:
  5.     uri-encoding: utf-8
  7. # 通用的servlet容器配置
  8. server:
  9.     xxx: 
  10. # Tomcat的设置
  11. server:
  12.     tomcat: 
  13.         xxx:

7.1.2 编写一个 EmbeddedServletContainerCustomizer (嵌入式的 Servlet 容器的定制器)来修改 Servlet 有关配置

  1. package com.sunxiaping.springboot.config;
  3. import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
  4. import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  7. import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
  8. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
  10. @Configuration
  11. public class SpringMvcConfig extends WebMvcConfigurerAdapter {
  13.     @Override
  14.     public void addViewControllers(ViewControllerRegistry registry) {
  15.         registry.addViewController("/index").setViewName("index");
  16.         registry.addViewController("/").setViewName("index");
  17.         registry.addViewController("/index.html").setViewName("index");
  18.         registry.addViewController("/index.htm").setViewName("index");
  19.     }
  21.     @Bean
  22.     public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer() {
  23.         return new EmbeddedServletContainerCustomizer() {
  24.             /**定制嵌入式的Servlet容器的相关规则
  25.              * @param container
  26.              */
  27.             @Override
  28.             public void customize(ConfigurableEmbeddedServletContainer container) {
  29.                 container.setPort(8081);
  30.             }
  31.         };
  32.     }   
  33. }

7.1.3 注册 Servlet 三大组件

  1. package com.sunxiaping.springboot.servet;
  3. import javax.servlet.ServletException;
  4. import javax.servlet.http.HttpServlet;
  5. import javax.servlet.http.HttpServletRequest;
  6. import javax.servlet.http.HttpServletResponse;
  7. import java.io.IOException;
  9. public class SelfServlet extends HttpServlet {
  11.     @Override
  12.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  13.         resp.getWriter().println("hello servlet");
  14.     }
  16.     @Override
  17.     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  18.         this.doGet(req, resp);
  19.     }
  20. }
  1. package com.sunxiaping.springboot.config;
  3. import com.sunxiaping.springboot.servet.SelfServlet;
  4. import org.springframework.boot.web.servlet.ServletRegistrationBean;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  8. @Configuration
  9. public class ServletConfig {
  11.     /**
  12.      * 注册Servlet,向容器中添加ServletRegistrationBean组件
  13.      * 注册Filter，向容器中添加FilterRegistrationBean组件
  14.      * 注册Listener，向容器中添加ServletListenerRegistrationBean组件
  15.      *
  16.      * @return
  17.      */
  18.     @Bean
  19.     public ServletRegistrationBean servletRegistrationBean() {
  20.         return new ServletRegistrationBean(new SelfServlet(), "/hello");
  21.     }
  22. }

7.2 SpringBoot 支持其他的 Servlet 容器

  • SpringBoot 默认支持 Tomcat 、Jetty 、Undertow 。

SpringBoot默认支持的Servlet容器.png

  • Tomcat(默认支持)：
  1. <dependency>
  2.     <!-- 引入web模块，默认支持Tomcat -->
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-web</artifactId>
  5. </dependency>
  • Jetty：
  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-web</artifactId>
  4.     <exclusions>
  5.         <exclusion>
  6.             <artifactId>spring-boot-starter-tomcat</artifactId>
  7.             <groupId>org.springframework.boot</groupId>
  8.         </exclusion>
  9.     </exclusions>
  10. </dependency>
  11. <dependency>
  12.     <groupId>org.springframework.boot</groupId>
  13.     <artifactId>spring-boot-starter-jetty</artifactId>
  14. </dependency>
  • Undertow：
  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-web</artifactId>
  4.     <exclusions>
  5.         <exclusion>
  6.             <artifactId>spring-boot-starter-tomcat</artifactId>
  7.             <groupId>org.springframework.boot</groupId>
  8.         </exclusion>
  9.     </exclusions>
  10. </dependency>
  11. <dependency>
  12.     <groupId>org.springframework.boot</groupId>
  13.     <artifactId>spring-boot-starter-undertow</artifactId>
  14. </dependency>

7.3 嵌入式 Servlet 容器自动配置原理

  • EmbeddedServletContainerAutoConfiguration：嵌入式的 Servlet 容器自动配置
  1. @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
  2. @Configuration
  3. @ConditionalOnWebApplication
  4. @Import(BeanPostProcessorsRegistrar.class) 
  5. //BeanPostProcessorsRegistrar：给容器中导入一些组件。
  6. //导入了EmbeddedServletContainerCustomizerBeanPostProcessor
  7. //后置处理器：Bean初始化前后（创建完对象，还没赋值）执行初始化工作。
  8. public class EmbeddedServletContainerAutoConfiguration {
  10.     @Configuration
  11.     @ConditionalOnClass({ Servlet.class, Tomcat.class }) //判断当前是否引入了Tomcat的依赖
  12.     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)//判断当前容器没有用户自己定义的EmbeddedServletContainerFactory：嵌入式的Servlet容器工厂；作用是创建嵌入式的Servlet容器
  13.     public static class EmbeddedTomcat {
  15.         @Bean
  16.         public TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory() {
  17.             return new TomcatEmbeddedServletContainerFactory();
  18.         }
  20.     }
  22.     /**
  23.      * Nested configuration if Jetty is being used.
  24.      */
  25.     @Configuration
  26.     @ConditionalOnClass({ Servlet.class, Server.class, Loader.class,
  27.             WebAppContext.class })
  28.     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
  29.     public static class EmbeddedJetty {
  31.         @Bean
  32.         public JettyEmbeddedServletContainerFactory jettyEmbeddedServletContainerFactory() {
  33.             return new JettyEmbeddedServletContainerFactory();
  34.         }
  36.     }
  38.     /**
  39.      * Nested configuration if Undertow is being used.
  40.      */
  41.     @Configuration
  42.     @ConditionalOnClass({ Servlet.class, Undertow.class, SslClientAuthMode.class })
  43.     @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
  44.     public static class EmbeddedUndertow {
  46.         @Bean
  47.         public UndertowEmbeddedServletContainerFactory undertowEmbeddedServletContainerFactory() {
  48.             return new UndertowEmbeddedServletContainerFactory();
  49.         }
  51.     }
  52.     //略
  54. }
  • EmbeddedServletContainerFactory：嵌入式的 Servlet 容器工厂
  1. public interface EmbeddedServletContainerFactory {
  3.     /**
  4.      * 获取的嵌入式的Servlet容器
  5.      */
  6.     EmbeddedServletContainer getEmbeddedServletContainer(
  7.             ServletContextInitializer... initializers);
  9. }

嵌入式的Servlet容器.png

  • EmbeddedServletContainer：嵌入式的 Servlet 容器。
  1. public interface EmbeddedServletContainer {
  3.     /**
  4.      * Starts the embedded servlet container. Calling this method on an already started
  5.      * container has no effect.
  6.      * @throws EmbeddedServletContainerException if the container cannot be started
  7.      */
  8.     void start() throws EmbeddedServletContainerException;
  10.     /**
  11.      * Stops the embedded servlet container. Calling this method on an already stopped
  12.      * container has no effect.
  13.      * @throws EmbeddedServletContainerException if the container cannot be stopped
  14.      */
  15.     void stop() throws EmbeddedServletContainerException;
  17.     /**
  18.      * Return the port this server is listening on.
  19.      * @return the port (or -1 if none)
  20.      */
  21.     int getPort();
  23. }

嵌入式的Servlet容器工厂.png

  • 以 TomcatEmbeddedServletContainerFactory 为例：
  1. public class TomcatEmbeddedServletContainerFactory
  2.         extends AbstractEmbeddedServletContainerFactory implements ResourceLoaderAware {
  3.        @Override
  4.     public EmbeddedServletContainer getEmbeddedServletContainer(
  5.             ServletContextInitializer... initializers) {
  6.          //创建一个Tomcat
  7.         Tomcat tomcat = new Tomcat();
  8.          //配置TOmcat的基本环境
  9.         File baseDir = (this.baseDirectory != null ? this.baseDirectory
  10.                 : createTempDir("tomcat"));
  11.         tomcat.setBaseDir(baseDir.getAbsolutePath());
  12.         Connector connector = new Connector(this.protocol);
  13.         tomcat.getService().addConnector(connector);
  14.         customizeConnector(connector);
  15.         tomcat.setConnector(connector);
  16.         tomcat.getHost().setAutoDeploy(false);
  17.         configureEngine(tomcat.getEngine());
  18.         for (Connector additionalConnector : this.additionalTomcatConnectors) {
  19.             tomcat.getService().addConnector(additionalConnector);
  20.         }
  21.         prepareContext(tomcat.getHost(), initializers);
  22.          //将配置好的Tomcat传入进去，返回一个嵌入式的Servlet容器，并且启动Tomcat服务器
  23.         return getTomcatEmbeddedServletContainer(tomcat);
  24.     }
  26.     protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
  27.             Tomcat tomcat) {
  28.         return new TomcatEmbeddedServletContainer(tomcat, getPort() >= 0);
  29.     }
  31.     public TomcatEmbeddedServletContainer(Tomcat tomcat, boolean autoStart) {
  32.         Assert.notNull(tomcat, "Tomcat Server must not be null");
  33.         this.tomcat = tomcat;
  34.         this.autoStart = autoStart;
  35.         initialize();
  36.     }
  37.     private void initialize() throws EmbeddedServletContainerException {
  38.         TomcatEmbeddedServletContainer.logger
  39.                 .info("Tomcat initialized with port(s): " + getPortsDescription(false));
  40.         synchronized (this.monitor) {
  41.             try {
  42.                 addInstanceIdToEngineName();
  43.                 try {
  44.                     // Remove service connectors to that protocol binding doesn't happen
  45.                     // yet
  46.                     removeServiceConnectors();
  48.                     // 启动Tomcat
  49.                     this.tomcat.start();
  51.                     // We can re-throw failure exception directly in the main thread
  52.                     rethrowDeferredStartupExceptions();
  54.                     Context context = findContext();
  55.                     try {
  56.                         ContextBindings.bindClassLoader(context, getNamingToken(context),
  57.                                 getClass().getClassLoader());
  58.                     }
  59.                     catch (NamingException ex) {
  60.                         // Naming is not enabled. Continue
  61.                     }
  63.                     // Unlike Jetty, all Tomcat threads are daemon threads. We create a
  64.                     // blocking non-daemon to stop immediate shutdown
  65.                     startDaemonAwaitThread();
  66.                 }
  67.                 catch (Exception ex) {
  68.                     containerCounter.decrementAndGet();
  69.                     throw ex;
  70.                 }
  71.             }
  72.             catch (Exception ex) {
  73.                 throw new EmbeddedServletContainerException(
  74.                         "Unable to start embedded Tomcat", ex);
  75.             }
  76.         }
  77.     }
  78.     //略
  79. }
  • 我们对嵌入式容器的配置修改是怎么修改的？
    • ① ServerProperties。ServerProperties 其实是 EmbeddedServletContainerCustomizer 的子类。
    • ② EmbeddedServletContainerCustomizer ：定制器帮我们修改了 Servlet 容器的配置。
  • 容器中导入了 EmbeddedServletContainerCustomizerBeanPostProcessor ：
  1. public class EmbeddedServletContainerCustomizerBeanPostProcessor
  2.         implements BeanPostProcessor, BeanFactoryAware {
  3.     //在初始化之前
  4.      @Override
  5.     public Object postProcessBeforeInitialization(Object bean, String beanName)
  6.             throws BeansException {
  7.          //如果当前初始化的是一个ConfigurableEmbeddedServletContainer类型的组件
  8.         if (bean instanceof ConfigurableEmbeddedServletContainer) {
  9.              //EmbeddedServletContainerCustomizer定制器，调用每个定制器的customize方法，来给Servlet容器进行属性赋值
  10.             postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean);
  11.         }
  12.         return bean;
  13.     }
  14.     @Override
  15.     public Object postProcessAfterInitialization(Object bean, String beanName)
  16.             throws BeansException {
  17.         return bean;
  18.     }
  20.     private void postProcessBeforeInitialization(
  21.             ConfigurableEmbeddedServletContainer bean) {
  22.         for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) {
  23.             customizer.customize(bean);
  24.         }
  25.     }
  26.     private Collection<EmbeddedServletContainerCustomizer> getCustomizers() {
  27.         if (this.customizers == null) {
  28.             // Look up does not include the parent context
  29.             this.customizers = new ArrayList<EmbeddedServletContainerCustomizer>(
  30.                     this.beanFactory
  31.                                //从容器中获取所有EmbeddedServletContainerCustomizer类型的组件
  32.                                //所以定制容器，可以给容器中配置EmbeddedServletContainerCustomizer类型的组件
  33.                             .getBeansOfType(EmbeddedServletContainerCustomizer.class,
  34.                                     false, false)
  35.                             .values());
  36.             Collections.sort(this.customizers, AnnotationAwareOrderComparator.INSTANCE);
  37.             this.customizers = Collections.unmodifiableList(this.customizers);
  38.         }
  39.         return this.customizers;
  40.     }
  41.     //其他略
  43. }

总结：

  • ① SpringBoot 根据导入的依赖情况，给容器中添加相应的 EmbeddedServletContainerFactory（以 TomcatEmbeddedServletContainerFactory 为例）。
  • ② 容器中某个组件要创建对象就会惊动后置处理器（EmbeddedServletContainerCustomizerBeanPostProcessor），是因为 EmbeddedServletContainerAutoConfiguration 中使用 @Import 注解，导入了 BeanPostProcessorsRegistrar ，而 BeanPostProcessorsRegistrar 是一个 ImportBeanDefinitionRegistrar ，向容器中导入了 EmbeddedServletContainerCustomizerBeanPostProcessor ，简而言之，只要是嵌入式的 Servlet 容器工厂，后置处理器就工作。
  • ③ 后置处理器，从容器中获取所有的 EmbeddedServletContainerCustomizer ，调用定制器的 customize（ServerProperties 其实就是 EmbeddedServletContainerCustomizer ）。

7.4 嵌入式 Servlet 容器启动原理

  • ① SpringBoot 应用启动运行 run 方法。
  • ② refreshContext(context)；SpringBoot 刷新 IOC 容器（创建 IOC 容器，并初始化容器，创建容器中的每一个组件）；如果是 Web 应用，创建的是 AnnotationConfigEmbeddedWebApplicationContext ；如果不是 web 应用，创建的是 ConfigurableWebApplicationContext 。
  • ③ refresh(context); 刷新刚才创建好的 web 容器。
  1. @Override
  2. public void refresh() throws BeansException, IllegalStateException {
  3.     synchronized (this.startupShutdownMonitor) {
  4.         // Prepare this context for refreshing.
  5.         prepareRefresh();
  7.         // Tell the subclass to refresh the internal bean factory.
  8.         ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
  10.         // Prepare the bean factory for use in this context.
  11.         prepareBeanFactory(beanFactory);
  13.         try {
  14.             // Allows post-processing of the bean factory in context subclasses.
  15.             postProcessBeanFactory(beanFactory);
  17.             // Invoke factory processors registered as beans in the context.
  18.             invokeBeanFactoryPostProcessors(beanFactory);
  20.             // Register bean processors that intercept bean creation.
  21.             registerBeanPostProcessors(beanFactory);
  23.             // Initialize message source for this context.
  24.             initMessageSource();
  26.             // Initialize event multicaster for this context.
  27.             initApplicationEventMulticaster();
  29.             // 刷新容器
  30.             onRefresh();
  32.             // Check for listener beans and register them.
  33.             registerListeners();
  35.             // Instantiate all remaining (non-lazy-init) singletons.
  36.             finishBeanFactoryInitialization(beanFactory);
  38.             // Last step: publish corresponding event.
  39.             finishRefresh();
  40.         }
  42.         catch (BeansException ex) {
  43.             if (logger.isWarnEnabled()) {
  44.                 logger.warn("Exception encountered during context initialization - " +
  45.                             "cancelling refresh attempt: " + ex);
  46.             }
  48.             // Destroy already created singletons to avoid dangling resources.
  49.             destroyBeans();
  51.             // Reset 'active' flag.
  52.             cancelRefresh(ex);
  54.             // Propagate exception to caller.
  55.             throw ex;
  56.         }
  58.         finally {
  59.             // Reset common introspection caches in Spring's core, since we
  60.             // might not ever need metadata for singleton beans anymore...
  61.             resetCommonCaches();
  62.         }
  63.     }
  64. }
  • ④ onRefresh(); web 的 IOC 容器重写了 onRefresh 方法。
  • ⑤ web 的IOC 容器会创建嵌入式的 Servlet 容器。
  1. public class EmbeddedWebApplicationContext extends GenericWebApplicationContext {
  3.     @Override
  4.     protected void onRefresh() {
  5.         super.onRefresh();
  6.         try {
  7.             //创建嵌入式的Servlet容器
  8.             createEmbeddedServletContainer();
  9.         }
  10.         catch (Throwable ex) {
  11.             throw new ApplicationContextException("Unable to start embedded container",
  12.                     ex);
  13.         }
  14.     }
  16.     private void createEmbeddedServletContainer() {
  17.         EmbeddedServletContainer localContainer = this.embeddedServletContainer;
  18.         ServletContext localServletContext = getServletContext();
  19.         if (localContainer == null && localServletContext == null) {
  20.             //获取嵌入式的Servlet容器工厂
  21.              //从IOC容器中获取EmbeddedServletContainerFactory组件。TomcatEmbeddedServletContainerFactory创建对象，后置处理器一看是这个对象，就获取所有的定制器来先定制Servlet容器的相关配置
  22.             EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory();
  23.             this.embeddedServletContainer = containerFactory
  24.                     .getEmbeddedServletContainer(getSelfInitializer());
  25.         }
  26.         else if (localServletContext != null) {
  27.             try {
  28.                 getSelfInitializer().onStartup(localServletContext);
  29.             }
  30.             catch (ServletException ex) {
  31.                 throw new ApplicationContextException("Cannot initialize servlet context",
  32.                         ex);
  33.             }
  34.         }
  35.         initPropertySources();
  36.     }
  37.     //其他略
  39. }
  • ⑥ 获取嵌入式的 Servlet 容器工厂：
  1. public class EmbeddedWebApplicationContext extends GenericWebApplicationContext {
  3.     @Override
  4.     protected void onRefresh() {
  5.         super.onRefresh();
  6.         try {
  7.             //创建嵌入式的Servlet容器
  8.             createEmbeddedServletContainer();
  9.         }
  10.         catch (Throwable ex) {
  11.             throw new ApplicationContextException("Unable to start embedded container",
  12.                     ex);
  13.         }
  14.     }
  16.     private void createEmbeddedServletContainer() {
  17.         EmbeddedServletContainer localContainer = this.embeddedServletContainer;
  18.         ServletContext localServletContext = getServletContext();
  19.         if (localContainer == null && localServletContext == null) {
  20.             //获取嵌入式的Servlet容器工厂
  21.              //从IOC容器中获取EmbeddedServletContainerFactory组件。TomcatEmbeddedServletContainerFactory创建对象，后置处理器一看是这个对象，就获取所有的定制器来先定制Servlet容器的相关配置
  22.             EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory();
  23.             this.embeddedServletContainer = containerFactory
  24.                     .getEmbeddedServletContainer(getSelfInitializer());
  25.         }
  26.         else if (localServletContext != null) {
  27.             try {
  28.                 getSelfInitializer().onStartup(localServletContext);
  29.             }
  30.             catch (ServletException ex) {
  31.                 throw new ApplicationContextException("Cannot initialize servlet context",
  32.                         ex);
  33.             }
  34.         }
  35.         initPropertySources();
  36.     }
  37.     //其他略
  39. }
  • ⑦ 使用容器工厂获取嵌入式的 Servle t容器：this.embeddedServletContainer = containerFactory.getEmbeddedServletContainer(getSelfInitializer());
  • ⑧ 嵌入式的 Servlet 容器创建对象并启动 Servlet 容器。