Tomcat

session管理

前言

假设有一台 nginx 充当负载均衡；后端有两台 tomcat（tomcat1 和 tomcat2）
- 那么当 nginx 以轮询的方式调度到后端的 tomcat1 时，tomcat1 会生成 session id 并发送给客户端
- 客户端再下次访问时，会在 cookie 中携带 sessionid，而这时如果恰巧 nginx 将客户端的请求转发到了 tomcat2 上，那么 tomcat2 发现此 cookie 中的 session id 并非是自己的进而会将其抛弃并重新生成一个 session id 发送给客户端（tomcat1 也是如此）
- 这样以来最终的结果就是客户端不端的收到新的 session id，而旧的 session id 因为在其它 tomcat 主机上没有对应的数据，所以相关的购物车等信息将不会保持保存

session 持久化方案：

负载均衡处基于 cookie 或 session 进行调度
Tomcat session 复制集群
session 共享

测试环境说明

index.jsp（测试 session 的 jsp文件）

<%@ page import="java.util.*" %>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>lbjsptest</title>
</head>
<body>
<div>On <%=request.getServerName() %></div>
<div><%=request.getLocalAddr() + ":" + request.getLocalPort() %></div>
<div>SessionID = <span style="color:blue"><%=session.getId() %></span></div>
<%=new Date()%>
</body>
</html>

/etc/hosts

10.0.0.8  azheng.com  # nginx
10.0.0.18 t1.azheng.com # tomcat1
10.0.0.28 t2.azheng.com # tomcat2

负载均衡基于 session 调度

实现前

nginx 配置

/apps/nginx/conf/nginx.conf

...
http {
...
    upstream tomcat-server {
        server 10.0.0.18:8080;
        server 10.0.0.28:8080;
    }

    server {
        listen       80;
        server_name  azheng.com;
        charset utf-8;

        location / {
            proxy_pass http://tomcat-server;
        }
    }
...

实现前测试

以轮询方式调度 session 不会得以绑定

# curl azheng.com
...
<div>On tomcat-server</div>
<div>10.0.0.18:8080</div>
<div>SessionID = <span style="color:blue">E987819BA4D00194F8825DC61D975083</span></div>
...

# curl azheng.com
...
<div>On tomcat-server</div>
<div>10.0.0.28:8080</div>
<div>SessionID = <span style="color:blue">26A809AFA62BC6C31DB46A6661E4A578</span></div>
...

实现后

nginx 配置

/apps/nginx/conf/nginx.conf

...
http {
...
    upstream tomcat-server {
        hash $cookie_JSESSIONID; # 添加基于JSESSIONID调度，JSESSIONID一致 则每次都会调度到同一台主机上
        server 10.0.0.18:8080;
        server 10.0.0.28:8080;
    }

    server {
        listen       80;
        server_name  azheng.com;
        charset utf-8;

        location / {
            proxy_pass http://tomcat-server;
        }
    }
...

实现后测试

# 获取 sessionid
# curl -I azheng.com
HTTP/1.1 200 
Server: nginx/1.18.0
Date: Tue, 30 Aug 2022 04:52:14 GMT
Content-Type: text/html;charset=ISO-8859-1
Connection: keep-alive
Set-Cookie: JSESSIONID=4228BB49F03E4D91834D74A164EECEEB; Path=/; HttpOnly

---

# 在请求报文中添加 session
# curl -H "Cookie: JSESSIONID=4228BB49F03E4D91834D74A164EECEEB" azheng.com
...
style="color:blue">4228BB49F03E4D91834D74A164EECEEB</span></div>
Tue Aug 30 12:52:27 CST 2022
...

---

# 会话得以保持
# curl -H "Cookie: JSESSIONID=4228BB49F03E4D91834D74A164EECEEB" azheng.com
...
style="color:blue">4228BB49F03E4D91834D74A164EECEEB</span></div>
Tue Aug 30 12:54:58 CST 2022
...
# curl -H "Cookie: JSESSIONID=4228BB49F03E4D91834D74A164EECEEB" azheng.com
...
style="color:blue">4228BB49F03E4D91834D74A164EECEEB</span></div>
Tue Aug 30 12:54:59 CST 2022
...

session 复制

Tomcat session replication cluster

安装

Tomcat 安装前提

Tomcat 依赖 JDK ，JDK未安装则 Tomcat 无法启动

[root@centos ~]# startup.sh 
Neither the JAVA_HOME nor the JRE_HOME environment variable is defined
At least one of these environment variable is needed to run this program

Tomcat 基于包安装

centos7

centos 7 仓库源中自带 Tomcat 7.0 版本，此方式安装版本较低，不推荐

centos8

centos 8 仓库中目前没有 Tomcat 相关的 yum 源

Tomcat 二进制安装

Centos

下载地址：https://dlcdn.apache.org/tomcat/tomcat-8/

[root@centos8 ~]# wget https://dlcdn.apache.org/tomcat/tomcat-8/v8.5.78/bin/apache-tomcat-8.5.78.tar.gz

[root@centos8 ~]# tar xf apache-tomcat-8.5.78.tar.gz -C /usr/local/

[root@centos8 ~]# cd /usr/local/

[root@centos8 local]# ln -s /usr/local/apache-tomcat-8.5.78/ tomcat

#指定PATH变量
[root@centos8 ~]# echo 'PATH=/usr/local/tomcat/bin:$PATH' > /etc/profile.d/tomcat.sh
[root@centos8 ~]# . /etc/profile.d/tomcat.sh
[root@centos8 ~]# echo $PATH
/usr/local/tomcat/bin:/usr/local/jdk/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin


#Service File（创建service文件一是方便管理，二是可以让tomcat以tomcat的普通用户启动，更加安全）
----------------------------------------------------------------------------------------
#创建一个 tomcat 账号
[root@centos8 ~]# useradd -u 808 -r -s /sbin/nologin tomcat

#将 tomcat 目录下的文件所有者所属组改为 tomcat
[root@centos8 ~]# chown -R tomcat.tomcat /usr/local/tomcat/

#准备service文件中JDK相关环境文件（编译安装的JDK才需指定）
[root@centos8 ~]# vim /usr/local/tomcat/conf/tomcat.conf
#两个变量至少写一项才能启动tomcat
JAVA_HOME=/usr/local/jdk
#JRE_HOME=/usr/local/jdk/jre

#创建service文件
[root@centos8 ~]# vim /lib/systemd/system/tomcat.service
[Unit]
Description=Apache Tomcat Web Application Container
After=syslog.target network.target

[Service]
Type=forking
EnvironmentFile=/usr/local/tomcat/conf/tomcat.conf #yum或apt安装的openjdk此行注释即可
ExecStart=/usr/local/tomcat/bin/startup.sh
ExecStop=/usr/local/tomcat/bin/shutdown.sh
User=tomcat
Group=tomcat

[Install]
WantedBy=multi-user.target

#测试
[root@centos8 ~]# systemctl daemon-reload
[root@centos8 ~]# systemctl enable --now tomcat.service

Ubuntu

下载地址：https://dlcdn.apache.org/tomcat/tomcat-8/

root@ubuntu:/usr/local/src# ls
apache-tomcat-8.5.71.tar.gz

root@ubuntu:/usr/local/src# tar xf apache-tomcat-8.5.71.tar.gz -C /apps

root@ubuntu:/usr/local/src# cd /apps/

root@ubuntu:/apps# ln -s apache-tomcat-8.5.71/ tomcat

#指定PATH变量
root@ubuntu:/apps# ln -s apache-tomcat-8.5.71/ tomcat
root@ubuntu:/apps# echo 'PATH=/apps/tomcat/bin:$PATH' > /etc/profile.d/tomcat.sh
root@ubuntu:/apps# . /etc/profile.d/tomcat.sh
root@ubuntu:/apps# echo $PATH
/apps/tomcat/bin:/apps/jdk/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin


#Service File（创建service文件一是方便管理，二是可以让tomcat以tomcat的普通用户启动，更加安全）
----------------------------------------------------------------------------------------
#创建一个 tomcat 账号
root@ubuntu:/apps# useradd -u 808 -r -s /sbin/nologin tomcat

#将 tomcat 目录下的文件所有者所属组改为 tomcat
root@ubuntu:/apps# chown -R tomcat.tomcat /apps/tomcat/

#准备service文件中相关环境文件
root@ubuntu:/apps# vim /apps/tomcat/conf/tomcat.conf
#两个变量至少写一项才能启动tomcat
JAVA_HOME=/apps/tomcat/jdk
#JRE_HOME=/apps/tomcat/jdk/jre

#创建service文件
root@ubuntu:/apps# vim /lib/systemd/system/tomcat.service
[Unit]
Description=Apache Tomcat Web Application Container
After=syslog.target network.target

[Service]
Type=forking
EnvironmentFile=/apps/tomcat/conf/tomcat.conf
ExecStart=/apps/tomcat/bin/startup.sh
ExecStop=/apps/tomcat/bin/shutdown.sh
User=tomcat
Group=tomcat

[Install]
WantedBy=multi-user.target

#测试
root@ubuntu:/apps# systemctl daemon-reload
root@ubuntu:/apps# systemctl enable --now tomcat.service

#观察8080端口是否启动
root@ubuntu:/apps# ss -ntl
LISTEN   0    100        *:8080        *:*

基础

JAVA 相关术语

Java SE API：Java基础类库开发接口

JRE：Java运行时环境，包含JVM+Jave核心类库

servlet

主要功能在于交互式地浏览和生成数据，生成动态Web内容。
servlet是Server Applet的简称，翻译过来就是服务程序．好吧，这么说你可能还是不太懂，简单的讲，这个servlet是运行在服务器上的一个小程序，用来处理服务器请求的．进一步讲，我们知道，一般的网页程序，是由我们通过浏览器访问来实现的，在这个过程中，我们的浏览器发送访问请求，服务器接收请求，并对浏览器的请求作出相应的处理．这就是我们熟悉的B/S模型(浏览器－服务器模型)．而servlet就是对请求作出处理的组件，运行于支持Java的应用服务器中．

Tomcat 概述

Tomcat不仅是一个应用程序服务器，也是一个web服务器
Tomcat实现类似Apache或Nginx的功能，可以理解为Tomcat实现了web功能，可以将编好的Java程序以web的方式让用户通过http协议来访问
- 运行流程：OS > JDK > Tomcat >APP
Tomcat 具有处理 HTML 页面的功能
它还是一个 servlet 和 JSP容器
官网：https://tomcat.apache.org/
官方文档：https://tomcat.apache.org/tomcat-8.5-doc/index.html
帮助文档：https://cwiki.apache.org/confluence/display/tomcat/

https://cwiki.apache.org/confluence/display/TOMCAT/FAQ
日志记录参考：https://tomcat.apache.org/tomcat-8.5-doc/logging.html

Tomcat 端口说明

8080/tcp # tomcat默认服务端口

8443/tcp # tomcat https服务端口

8005/tcp # tomcat管理端口（比如停止tomcat服务）

8009/tcp # tomcat AJP协议使用的端口

Tomcat AJP 协议

Apache JServ Protocol 定向包协议
AJP协议是以二进制方式进行数据传输，而http是以文本方式进行传输的
在使用 Apache 作为反向代理转发到后端的 Tomcat 时，两者可以使用AJP协议进行数据传输（因为两者同属 Apache 基金会下的项目所以都支持 AJP 协议？）

配置文件

Tomcat 配置文件分类

官方帮助文档：https://tomcat.apache.org/tomcat-8.5-doc/index.html

[root@centos8 ~]# cd /usr/local/tomcat/conf/
[root@centos8 conf]# find . -type f
./server.xml #主配置文件

./web.xml #此文件为所有的webapps提供默认部署相关的全局配置，（每个web应用也可以使用专用子配置文件，优先级高于全局配置文件，其存放在应用目录下的WEB-INF目录中并且名称也为web.xml）

./context.xml #此文件为所有的webapps提供默认定义所有应用均需加载的context全局配置，（每个web应用也可以使用专用子配置文件，优先级高于全局配置文件，其存放在应用目录下的WEB-INF目录中并且名称也为context.xml）

./tomcat-users.xml #用户认证的账号和密码文件
./tomcat-users.xsd

./catalina.policy #当使用security选项启动tomcat时，此文件用于为tomcat设置安全策略

./catalina.properties #tomcat 环境变量的配置，用于设定类加载器路径，以及一些与JVM调优相关参数

./logging.properties #tomcat 日志系统相关配置，可以修改日志级别和日志路径等

./jaspic-providers.xml
./jaspic-providers.xsd

./tomcat.conf #自定义的配置文件，主要存放了JAVA_HOME全局变量 jdk的位置

配置文件 server.xml 说明

server.xml 为主配置文件

server.xml 文件结构

$CATALINA_BASE 表示tomcat的家目录，如：/apps/tomcat

#$CATALINA_BASE/conf/server.xml 
...
<?xml version="1.0" encoding="UTF-8"?>
<Server port="8005" shutdown="SHUTDOWN">
    <Service name="Catalina">
        <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
        <Connector protocol="AJP/1.3"
               address="::1"
               port="8009"
               redirectPort="8443" />
        <Engine name="Catalina" defaultHost="localhost">
            <Host name="localhost"  appBase="webapps" unpackWARs="true" autoDeploy="true"> 
                <Context >
                <Context />
      </Host>
    </Engine>
  </Service>
</Server>
...

server

服务器，代表整个 Tomcat 容器，Tomcat运行的进程实例，一台主机可以启动多 Tomcat 实例，需要确保端口不要产生冲突
一个 server中可以有多个service，但通常就一个

#$CATALINA_BASE/conf/server.xml
...
<Server port="8005" shutdown="SHUTDOWN">
... 
</Server>

8005/tcp 端口安全配置

8005/tcp 是Tomcat的管理端口
默认监听在127.0.0.1上
无需验证就可向此IP和端口发送SHUTDOWN这个字符串，Tomcat接受到后就会关闭此server
此功能建议禁用

[root@18 ~]# vim /usr/local/tomcat/conf/server.xml
...
<Server port="8005" shutdown="SHUTDOWN"> #将8005改成-1将禁用，此行不能被注释，否则tomcat将无法启动，shutdown=后面得内容可以自定义 而后可以实现使用自定义得字符串关闭tomcat
...

---------------------------------------------------------------------------------
#范例
#执行前
[root@tomcat-node1 ~]# ss -ntl
State          Recv-Q         Send-Q                      Local Address:Port                 Peer Address:Port        
LISTEN         0              128                               0.0.0.0:22                        0.0.0.0:*           
LISTEN         0              1                      [::ffff:127.0.0.1]:8005                            *:*           
LISTEN         0              100                                     *:8080                            *:*           
LISTEN         0              128                                  [::]:22                           [::]:*           
#执行
[root@tomcat-node1 ~]# telnet 127.0.0.1 8005
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
SHUTDOWN
Connection closed by foreign host.
#可以看到tomcat服务已经关闭
[root@tomcat-node1 ~]# ss -ntl
State          Recv-Q         Send-Q                   Local Address:Port                   Peer Address:Port         
LISTEN         0              128                            0.0.0.0:22                          0.0.0.0:*            
LISTEN         0              128                               [::]:22                             [::]:*

service

服务，实现组织 engine 和 connector 之间的对应关系
一个service中只能包含一个engine
一般情况下，一个server实例只配置一个service，

#$CATALINA_BASE/conf/server.xml
...

<Server port="8005" shutdown="SHUTDOWN">
...
  <Service name="Catalina"> <!-- name属性该service的ID -->
... 
</Server>

connector

协议的连接器，有HTTP（默认端口8080/tcp）、HTTPS（默认端口8443/tcp）、AJP（默认端口8009/tcp）（AJP 是一种基于TCP的二进制通讯协议）
一个connector只属于某一个engine
redirectPort：重定向端口，如果访问HTTPS协议，则自动转向这个连接器。但大多数时候 tomcat不会开启https功能，因为tomcat部署偏内层所以HTTPS的性能不好

#$CATALINA_BASE/conf/server.xml
...

<Server port="8005" shutdown="SHUTDOWN">
...
  <Service name="Catalina">
...
    <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" /> <!-- Connector配置 -->
... 
</Server>

自定义http服务器版本信息

默认不显示tomcat的http的server头信息，可以指定tomcat的http的server头信息为相应的值

#默认不显示任何版本信息
[root@localhost ~]#curl -I 10.0.0.18:8080
HTTP/1.1 200 
Content-Type: text/html;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 13 Sep 2021 12:08:48 GMT


#自定义版本信息
[root@tomcat-node1  ~]# vim /usr/local/tomcat/conf/server.xml
...
    <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" server=azhengweb/> #加上一个server=自定义的名称
...


[root@tomcat-node1  ~]# systemctl restart tomcat.service

#测试
[root@localhost ~]#curl -I 10.0.0.18:8080
HTTP/1.1 200 
Content-Type: text/html;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 13 Sep 2021 12:17:22 GMT
Server: azhengweb

engine

引擎，用来响应并处理用户请求
一个 engine 上可以绑定多个 connector

#$CATALINA_BASE/conf/server.xml
...

<Server port="8005" shutdown="SHUTDOWN">
...
  <Service name="Catalina">
...
    <Connector port="8081" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
...
    <Engine name="Catalina" defaultHost="localhost"> <!-- Engine配置 -->
... 
</Server>

host

虚拟主机，可以实现多虚拟主机，例如使用不同的主机头区分
指向内部某虚拟主机，默认虚拟主机可以改动，默认localhost

#$CATALINA_BASE/conf/server.xml
...

<Server port="-1" shutdown="SHUTDOWN">
...
  <Service name="Catalina">
...
    <Connector port="8081" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
...
    <Engine name="Catalina" defaultHost="localhost">
...
#Host配置
#name:虚拟主机的名称，即url
#appBase:虚拟主机数据存放位置，可以写相对路径或绝对路径，相对路径是相对于$CATALINA_BASE的路径 #unpackWARs:自动解war包，生产中需禁用，防止有人在此目录添加恶意的war包对站点实施攻击等...
#autoDeploy:自动部署，生产中需禁用
      <Host name="localhost"  appBase="webapps"
            unpackWARs="true" autoDeploy="true">
...          
</Server>

实现多虚拟主机

准备虚拟主机数据

#虚拟主机1准备
[root@tomcat-node1 ~]# mkdir -p /data/webapps/app1/ROOT
[root@tomcat-node1 ~]# echo 'app1 page' > /data/webapps/app1/ROOT/index.jsp

#虚拟主机2准备
[root@tomcat-node1 ~]# mkdir -p /data/webapps/app2/ROOT
[root@tomcat-node1 ~]# echo 'app2 page' > /data/webapps/app2/ROOT/index.jsp

#修改权限
[root@tomcat-node1 ~]# chown -R tomcat.tomcat /data/webapps*

修改配置文件

-为标注分界线，方便查阅，无需在tomcat中配置
为app2单独配置了日志记录，不写的话就是不启用日志记录

[root@tomcat-node1 ~]# vim /usr/local/tomcat/conf/server.xml 
...
      </Host>
--------------------------------------------------------------------------------
      <Host name="app1.azheng.vip"  appBase="/data/webapps/app1/"
            unpackWARs="true" autoDeploy="false">
      </Host>

      <Host name="app2.azheng.vip"  appBase="/data/webapps/app2/"
            unpackWARs="true" autoDeploy="false">
        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
               prefix="app2_access_log" suffix=".txt"
               pattern="%h %l %u %t &quot;%r&quot; %s %b" />
      </Host>
--------------------------------------------------------------------------------
    </Engine>
...

#重启服务
[root@tomcat-node1 ~]# systemctl restart tomcat.service

测试

#客户段修改DNS
[root@clicent ~]#vim /etc/hosts
10.0.0.18 app1.azheng.vip app2.azheng.vip

#测试访问
[root@clicent ~]#curl app1.azheng.vip:8080
app1 page
[root@clicent ~]#curl app2.azheng.vip:8080
app2 page

valve

valve(阀门)组件可以定义日志，也可以定义访问控制
valve存在多种类型：
- 定义访问日志：org.apache.catalina.valves.AccessLogValve
- 定义访问控制：org.apache.catalina.valves.RemoteAddrValve

范例：

#定义访问日志
    <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="app2_access_log" suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />


#定义访问控制
    <Valve className="org.apache.catalina.valves.RemoteAddrValve"
    deny="10\.0\.0\.\d+"/>

context

应用的上下文，配置特定 url 路径映射和目录的映射关系，即：url –> directory
注意：新版本tomcat以及将此配置定义为了单独的子配置文件，详参下文：
也可以在 server.xml 中定义？

配置文件 context.xml 说明

路径重定向

日志

参考文档：https://cwiki.apache.org/confluence/display/TOMCAT/Logging

主配置文件

/usr/local/tomcat/conf/logging.properties

日志记录格式说明

参考文档：https://tomcat.apache.org/tomcat-9.0-doc/config/valve.html#Access_Logging

%a - Remote IP address.See also %{xxx}a below.
%A - Local IP address
%b - Bytes sent, excluding HTTP headers, or '-' if zero
%B - Bytes sent, excluding HTTP headers
%h - Remote host name (or IP address if enableLookups for the connector is false)
%H - Request protocol
%l - Remote logical username from identd (always returns'-')
%m - Request method (GET, POST, etc.)
%p - Local port on which this request was received.See also %{xxx}p below.
%q - Query string (prepended with a '?' if it exists)
%r - First line of the request (method and request URI)
%s - HTTP status code of the response
%S - User session ID
%t - Date and time, in Common Log Format
%u - Remote user that was authenticated (if any), else '-' (escaped if required)
%U - Requested URL path
%v - Local server name
%D - Time taken to process the request in millis. Note: Inhttpd %D is microseconds. Behaviour will be aligned to httpdin Tomcat 10 onwards.
%T - Time taken to process the request, in seconds. Note: Thisvalue has millisecond resolution whereas in httpd it hassecond resolution. Behaviour will be align to httpdin Tomcat 10 onwards.
%F - Time taken to commit the response, in milliseconds
%I - Current request thread name (can compare later with stacktraces)
%X - Connection status when response is completed: 
    ◦X = Connection aborted before the response completed.
    ◦+ = Connection may be kept alive after the response is sent.
    ◦- = Connection will be closed after the response is sent.

#There is also support to write information incoming or outgoingheaders, cookies, session or request attributes and specialtimestamp formats.It is modeled after the Apache HTTP Server log configurationsyntax. Each of them can be used multiple times with different xxx keys: 
%{xxx}a write remote address (client) (xxx==remote) orconnection peer address (xxx=peer)
%{xxx}i write value of incoming header with name xxx (escaped if required)
%{xxx}o write value of outgoing header with name xxx (escaped if required)
%{xxx}c write value of cookie with name xxx (escaped if required)
%{xxx}r write value of ServletRequest attribute with name xxx (escaped if required)
%{xxx}s write value of HttpSession attribute with name xxx (escaped if required)
%{xxx}p write local (server) port (xxx==local) orremote (client) port (xxx=remote)
%{xxx}t write timestamp at the end of the request formatted using theenhanced SimpleDateFormat pattern xxx

...

时间格式说明

**官方自定义格式说明：**https://httpd.apache.org/docs/2.4/mod/mod_log_config.html#formats

格式符	说明
%a	星期的英文单词的缩写：如星期一，则返回 `Mon`
%A	星期的英文单词的全拼：如星期一，返回 `Monday`
%b	月份的英文单词的缩写：如一月，则返回 `Jan`
%B	月份的引文单词的缩写：如一月，则返回 `January`
%c	返回`datetime`的字符串表示，如`03/08/15 23:01:26`
%d	返回的是当前时间是当前月的第几天
%f	微秒的表示：范围: [0,999999]
%H	以24小时制表示当前小时
%I	以12小时制表示当前小时
%j	返回当天是当年的第几天范围[001,366]
%M	返回月份范围[0,12]
%m	返回分钟数范围 [0,59]
%P	返回是上午还是下午–`AM` or `PM`
%s	返回秒数范围 [0,61]。。。手册说明的
%U	返回当周是当年的第几周以周日为第一天
%W	返回当周是当年的第几周以周一为第一天
%w	当天在当周的天数，范围为[0, 6]，6表示星期天
%x	日期的字符串表示：03/08/15
%X	时间的字符串表示：23:22:08
%y	两个数字表示的年份 15
%Y	四个数字表示的年份 2015
%z	与utc时间的间隔（如果是本地时间，返回空字符串）
%Z	时区名称（如果是本地时间，返回空字符串）

范例：记录格式改为json

#默认记录格式
#vim /apps/tomcat/conf/server.xml
...
pattern="%h %l %u %{Y-M-H:m:s}t &quot;%r&quot; %s %b"
...
#输出格式如下：
10.0.0.102 - - 2021-10-15:36:7 "GET / HTTP/1.1" 200 11156
--------------------------------------------------------------------------------------
#转为ELK需要的json格式，说明：&quot; 在html中表示双引号
vim /apps/tomcat/conf/server.xml
...
        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
               prefix="tomcat_access_log" suffix=".log"
               pattern="{&quot;client&quot;:&quot;%h&quot;,  &quot;client user&quot;:&quot;%l&quot;,   &quot;authenticated&quot;:&quot;%u&quot;,   &quot;access time&quot;:&quot;%t&quot;,     &quot;method&quot;:&quot;%r&quot;,   &quot;status&quot;:&quot;%s&quot;,  &quot;send bytes&quot;:&quot;%b&quot;,  &quot;Query?string&quot;:&quot;%q&quot;,  &quot;partner&quot;:&quot;%{Referer}i&quot;,  &quot;Agent version&quot;:&quot;%{User-Agent}i&quot;}"/>
#以上配置文件在135行
...
--------------------------------------------------------------------------------------
#输出格式如下：
{"client":"10.0.0.102",  "client user":"-",   "authenticated":"-",   "access time":"[15/Oct/2021:15:42:25 +0800]",     "method":"GET / HTTP/1.1",   "status":"200",  "send bytes":"11156",  "Query?string":"",  "partner":"-",  "Agent version":"curl/7.68.0"}
--------------------------------------------------------------------------------------
#json转换器显示结果：
{
    "client":"10.0.0.102",
    "client user":"-",
    "authenticated":"-",
    "access time":"[15/Oct/2021:15:42:25 +0800]",
    "method":"GET / HTTP/1.1",
    "status":"200",
    "send bytes":"11156",
    "Query?string":"",
    "partner":"-",
    "Agent version":"curl/7.68.0"
}

性能优化

前言

Tomcat 的运行依赖于 JVM，从虚拟机的角度把 Tomcat 的优化分为两部分：
- 外部环境调优 JVM
- Tomcat 自身调优

Tomcat JVM 优化

$CATALINA_BASE/bin/catalina.sh
优化参数没有最佳实践，需根据实际环境进行微调从而达到最佳性能

...
# OS specific support.  $var _must_ be set to either true or false.
# 添加下面一行
JAVA_OPTS="-server -Xms1024m -Xmx1024m -XX:NewSize=512m -XX:MaxNewSize=512M"

# 横着写报错：-Xms1024m: command not found
#JAVA_OPTS="-server
#-Xms1024m
#-Xmx1024m
#-XX:NewSize=512m
#-XX:MaxNewSize=512M"
...

选项说明：

-server # VM运行在server工作模式，为在服务端最大化程序运行速度而优化

-client # VM运行在client工作模式，为客户端环境减少启动时间而优化

# 使用“java -version”可以查看当前工作模式

------------------------

-Xms1024m # 初始Heap大小，使用的最小内存

-Xmx1024m # Java heap最大值，使用的最大内存。经验: 设置Xms大小等于Xmx大小

-XX:NewSize=512m # 表示新生代初始内存的大小，应该小于 -Xms的值

-XX:MaxNewSize=512M # 表示新生代可被分配的内存的最大上限，应该小于 -Xmx的值

-XX:PermSize=1024m # 设定内存的永久保存区域,内存的永久保存区域，VM 存放Class 和 Meta信息，JVM在运行期间不会清除该区域

-XX:MaxPermSize=1024m # 设定最大内存的永久保存区域。经验: 设置PermSize大小等于MaxPermSize大小

-XX:+DisableExplicitGC # 自动将System.gc() 调用转换成一个空操作，即应用中调用System.gc()会变成一个空操作，避免程序员在代码里进行System.gc()这种危险操作。System.gc()除非是到了万不得也的情况下使用，都应该交给 JVM。

验证：
- ps aux|grep java
  - tomcat 782 1.4 8.5 2983740 170424 ? Sl 00:39 0:04 /usr/local/jdk/bin/java -Djava.util.logging.config.file=/usr/local/tomcat/conf/logging.properties -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager -server -Xms1024m -Xmx1024m -XX:NewSize=512m -XX:MaxNewSize=512M -Djdk.tls.ephemeralDHKeySize=2048 -Djava.protocol.handler.pkgs=org.apache.catalina.webresources -Dorg.apache.catalina.security.SecurityListener.UMASK=0027 -Dignore.endorsed.dirs= -classpath /usr/local/tomcat/bin/bootstrap.jar:/usr/local/tomcat/bin/tomcat-juli.jar -Dcatalina.base=/usr/local/tomcat -Dcatalina.home=/usr/local/tomcat -Djava.io.tmpdir=/usr/local/tomcat/temp org.apache.catalina.startup.Bootstrap start

Tomcat 开启 JMX 监控

# vim /usr/local/tomcat/bin/catalina.sh
...
CATALINA_OPTS="${CATALINA_OPTS} -Djava.rmi.server.hostname=$(hostname -I | awk '{print $1}')"
#CATALINA_OPTS="${CATALINA_OPTS} -Djava.rmi.server.hostname=10.0.0.18"
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote=true"
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.port=12345"
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"


# 说明：
CATALINA_OPTS="${CATALINA_OPTS} -Djava.rmi.server.hostname=JMX_HOST" #tomcat(Java程序)运行主机的IP地址，如果要在多台主机运行可以采用变量的方式获取当前主机的IP：$(hostname -I | awk '{print $1}')"
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote=true" #启动远程监控JMX
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.port=JMX_PORT" #JMX监听的端口号，要和zabbix添加主机时候的端口一致即可 
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.ssl=false" #不启用ssl连接
CATALINA_OPTS="${CATALINA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false" #不启用授权

Tomcat 运行模式优化

Tomcat的运行模式有： bio,nio, apr

应用部署

应用部署前言

Tomcat 应用部署和其它web服务的区别：

nginx部署方式

假设在nginx中部署2个网站应用 eshop、forum，假设网站根目录是/data/nginx/html/，那么部署可以是这样的：

eshop解压缩所有文件放到 /data/nginx/html/ 目录下
forum的文件放到 /data/nginx/html/forum/ 目录下

最终网页连接和目录的对应关系：

http://localhost/ #即对应eshop的应用，对应的目录是：/data/nginx/html/

http://localhost/forum/ #即对应forum的应用，对应的目录是：/data/nginx/html/forum/

tomcat部署方式

tomcat的默认根目录是 $CATALINA_BASE/webapps/ROOT

eshop解压缩所有文件放到 $CATALINA_BASE/webapps/ROOT 目录下
forum的文件放到 $CATALINA_BASE/webapps/forum/ 目录下

最终网页连接和目录的对应关系：

http://localhost/ #即对应eshop的应用，对应的目录是：$CATALINA_BASE/webapps/ROOT

http://localhost/forum/ #即对应forum的应用，对应的目录是：$CATALINA_BASE/webapps/forum/

其它说明：

$CATALINA_BASE 就是 tomcat 的家目录，比如：/usr/local/tomcat/
如果同时存在 $CATALINA_BASE/webapps/forum/ 和 $CATALINA_BASE/webapps/ROOT/forum/，则以 $CATALINA_BASE/webapps/forum/优先生效
每一个虚拟主机都可以使用appBase指令配置自己的站点目录，使用appBase目录下的ROOT目录作为主站目录

部署目录说明

Tomcat 中默认网站根目录是：$CATALINA_BASE/webapps/
$CATALINA_BASE: /usr/local/tomcat（即tomcat安装时的根目录）
$CATALINA_BASE/webapps/ 下面的每个目录都是对应的 WebApp
WebApp目录中，可能有以下子目录，但下面子目录是非必须的
- WEB-INF/：当前目录WebApp的私有资源路径，通常存储当前应用使用的web.xml和context.xml配置文件
- META-INF/：类似于WEB-INF/，也是私有资源的配置信息，和WEB-INF/目录一样浏览器无法访问
- classes/：类文件，当前webapp需要的类
- lib/：当前应用依赖的jar包

部署目录规划

实际生产环境参考范例：
/data/tomcat/tomcat_appdir 保存web压缩包的目录
- 如：
  - myapp_2022-03-06-22:06:43.tar.gz
  - myapp_2022-03-08-23:06:32.tar.gz
  - myapp.war 等…
/data/tomcat/tomcat_webdir 保存web压缩包解压后的目录，也就是java代码的实际存放目录
- 如：
  - myapp_2022-03-06-22:06:43
  - myapp_2022-03-08-23:06:32 等…
/data/tomcat/tomcat_webapps tomcat加载目录，在server.xml定义，等价于/usr/local/tomcat/webapps/，主要是将此目录下的app以软连接的方式指向/data/tomcat/tomcat_webdir中的版本
- 如：
  - /usr/local/tomcat/webapps/myapp –> /data/tomcat/tomcat_webdir/myapp_2022-03-08-23:06:32

目录创建方式

[root@tomcat-node1 ~]# mkdir -p /data/tomcat/tomcat_{appdir,webapps,webdir}

server.xml配置

[root@tomcat-node1 ~]# vim /usr/local/tomcat/conf/server.xml 
...
      <Host name="myapp"  appBase="/data/tomcat/tomcat_webapps">
...

主页部署

主页存放位置和查找次序说明

默认情况下 tomcat 会在 $CATALINA_BASE/webapps/ROOT/ 目录下寻找主页文件
查找次序如下：
1. index.html
2. index.htm
3. index.jsp
可以通过修改 $CATALINA_BASE/conf/web.xml 文件中的标签中的内容修改默认页面文件查找次序

修改默认主页查找次序

全局修改默认主页

优先级低于webAPP的专有配置
需重启tomcat服务才能生效（测试发现 Tomcat/8.5.73 无需重启也可生效）

#准备测试页面
[root@centos8 ~]# echo 'index.jsp' > /usr/local/tomcat/webapps/ROOT/index.jsp 
[root@centos8 ~]# echo 'index.html' > /usr/local/tomcat/webapps/ROOT/index.html 
[root@centos8 ~]# echo 'index.htm' > /usr/local/tomcat/webapps/ROOT/index.htm

#修改前测试
[root@client ~]#curl 10.0.0.8:8080
index.html

#修改全局配置文件
[root@centos8 ~]# vim /usr/local/tomcat/conf/web.xml 
...
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>       
    </welcome-file-list>
...

#修改后测试
[root@client ~]#curl 10.0.0.8:8080
index.jsp

webAPP专有配置修改默认主页

优先级高于全局配置
无需重启tomcat即可生效

#准备测试页面
[root@centos8 ~]#echo 'index.jsp' > /usr/local/tomcat/webapps/WEB-INF/index.jsp 
[root@centos8 ~]#echo 'index.html' > /usr/local/tomcat/webapps/WEB-INF/index.html 
[root@centos8 ~]#echo 'index.htm' > /usr/local/tomcat/webapps/WEB-INF/index.htm

#修改前测试
[root@client ~]#curl 10.0.0.8:8080/WEB-INF
index.jsp

#修改webAPP专有配置
[root@centos8 ~]# vim /usr/local/tomcat/webapps/ROOT/WEB-INF/web.xml 
...
#在文件倒数第二行添加添加
    <welcome-file-list>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>index.html</welcome-file>
    </welcome-file-list>

</web-app>

#测试访问
[root@client ~]#curl 10.0.0.8:8080/WEB-INF
index.htm

#全局配置如下：
#可以发现应用独立配置优先级高于全局配置
[root@centos8 ~]# vim /usr/local/tomcat/conf/web.xml 
...
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>       
    </welcome-file-list>
...

应用部署

将webapp的源文件放置到目标目录，通过web.xml和context.xml文件中配置的路径就可以访问该webapp，通过类加载器加载其特有的类和依赖的类到JVM上，最终实现用户可以通过浏览器访问该应用