Spring Boot 3.x- Servlet Web应用程序开发(嵌入式容器)

系列文章目录

文章目录

系列文章目录
前言
使用非Tomcat容器
Servlet, Filter, 和 Listener
- 注册
扫描
Servlet上下文初始化
ServletWebServerApplicationContext
定制嵌入式Servlet容器
SameSite Cookie
编码配置容器
直接定制ConfigurableServletWebServerFactory
JSP限制

前言

对于servlet应用程序，Spring Boot包括对嵌入式Tomcat、Jetty和Undertow服务器的支持。大多数开发人员使用适当的“Starter”来获得完全配置的实例。默认情况下，嵌入式服务器在端口8080上侦听HTTP请求。

使用非Tomcat容器

许多Spring Boot启动器都包含默认的嵌入式容器。对于servlet堆栈应用程序，spring-boot-starter-web通过包含spring-boot-starter-tomcat来包含Tomcat，但您可以使用spring-boot-starter-jetty或spring-boot-starter-undertow来代替。

当切换到不同的HTTP服务器时，您需要将默认依赖项交换为您需要的依赖项。为了帮助完成这个过程，Spring Boot为每个受支持的HTTP服务器提供了一个单独的starter。

下面的Maven示例展示了如何在Spring MVC中排除Tomcat并包含Jetty:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!-- Exclude the Tomcat dependency -->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- Use Jetty instead -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jetty</artifactId>
</dependency>

如果你想使用Jetty 10，它支持servlet 4.0，你可以这样做，如下所示的例子:

<properties>
    <jetty.version>10.0.8</jetty.version>
</properties>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <!-- Exclude the Tomcat dependency -->
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
        <!-- Exclude the Jetty-9 specific dependencies -->
        <exclusion>
            <groupId>org.eclipse.jetty.websocket</groupId>
            <artifactId>websocket-server</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.eclipse.jetty.websocket</groupId>
            <artifactId>javax-websocket-server-impl</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- Use Jetty instead -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jetty</artifactId>
</dependency>

Servlet, Filter, 和 Listener

当使用嵌入的servlet容器时，你可以通过使用Spring bean或扫描servlet组件从servlet规范注册Servlet、Filter和Listener(如HttpSessionListener)。

注册

任何作为Spring bean的Servlet、Filter或servlet *Listener实例都被注册到嵌入式容器中。而且非常方便使用application.properties的属性值。

默认情况下，如果上下文只包含单个Servlet，则将其映射到/。在使用多个servlet bean的情况下，bean名被用作路径前缀。过滤器映射到/*。
如果基于约定的映射不够灵活，你可以使用ServletRegistrationBean、FilterRegistrationBean和ServletListenerRegistrationBean类进行完全控制。

通常情况下，保持过滤器无序是安全的。如果需要特定的顺序，你应该用@Order注解过滤器，或者让它实现Ordered接口。

不能通过使用@Order注解过滤器的bean方法来配置它的顺序。

如果你不能更改Filter类以添加@Order或实现Ordered接口，则必须为Filter定义一个FilterRegistrationBean，并使用setOrder(int)方法设置注册bean的顺序。

避免配置顺序为Ordered.HIGHEST_PRECEDENCE读取请求体的过滤器，因为它可能会违背应用程序的字符编码配置。如果servlet过滤器包装了请求，它应该配置一个小于或等于OrderedFilter.REQUEST_WRAPPER_FILTER_MAX_ORDER的顺序。

要查看应用程序中每个Filter的顺序，请为web日志记录组启用调试级别日志记录(logging.level.web=debug)。注册过滤器的详细信息，包括它们的顺序和URL模式，将在启动时被记录。

注册Filter bean时要小心，因为它们是在应用程序生命周期的早期初始化的。如果你需要注册与其他bean交互的过滤器，请考虑使用DelegatingFilterProxyRegistrationBean。

扫描

当使用嵌入式容器时，可以通过使用@ServletComponentScan来启用带有@WebServlet、@WebFilter和@WebListener注释的类的自动注册。

@ServletComponentScan在独立的容器中不起作用，而是使用容器的内置发现机制。

Servlet上下文初始化

嵌入的servlet容器不会直接执行jakarta.servlet.ServletContainerInitializer接口或Spring的org.springframework.web.WebApplicationInitializer接口。

这是一个有意的设计决策，旨在减少第三方库在war中运行可能破坏Spring Boot应用程序的风险。
如果你需要在Spring Boot应用程序中执行servlet上下文初始化，你应该注册一个实现org.springframework.boot.web.servlet.ServletContextInitializer接口的bean。
单个onStartup方法提供了对ServletContext的访问，如果有必要，可以很容易地将其用作现有WebApplicationInitializer的适配器。

ServletWebServerApplicationContext

在内部，Spring Boot使用了一种不同类型的ApplicationContext来支持嵌入式servlet容器。

ServletWebServerApplicationContext是WebApplicationContext的一种特殊类型，它通过搜索单个ServletWebServerFactory bean来引导自己。
通常TomcatServletWebServerFactory, JettyServletWebServerFactory，或UndertowServletWebServerFactory已经被自动配置。

在嵌入式容器设置中，ServletContext被设置为在应用程序上下文初始化期间发生的服务器启动的一部分。因此，ApplicationContext中的bean不能用ServletContext可靠地初始化。

解决这个问题的一种方法是将ApplicationContext作为bean的依赖项注入，并仅在需要时访问ServletContext。另一种方法是在服务器启动后使用回调。可以使用ApplicationListener来监听ApplicationStartedEvent，如下所示:

public class MyDemoBean implements ApplicationListener<ApplicationStartedEvent> {
   
     

    private ServletContext servletContext;

    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
   
     
        ApplicationContext applicationContext = event.getApplicationContext();
        this.servletContext = ((WebApplicationContext) applicationContext).getServletContext();
    }

}

定制嵌入式Servlet容器

servlet容器设置可以通过使用Spring Environment属性来配置。通常可以在application.properties 或 application.yaml配置属性

常用的服务器设置包括:

1、 网络设置：HTTP请求的监听端口(server.port),绑定地址(server.address)；
2、 Session设置：会话是否持久(server.servlet.session.persistent),session超时(server.servlet.session.timeout),会话数据存储位置(server.servlet.session.store-dir),session-cookie配置(server.servlet.session.cookie.*)；
3、 错误管理:错误页面的路径(server.error.path)；
4、 SSL:SSL可以通过设置各种server.ssl.*属性，通常在application.properties；
5、 HTTP压缩；

除了通用配置，针对不同容器Spring Boot也有个性化配置比如:server.tomcat 和 server.undertow。

SameSite Cookie

浏览器可以使用SameSite cookie属性来控制是否以及如何在跨站点请求中提交cookie。

Chrome 51 开始，浏览器的 Cookie 新增加了一个SameSite属性，用来防止 CSRF 攻击和用户追踪。

如果你想改变你的session cookie的SameSite属性，你可以使用server.servlet.session.cookie.same-site属性。自动配置的Tomcat、Jetty和Undertow服务器支持此属性。它还用于配置基于SessionRepository bean的Spring Session servlet。

例如，如果你希望你的会话cookie有一个SameSite属性为None，你可以将以下内容添加到你的application.properties 或者 application.yaml文件:

server:
  servlet:
    session:
      cookie:
        same-site: "none"

如果你想要改变添加到HttpServletResponse的其他cookie上的SameSite属性，你可以使用CookieSameSiteSupplier。CookieSameSiteSupplier被传递一个Cookie，会返回一个SameSite值或null。
你可以使用许多方便的工厂和过滤器方法来快速匹配特定的cookie。例如，添加以下bean将自动匹配名称为myapp.*的cookie，并设置SameSite为Lax。

@Configuration(proxyBeanMethods = false)
public class MySameSiteConfiguration {
   
     

    @Bean
    public CookieSameSiteSupplier applicationCookieSameSiteSupplier() {
   
     
        return CookieSameSiteSupplier.ofLax().whenHasNameMatching("myapp.*");
    }

}

编码配置容器

如果需要以编程方式配置嵌入式servlet容器，你可以注册一个实现WebServerFactoryCustomizer接口的Spring bean。WebServerFactoryCustomizer提供对ConfigurableServletWebServerFactory的访问。其中包括许多自定义setter方法。下面的例子显示了以编程方式设置端口:

@Component
public class MyWebServerFactoryCustomizer implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
   
     

    @Override
    public void customize(ConfigurableServletWebServerFactory server) {
   
     
        server.setPort(9000);
    }

}

TomcatServletWebServerFactory, JettyServletWebServerFactory和UndertowServletWebServerFactory是ConfigurableServletWebServerFactory的专用变体，它们为Tomcat,Jetty,Undertow提供了额外的定制setter方法。

下面的例子展示了如何定制TomcatServletWebServerFactory来提供对特定于tomcat的配置选项的访问:

@Component
public class MyTomcatWebServerFactoryCustomizer implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
   
     

    @Override
    public void customize(TomcatServletWebServerFactory server) {
   
     
        server.addConnectorCustomizers((connector) -> connector.setAsyncTimeout(Duration.ofSeconds(20).toMillis()));
    }

}

直接定制ConfigurableServletWebServerFactory

对于需要从ServletWebServerFactory扩展的更高级用例，你可以自己公开此类类型的bean。
为许多配置选项提供了setter。如果您需要执行一些更特殊的操作，还提供了几个受保护的方法“hooks”。

自动配置的定制器仍然应用于自定义工厂，因此要谨慎使用该选项。

JSP限制

当运行使用嵌入式servlet容器(并打包为可执行归档文件)的Spring Boot应用程序时，JSP支持存在一些限制。

1、使用Jetty和Tomcat，如果您使用war打包，它应该可以工作当使用java-jar启动时，可执行war可以工作，也可以部署到任何标准容器使用可执行jar时不支持jsp；
2、 Undertow不支持jsp；
3、创建自定义error.jsp页面不会覆盖用于错误处理的默认视图，需要使用自定义错误页面方式；