配置Jetty Maven外掛-版本9.x

Jetty Maven外掛可用於快速開發和測試。您可以將其新增到根據常用Maven預設值構建的任何webapp專案。然後，外掛可以定期掃描您的專案以進行更改，並自動重新部署Web應用程式（如果有）。這通過消除構建和部署步驟使開發週期更高效：您使用IDE對專案進行更改，並且正在執行的Web容器自動選擇它們，允許您立即測試它們。

重要

您需要為此外掛使用Maven 3和Java 1.7。

快速入門：啟動並執行

首先，新增jetty-maven-plugin到您的 pom.xml定義：

五

<plugin>

<groupId>org.eclipse.jetty</groupId>

<artifactId>jetty-maven-plugin</artifactId>

<version>9.2.21.v20170120</

version>

</plugin>

然後，從與root使用者相同的目錄中 pom.xml鍵入：

<span style="color:#444444"><span style="color:black"><span style="color:black">mvn碼頭：跑</span></span></span>

這將啟動Jetty並在http：// localhost：8080 /上提供您的專案。

Jetty繼續執行直到你停止它。在執行時，它會定期掃描專案檔案的更改，因此如果您儲存更改並重新編譯類檔案，Jetty將重新部署您的Web應用程式，您可以立即測試您剛剛進行的更改。

您可以ctrl-c在執行它的終端視窗中使用a來終止外掛。

支援的目標

Jetty Maven外掛有許多不同的Maven目標。可以說最有用的是 run我們在快速入門部分看到的目標，該部分在未組裝的webapp上執行Jetty。還有其他目標可以幫助您完成不同的任務。例如，您可能需要在Jetty的分叉例項中執行Web應用程式，而不是在執行Maven的程序中執行; 或者您可能需要對您希望部署Web應用程式的maven生命週期階段進行更精細的控制。完成這些任務有不同的目標，以及其他幾個任務。

要檢視Jetty Maven外掛支援的所有目標列表，請執行以下操作：

<span style="color:#444444"><span style="color:black"><span style="color:black">mvn碼頭：幫忙</span></span></span>

要檢視可針對特定目標配置的詳細引數列表，請執行以下操作：

<span style="color:#444444"><span style="color:black"><span style="color:black">mvn jetty：help -Ddetail = true -Dgoal = goal-name</span></span></span>

配置Jetty容器

這些配置元素設定了您的webapp執行的Jetty環境。它們與大多數目標相同：

httpConnector

可選的。如果未指定，Jetty將建立一個偵聽埠8080 的ServerConnector例項。例如，可以使用jetty.port命令列上的系統屬性更改此預設埠號mvn -Djetty.port=9999 jetty:run。或者，您可以使用此配置元素來設定ServerConnector的資訊。以下是有效的配置子元素：

港口

要偵聽的聯結器的埠號。預設情況下為8080。

主辦

聯結器偵聽的特定介面。預設情況下，所有介面。

名稱

聯結器的名稱，用於配置上下文以僅響應特定聯結器。

空閒超時

連線的最大空閒時間。

soLinger

套接字逗留時間。

您可以在標準的jetty xml配置檔案中配置聯結器，並將其位置放入引數中。請注意，由於jetty-9.0不再可以直接在pom.xml中配置https聯結器：您需要使用jetty xml配置檔案來執行此操作。 jettyXml

jettyXml

可選的。除了任何外掛配置引數之外，以逗號分隔的要應用的檔案位置列表。如果您要部署其他Web應用程式，處理程式，特定型別的聯結器等，或者如果您有其他無法從外掛配置的Jetty物件，則可以使用它。 jetty xml

scanIntervalSeconds

掃描webapp以檢查更改並在檢測到任何熱備份時自動進行熱重新部署之間的暫停（以秒為單位）。 預設情況下，此值為0，這將禁用熱部署掃描。大於0的數字啟用它。

重灌

預設值為“自動”，與非零結合使用會在檢測到更改時自動進行熱重新部署。設定為“手動”而不是通過在執行外掛的控制檯中鍵入換行來觸發掃描。當您執行一系列要忽略的更改時，這可能很有用。在該用途中，使用引數。 scanIntervalSeconds reload

dumpOnStart

可選的。預設值為false。如果為true，則jetty將在啟動時轉儲伺服器結構。

loginServices

可選的。org.eclipse.jetty.security.LoginService 實現列表。請注意，沒有預設領域。如果你在你的領域使用領域，web.xml你可以在這裡指定一個相應的領域。您可以在jetty xml檔案中配置登入服務，並將其位置新增到 jettyXml引數中。

requestLog

可選的。的的實現org.eclipse.jetty.server.RequestLog 請求日誌介面。可以使用尊重NCSA格式的實現org.eclipse.jetty.server.NCSARequestLog。還有其他三種配置RequestLog的方法：

在jetty xml配置檔案中，如jettyXml引數中指定的那樣。
在上下文xml配置檔案中，如contextXml引數中指定的那樣。
在webApp元素中。

See Configuring Request Logs for more information.

伺服器

自jetty-9.3.1以來可選。這將配置org.eclipse.jetty.server.Server 外掛的例項，但通常不需要配置它，因為外掛會自動為您配置一個。特別是，如果使用jettyXml元素，那麼通常不希望定義此元素，因為您可能正在使用jettyXml檔案來配置具有特殊建構函式引數的伺服器，例如自定義執行緒池。如果同時定義伺服器元素並使用jettyXml元素，該元素指向具有類似“<Configure id =”Server“class =”org.eclipse.jetty.server.Server“>”的行的配置檔案

stopPort

可選的。偵聽停止命令的埠。與停止或分叉目標結合使用很有用。

STOPKEY

可選的。與stopPort一起用於停止碼頭。與stop或run-forked目標一起使用時很有用。

系統屬性

可選。允許您配置系統屬性以執行外掛。有關更多資訊，請參閱設定系統屬性。

systemPropertiesFile

可選的。包含要為外掛執行設定的系統屬性的檔案。預設情況下，您在此處進行的設定不會覆蓋已在命令列，JVM或POM via中設定的任何系統屬性systemProperties。讀取設定系統屬性以瞭解如何強制覆蓋。

跳躍

預設值為false。如果為true，則外掛的執行退出。與 -Djetty.skip在命令列上設定SystemProperty相同。在整合測試期間配置Jetty以執行並且您想跳過測試時，這非常有用

useProvidedScope

預設值是false。如果為true，則將依賴項 <scope>provided</scope>放在容器類路徑中。請注意，這不是webapp類路徑，因為“提供”表示通常期望這些依賴項由容器提供。你應該很少需要使用它。相反，您應該將提供的依賴項複製為相反的顯式依賴項plugin。

excludedGoals

可選的。jetty外掛目標名稱列表，它將導致外掛列印資訊性訊息並退出。如果您想阻止使用者執行您知道無法使用專案的目標，則非常有用。

配置Https聯結器

要配置https聯結器，您需要使用jetty xml配置檔案。此示例使用直接從jetty分發etc /目錄複製的檔案，但您當然可以組成自己的xml檔案。我們將使用以下檔案：

的jetty.xml

設定org.eclipse.jetty.server.Server 要使用的外掛的例項的各種特徵。重要的是，它設定了org.eclipse.jetty.server.HttpConfiguration 我們可以在配置聯結器的後續xml檔案中引用的元素。這是相關部分：

五

<New id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration">

<Set name="secureScheme">https</Set>

<Set name="securePort"><Property name="jetty.secure.port" default="8443" /></Set>

<Set name="outputBufferSize">32768</Set>

<Set name="requestHeaderSize">8192</Set>

<Set name="responseHeaderSize">8192</Set>

<Set name="sendServerVersion">true</Set>

<Set name="sendDateHeader">false</Set>

<Set name="headerCacheSize">512</Set>

<!-- Uncomment to enable handling of X-Forwarded- style headers

<Call name="addCustomizer">

<Arg><New class="org.eclipse.jetty.server.ForwardedRequestCustomizer"/></Arg>

</Call>

-->

</New>

碼頭，ssl.xml

設定將由https聯結器使用的ssl。這是jetty-ssl.xmljetty-distribution中的檔案：

五

三十

<?xml version="1.0"?>

<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd">

<Configure id="Server" class="org.eclipse.jetty.server.Server">

<Call name="addConnector">

<Arg>

<New id="sslConnector" class="org.eclipse.jetty.server.ServerConnector">

<Arg name="server"><Ref refid="Server" /></Arg>

<Arg name="acceptors" type="int"><Property name="ssl.acceptors" default="-1"/></Arg>

<Arg name="selectors" type="int"><Property name="ssl.selectors" default="-1"/></Arg>

<Arg name="factories">

<Array type="org.eclipse.jetty.server.ConnectionFactory">

<!-- uncomment to support proxy protocol

<Item>

<New class="org.eclipse.jetty.server.ProxyConnectionFactory"/>

</Item>-->

</Array>

</Arg>

<Set name="host"><Property name="jetty.host" /></Set>

<Set name="port"><Property name="ssl.port" default="443" /></Set>

<Set name="idleTimeout"><Property name="ssl.timeout" default="30000"/></Set>

<Set name="soLingerTime"><Property name="ssl.soLingerTime" default="-1"/></Set>

<Set name="acceptorPriorityDelta"><Property name="ssl.acceptorPriorityDelta" default="0"/></Set>

<Set name="selectorPriorityDelta"><Property name="ssl.selectorPriorityDelta" default="0"/></Set>

<Set name="acceptQueueSize"><Property name="ssl.acceptQueueSize" default="0"/></Set>

</New>

</Arg>

</Call>

<New id="sslContextFactory" class="org.eclipse.jetty.util.ssl.SslContextFactory">

<Set name="KeyStorePath"><Property name="jetty.base" default="." />/<Property name="jetty.keystore" default="etc/keystore"/></Set>

<Set name="KeyStorePassword"><Property name="jetty.keystore.password" default="OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4"/></Set>

<Set name="KeyManagerPassword"><Property name="jetty.keymanager.password" default="OBF:1u2u1wml1z7s1z7a1wnl1u2g"/></Set>

<Set name="TrustStorePath"><Property name="jetty.base" default="." />/<Property name="jetty.truststore" default="etc/keystore"/></Set>

<Set name="TrustStorePassword"><Property name="jetty.truststore.password" default="OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4"/></Set>

<Set name="EndpointIdentificationAlgorithm"></Set>

<Set name="NeedClientAuth"><Property name="jetty.ssl.needClientAuth" default="false"/></Set>

<Set name="WantClientAuth"><Property name="jetty.ssl.wantClientAuth" default="false"/></Set>

<Set name="ExcludeCipherSuites">

<Array type="String">

<Item>SSL_RSA_WITH_DES_CBC_SHA</Item>

<Item>SSL_DHE_RSA_WITH_DES_CBC_SHA</Item>

<Item>SSL_DHE_DSS_WITH_DES_CBC_SHA</Item>

<Item>SSL_RSA_EXPORT_WITH_RC4_40_MD5</Item>

<Item>SSL_RSA_EXPORT_WITH_DES40_CBC_SHA</Item>

<Item>SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA</Item>

<Item>SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA</Item>

</Array>

</Set>

</New>

<New id="sslHttpConfig" class="org.eclipse.jetty.server.HttpConfiguration">

<Arg><Ref refid="httpConfig"/></Arg>

<Call name="addCustomizer">

<Arg><New class="org.eclipse.jetty.server.SecureRequestCustomizer"/></Arg>

</Call>

</New>

</Configure>

碼頭，https.xml

使用HttpConfiguration jetty.xml和來自 jetty-ssl.xml以下的ssl配置設定https聯結器：

五

<?xml version="1.0"?>

<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd">

<Configure id="sslConnector" class="org.eclipse.jetty.server.ServerConnector">

<Call name="addIfAbsentConnectionFactory">

<Arg>

<New class="org.eclipse.jetty.server.SslConnectionFactory">

<Arg name="next">http/1.1</Arg>

<Arg name="sslContextFactory"><Ref refid="sslContextFactory"/></Arg>

</New>

</Arg>

</Call>

<Call name="addConnectionFactory">

<Arg>

<New class="org.eclipse.jetty.server.HttpConnectionFactory">

<Arg name="config"><Ref refid="sslHttpConfig" /></Arg>

</New>

</Arg>

</Call>

</Configure>

現在你需要讓外掛知道應用上面的檔案：

五

<plugin>

<groupId>org.eclipse.jetty</groupId>

<artifactId>jetty-maven-plugin</artifactId>

<version>9.2.21.v20170120</version>

<configuration>

<jettyXml>${project.basedir}/src/jetty/etc/jetty.xml,${project.basedir}/src/jetty/etc/jetty-ssl.xml,${project.basedir}/src/jetty/etc/jetty-https.xml</jettyXml>

<webAppConfig> <contextPath>${project.basedir}</contextPath> </webAppConfig>

</configuration>

</plugin>

警告

就像已安裝的Jetty發行版一樣，xml檔案的排序非常重要。

您還可以使用jetty xml檔案為要使用的外掛配置http聯結器。這裡我們使用jetty-http.xmlJetty發行版中的相同檔案：

五

三十

<?xml version="1.0"?>

<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_9_0.dtd">

<Configure id="Server" class="org.eclipse.jetty.server.Server">

<Call name="addConnector">

<Arg>

<New id="httpConnector" class="org.eclipse.jetty.server.ServerConnector">

<Arg name="server"><Ref refid="Server" /></Arg>

<Arg name="acceptors" type="int"><Property name="http.acceptors" default="-1"/></Arg>

<Arg name="selectors" type="int"><Property name="http.selectors" default="-1"/></Arg>

<Arg name="factories">

<Array type="org.eclipse.jetty.server.ConnectionFactory">

<!-- uncomment to support proxy protocol

<Item>

<New class="org.eclipse.jetty.server.ProxyConnectionFactory"/>

</Item>-->

<Item>

<New class="org.eclipse.jetty.server.HttpConnectionFactory">

<Arg name="config"><Ref refid="httpConfig" /></Arg>

</New>

</Item>

</Array>

</Arg>

<Set name="host"><Property name="jetty.host" /></Set>

<Set name="port"><Property name="jetty.port" default="80" /></Set>

<Set name="idleTimeout"><Property name="http.timeout" default="30000"/></Set>

<Set name="soLingerTime"><Property name="http.soLingerTime" default="-1"/></Set>

<Set name="acceptorPriorityDelta"><Property name="http.acceptorPriorityDelta" default="0"/></Set>

<Set name="selectorPriorityDelta"><Property name="http.selectorPriorityDelta" default="0"/></Set>

<Set name="acceptQueueSize"><Property name="http.acceptQueueSize" default="0"/></Set>

</New>

</Arg>

</Call>

</Configure>

現在我們將它新增到要應用的外掛的配置列表中：

五

<plugin>

<groupId>org.eclipse.jetty</groupId>

<artifactId>jetty-maven-plugin</artifactId>

<version>9.2.21.v20170120</version>

<configuration>

<jettyXml>${project.basedir}/src/jetty/etc/jetty.xml,${project.basedir}/src/jetty/etc/jetty-http.xml,${project.basedir}/src/jetty/etc/jetty-ssl.xml,${project.basedir}/src/jetty/etc/jetty-https.xml</jettyXml>

<webAppConfig> <contextPath>${project.basedir}</contextPath> </webAppConfig>

</configuration>

</plugin>

或者，您可以使用pom內的httpConnector配置元素，如上所述。

配置WebApp

這些配置引數適用於您的webapp。它們幾乎是所有目標的共同點。

Web應用程式

表示類的擴充套件org.eclipse.jetty.webapp.WebAppContext。您可以使用此物件上的任何setter方法來配置您的webapp。以下是一些最有用的：

的contextPath

您的webapp的上下文路徑。預設情況下，此設定為/。

描述

該路徑web.xml為你的web應用檔案。

defaultsDescriptor

在webdefault.xml將之前應用於webapp 的檔案的路徑web.xml。如果您不提供，Jetty使用烘焙到的預設檔案 jetty-webapp.jar。

overrideDescriptor

web.xml讀取後Jetty應用的檔案的路徑 web.xml。您可以使用它來替換或新增配置。

tempDirectory

當您的webapp執行時，Jetty可用於擴充套件或複製jar和jsp編譯的目錄的路徑。預設是 ${project.build.outputDirectory}/tmp。

baseResource

Jetty提供靜態資源的路徑。預設為 src/main/webapp。

resourceBases

baseResource如果您有多個目錄要從中提供靜態內容，請使用而不是。這是一組目錄名稱。

baseAppFirst

預設為“true”。控制是否在webapp的原始基礎資源之前或之後新增任何重疊的戰爭。有關更多資訊，請參閱有關重疊戰爭的部分。

contextXml

在 webApp元素之後應用於webapp的上下文xml檔案的路徑。

配置Jetty Maven外掛-版本9.x