此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.4.0! |
嵌入式 Web 服务器
每个 Spring Boot Web 应用程序都包含一个嵌入式 Web 服务器。 此功能会导致许多作问题,包括如何更改嵌入式服务器以及如何配置嵌入式服务器。 本节将回答这些问题。
使用其他 Web 服务器
许多 Spring Boot Starters包括默认的嵌入式容器。
-
对于 servlet 堆栈应用程序,
spring-boot-starter-web
包括 Tomcat,包括spring-boot-starter-tomcat
,但您可以使用spring-boot-starter-jetty
或spring-boot-starter-undertow
相反。 -
对于反应式堆栈应用程序,
spring-boot-starter-webflux
包括 Reactor Netty,包括spring-boot-starter-reactor-netty
,但您可以使用spring-boot-starter-tomcat
,spring-boot-starter-jetty
或spring-boot-starter-undertow
相反。
切换到其他 HTTP 服务器时,您需要将默认依赖项交换为所需的依赖项。 为了帮助完成此过程, Spring Boot 为每个受支持的 HTTP 服务器提供了一个单独的Starters。
下面的 Maven 示例展示了如何排除 Tomcat 并包括 Jetty for Spring MVC:
<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>
下面的 Gradle 示例配置了必要的依赖项和模块替换,以使用 Undertow 代替 Spring WebFlux 的 Reactor Netty:
dependencies {
implementation "org.springframework.boot:spring-boot-starter-undertow"
implementation "org.springframework.boot:spring-boot-starter-webflux"
modules {
module("org.springframework.boot:spring-boot-starter-reactor-netty") {
replacedBy("org.springframework.boot:spring-boot-starter-undertow", "Use Undertow instead of Reactor Netty")
}
}
}
spring-boot-starter-reactor-netty 需要使用WebClient 类,因此即使需要包含不同的 HTTP 服务器,也可能需要保持对 Netty 的依赖。 |
禁用 Web 服务器
如果你的 Classpath 包含启动 Web 服务器所需的位,Spring Boot 将自动启动它。
要禁用此行为,请配置WebApplicationType
在application.properties
,如以下示例所示:
-
Properties
-
YAML
spring.main.web-application-type=none
spring:
main:
web-application-type: "none"
更改 HTTP 端口
在独立应用程序中,主 HTTP 端口默认为8080
但可以使用server.port
(例如,在application.properties
或作为 System 属性)。
得益于Environment
值,您还可以使用SERVER_PORT
(例如,作为 OS 环境变量)。
要完全关闭 HTTP 端点,但仍创建一个WebApplicationContext
用server.port=-1
(这样做有时对测试很有用)。
有关更多详细信息,请参见“Spring Boot 功能”部分中的自定义嵌入式 Servlet 容器,或者ServerProperties
类。
在运行时发现 HTTP 端口
您可以从日志输出或WebServerApplicationContext
通过其WebServer
.
获取该 ID 并确保它已初始化的最佳方法是添加一个@Bean
的类型ApplicationListener<WebServerInitializedEvent>
并在发布事件时将容器从事件中拉出。
使用@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
也可以使用@LocalServerPort
annotation 中,如以下示例所示:
-
Java
-
Kotlin
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.server.LocalServerPort;
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyWebIntegrationTests {
@LocalServerPort
int port;
// ...
}
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment
import org.springframework.boot.test.web.server.LocalServerPort
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyWebIntegrationTests {
@LocalServerPort
var port = 0
// ...
}
|
启用 HTTP 响应压缩
Jetty、Tomcat、Reactor Netty 和 Undertow 支持 HTTP 响应压缩。
可以在application.properties
如下:
-
Properties
-
YAML
server.compression.enabled=true
server:
compression:
enabled: true
默认情况下,响应的长度必须至少为 2048 字节才能执行压缩。
您可以通过设置server.compression.min-response-size
财产。
默认情况下,仅当响应的内容类型为以下之一时,才会压缩响应:
-
text/html
-
text/xml
-
text/plain
-
text/css
-
text/javascript
-
application/javascript
-
application/json
-
application/xml
您可以通过设置server.compression.mime-types
财产。
配置 SSL
SSL 可以通过设置各种server.ssl.*
属性,通常位于application.properties
或application.yaml
.
看Ssl
,了解所有受支持属性的详细信息。
以下示例显示了使用 Java KeyStore 文件设置 SSL 属性:
-
Properties
-
YAML
server.port=8443
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=secret
server.ssl.key-password=another-secret
server:
port: 8443
ssl:
key-store: "classpath:keystore.jks"
key-store-password: "secret"
key-password: "another-secret"
使用如上例所示的配置意味着应用程序不再支持端口 8080 上的纯 HTTP 连接器。
Spring Boot 不支持通过 HTTP 连接器和 HTTPS 连接器的配置application.properties
.
如果要同时拥有两者,则需要以编程方式配置其中一个。
我们建议使用application.properties
配置 HTTPS,因为 HTTP 连接器是两者中更容易以编程方式配置的。
使用 PEM 编码的文件
您可以使用 PEM 编码的文件,而不是 Java KeyStore 文件。
您应该尽可能使用 PKCS#8 密钥文件。
PEM 编码的 PKCS#8 密钥文件以-----BEGIN PRIVATE KEY-----
或-----BEGIN ENCRYPTED PRIVATE KEY-----
页眉。
如果您有其他格式的文件,例如 PKCS#1 (-----BEGIN RSA PRIVATE KEY-----
) 或 SEC 1 (-----BEGIN EC PRIVATE KEY-----
),您可以使用 OpenSSL 将它们转换为 PKCS#8:
openssl pkcs8 -topk8 -nocrypt -in <input file> -out <output file>
以下示例显示了使用 PEM 编码的证书和私钥文件设置 SSL 属性:
-
Properties
-
YAML
server.port=8443
server.ssl.certificate=classpath:my-cert.crt
server.ssl.certificate-private-key=classpath:my-cert.key
server.ssl.trust-certificate=classpath:ca-cert.crt
server:
port: 8443
ssl:
certificate: "classpath:my-cert.crt"
certificate-private-key: "classpath:my-cert.key"
trust-certificate: "classpath:ca-cert.crt"
使用 SSL 捆绑包
或者,可以在 SSL 捆绑包中配置 SSL 信任材料并应用于 Web 服务器,如以下示例所示:
-
Properties
-
YAML
server.port=8443
server.ssl.bundle=example
server:
port: 8443
ssl:
bundle: "example"
这server.ssl.bundle 属性不能与server.ssl . |
配置服务器名称指示
Tomcat、Netty 和 Undertow 可以配置为对单个主机名使用唯一的 SSL 信任材料,以支持服务器名称指示 (SNI)。 Jetty 不支持 SNI 配置,但如果提供了多个证书,Jetty 可以自动设置 SNI。
假设名为web
,web-alt1
和web-alt2
,则以下配置可用于将每个捆绑包分配给嵌入式 Web 服务器提供的主机名:
-
Properties
-
YAML
server.port=8443
server.ssl.bundle=web
server.ssl.server-name-bundles[0].server-name=alt1.example.com
server.ssl.server-name-bundles[0].bundle=web-alt1
server.ssl.server-name-bundles[1].server-name=alt2.example.com
server.ssl.server-name-bundles[1].bundle=web-alt2
server:
port: 8443
ssl:
bundle: "web"
server-name-bundles:
- server-name: "alt1.example.com"
bundle: "web-alt1"
- server-name: "alt2.example.com"
bundle: "web-alt2"
使用server.ssl.bundle
将用于默认主机以及任何支持 SNI 的客户端。
如果有server.ssl.server-name-bundles
配置。
配置 HTTP/2
您可以在 Spring Boot 应用程序中使用server.http2.enabled
configuration 属性。
双h2
(基于 TLS 的 HTTP/2)和h2c
(HTTP/2 over TCP) 支持。
要使用h2
,还必须启用 SSL。
未启用 SSL 时,h2c
将被使用。
例如,您可能希望使用h2c
当您的应用程序在执行 TLS 终止的代理服务器后面运行时。
使用 Tomcat 的 HTTP/2
Spring Boot 默认随 Tomcat 10.1.x 一起提供,它支持h2c
和h2
开箱即用。
或者,您可以使用libtcnative
为h2
如果库及其依赖项安装在主机作系统上,则为 SUPPORT。
库目录必须可用于 JVM 库路径(如果尚未可用)。
您可以使用 JVM 参数(例如-Djava.library.path=/usr/local/opt/tomcat-native/lib
.
更多相关信息,请参阅 Tomcat 官方文档。
使用 Jetty 的 HTTP/2
对于 HTTP/2 支持,Jetty 需要额外的org.eclipse.jetty.http2:jetty-http2-server
Dependency。
要使用h2c
不需要其他依赖项。
要使用h2
,您还需要根据您的部署选择以下依赖项之一:
-
org.eclipse.jetty:jetty-alpn-java-server
使用 JDK 内置支持 -
org.eclipse.jetty:jetty-alpn-conscrypt-server
和 Conscrypt 库
使用 Reactor Netty 的 HTTP/2
这spring-boot-webflux-starter
默认使用 Reactor Netty 作为服务器。
Reactor Netty 支持h2c
和h2
开箱即用。
为了实现最佳的运行时性能,此服务器还支持h2
使用本机库。
要启用此功能,您的应用程序需要具有额外的依赖项。
Spring Boot 管理io.netty:netty-tcnative-boringssl-static
“uber jar”,包含适用于所有平台的本机库。
开发人员可以选择使用分类器仅导入所需的依赖项(参见 Netty 官方文档)。
配置 Web 服务器
通常,您应该首先考虑使用众多可用配置键之一,并通过在application.properties
或application.yaml
文件。
请参阅发现外部属性的内置选项)。
这server.*
namespace 在这里非常有用,它包括server.tomcat.*
,server.jetty.*
和其他 API 的服务器特定功能。
请参阅通用应用程序属性列表。
前面的部分已经涵盖了许多常见使用案例,例如压缩、SSL 或 HTTP/2。
但是,如果您的使用案例不存在配置键,则应查看WebServerFactoryCustomizer
.
您可以声明这样的组件并访问与您选择的相关的服务器工厂:您应该为所选服务器(Tomcat、Jetty、Reactor Netty、Undertow)和所选的 Web 堆栈(servlet 或 reactive)选择变体。
以下示例适用于 Tomcat,其中spring-boot-starter-web
(Servlet 堆栈):
-
Java
-
Kotlin
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;
@Component
public class MyTomcatWebServerCustomizer implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
@Override
public void customize(TomcatServletWebServerFactory factory) {
// customize the factory here
}
}
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.stereotype.Component
@Component
class MyTomcatWebServerCustomizer : WebServerFactoryCustomizer<TomcatServletWebServerFactory?> {
override fun customize(factory: TomcatServletWebServerFactory?) {
// customize the factory here
}
}
Spring Boot 在内部使用该基础结构来自动配置服务器。
自动配置WebServerFactoryCustomizer bean 的顺序为0 ,并将在任何用户定义的定制器之前进行处理,除非它具有另有说明的明确顺序。 |
一旦您可以访问WebServerFactory
使用定制器,您可以使用它来配置特定部分,如连接器、服务器资源或服务器本身 - 所有这些都使用特定于服务器的 API。
此外,Spring Boot 还提供:
服务器 | Servlet 堆栈 | 反应式堆栈 |
---|---|---|
Tomcat |
||
Jetty |
||
Undertow |
||
反应器 |
不适用 |
作为最后的手段,您也可以声明自己的WebServerFactory
bean,它将覆盖 Spring Boot 提供的 bean。
执行此作时,自动配置的定制器仍会应用于您的自定义工厂,因此请谨慎使用该选项。
向应用程序添加 Servlet、Filter 或 Listener
在 servlet 堆栈应用程序中,即使用spring-boot-starter-web
,有两种方法可以添加Servlet
,Filter
,ServletContextListener
以及 Servlet API 支持的其他侦听器添加到应用程序中:
使用 Spring Bean 添加 Servlet、Filter 或 Listener
要添加Servlet
,Filter
或 Servlet*Listener
通过使用 Spring Bean,您必须提供@Bean
定义。
当您想要注入配置或依赖项时,这样做可能非常有用。
但是,您必须非常小心,不要让它们引起太多其他 bean 的急切初始化,因为它们必须在应用程序生命周期的早期就安装在容器中。
(例如,让它们依赖于您的DataSource
或 JPA 配置。
您可以通过在首次使用时而不是在初始化时延迟初始化 bean 来解决此类限制。
对于过滤器和 servlet,您还可以通过添加FilterRegistrationBean
或ServletRegistrationBean
而不是基础组件或除了基础组件之外。
如果没有 |
与任何其他 Spring bean 一样,您可以定义 servlet 过滤器 bean 的顺序;请确保检查 Registering Servlets, Filters, and Listeners as Spring Beans 部分。
禁用 Servlet 或过滤器的注册
如前所述,任何Servlet
或Filter
Bean 会自动注册到 Servlet 容器中。
要禁用特定Filter
或Servlet
bean,为其创建一个注册 bean 并将其标记为已禁用,如以下示例所示:
-
Java
-
Kotlin
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyFilterConfiguration {
@Bean
public FilterRegistrationBean<MyFilter> registration(MyFilter filter) {
FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>(filter);
registration.setEnabled(false);
return registration;
}
}
import org.springframework.boot.web.servlet.FilterRegistrationBean
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyFilterConfiguration {
@Bean
fun registration(filter: MyFilter): FilterRegistrationBean<MyFilter> {
val registration = FilterRegistrationBean(filter)
registration.isEnabled = false
return registration
}
}
使用 Classpath 扫描添加 Servlet、过滤器和侦听器
@WebServlet
,@WebFilter
和@WebListener
带注释的类可以自动注册到嵌入式 servlet 容器中,方法是将@Configuration
class 替换为@ServletComponentScan
并指定包含要注册的组件的包。
默认情况下,@ServletComponentScan
从 Annotated 类的包中扫描。
配置访问日志记录
可以通过 Tomcat、Undertow 和 Jetty 各自的命名空间为 Tomcat、Undertow 和 Jetty 配置访问日志。
例如,以下设置使用自定义模式记录对 Tomcat 的访问。
-
Properties
-
YAML
server.tomcat.basedir=my-tomcat
server.tomcat.accesslog.enabled=true
server.tomcat.accesslog.pattern=%t %a %r %s (%D microseconds)
server:
tomcat:
basedir: "my-tomcat"
accesslog:
enabled: true
pattern: "%t %a %r %s (%D microseconds)"
日志的默认位置是logs 目录。
默认情况下,logs directory 是一个临时目录,因此您可能希望修复 Tomcat 的基目录或使用日志的绝对路径。
在前面的示例中,日志位于my-tomcat/logs 相对于应用程序的工作目录。 |
Undertow 的访问日志记录可以采用类似的方式进行配置,如以下示例所示:
-
Properties
-
YAML
server.undertow.accesslog.enabled=true
server.undertow.accesslog.pattern=%t %a %r %s (%D milliseconds)
server.undertow.options.server.record-request-start-time=true
server:
undertow:
accesslog:
enabled: true
pattern: "%t %a %r %s (%D milliseconds)"
options:
server:
record-request-start-time: true
请注意,除了启用访问日志记录和配置其模式之外,还启用了记录请求开始时间。
当包含响应时间 (%D
) 在 Access Log 模式中。
日志存储在logs
目录。
您可以通过设置server.undertow.accesslog.dir
财产。
最后,Jetty 的访问日志记录也可以按如下方式配置:
-
Properties
-
YAML
server.jetty.accesslog.enabled=true
server.jetty.accesslog.filename=/var/log/jetty-access.log
server:
jetty:
accesslog:
enabled: true
filename: "/var/log/jetty-access.log"
默认情况下,日志会重定向到System.err
.
有关更多详细信息,请参阅 Jetty 文档。
在前端代理服务器后面运行
如果您的应用程序在代理、负载均衡器或云中运行,则请求信息(如主机、端口、方案等)可能会在此过程中发生变化。
您的应用程序可能正在 上运行10.10.10.10:8080
,但 HTTP 客户端应该只能看到example.org
.
RFC7239 “Forwarded Headers” 定义Forwarded
HTTP 标头;代理可以使用此标头提供有关原始请求的信息。
您可以将应用程序配置为读取这些标头,并在创建链接并将其发送到 HTTP 302 响应、JSON 文档或 HTML 页面中的客户端时自动使用该信息。
还有一些非标准的标头,例如X-Forwarded-Host
,X-Forwarded-Port
,X-Forwarded-Proto
,X-Forwarded-Ssl
和X-Forwarded-Prefix
.
如果代理添加了常用的X-Forwarded-For
和X-Forwarded-Proto
标题, 设置server.forward-headers-strategy
自NATIVE
就足以支持这些。
使用此选项,Web 服务器本身本身支持此功能;您可以查看他们的特定文档以了解特定行为。
如果这还不够,Spring 框架为 servlet 堆栈提供了一个ForwardedHeaderFilter,为反应堆栈提供了一个ForwardedHeaderTransformer。
您可以通过设置server.forward-headers-strategy
自FRAMEWORK
.
如果您使用 Tomcat 并在代理处终止 SSL,则server.tomcat.redirect-context-root 应设置为false .
这允许X-Forwarded-Proto 标头。 |
如果您的应用程序在受支持的 Cloud Platform 中运行,则server.forward-headers-strategy property 默认为NATIVE .
在所有其他实例中,它默认为NONE . |
自定义 Tomcat 的代理配置
如果使用 Tomcat,还可以配置用于携带“转发”信息的标头的名称,如以下示例所示:
-
Properties
-
YAML
server.tomcat.remoteip.remote-ip-header=x-your-remote-ip-header
server.tomcat.remoteip.protocol-header=x-your-protocol-header
server:
tomcat:
remoteip:
remote-ip-header: "x-your-remote-ip-header"
protocol-header: "x-your-protocol-header"
Tomcat 还配置了一个正则表达式,该表达式与要信任的内部代理匹配。
请参阅server.tomcat.remoteip.internal-proxies
附录中的条目作为其默认值。
您可以通过在application.properties
,如以下示例所示:
-
Properties
-
YAML
server.tomcat.remoteip.internal-proxies=192\.168\.\d{1,3}\.\d{1,3}
server:
tomcat:
remoteip:
internal-proxies: "192\\.168\\.\\d{1,3}\\.\\d{1,3}"
您可以通过设置internal-proxies 清空(但在生产环境中不要这样做)。 |
您可以完全控制 Tomcat 的RemoteIpValve
通过关闭 automatic one(为此,请将server.forward-headers-strategy=NONE
) 并使用WebServerFactoryCustomizer
豆。
使用 Tomcat 启用多个连接器
您可以添加Connector
到TomcatServletWebServerFactory
,该连接器可以允许多个连接器,包括 HTTP 和 HTTPS 连接器,如以下示例所示:
-
Java
-
Kotlin
import org.apache.catalina.connector.Connector;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyTomcatConfiguration {
@Bean
public WebServerFactoryCustomizer<TomcatServletWebServerFactory> connectorCustomizer() {
return (tomcat) -> tomcat.addAdditionalTomcatConnectors(createConnector());
}
private Connector createConnector() {
Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
connector.setPort(8081);
return connector;
}
}
import org.apache.catalina.connector.Connector
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyTomcatConfiguration {
@Bean
fun connectorCustomizer(): WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
return WebServerFactoryCustomizer { tomcat: TomcatServletWebServerFactory ->
tomcat.addAdditionalTomcatConnectors(
createConnector()
)
}
}
private fun createConnector(): Connector {
val connector = Connector("org.apache.coyote.http11.Http11NioProtocol")
connector.port = 8081
return connector
}
}
启用 Tomcat 的 MBean 注册表
默认情况下,Embedded Tomcat 的 MBean 注册表处于禁用状态。
这样可以最大程度地减少 Tomcat 的内存占用。
例如,如果您想使用 Tomcat 的 MBean,以便 Micrometer 可以使用它们来公开度量,则必须使用server.tomcat.mbeanregistry.enabled
属性执行此作,如以下示例所示:
-
Properties
-
YAML
server.tomcat.mbeanregistry.enabled=true
server:
tomcat:
mbeanregistry:
enabled: true
使用 Undertow 启用多个侦听器
添加UndertowBuilderCustomizer
到UndertowServletWebServerFactory
并将侦听器添加到io.undertow.Undertow.Builder
,如以下示例所示:
-
Java
-
Kotlin
import io.undertow.Undertow.Builder;
import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyUndertowConfiguration {
@Bean
public WebServerFactoryCustomizer<UndertowServletWebServerFactory> undertowListenerCustomizer() {
return (factory) -> factory.addBuilderCustomizers(this::addHttpListener);
}
private Builder addHttpListener(Builder builder) {
return builder.addHttpListener(8080, "0.0.0.0");
}
}
import io.undertow.Undertow
import org.springframework.boot.web.embedded.undertow.UndertowBuilderCustomizer
import org.springframework.boot.web.embedded.undertow.UndertowServletWebServerFactory
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
@Configuration(proxyBeanMethods = false)
class MyUndertowConfiguration {
@Bean
fun undertowListenerCustomizer(): WebServerFactoryCustomizer<UndertowServletWebServerFactory> {
return WebServerFactoryCustomizer { factory: UndertowServletWebServerFactory ->
factory.addBuilderCustomizers(
UndertowBuilderCustomizer { builder: Undertow.Builder -> addHttpListener(builder) })
}
}
private fun addHttpListener(builder: Undertow.Builder): Undertow.Builder {
return builder.addHttpListener(8080, "0.0.0.0")
}
}
使用 @ServerEndpoint 创建 WebSocket 终端节点
如果您想使用@ServerEndpoint
在使用嵌入式容器的 Spring Boot 应用程序中,您必须声明一个ServerEndpointExporter
@Bean
,如以下示例所示:
-
Java
-
Kotlin
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration(proxyBeanMethods = false)
public class MyWebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.web.socket.server.standard.ServerEndpointExporter
@Configuration(proxyBeanMethods = false)
class MyWebSocketConfiguration {
@Bean
fun serverEndpointExporter(): ServerEndpointExporter {
return ServerEndpointExporter()
}
}
前面示例中显示的 Bean 注册了任何@ServerEndpoint
带有底层 WebSocket 容器的带注释的 bean。
当部署到独立的 servlet 容器时,此角色由 servlet 容器初始值设定项执行,而ServerEndpointExporter
bean 不是必需的。