Jar

説明

複数のファイルをJarファイルにまとめます。

basedir 属性は、Jar化する際の基準ディレクトリです。

ファイルのパーミッションは、結果のJarファイルには保存されないことに注意してください。

Jar化するファイルセットを絞り込むことができます。これは、includes、includesfile、excludes、excludesfile、および defaultexcludes 属性を使用して行います。includes または includesfile 属性では、パターンを使用して含めるファイルを指定します。exclude または excludesfile 属性は、除外するファイルを指定するために使用されます。これもパターンを使用して行います。最後に、defaultexcludes 属性を使用して、デフォルトの除外を使用するかどうかを指定できます。ファイルの包含/除外の仕組み、およびパターンの記述方法については、ディレクトリベースのタスクのセクションを参照してください。

このタスクは暗黙的な FileSet を形成し、<fileset> のほとんどの属性（dir は basedir になります）と、ネストされた <include>、<exclude>、および <patternset> 要素をサポートします。

より柔軟性を高めるためにネストされたファイルセットを使用することもでき、複数のファイルセットを指定して異なるファイルツリーを1つのJARにマージすることもできます。zip タスクの拡張 fileset および groupfileset 子要素も、jar タスクで使用できます。詳細と例については、Zip タスクを参照してください。

update パラメーターは、JARファイルが既に存在する場合の動作を制御します。「yes」に設定すると、JARファイルは指定されたファイルで更新されます。「no」（デフォルト）に設定すると、JARファイルは上書きされます。この使用例は、Zipタスクのドキュメントに記載されています。ZIPファイルはファイルの変更時刻を2秒の粒度で保存することに注意してください。ファイルがアーカイブ内のエントリよりも2秒未満新しい場合、Antはそれを新しいとは見なしません。

マニフェストが省略された場合は、Apache Antによって単純なマニフェストが提供されます。

whenmanifestonly パラメーターは、マニフェストファイルまたはネストされたサービス以外のファイルが一致しない場合の動作を制御します。「skip」の場合、JARは作成されず、警告が発行されます。「fail」の場合、JARは作成されず、ビルドはエラーで停止します。「create」（デフォルト）の場合、空のJARファイル（マニフェストとサービスのみを含む）が作成されます。

（Jar タスクには、JARファイルのマニフェストファイルを指定するためのショートカットがあります。同じことは、Zip タスクで zipfileset の fullpath 属性を使用することによっても実現できます。1つの違いは、manifest 属性が指定されていない場合、Jar タスクは空のものを含めることです。）

マニフェストは、Jarファイル仕様に従ってJarタスクによって処理されます。特に、これにより、72バイトを超えるマニフェスト行がラップされ、次の行に続く可能性があることに注意してください。

Jar タスクは、バージョン管理仕様に従ってパッケージ情報を指定したかどうかを確認します。

ZIP形式では、同じ完全修飾名の複数のファイルを単一のアーカイブ内に存在させることができることに注意してください。これは、 unsuspecting なユーザーにさまざまな問題を引き起こすことが documented されています。この動作を回避するには、duplicate 属性をデフォルトの「add」以外の値に設定する必要があります。

JARファイルに暗号署名するには、このタスクから作成したJARに対してSignJarタスクを使用します。

JEP 238マルチリリースjarの単純なバージョンを作成するには、特別なツールは必要ありません。必要なmanifestエントリを設定し、JEP 238の例でわかるように、必要な場所にファイルを配置するだけです。この種のjarを調整する場合、たとえば、バージョンブランチから「同じ」クラスを削除してサイズを小さくする場合、さらに多くのことを行う必要があります...

パラメータ

ネストされた要素として指定されたパラメータ

metainf

ネストされたmetainf要素は、FileSetを指定します。このファイルセットに含まれるすべてのファイルは、jarファイルのMETA-INFディレクトリに配置されます。このファイルセットにMANIFEST.MFという名前のファイルが含まれている場合、ファイルは無視され、警告が表示されます。

manifest

ネストされた manifest 要素を使用すると、Jar ファイルのマニフェストを外部ファイルではなく、ビルドファイルにインラインで指定できます。この要素は manifest タスクと同じですが、file 属性と mode 属性は省略する必要があります。

インラインマニフェストと外部ファイルの両方が指定されている場合、マニフェストはマージされます。

インラインマニフェストを使用する場合、Jar タスクはマニフェストの内容が変更されたかどうかを確認します（つまり、指定されたマニフェストが、jar に存在するマニフェスト（存在する場合）と何らかの形で異なるかどうか）。マニフェストの値が変更された場合、jar は必要に応じて更新または再構築されます。

indexjars

Ant 1.6.2以降

ネストされた indexjars 要素は、パスのような構造を指定します。タスクの index 属性を true に設定しない限り、その内容は完全に無視されます。

このタスクによって作成されたインデックスには、このパスに含まれるアーカイブのインデックスが含まれます。アーカイブに使用される名前は、マニフェストによって異なります。

• 生成された jar のマニフェストに Class-Path 属性が含まれていない場合、先頭のディレクトリパスを含まないファイル名が使用され、パスのすべての部分がインデックス化されます。
• マニフェストに Class-Path 属性が含まれている場合、このタスクは Class-Path のどの部分が特定のアーカイブに属しているかを推測しようとします。名前を推測できない場合、アーカイブはスキップされます。それ以外の場合、Class-Path 属性内にリストされている名前が使用されます。

indexmetainf 属性が true に設定されていない限り、このタスクは、空であるか、META-INF ディレクトリ内のファイルのみを含むアーカイブのインデックスエントリを作成しません。

indexjarsmapper

Ant 1.10.9以降

ネストされた indexjarsmapper 要素は、デフォルトのファイル名変換では不十分な場合、indexjars で指定されたアーカイブのカスタムファイル名変換を実行するために使用できます。

service

Ant 1.7.0以降

ネストされた service 要素は、サービスを指定します。サービスについては、サービスプロバイダーの概要で説明されています。このアプローチでは、プロバイダー JAR に、提供されるサービスによって名前が付けられたファイル（たとえば、META-INF/services/javax.script.ScriptEngineFactory）を含めます。このファイルには、実装クラス名が 1 行に 1 つずつ（通常は JAR ごとに 1 つだけ）含まれています。

サービスの名前は type 属性によって設定されます。サービスを実装するクラス名は、provider 属性、またはサービスを実装する複数のクラスを指定する場合は、ネストされた provider 要素によって指定されます。

プロバイダーのクラス名は、provider 属性、または単一の classname 属性を持つネストされた <provider> 要素によって指定されます。JAR ファイルにサービスの実装が複数ある場合、複数のネストされた <provider> 要素を使用できます。

例

単純

${build}/classes ディレクトリ内のすべてのファイルを、${dist}/lib ディレクトリにある app.jar というファイルに Jar します。

<jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/>

フィルター付き

${build}/classes ディレクトリ内のすべてのファイルを、${dist}/lib ディレクトリにある app.jar というファイルに Jar します。Test.class という名前のファイルは除外されます。

<jar destfile="${dist}/lib/app.jar"
     basedir="${build}/classes"
     excludes="**/Test.class"/>

${build}/classes ディレクトリ内のすべてのファイルを、${dist}/lib ディレクトリにある app.jar というファイルに Jar します。mypackage/test ディレクトリ以下のファイルのみが使用され、Test.class という名前のファイルは除外されます。

<jar destfile="${dist}/lib/app.jar"
     basedir="${build}/classes"
     includes="mypackage/test/**"
     excludes="**/Test.class"/>

複数のファイルセット

${build}/classes ディレクトリと ${src}/resources ディレクトリのすべてのファイルを、${dist}/lib ディレクトリにある app.jar というファイルにまとめて Jar します。Test.class という名前のファイルは除外されます。${build}/classes/mypackage/MyClass.class や ${src}/resources/mypackage/image.gif などのファイルがある場合、それらは jar 内の同じディレクトリに表示されます（そのため、Java では同じパッケージと見なされます）。

<jar destfile="${dist}/lib/app.jar">
    <fileset dir="${build}/classes"
             excludes="**/Test.class"/>
    <fileset dir="${src}/resources"/>
</jar>

アーカイブのマージ

メインクラス com.acme.checksites.Main を使用して実行可能な jar ファイルを作成し、jar lib/main/some.jar からすべてのクラスを埋め込みます。

<jar destfile="build/main/checksites.jar">
    <fileset dir="build/main/classes"/>
    <zipfileset includes="**/*.class" src="lib/main/some.jar"/>
    <manifest>
      <attribute name="Main-Class"
                 value="com.acme.checksites.Main"/>
    </manifest>
</jar>

メインクラス com.acme.checksites.Main を使用して実行可能な jar ファイルを作成し、lib/main 内のすべての jar からすべてのクラスを埋め込みます。

<jar destfile="build/main/checksites.jar">
    <fileset dir="build/main/classes"/>
    <restrict>
       <name name="**/*.class"/>
       <archives>
           <zips>
               <fileset dir="lib/main" includes="**/*.jar"/>
           </zips>
       </archives>
    </restrict>
    <manifest>
        <attribute name="Main-Class"
              value="com.acme.checksites.Main"/>
    </manifest>
</jar>

インラインマニフェスト

<jar destfile="test.jar" basedir=".">
    <include name="build"/>
    <manifest>
        <!-- If this is an Applet or Web Start application, include
             the proper attributes from https://docs.oracle.com/javase/8/docs/technotes/guides/jweb/index.html -->
        <attribute name="Permissions" value="sandbox"/>
        <attribute name="Codebase" value="example.com"/>
        <!-- Who is building this jar? -->
        <attribute name="Built-By" value="${user.name}"/>
        <!-- Information about the program itself -->
        <attribute name="Implementation-Vendor" value="ACME inc."/>
        <attribute name="Implementation-Title" value="GreatProduct"/>
        <attribute name="Implementation-Version" value="1.0.0beta2"/>
        <!-- details -->
        <section name="common/MyClass.class">
            <attribute name="Sealed" value="false"/>
        </section>
    </manifest>
</jar>

これは、ビルドプログラムのバージョン（Implementation-Version）を含むインラインマニフェストの指定例です。Built-By 属性は、Ant プロパティ user.name の値を取ります。上記によって生成されたマニフェストは次のようになります。

Manifest-Version: 1.0
Permissions: sandbox
Codebase: example.com
Built-By: conor
Implementation-Vendor: ACME inc.
Implementation-Title: GreatProduct
Implementation-Version: 1.0.0beta2
Created-By: Apache Ant 1.9.2

Name: common/MyClass.class
Sealed: false

サービスプロバイダー

スクリプトインターフェースの実装でサービスを指定する jar ファイルを作成する方法を次に示します。

<jar destfile="pinky.jar">
    <fileset dir="build/classes"/>
    <service type="javax.script.ScriptEngineFactory"
             provider="org.acme.PinkyLanguage"/>
</jar>

スクリプトインターフェースの 2 つの実装でサービスを指定する jar ファイルを作成する方法を次に示します。

<jar destfile="pinkyandbrain.jar">
    <fileset dir="classes"/>
    <service type="javax.script.ScriptEngineFactory">
        <provider classname="org.acme.PinkyLanguage"/>
        <provider classname="org.acme.BrainLanguage"/>
    </service>
</jar>

JEP 238 の例：マルチリリース JAR ファイル

ここでは、仕様 JEP 238 に従って、*マルチリリース JAR ファイル* を作成します。これは、JAR の上に、実行する Java のバージョンに応じて使用可能な追加のクラスまたは上書きするクラスを jar に配置する可能性を定義しています。
基本的には、マニフェストエントリ Multi-Release: true を設定し、すべての追加または上書きするクラスを META-INF/versions/number/package-structure（例：META-INF/versions/9/org/apache/ant/MyClass.class）に配置する必要があるということです。

この例では、通常のクラスは ${java.classes} にコンパイルされ、Java 9 クラスは ${java9.classes} にコンパイルされると想定しています。

<jar destfile="mrjar.jar">
    <manifest>
        <!-- special mf-entry according to the spec -->
        <attribute name="Multi-Release" value="true"/>
    </manifest>
    <!-- directory structure according to the spec ... -->
    <!-- ... default classes loadable by old (<Java 9) versions -->
    <fileset dir="${java.classes}"/>
    <!-- ... per release classes, require Java 9+ for loadable via standard ClassLoader -->
    <zipfileset prefix="META-INF/versions/9/" dir="${java9.classes}"/>
</jar>