Jetty9配置说明

缺乏、安全感 2022-05-18 21:06 599阅读 0赞

[http://www.littlefisher.site/2018/06/27/Jetty9%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E/][http_www.littlefisher.site_2018_06_27_Jetty9_E9_85_8D_E7_BD_AE_E8_AF_B4_E6_98_8E]

公司所使用的`Jetty`版本还是`Jetty7`，最近一方面是有想法把公司的`Jetty`版本升级为最新，另外也让自己熟悉一下`Jetty`的使用与配置，也算是对自己的一个提升吧。公司内对技术的看重程度较低，只能通过公司内点点滴滴的技术问题修复，来间接提升自己的能力。这边博文就是为了说明一下`Jetty9`如何做到所有的配置都集于一个文件，避免每次部署新的`Jetty`都要在各个文件中来来回回的修改文件。

### 基础命令 ###

在`Jetty`的根目录下执行以下命令

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>java -jar start.jar --add-to-start=console-capture
</pre> </td> 
  </tr> 
 </tbody> 
</table>

上面命令中的`console-capture`为功能，`Jetty`默认仅开启一部分功能，其他所需的功能，通过以上命令，可以自己来添加。添加成功后，会在`start.ini`中新增该功能的配置项。  
如果需要一次新增多个功能，执行下面命令

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>java -jar start.jar --add-to-start=console-capture,jvm
</pre> </td> 
  </tr> 
 </tbody> 
</table>

这个命令新增了`console-capture`和`jvm`这`2`个功能。具体功能是干嘛用的，后面做描述。

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>java -jar start.jar --list-config
</pre> </td> 
  </tr> 
 </tbody> 
</table>

以上命令用于展示出当前`Jetty`已启动的功能及已配置的参数

### 当前公司所需`Jetty`功能 ###

`console-capture`

该功能用于开启`Jetty`的日志打印功能  
执行下面命令开启该功能

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>java -jar start.jar --add-to-start=console-capture
</pre> </td> 
  </tr> 
 </tbody> 
</table>

该功能在`start.ini`中所对应的配置参数如下

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
</pre> </td> 
   <td> <pre># --------------------------------------- 
# Module: console-capture
# Redirects JVMs console stderr and stdout to a log file,
# including output from Jetty's default StdErrLog logging.
# --------------------------------------- 
--module=console-capture

## Logging directory (relative to $jetty.base)
# jetty.console-capture.dir=logs

## Whether to append to existing file
# jetty.console-capture.append=true

## How many days to retain old log files
# jetty.console-capture.retainDays=90

## Timezone of the log timestamps
# jetty.console-capture.timezone=GMT
</pre> </td> 
  </tr> 
 </tbody> 
</table>

以上内容为执行了命令后自动在`start.ini`中生成的文件，下面附上一份说明

## 日志存放位置，默认是当前Jetty的跟目录下的logs目录，该配置一般需要修改为多个jetty统一的日志存放位置，例如/data/logs/jettyDEMO
# jetty.console-capture.dir=logs

## 重启服务后，是否接着之前的日志文件继续打印，默认是false
# jetty.console-capture.append=true

## 老的日志文件存放多久，默认是90天
# jetty.console-capture.retainDays=90

## 日志文件的时区配置，默认是GMT，针对于咱们国家而言，由于是东八区，所以配置为Asia/Shanghai
# jetty.console-capture.timezone=GMT
</pre> </td> 
  </tr> 
 </tbody> 
</table>

`jvm`

该模块用于配置`Jetty`启动时的`jvm`参数  
执行下面命令开启该功能

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
</pre> </td> 
   <td> <pre>java -jar start.jar --add-to-start=jvm
</pre> </td> 
  </tr> 
 </tbody> 
</table>

该功能在`start.ini`中所对应的配置参数如下

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
</pre> </td> 
   <td> <pre># --------------------------------------- 
# Module: jvm
# A noop module that creates an ini template useful for
# setting JVM arguments (eg -Xmx )
# --------------------------------------- 
--module=jvm

## JVM Configuration
## If JVM args are include in an ini file then --exec is needed
## to start a new JVM from start.jar with the extra args.
##
## If you wish to avoid an extra JVM running, place JVM args
## on the normal command line and do not use --exec
# --exec
# -Xmx2000m
# -Xmn512m
# -XX:+UseConcMarkSweepGC
# -XX:ParallelCMSThreads=2
# -XX:+CMSClassUnloadingEnabled
# -XX:+UseCMSCompactAtFullCollection
# -XX:CMSInitiatingOccupancyFraction=80
# -internal:gc
# -XX:+PrintGCDateStamps
# -XX:+PrintGCTimeStamps
# -XX:+PrintGCDetails
# -XX:+PrintTenuringDistribution
# -XX:+PrintCommandLineFlags
# -XX:+DisableExplicitGC
</pre> </td> 
  </tr> 
 </tbody> 
</table>

以上内容为执行了命令后自动在`start.ini`中生成的文件，下面附上一份说明

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
</pre> </td> 
   <td> <pre># --------------------------------------- 
# Module: jvm
# A noop module that creates an ini template useful for
# setting JVM arguments (eg -Xmx )
# --------------------------------------- 
--module=jvm

## JVM Configuration
## 由于Jetty启动之后才能读取这个配置文件，所以说其实并没有加载这里的JVM参数。而使用--exec的话，会额外启动一个进行用于加载这里的JVM配置参数。除非说JVM的配置参数是写死在bin/jetty.sh里，否则--exec是必须要带的。
--exec
-Xms512m
-Xmx768m
# -Xmx2000m
# -Xmn512m
# -XX:+UseConcMarkSweepGC
# -XX:ParallelCMSThreads=2
# -XX:+CMSClassUnloadingEnabled
# -XX:+UseCMSCompactAtFullCollection
# -XX:CMSInitiatingOccupancyFraction=80
# -internal:gc
# -XX:+PrintGCDateStamps
# -XX:+PrintGCTimeStamps
# -XX:+PrintGCDetails
# -XX:+PrintTenuringDistribution
# -XX:+PrintCommandLineFlags
# -XX:+DisableExplicitGC
</pre> </td> 
  </tr> 
 </tbody> 
</table>

### `Jetty`启动 ###

进入`Jetty`根目录下的`bin`目录，执行如下命令

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
</pre> </td> 
   <td> <pre>sh jetty.sh start # 启动Jetty
sh jetty.sh restart # 重启Jetty
sh jetty.sh stop # 停止Jetty
</pre> </td> 
  </tr> 
 </tbody> 
</table>

命令就是这么简单

### 设置contextPath ###

在`Jetty`根目录的`webapps`下，新增跟`war`包同名的`xml`文件，例如有一个`war`包叫做`hsjry-credit-deploy.war`，则新增一个`hsjry-credit-deploy.xml`文件，文件中是以下内容

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
</pre> </td> 
   <td> <pre>&lt;?xml version="1.0"?&gt;
&lt;!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_3.dtd"&gt;
&lt;Configure class="org.eclipse.jetty.webapp.WebAppContext"&gt;
  &lt;Set name="contextPath"&gt;/blog-web&lt;/Set&gt;
  &lt;Set name="war"&gt;&lt;SystemProperty name="jetty.home" default="."/&gt;/webapps/hsjry-credit-deploy.war&lt;/Set&gt;
&lt;/Configure&gt;
</pre> </td> 
  </tr> 
 </tbody> 
</table>

通过这种方式设置`contextPath`

### 代码中`Jetty`版本升级 ###

由于部署所有的`Jetty`版本都已经升级，未避免开发人员自测时和部署时由于环境不同导致的`bug`，所以建议代码中也把`Jetty`版本进行升级。另外`maven`中针对于`Jetty`的`groupId`都已经进行了变更，原本的版本都已经不做维护了。

以下内容是`credit`模块`deploy`工程的`pom.xml`里，关于`Jetty`容器原来的配置

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
</pre> </td> 
   <td> <pre>&lt;build&gt;
  &lt;finalName&gt;hsjry-credit-deploy&lt;/finalName&gt;
  &lt;plugins&gt;
    &lt;plugin&gt;
      &lt;groupId&gt;org.mortbay.jetty&lt;/groupId&gt;
      &lt;artifactId&gt;maven-jetty-plugin&lt;/artifactId&gt;
      &lt;version&gt;6.1.26&lt;/version&gt;
      &lt;configuration&gt;
        &lt;connectors&gt;
          &lt;connector implementation="org.mortbay.jetty.nio.SelectChannelConnector"&gt;
            &lt;port&gt;8086&lt;/port&gt;
            &lt;port&gt;8097&lt;/port&gt;
            &lt;maxIdleTime&gt;30000&lt;/maxIdleTime&gt;
          &lt;/connector&gt;
        &lt;/connectors&gt;
        &lt;!-- 自动发现改变是时间，进行热部署，默认是0，不热部署 &lt;scanIntervalSeconds&gt;1&lt;/scanIntervalSeconds&gt; --&gt;
        &lt;webAppSourceDirectory&gt;src/main/webapp&lt;/webAppSourceDirectory&gt;
        &lt;webAppConfig&gt;
          &lt;contextPath&gt;/hsjry-credit-deploy&lt;/contextPath&gt;
        &lt;/webAppConfig&gt;
        &lt;reload&gt;automatic&lt;/reload&gt;
        &lt;systemProperties&gt;
          &lt;systemProperty&gt;
            &lt;name&gt;org.mortbay.util.URI.charset&lt;/name&gt;
            &lt;value&gt;UTF-8&lt;/value&gt;
          &lt;/systemProperty&gt;
        &lt;/systemProperties&gt;
      &lt;/configuration&gt;
    &lt;/plugin&gt;

&lt;/plugins&gt;
&lt;/build&gt;
</pre> </td> 
  </tr> 
 </tbody> 
</table>

以下内容是新版本`Jetty`进行配置的内容

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
</pre> </td> 
   <td> <pre>&lt;build&gt;
  &lt;plugins&gt;
    &lt;plugin&gt;
      &lt;groupId&gt;org.eclipse.jetty&lt;/groupId&gt;
      &lt;artifactId&gt;jetty-maven-plugin&lt;/artifactId&gt;
      &lt;version&gt;9.4.9.v20180320&lt;/version&gt;
      &lt;configuration&gt;
        &lt;!--自动发现改变是时间，进行热部署，默认是0，不热部署--&gt;
        &lt;scanIntervalSeconds&gt;10&lt;/scanIntervalSeconds&gt;
        &lt;!--手动重加载 可选值 ：[automatic|manual]--&gt;
        &lt;reload&gt;automatic&lt;/reload&gt;
        &lt;httpConnector&gt;
          &lt;port&gt;8097&lt;/port&gt;
          &lt;idleTimeout&gt;30000&lt;/idleTimeout&gt;
        &lt;/httpConnector&gt;
        &lt;webApp&gt;
          &lt;contextPath&gt;/hsjry-credit-deploy&lt;/contextPath&gt;
        &lt;/webApp&gt;
        &lt;webAppSourceDirectory&gt;src/main/webapp&lt;/webAppSourceDirectory&gt;
        &lt;!--
        jetty9.3+版本的默认字符集已使用UTF-8，无需再进行配置
        https://github.com/eclipse/jetty.project/issues/804
        --&gt;
      &lt;/configuration&gt;
    &lt;/plugin&gt;

&lt;/plugins&gt;
&lt;/build&gt;
</pre> </td> 
  </tr> 
 </tbody> 
</table>

[http_www.littlefisher.site_2018_06_27_Jetty9_E9_85_8D_E7_BD_AE_E8_AF_B4_E6_98_8E]: http://www.littlefisher.site/2018/06/27/Jetty9%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E/