第26章 War プラグイン

To use the War plugin, include the following in your build script:

War プラグインを使うためには、ビルドスクリプトに下記を含めます：

apply plugin: 'war'

The War plugin adds the following tasks to the project.

War プラグインは 次のタスクをプロジェクトに追加します。

The War plugin adds the following dependencies to tasks added by the Java plugin.

War プラグインは Java プラグインで追加されたタスクに対し、次の依存関係を追加します。

図26.1 War プラグイン - タスクWar plugin - tasks

The War plugin adds two dependency configurations named providedCompile and providedRuntime. Those two configurations have the same scope as the respective compile and runtime configurations, except that they are not added to the WAR archive. It is important to note that those provided configurations work transitively. Let's say you add commons-httpclient:commons-httpclient:3.0 to any of the provided configurations. This dependency has a dependency on commons-codec. Because this is a “provided” configuration, this means that neither of these dependencies will be added to your WAR, even if the commons-codec library is an explicit dependency of your compile configuration. If you don't want this transitive behavior, simply declare your provided dependencies like commons-httpclient:commons-httpclient:3.0@jar.

War プラグインは providedCompile と providedRuntime の２つの依存構成を追加します。 これらの構成は WAR アーカイブには追加されないという点を除けば、それぞれ compile、runtime と同じスコープを持ちます。 provided 構成が推移的に機能することは特筆すべき点です。 そうですね。例えば provided 構成の何れかに commons-httpclient:commons-httpclient:3.0 を追加したとします。 この依存ライブラリは commons-codec に依存します。 これは、たとえ、commons-codec が compile 構成に依存していることが明らかであったとしても WAR ファイルには httpclient も commons-codec も追加されないことを意味します。 もし、この推移的な挙動を望まないのであれば、単純に commons-httpclient:commons-httpclient:3.0@jar を dependencies の provided 構成に定義してください。

>These properties are provided by a WarPluginConvention convention object.

これらのプロパティは WarPluginConvention オブジェクトによって提供されています。

>The default behavior of the War task is to copy the content of src/main/webapp to the root of the archive. Your webapp directory may of course contain a WEB-INF sub-directory, which may contain a web.xml file. Your compiled classes are compiled to WEB-INF/classes. All the dependencies of the runtime ^[21] configuration are copied to WEB-INF/lib.

The War class in the API documentation has additional useful information.

Here is an example with the most important customization options:

以下は最も重要なカスタマイズ例です。

configurations {
   moreLibs
}

repositories {
   flatDir { dirs "lib" }
   mavenCentral()
}

dependencies {
    compile module(":compile:1.0") {
        dependency ":compile-transitive-1.0@jar"
        dependency ":providedCompile-transitive:1.0@jar"
    }
    providedCompile "javax.servlet:servlet-api:2.5"
    providedCompile module(":providedCompile:1.0") {
        dependency ":providedCompile-transitive:1.0@jar"
    }
    runtime ":runtime:1.0"
    providedRuntime ":providedRuntime:1.0@jar"
    testCompile "junit:junit:4.11"
    moreLibs ":otherLib:1.0"
}

war {
    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.
    classpath fileTree('additionalLibs') // adds a file-set to the WEB-INF/lib dir.
    classpath configurations.moreLibs // adds a configuration to the WEB-INF/lib dir.
    webXml = file('src/someWeb.xml') // copies a file to WEB-INF/web.xml
}

Of course one can configure the different file-sets with a closure to define excludes and includes.

もちろん、excludes と includes を定義したクロージャを使って異なるファイルセットを設定することもできます。