【Spring Boot 系列 定製與優化內置的Tomcat容器】

一、Spring Boot 定製與優化內置Tomcat容器。

內置的容器有三個分別是Undertow、Jetty、Tomcat,Spring Boot 對這三個容器分別進行了實現，它們上層接口都是EmbeddedServletContainerFactory，該接口也是本文的主要核心.

對於內置容器的定製與優化主要有兩種方式,第一種方式是經過配置文件來配置，另一種是經過碼代碼的方式.接下來主要對上述兩種方式進行實現。

二、經過配置文件來定製與優化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類內置屬性。

三、經過碼代碼方式實現對內置容器的配置與優化

有兩種方式顯示用代碼進行對內置容器進行優化與定製,第一種實現內置Servlet容器定製器(org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer),並將類交給Spring容器管理,另一種是在Spring容器中配置EmbeddedServletContainerFactory接口實現類，這裏咱們主要針對內置Tomcat，即TomcatEmbeddedServletContainerFactory類

3.一、第一種方式實現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.一、在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;
    }
}

四、總結

本文主要記錄對內置容器優化和定製的方式,用於本身加深對SpringBoot理解。