Spring Boot默认Tomcat为Servlet容器,以Tomcat为例进行说明,Tomcat,Jetty,Undertow都是通用的。
1.配置Tomcat
*Tomcat的所有属性都在org.spring framework.boot.autoconfiguration.web.ServerProperties
配置类中做了定义。
- 定制的配置在application.properties中配置属性即可。
- 通常Servlet容器配置都已“server”作为前缀,Tomcat的配置都以“server.tomcat”作为前缀
Servlet容器
server.port=# 配置程序端口,默认8080
server.serrsion-timeout= #用户会话session过期时间,以秒为单位
server.context-path= #配置访问路径。默认为/
Tomcat
server.tomcat.uri-encoding = #配置Tomcat编码,默认UTF-8
server.tomcat.compression = # Tomcat 是否开启压缩,默认为关闭off
2. 代码配置
- 需要通过代码的方式配置servlet容器,可以注册一个实现EmbeddedServletContainerCustomizer接口的Bean。
- 若想直接配置Tomcat,Jetty,Undertow等,可以直接定义TomcatEmbeddedServletContainer、...
2.1 通用配置
(1)新建类的配置
@Component
public class CustomServletContainer implements EmbeddedServletContainerCustomizer {
@Override
public void customize(ConfigurationEmbeddedServletContainer container) {
container.setPort(8888);
container.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/404.html"));
container.setSessionTimeout(10, TimeUnit.MINUTES);
}
}
(2) 当前配置文件内配置。
在当前已有的配置文件内添加类的Bean,需要在Spring配置中,当前类要声明为static:
@Component
public static class CustomServletContainer implements EmbeddedServletContainerCustomizer{
@Override
public void customize(ConfigurableEmbeddedServletContainer container){
container.setPort(8888); // 配置端口号
container.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/404")); // 配置错误页面
container.setSessionTimeout(10, TimeUnit.MINUTES); // 配置Servlet容器session过期时间
}
}
2.2 特定配置
Tomcat使用TomcatEmbeddedServletContainerFactory、Jetty使用JettyEmbeddedServletContainerFactory、Undertow使用UndertowEmbeddedServletContainerFactory。
以Tomcat为例:
@Bean
public EmbeddedServletContainerFactory servletContainerFactory(){
TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
factory.setPort(8888);//配置端口号
factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/404.html")); // 配置错误页面
factory.setSessionTimeout(10, TimeUnit.MINUTES);//设置session失效时间
return factory;
}
3. 替换Tomcat
Spring Boot默认使用tomcat作为Servlet容器。如果要替换,需要修改spring-boot-starter-web的依赖。
3.1 替换为Jetty
在pom.xml中,将spring-boot-starter-web的依赖由spring-boot-starter-tomcat替换为spring-boot-starter-Jetty:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jetty</artifactId>
</dependency>
此时可以看到。容器已经变为Jetty:
3.2 Tomcat换成Undertow
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-undetow</artifactId>
</dependency>
4.SSL配置
Spring Boot使用的是内嵌的Tomcat,因此SSL配置操作如下:
4.1生成证书
SSL需要一个证书,可以是自签名的,也可以是SSL证书授权中心获得。
在JDK或者JRE都有名为keytoo的证书管理工具,可以用来生成自签名的证书。这里需要指定-keyalg RSA,不然会出现ERR_SSL_VERSION_OR_CIPHER_MISMATCH 错误 导致无法访问。
keytool -genkey -alias tomcat -keyalg RSA
根据提示输入内容后,可以在当前目录生成一个.keystore文件,就是我们要用的证书文件。
4.2 Spring Boot配置SSL
在/src/main/resources/static
目录下添加index.html
作为测试。
将.keysotre
文件复制到项目的根目录,然后在application.properties中添加SSL配置:
server.ssl.key-store=.keystore
server.ssl.key-store-password=tomcat
server.ssl.key-store-type=JKS
server.ssl.key-alias=tomcat
之后启动spring boot后,控制台输出中可以看到:
Tomcat started on port(s): 8080 (https)
在浏览器中访问可以看到:
4.3 http跳转https
在地址栏中输入http,自动跳转https,这一功能需要配置TomcatEmbeddedServletContainerFactory,并添加Tomcat的connector来实现。
@Bean
public EmbeddedServletContainerFactory servletContainer(){
TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory(){
@Override
protected void postProcessContext(Context context){
SecurityConstraint securityConstraint = new SecurityConstraint();
securityConstraint.setUserConstraint("CONFIDENTIAL");
SecurityCollection collection = new SecurityCollection();
collection.addPattern("/*");
securityConstraint.addCollection(collection);
context.addConstraint(securityConstraint);
}
};
tomcat.addAdditionalTomcatConnectors(httpConnector());
return tomcat;
}
private Connector httpConnector() {
Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
connector.setScheme("http");
connector.setPort(8888);
connector.setSecure(false);
connector.setRedirectPort(8080);
return connector;
}
启动Spring Boot后,日志中可以看到
Tomcat started on port(s): 8080 (https) 8888 (http)
此时在浏览器中以http协议对8888端口发起请求会自动跳转到https协议的8080端口: