彩蛋推荐 |SpringBoot技术专题「Tomcat技术专区」用正确的姿势如何用外置tomcat配置及运行（Tomcat优化分析）

Posted 2023-01-29 洛神灬殇

前提概要

在特别特殊的时候，我们可能需要外置tomcat去运行程序，例如alitomcat等特殊场景，方便我们去定时化开发项目或者其他特殊场景。

外置tomcat执行

pom.xml文件首先更改打包方式 war,再排除springboot内置的 web 项目下tomcat依赖

Maven配置调整

移除tomcat依赖或者将tomcat依赖scope改为provide，移除tomcat依赖

<dependency>
　　<groupId>org.springframework.boot</groupId>
　　　　<artifactId>spring-boot-starter-web</artifactId>
　　　　<!-- 移除嵌入式tomcat插件 -->
　　　　<exclusions>
　　　　　　<exclusion>
　　　　　　　　<groupId>org.springframework.boot</groupId>
　　　　　　　　<artifactId>spring-boot-starter-tomcat</artifactId>
　　　　　　</exclusion>
　　　　</exclusions>
</dependency>

再引入tomcat依赖:

 <dependency>
    <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-tomcat</artifactId>
     <!--打包的时候可以不用包进去，别的设施会提供。事实上该依赖理论上可以参与编译，测试，运行等周期。
                相当于compile，但是打包阶段做了exclude操作-->
     <scope>provided</scope>
  </dependency>

将打包方式修改为war

<packaging>war</packaging>

调整springboot的启动类

继承org.springframework.boot.web.servlet.support.SpringBootServletInitializer，实现configure方法：
为什么继承该类，SpringBootServletInitializer源码注释：

• Note that a WebApplicationInitializer is only needed if you are building a war file and deploying it. If you prefer to run an embedded web server then you won’t need this at all.

• 注意，如果您正在构建WAR文件并部署它，则需要WebApplicationInitializer。如果你喜欢运行一个嵌入式Web服务器，那么你根本不需要这个。

DemoApplication,让其实现SpringBootServletInitializer,然后重写configure()方法：

方式一，启动类继承SpringBootServletInitializer实现configure：

@SpringBootApplication
public class Application extends SpringBootServletInitializer 
    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) 
        return builder.sources(Application.class);
    

方式二，新增加一个类继承SpringBootServletInitializer实现configure：

public class ServletInitializer extends SpringBootServletInitializer 
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) 
        //此处的Application.class为带有@SpringBootApplication注解的启动类
        return builder.sources(Application.class);
    

---

注意事项

• 使用外部Tomcat部署访问的时候，application.properties(或者application.yml)中配置的将失效，请使用tomcat的端口，tomcat，webapps下项目名进行访问。

server.port=
server.servlet.context-path=

• 为了防止应用上下文所导致的项目访问资源加载不到的问题，建议pom.xml文件中标签下添加标签：

<build>
    <!-- 应与application.properties(或application.yml)中context-path保持一致 -->
    <finalName>war包名称</finalName>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

---

1. IDEA 下，运行mvn clean,–> mvn package ,等到项目打包成功,在该项目文件位置找到target 下的 demo.war,拷贝到tomcat/webapps目录下,

2. 使用windows命令行,启动tomcat服务器,项目启动成功会出现, spring的标志。

3. 访问路径:localhost:8080/$打包文件名/请求url

4. 如何在访问时去掉war包名?

原理：Tomcat的默认根目录是ROOT，实际上ROOT这个项目在实际生产环境是没有用的，所以我们可以用我们的项目覆盖ROOT项目

操作过程

1. 删除ROOT下所有文件及文件夹.

2. 把我们项目的war包解压后，项目目录下的所有文件和子目录都拷贝到ROOT目录下即可或者有更狠的一招：直接删掉ROOT目录，然后把我们的项目打包名称改成ROOT.war，放到webapps下就行.

原理：Tomcat本身可以配置虚拟目录。方法就是在Server.xml中节点下加入Context信息。

如我们可以配置<Context path=“/abc” docBase=“D:\\app\\abc” … />，那我们可以通过地址http://localhost:8080/abc来访问我们放在D:\\app\\下面的abc项目。我们可以把这个path=“/abc"修改为path=”"。意思就是把abc映射到根目录，访问路径就会变成http://localhost:8080/。

按照配置虚拟目录的方式，在下添加一个Context节点，具体配置如下：

	<Engine name="Catalina" defaultHost="localhost">  
	        <Host name="localhost"  appBase="webapps" unpackWARs="true" autoDeploy="true">  
	        	<Context path="" docBase="Interface" reloadable="true" />  
	    	<!--注：我这里使用的是相对路径，Interface项目是放在Tomcat的webapps目录下的，当然也可以改为绝对路径--> 
	        </Host>  
        </Engine>

Spring Boot也提供了对JMX监控的支持。JMX监控对外暴露的信息相同，不过是使用MBeans容器将应用数据封装管理。

• Springboot 的jmx 是默认开启的，如果tomcat 部署两个原springboot 打成的war 包。

  • 需要将每一个项目的jmx关闭Application.properties 配置中 添加spring.jmx.enabled=false;

  • 在各自项目中都添加：spring.jmx.default-domain=project1以及spring.jmx.default-domain=project2保证domain是不一样的。

tomcat 相关配置修改

修改默认的http访问端口:8080 为 8181,在tomcat8.5/conf/server.xml文件里修改:示例

<Connector port="8181" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />

修改默认的session有效期

在tomcat/conf/web.xml文件里修改,范围是具体项目:示例

    <session-config>
       <session-timeout>30</session-timeout>
    </session-config>

在tomcat/conf/server.xml

<Context path="/test" docBase="/test"  
		　　defaultSessionTimeOut="3600" isWARExpanded="true"  
		　　isWARValidated="false" isInvokerEnabled="true"  
		　　isWorkDirPersistent="false"/>

在java后台代码里配置,具体页面的session有效时间

session.setMaxInactiveInterval（30*60)；

生效优先级: 3 > 2 > 1,

(彩蛋) tomcat 调优

tomcat 修改最大线程,在tomcat/conf/server.xml文件里修改:示例

---

• maxThreads=“X” 表示最多同时处理X个连接
• minSpareThreads=“X” 初始化X个连接
• maxSpareThreads=“X” 表示如果最多可以有X个线程，一旦超过X个,则会关闭不在需要的线程
• acceptCount=“X” 当同时连接的人数达到maxThreads时,还可以排队,队列大小为X.超过X就不处理

tomcat 内存优化

• Windows 下的catalina.bat
• Linux 下的catalina.sh 如:

JAVA_OPTS=’-Xms256m -Xmx512m’
-Xms JVM初始化堆的大小
-Xmx JVM堆的最大值 实际参数大小根据服务器配置或者项目具体设置.

Tomcat IO优化

1. 同步阻塞IO（JAVA BIO） 同步并阻塞，服务器实现模式为一个连接一个线程(one connection one thread 想想都觉得恐怖,线程可是非常宝贵的资源)，当然可以通过线程池机制改善。
   • BIO方式适用于连接数目比较小且固定的架构，这种方式对服务器资源要求比较高，并发局限于应用中，JDK1.4以前的唯一选择，但程序直观简单易理解.
2. JAVA NIO:又分为同步非阻塞IO,异步阻塞IO 与BIO最大的区别one request one thread.可以复用同一个线程处理多个connection(多路复用)
   • NIO方式适用于连接数目多且连接比较短（轻操作）的架构，比如聊天服务器，并发局限于应用中，编程比较复杂，JDK1.4开始支持.
3. 异步非阻塞IO(Java NIO2又叫AIO) 主要与NIO的区别主要是操作系统的底层区别.可以做个比喻:比作快递，NIO就是网购后要自己到官网查下快递是否已经到了(可能是多次)，然后自己去取快递；AIO就是快递员送货上门了(不用关注快递进度)。
   • AIO方式使用于连接数目多且连接比较长（重操作）的架构，比如相册服务器，充分调用OS参与并发操作，编程比较复杂，JDK7开始支持.

在server.xml中

实现对Tomcat的IO切换

APR是从操作系统级别来解决异步的IO问题,大幅度的提高性能. (http://apr.apache.org/).

1. APR(Apache Portable Runtime)是一个高可移植库,它是Apache HTTP Server 2.x的核心.能更好地和其它本地web技术集成，总体上让Java更有效率作为一个高性能web服务器平台而不是简单作为后台容器.
2. 在产品环境中，特别是直接使用Tomcat做WEB服务器的时候，应该使用Tomcat,Native来提高其性能.如果不配APR，基本上300个线程狠快就会用满，以后的请求就只好等待.但是配上APR之后，并发的线程数量明显下降，从原来的300可能会马上下降到只有几十，新的请求会毫无阻塞的进来.
3. 在局域网环境测，就算是400个并发，也是一瞬间就处理/传输完毕，但是在真实的Internet环境下，页面处理时间只占0.1%都不到，绝大部分时间都用来页面传输.如果不用APR，一个线程同一时间只能处理一个用户，势必会造成阻塞。所以生产环境下用apr是非常必要的.

（彩蛋）介绍一下请求头的前置表示法

根据request获取外网ip

• 可能是用户真是ip也可能是代理服务器的ip

String client_ip=request.getRemoteAddr();

• x-forwarded-for:代表客户端，也就是HTTP的请求端真实的IP，只有在通过了HTTP代理或者负载均衡服务器时才会添加该项:
  • X-Forwarded-For:简称XFF头，它代表客户端，也就是HTTP的请求端真实的IP
  • 只有在通过了HTTP 代理或者负载均衡服务器时才会添加该项
  • 标准格式如下：X-Forwarded-For: client_ip, proxy1_ip, proxy2_ip（所以取第一个值即可）
  • 此头是可构造的，因此某些应用中应该对获取到的ip进行验证

String ip = request.getHeader("x-forwarded-for");

• 在多级代理网络中，直接用getHeader(“x-forwarded-for”)可能获取到的是unknown信息，此时需要获取代理代理服务器重新包装的HTTP头信息。

if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
    //Apache+WebLogic搭配下出现的头
    ip = request.getHeader("Proxy-Client-IP");

• Proxy-Client-IP和WL-Proxy-Client-IP: 只有在Apache（Weblogic Plug-In Enable）+WebLogic搭配下出现，其中“WL”就是WebLogic的缩写 访问路径是:Client -> Apache WebServer + Weblogic http plugin -> Weblogic Instances

-保险的做法是：

	if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
            ip = request.getHeader("Proxy-Client-IP");
    
     if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
            ip = request.getHeader("WL-Proxy-Client-IP");
       
     if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
            ip = request.getRemoteAddr();
	

• 可通过http头伪造，是由代理服务器发送的请求头

if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
    ip = request.getHeader("HTTP_CLIENT_IP");

• 可通过http头伪造，和X-Forwarded-For格式类似，以“,"分隔

if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) 
    ip = request.getHeader("HTTP_X_FORWARDED_FOR");

//0:0:0:0:0:0:0:1: IPV6的形式,win7下可能会出现
return ip.equals(“0:0:0:0:0:0:0:1”) ? “127.0.0.1” : ip;