Spring Boot 揭秘与实战（五）服务器篇 - 内嵌的服务器 Tomcat剖析

￡神魔★判官ぃ 2022-06-01 13:58 226阅读 0赞

1.  [1. 内嵌的 Tomcat，一个Jar包运行][1._ Tomcat_Jar]
2.  [2. 如何定制内嵌 Tomcat][2._ Tomcat][3. War 包部署的使用细节][3._War]
    
    1.  [2.1. 设置内嵌Tomcat的端口][2.1._Tomcat]
    2.  [2.2. 设置内嵌Tomcat的最大线程数][2.2._Tomcat]
    3.  [2.3. 设置内嵌Tomcat的编码][2.3._Tomcat]
    4.  [2.4. 官方提供的常用配置参数][2.4.]
3.  
4.  [4. 总结][4.]
5.  [5. 源代码][5.]

Spring Boot 默认使用的是 Tomcat 作为内嵌的服务器。所以，我们搭建一个 Web 工程将会变得非常的简单。

## 内嵌的 Tomcat，一个Jar包运行 ##

还记得，《[Spring Boot 揭秘与实战（一） 快速上手][Spring Boot _]》讲到的例子么？我们来回顾下。  
首先，修改 POM 文件，添加依赖。

1.  <dependency>
2.  <groupId>org.springframework.boot</groupId>
3.  <artifactId>spring-boot-starter-web</artifactId>
4.  </dependency>

创建Java代码

1.  @RestController
2.  @EnableAutoConfiguration
3.  public class RestfulApiWebDemo \{ 
4.  @RequestMapping("/")
5.  String home() \{ 
6.  return "Hello World!";
7.  \}
8.  public static void main(String\[\] args) throws Exception \{ 
9.  SpringApplication.run(RestfulApiWebDemo.class, args);
10. \}
11. \}

直接运行 Java 类，或者可以通过 “mvn spring-boot:run” 在命令行启动该应用。会启动一个内嵌的 Tomcat 服务器运行在 8080 端口。访问 “http://localhost:8080” 可以看到页面上显示“Hello World!”。

此外，在 POM 文件添加插件。

1.  <plugin>
2.  <groupId>org.springframework.boot</groupId>
3.  <artifactId>spring-boot-maven-plugin</artifactId>
4.  </plugin>

在添加了插件后，当运行 “mvn package” 进行打包时，会打包成一个可以直接运行的 JAR 文件，使用 “java -jar” 命令就可以直接运行。

通过 Spring Boot 内嵌的 Tomcat 服务器，我们通过一个 jar 包就可以运行一个 web 工程，这个也很符合微服务的场景，我们在正式环境只要部署一个 jar 即可，当然，我们还可以把这个 jar 部署在 docker 容器中运行，是不是非常方便呢？

## 如何定制内嵌 Tomcat ##

### 设置内嵌Tomcat的端口 ###

Spring Boot 内嵌的 Tomcat 服务器默认运行在 8080 端口。如果，我们需要修改Tomcat的端口，我们可以在 src/main/resources/application.properties 中配置Tomcat信息。

1.  server.port=8089

现在，你可以重新运行上面的例子，看下是不是 Tomcat 的端口变成 8089 了。

### 设置内嵌Tomcat的最大线程数 ###

我们还可以修改内嵌的 Tomcat 服务器的最大线程数。

1.  server.tomcat.max\-threads=1000

### 设置内嵌Tomcat的编码 ###

在一些场景下，我们可能需要改动 Tomcat 的编码，例如是 GBK 还是 UTF-8。

1.  server.tomcat.uri\-encoding = UTF\-8

### 官方提供的常用配置参数 ###

除了上面讲到的3个场景外，我们还可以自定义设置路径地址、 SSL等参数。

这里列举一些官方提供的常用配置参数，如果有特定需求，可以进行内嵌 Tomcat 的定制。

1.  server.tomcat.accesslog.enabled=false \# Enable access log.
2.  server.tomcat.accesslog.pattern=common \# Format pattern for access logs.
3.  server.tomcat.accesslog.prefix=access\_log \# Log file name prefix.
4.  server.tomcat.accesslog.rename\-on\-rotate=false \# Defer inclusion of the date stamp in the file name until rotate time.
5.  server.tomcat.accesslog.suffix=.log \# Log file name suffix.
6.  server.tomcat.background\-processor\-delay=30 \# Delay in seconds between the invocation of backgroundProcess methods.
7.  server.tomcat.basedir= \# Tomcat base directory. If not specified a temporary directory will be used.
8.  server.tomcat.internal\-proxies=10\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
9.  192\\\\.168\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
10. 169\\\\.254\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
11. 127\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
12. 172\\\\.1\[6\-9\]\{ 1\}\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
13. 172\\\\.2\[0\-9\]\{ 1\}\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\}|\\\\
14. 172\\\\.3\[0\-1\]\{ 1\}\\\\.\\\\d\{ 1,3\}\\\\.\\\\d\{ 1,3\} \# regular expression matching trusted IP addresses.
15. server.tomcat.max\-threads=0 \# Maximum amount of worker threads.
16. server.tomcat.min\-spare\-threads=0 \# Minimum amount of worker threads.
17. server.tomcat.port\-header=X\-Forwarded\-Port \# Name of the HTTP header used to override the original port value.
18. server.tomcat.protocol\-header= \# Header that holds the incoming protocol, usually named "X-Forwarded-Proto".
19. server.tomcat.protocol\-header\-https\-value=https \# Value of the protocol header that indicates that the incoming request uses SSL.
20. server.tomcat.redirect\-context\-root= \# Whether requests to the context root should be redirected by appending a / to the path.
21. server.tomcat.remote\-ip\-header= \# Name of the http header from which the remote ip is extracted. For instance \`X-FORWARDED-FOR\`
22. server.tomcat.uri\-encoding=UTF\-8 \# Character encoding to use to decode the URI.

## War 包部署的使用细节 ##

如果，我们还是希望通过 war 包的方式，部署到外部的 Tomcat 服务器上， Spring Boot 也是支持的，不过需要一些额外的配置。

首先，要将最终的打包形式改为 war 包，所以需要将 packaging 的值修改为 war。

1.  <packaging>war</packaging>

接着，对依赖进行适当的配置，值得注意的是，在这里需要移除对嵌入的 Tomcat 的依赖，这样打出的 WAR 包中，在 lib 目录下才不会包含 Tomcat 相关的JAR包。

1.  <dependency>
2.  <groupId>org.springframework.boot</groupId>
3.  <artifactId>spring-boot-starter-web</artifactId>
4.  <exclusions>
5.  <exclusion>
6.  <groupId>org.springframework.boot</groupId>
7.  <artifactId>spring-boot-starter-tomcat</artifactId>
8.  </exclusion>
9.  </exclusions>
10. </dependency>
11. <dependency>
12. <groupId>org.springframework.boot</groupId>
13. <artifactId>spring-boot-starter-tomcat</artifactId>
14. <scope>provided</scope>
15. </dependency>

另外，为了保证编译正确，还需要添加对 servlet-api 的依赖，因此添加如下的配置。

1.  <dependency>
2.  <groupId>org.apache.tomcat</groupId>
3.  <artifactId>tomcat-servlet-api</artifactId>
4.  <version>7.0.42</version>
5.  <scope>provided</scope>
6.  </dependency>

设置，打包后的项目访问名称，在<build>节点里添加<finalName>内容。

1.  <build>
2.  <finalName>springboot-web-demo</finalName>
3.  </bulid>

如果我们想要将在外部的 Tomcat 服务器部署的 WAR 包，就不能依赖于 RestfulApiWebDemo 的 main 函数，要以类似于 web.xml 文件配置的方式来启动 Spring 应用上下文，此时我们需要声明一个类，这个类的作用与在 web.xml 中配置负责初始化 Spring 应用上下文的监听器作用类似，只不过在这里不需要编写额外的 XML 文件了。

1.  public class ServletInitializer extends SpringBootServletInitializer \{ 
2.  @Override
3.  protected SpringApplicationBuilder configure(SpringApplicationBuilder application) \{ 
4.  return application.sources(RestfulApiWebDemo.class);
5.  \}
6.  \}

大功告成，此时，我们可以通过 Maven 的 “mvn clean package” 打包出一个 war 包，并部署到外部的 Tomcat 服务器运行。访问 “[http://localhost:8080/springboot-web-demo/”][http_localhost_8080_springboot-web-demo] 可以看到页面上显示“Hello World!”。

## 总结 ##

Spring Boot 默认使用的是 Tomcat 作为内嵌的服务器。所以，我们搭建一个 Web 工程将会变得非常的简单，只需要一个 jar 包即可运行。此外，我们还可以对内嵌的 Tomcat 进行一些定制，例如端口、最大线程数、编码、 SSL 等。如果，我们还是希望通过 war 包的方式，部署到外部的 Tomcat 服务器上， Spring Boot 也是支持的，不过需要一些额外的配置，这个配置过程也只需要几个简单的步骤即可实现。

## 源代码 ##

> 相关示例完整代码： [springboot-action][]

(完)

[1._ Tomcat_Jar]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E5%86%85%E5%B5%8C%E7%9A%84-Tomcat%EF%BC%8C%E4%B8%80%E4%B8%AAJar%E5%8C%85%E8%BF%90%E8%A1%8C
[2._ Tomcat]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E5%A6%82%E4%BD%95%E5%AE%9A%E5%88%B6%E5%86%85%E5%B5%8C-Tomcat
[3._War]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#War-%E5%8C%85%E9%83%A8%E7%BD%B2%E7%9A%84%E4%BD%BF%E7%94%A8%E7%BB%86%E8%8A%82
[2.1._Tomcat]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E8%AE%BE%E7%BD%AE%E5%86%85%E5%B5%8CTomcat%E7%9A%84%E7%AB%AF%E5%8F%A3
[2.2._Tomcat]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E8%AE%BE%E7%BD%AE%E5%86%85%E5%B5%8CTomcat%E7%9A%84%E6%9C%80%E5%A4%A7%E7%BA%BF%E7%A8%8B%E6%95%B0
[2.3._Tomcat]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E8%AE%BE%E7%BD%AE%E5%86%85%E5%B5%8CTomcat%E7%9A%84%E7%BC%96%E7%A0%81
[2.4.]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E5%AE%98%E6%96%B9%E6%8F%90%E4%BE%9B%E7%9A%84%E5%B8%B8%E7%94%A8%E9%85%8D%E7%BD%AE%E5%8F%82%E6%95%B0
[4.]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E6%80%BB%E7%BB%93
[5.]: http://blog.720ui.com/2016/springboot_05_server_tomcat/#%E6%BA%90%E4%BB%A3%E7%A0%81
[Spring Boot _]: http://blog.720ui.com/2016/springboot_01_quickstart/
[http_localhost_8080_springboot-web-demo]: http://localhost:8080/springboot-web-demo/%E2%80%9D
[springboot-action]: https://github.com/lianggzone/springboot-action