War 插件 - Gradle 建構系統

providedCompile: 此配置應用於編譯時需要的相依性，但這些相依性由部署 WAR 的環境提供。因此，在此處宣告的相依性對於 main 和 test 編譯類別路徑是可見的。
providedRuntime: 此配置應用於執行時需要的相依性，但這些相依性由部署 WAR 的環境提供。在此處宣告的相依性僅對於 main 和 test 執行時類別路徑是可見的。

重要的是要注意，這些 provided 配置是可傳遞的。

假設您將 commons-httpclient:commons-httpclient:3.0 新增到任何提供的配置中。此相依性具有對 commons-codec 的相依性。由於這是一個「provided」配置，這表示即使 commons-codec 函式庫是您的 implementation 配置的明確相依性，這兩個相依性都不會新增到您的 WAR 中。

如果您不想要此傳遞行為，只需像 commons-httpclient:commons-httpclient:3.0@jar 一樣宣告您的 provided 相依性即可。

發布

components.web: 用於發布由 war 任務建立的生產 WAR 的 SoftwareComponent。

慣例屬性 (已棄用)

webAppDirName — String: 預設值: src/main/webapp

Web 應用程式來源目錄的名稱，相對於專案目錄。
webAppDir — (唯讀) File: 預設值: $webAppDirName，例如 src/main/webapp

Web 應用程式來源目錄的路徑。

這些屬性由 WarPluginConvention 物件提供。

透過慣例屬性配置 war 任務已棄用。如果您需要設定 war 任務的預設值，請直接配置任務。如果您想要配置專案中所有 War 類型的任務，請使用 tasks.withType(War.class).configureEach(…)。

War

War 任務的預設行為是將 src/main/webapp 的內容複製到歸檔的根目錄。您的 webapp 目錄當然可以包含 WEB-INF 子目錄，其中可能包含 web.xml 檔案。您編譯的類別會編譯到 WEB-INF/classes。runtime ^[1] 配置的所有相依性都會複製到 WEB-INF/lib。

War 類別在 API 文件中具有其他有用的資訊。

自訂

以下範例包含最重要的自訂選項

範例 2. War 插件的自訂

build.gradle.kts

repositories {
    mavenCentral()
}

dependencies {
    providedCompile("javax.servlet:servlet-api:2.5")
}

tasks.war {
    webAppDirectory = file("src/main/webapp")
    from("src/rootContent") // adds a file-set to the root of the archive
    webInf { from("src/additionalWebInf") } // adds a file-set to the WEB-INF dir.
    webXml = file("src/someWeb.xml") // copies a file to WEB-INF/web.xml
}

build.gradle

repositories {
    mavenCentral()
}

dependencies {
    providedCompile "javax.servlet:servlet-api:2.5"
}

war {
    webAppDirectory = file('src/main/webapp')
    from 'src/rootContent' // adds a file-set to the root of the archive
    webInf { from 'src/additionalWebInf' } // adds a file-set to the WEB-INF dir.
    webXml = file('src/someWeb.xml') // copies a file to WEB-INF/web.xml
}

當然，可以使用閉包配置不同的檔案集，以定義排除和包含。

1. runtime 配置擴展了 compile 配置。

此頁面是否有幫助？