Spring Boot 定制与优化内置的Tomcat容器

1、Spring
Boot 定制与优化内置Tomcat容器。

> 内置的容器有三个分别是Undertow、Jetty、Tomcat,Spring Boot 对这三个容器分别进行了实现，它们上层接口都是EmbeddedServletContainerFactory，该接口也是本文的主要核心.

对于内置容器的定制与优化主要有两种方式,第一种方式是通过配置文件来配置，另外一种是通过码代码的方式.接下来主要对上述两种方式进行实现。

2、通过配置文件来定制与优化Tomcat

> 配置的核心内容参考org.springframework.boot.autoconfigure.web.ServerProperties这个服务属性类,下面展示部分对tomcat的配置

server:
port: 8081
# tomcat设置
tomcat:
accesslog:
# 开启日志访问
enabled: true
# 日志保存路径
directory: e:/tmp/logs
更多的配置内容参考org.springframework.boot.autoconfigure.web.ServerProperties类内置属性。

3、通过码代码方式实现对内置容器的配置与优化

> 有两种方式显示用代码进行对内置容器进行优化与定制,第一种实现内置Servlet容器定制器(org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer),并将类交给Spring容器管理,另外一种是在Spring容器中配置EmbeddedServletContainerFactory接口实现类，这里我们主要针对内置Tomcat，即TomcatEmbeddedServletContainerFactory类

3.1、第一种方式实现EmbeddedServletContainerCustomizer接口,并交给Spring容器管理

@Component
public class MyEmbeddedServletContainerCustomizer implements EmbeddedServletContainerCustomizer {
@Override
public void customize(ConfigurableEmbeddedServletContainer container) {
//org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory
//说明默认是的Tomcat容器
System.out.println(container.getClass());
TomcatEmbeddedServletContainerFactory factory = (TomcatEmbeddedServletContainerFactory) container;
//设置端口
factory.setPort(8088);
//设置Tomcat的根目录
factory.setBaseDirectory(new File("d:/tmp/tomcat"));
//设置访问日志存放目录
factory.addContextValves(getLogAccessLogValue());
//设置Tomcat线程数和连接数
factory.addConnectorCustomizers(new MyTomcatConnectorCustomizer());
//初始化servletContext对象
factory.addInitializers((servletContext) -> {
System.out.println(" = = = = 获取服务器信息 = = " + servletContext.getServerInfo());
});

}
private AccessLogValve getLogAccessLogValue() {
AccessLogValve accessLogValve = new AccessLogValve();
accessLogValve.setDirectory("d:/tmp/tomcat/logs");
accessLogValve.setEnabled(true);
accessLogValve.setPattern(Constants.AccessLog.COMMON_PATTERN);
accessLogValve.setPrefix("springboot-access-log");
accessLogValve.setSuffix(".txt");
return accessLogValve;
}
}

/**
* 定制tomcat的连接数与线程数
*/
class MyTomcatConnectorCustomizer implements TomcatConnectorCustomizer {
@Override
public void customize(Connector connector) {
//连接协议 HTTP/1.1
System.out.println(connector.getProtocol());
//连接协议处理器 org.apache.coyote.http11.Http11NioProtocol
System.out.println(connector.getProtocolHandler().getClass());
//Http11NioProtocol
Http11NioProtocol protocolHandler = (Http11NioProtocol) connector.getProtocolHandler();
// 设置最大连接数
protocolHandler.setMaxConnections(2000);
// 设置最大线程数
protocolHandler.setMaxThreads(500);
}
}

3.2、在Spring容器中配置EmbeddedServletContainerFactory实现类

@SpringBootConfiguration
public class WebServerConfiguration {
@Bean
public EmbeddedServletContainerFactory embeddedServletContainerFactory() {
TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
//设置端口
factory.setPort(8089);
//设置404错误界面
factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/404.html"));
//设置在容器初始化的时候触发
factory.addInitializers((servletContext) -> {
System.out.println(" = = = = 获取服务器信息 = = " + servletContext.getServerInfo());
});
//设置最大连接数和最大线程数
factory.addConnectorCustomizers((connector) -> {
Http11NioProtocol protocolHandler = (Http11NioProtocol) connector.getProtocolHandler();
protocolHandler.setMaxConnections(2000);
protocolHandler.setMaxThreads(500);
});
//设置访问日志记录文件的目录
factory.addContextValves(getLogAccessLogValue());
return factory;
}

private AccessLogValve getLogAccessLogValue() {
AccessLogValve accessLogValve = new AccessLogValve();
accessLogValve.setDirectory("d:/tmp/logs");
accessLogValve.setEnabled(true);
accessLogValve.setPattern(Constants.AccessLog.COMMON_PATTERN);
accessLogValve.setPrefix("SpringBoot-Access-Log");
accessLogValve.setSuffix(".txt");
return accessLogValve;
}
}

4、总结
本文主要记录对内置容器优化和定制的方式,用于自己加深对SpringBoot理解。

文章来源：https://my.oschina.net/serve/blog/1581862