Javac

説明

Java ソースツリーをコンパイルします。

ソースディレクトリとデスティネーションディレクトリは、コンパイルする Java ソースファイルを再帰的にスキャンされます。対応する .class ファイルがない、または .class ファイルが .java ファイルよりも古い .java ファイルのみがコンパイルされます。

注意: Apache Ant は、再構築が必要なクラスを見つけるために、ソースファイルとクラスファイルの名前のみを使用します。ソースをスキャンしないため、ネストされたクラス、ソースファイルとは異なる名前のクラスなどについては認識しません。存在/変更時刻以外の依存関係チェックについては、<depend> タスクを参照してください。

ソースファイルがパッケージの一部である場合、ソースツリーのディレクトリ構造はパッケージ階層に従う必要があります。

コンパイルされるファイルのセットを絞り込むことができます。これは、includes、includesfile、excludes、および excludesfile 属性を使用して行うことができます。includes または includesfile 属性を使用して、含めるファイルを指定します。exclude または excludesfile 属性は、除外するファイルを指定するために使用されます。どちらの場合も、ファイルのリストは、srcdir 属性またはネストされた <src> 要素で指定されたディレクトリを基準としたファイル名、またはワイルドカードパターンを使用して指定できます。ファイルの包含/除外の仕組み、およびワイルドカードパターンの記述方法については、ディレクトリベースのタスクのセクションを参照してください。

異なるコンパイラを使用することができます。これは、ビルド全体で all <javac> tasksに影響を与えるグローバルな build.compiler プロパティを設定するか、現在の <javac> タスクに固有の compiler 属性を設定するか、org.apache.tools.ant.taskdefs.compilers.CompilerAdapter を実装する任意のtypedef またはcomponentdefされた型のネストされた要素を使用することで指定できます。build.compiler プロパティまたは compiler 属性の有効な値は次のとおりです。

• classic (JDK 1.1/1.2 の標準コンパイラ) – javac1.1 および javac1.2 をエイリアスとして使用できます。
• modern (JDK 1.3 以降の標準コンパイラ) – javac1.3、javac1.4、javac1.5、javac1.6、javac1.7 (Ant 1.8.2 以降)、javac1.8 (Ant 1.8.3 以降)、javac1.9 (Ant 1.9.5 以降)、javac9 (Ant 1.9.8 以降)、javac10+ (Ant 1.10.2 以降) をエイリアスとして使用できます。
• jikes (Jikes コンパイラ)。
• jvc (Microsoft の SDK for Java / Visual J++ のコマンドラインコンパイラ) – microsoft をエイリアスとして使用できます。
• kjc (kopi コンパイラ)。
• gcj (GCC の gcj コンパイラ)。
• sj (Symantec Java コンパイラ) – symantec をエイリアスとして使用できます。
• extJavac (modern または classic を独自の JVM で実行します)。

デフォルトは javacX で、X は Ant を実行している JDK のバージョンによって異なります。提供されているものとは異なるコンパイラインターフェースを使用する場合は、CompilerAdapter インターフェース (パッケージ org.apache.tools.ant.taskdefs.compilers) を実装するクラスを作成できます。build.compiler プロパティまたは compiler 属性に完全なクラス名を指定します。

fork 属性は、build.compiler プロパティまたは compiler 属性の設定をオーバーライドし、JAVA_HOME に JDK 1.1 以降が設定されていることを想定しています。

fork=true を設定した場合でも、compiler 属性を使用して、Ant がコマンドラインスイッチをまとめるときにどの JDK バージョンを想定するかを指示することもできます。これは、現在の JDK が 1.2+ である場合に JDK 1.1 のコンパイラを実行する場合に便利です。compiler=javac1.1 と (たとえば) depend=true を使用すると、Ant は -Xdepend の代わりにコマンドラインスイッチ -depend を使用します。

このタスクは、コンパイラに渡すクラスパスから、存在しないファイル/ディレクトリを指すすべてのエントリを削除します。

フォークされた実行可能ファイル (存在する場合) の作業ディレクトリは、プロジェクトのベースディレクトリです。

Windows の注意: Windows で modern コンパイラがフォークされていないモードで使用されている場合、<javac> タスクのクラスパスに存在するファイルがロックされ、解放されません。この副作用として、ビルドの後半でこれらのファイルを削除または移動できなくなります。回避策は、コンパイラを呼び出すときにフォークすることです。

ソースに @Native アノテーションが付加されたネイティブメソッドまたはフィールドが含まれている場合、javac の -h スイッチを使用してネイティブヘッダーファイルを生成するために、nativeheaderdir 属性を設定できます。Ant がどのファイルをコンパイルするかを決定するロジックは、ネイティブヘッダーを考慮していないことに注意してください。つまり、.class が対応する .java ファイルよりも新しい場合、ネイティブヘッダーファイルが生成されていても古くなっている場合でも、ファイルはコンパイルされません。

パラメータ

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

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

srcdir、classpath、sourcepath、bootclasspath、modulepath、modulesourcepath、upgrademodulepath、および extdirs

<javac> の srcdir、classpath、sourcepath、bootclasspath、extdirs、modulepath、modulesourcepath、および upgrademodulepath 属性は、パスのような構造 であり、ネストされた <src>（名前が異なります！）、<classpath>、<sourcepath>、<bootclasspath>、<extdirs>、<modulepath>、<modulesourcepath>、および <upgrademodulepath> 要素を介してそれぞれ設定することもできます。

compilerarg

ネストされた <compilerarg> 要素を使用して、コンパイラに追加のコマンドライン引数を指定できます。これらの要素は、コマンドライン引数のように指定されますが、指定されたコンパイラ実装が使用される場合にのみ引数を有効にするために使用できる追加の属性があります。

compilerclasspath

Ant 1.8.0 以降

カスタムクラスが指定されている場合にコンパイラ実装をロードするときに使用するクラスパスを保持するパスのような構造。組み込みコンパイラのいずれかを使用する場合、効果はありません。

CompilerAdapter を実装するタイプのネストされた要素

Ant 1.8.0 以降

定義された型が CompilerAdapter インターフェースを実装する場合、その型のネストされた要素を compiler 属性の代わりに使用できます。

例

${src} ディレクトリ以下のすべての .java ファイルをコンパイルし、.class ファイルを ${build} ディレクトリに保存します。使用されるクラスパスには xyz.jar が含まれ、デバッグ情報付きでコンパイルされます。ソースレベルは 1.4 なので、assert ステートメントを使用できます。

<javac srcdir="${src}"
       destdir="${build}"
       classpath="xyz.jar"
       debug="on"
       source="1.4"/>

${src} ディレクトリ以下のすべての .java ファイルをコンパイルし、.class ファイルを ${build} ディレクトリに保存します。Java コンパイラは、デフォルトの javac 実行ファイルを使用してフォークされます。ソースレベルは 1.2（1.1 または 1.3 と同様）であり、クラスファイルは JDK 1.2+ でも実行できる必要があります。

<javac srcdir="${src}"
       destdir="${build}"
       fork="true"
       source="1.2"
       target="1.2"/>

${src} ディレクトリ以下のすべての .java ファイルをコンパイルし、.class ファイルを ${build} ディレクトリに保存します。Java コンパイラは、java$javac.exe という名前の実行ファイルを使用してフォークされます。$ 記号は、2 番目の記号でエスケープする必要があることに注意してください。ソースレベルは 1.5 なので、ジェネリックスを使用できます。

<javac srcdir="${src}"
       destdir="${build}"
       fork="java$$javac.exe"
       source="1.5"/>

${src} ディレクトリ以下の .java ファイルをコンパイルし、.class ファイルを ${build} ディレクトリに保存します。使用されるクラスパスには xyz.jar が含まれ、デバッグ情報はオンです。mypackage/p1 および mypackage/p2 以下のファイルのみが使用されます。mypackage/p1/testpackage ディレクトリ以下のすべてのファイルはコンパイルから除外されます。ソースレベルまたはターゲットレベルを指定していないため、使用される実際の値は、Ant を実行した JDK によって異なります。

<javac srcdir="${src}"
       destdir="${build}"
       includes="mypackage/p1/**,mypackage/p2/**"
       excludes="mypackage/p1/testpackage/**"
       classpath="xyz.jar"
       debug="on"/>

これは前の例と同じですが、プロパティ src2 で定義された 2 番目のソースパスが追加されています。これは、ネストされた <src> 要素を使用して次のように表すこともできます。

<javac destdir="${build}"
       classpath="xyz.jar"
       debug="on">
  <src path="${src}"/>
  <src path="${src2}"/>
  <include name="mypackage/p1/**"/>
  <include name="mypackage/p2/**"/>
  <exclude name="mypackage/p1/testpackage/**"/>
</javac>

別の JDK の javac コンパイラを実行する場合は、コンパイラの場所と使用する JDK のバージョンを Ant に指示して、正しいコマンドラインスイッチを選択できるようにする必要があります。次の例では、新しいプロセスで JDK 1.1 javac を実行し、Ant が異なるバージョンの JVM で実行されている場合でも正しいコマンドラインスイッチを使用します。

<javac srcdir="${src}"
       destdir="${build}"
       fork="yes"
       executable="/opt/java/jdk1.1/bin/javac"
       compiler="javac1.1"/>

**注意**：共通ルート以下の特定のパッケージにあるソースファイルのみをコンパイルする場合は、include/exclude 属性または <include>/<exclude> ネストされた要素を使用して、これらのパッケージをフィルタリングします。パッケージ構造の一部を srcdir 属性（またはネストされた <src> 要素）に含めないでください。そうしないと、コンパイルターゲットを実行するたびに Ant がソースファイルを再コンパイルします。詳細については、Ant FAQ を参照してください。

明示的に指定されたファイルのみをコンパイルし、javac のデフォルトの検索メカニズムを無効にする場合は、sourcepath 属性の設定を解除できます。

<javac sourcepath="" srcdir="${src}"
       destdir="${build}" >
  <include name="**/*.java"/>
  <exclude name="**/Example.java"/>
</javac>

このようにして、javac は ${src} ディレクトリ以下のすべての Java ソースファイルをコンパイルしますが、例はスキップします。コンパイラは、例以外のファイルの一部がそれらを参照している場合でもエラーを生成します。

特別な JDK（Ant が現在使用している JDK 以外）でコンパイルする場合は、executable 属性と fork 属性を設定します。taskname を使用すると、ログにこれらの設定が修正されていることが示される場合があります。

<javac srcdir=""
       destdir=""
       executable="path-to-java14-home/bin/javac"
       fork="true"
       taskname="javac1.4"/>

lint などの他のコンパイラオプションをアクティブにする場合は、<compilerarg> 要素を使用できます。

<javac srcdir="${src.dir}"
       destdir="${classes.dir}"
       classpathref="libraries">
  <compilerarg value="-Xlint"/>
</javac>

カスタム CompilerAdapter org.example.MyAdapter を使用する場合は、compiler 属性を使用できます。

<javac srcdir="${src.dir}"
       destdir="${classes.dir}"
       compiler="org.example.MyAdapter"/>

または、次のように型を定義してタスクにネストします。

<componentdef classname="org.example.MyAdapter"
              name="myadapter"/>
<javac srcdir="${src.dir}"
       destdir="${classes.dir}">
  <myadapter/>
</javac>

この場合、コンパイラアダプターは独自の属性とネストされた要素をサポートできます。

次の例は、Java 9+ モジュールの使用方法を示しています。

${src} ディレクトリ以下の単一モジュール内のすべての .java ファイルをコンパイルし、.class ファイルを ${build} ディレクトリに保存します。コンパイルでは、modules フォルダーにあるアプリケーションモジュールが使用されます。ソースレベルは、モジュールを有効にするために 9 です。

<javac srcdir="${src}"
       destdir="${build}"
       includeantruntime="false"
       modulepath="modules"
       source="9"/>

${src} ディレクトリ以下のすべてのソースモジュールで、gen/classes、lin32/classes、および lin64/classes 内のすべての .java ファイルをコンパイルします。${build} ディレクトリにモジュールディレクトリを生成します。${build} ディレクトリ以下の各生成されたモジュールディレクトリには、対応するソースモジュールからの .class ファイルが含まれています。* は、コンパイルモジュールセット内のいずれかのモジュールの名前を表すトークンです。{ ... , ... } は、展開の選択肢を表します。コンパイルでは、modules フォルダーにあるアプリケーションモジュールが使用されます。ソースレベルは、モジュールを有効にするために 9 です。

<javac modulesourcepath="${src}/*/{gen,lin{32,64}}/classes"
       destdir="${build}"
       includeantruntime="false"
       modulepath="modules"
       source="9"/>

Jikes の注意事項

Jikes 1.15 以上が必要です。

Jikes はいくつかの追加オプションをサポートしています。これらのオプションは、タスクを呼び出す前に、以下に示すプロパティを定義することで設定できます。各プロパティの設定は、ビルド全体のすべての <javac> タスクに有効です。Ant 開発者は、これが醜くて柔軟性がないことを認識しています。将来、より良いソリューションが期待されます。すべてのオプションは boolean であり、false 以外として解釈するには、true または yes に設定する必要があります。デフォルトでは、build.compiler.warnings は true で、その他はすべて false です。

Jvc の注意事項

Jvc は、<javac> を呼び出す前にプロパティ build.compiler.jvc.extensions を false に設定しない限り、Microsoft 拡張機能を有効にします。

ブートストラップオプション

Sun の javac コンパイラには、-bootclasspath コマンドラインオプションがあります。これは、<javac> タスクの bootclasspath 属性/要素に対応します。Sun のコンパイラでは、-X 属性と -J-X 属性を使用して、ブートクラスパスをより詳細に制御することもできます。これらは <compilerarg> を使用して設定できます。*Ant 1.6.0 以降*、パス参照を OS に依存しない方法で使用できる文字列に変換するためのショートカットがあります（pathshortcut を参照）。例えば

<path id="lib.path.ref">
  <fileset dir="lib" includes="*.jar"/>
</path>
<javac srcdir="src" destdir="classes">
  <compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/>
</javac>

OpenJDK に関する注意

OpenJDK プロジェクトは、javac コンパイラ をオープンソースプロジェクトとして提供しています。このプロジェクトの出力は、javac コンパイラを含む javac.jar です。このコンパイラは、-Xbootclasspath/p Java 引数を使用して <javac> タスクで使用できます。この引数は javac 実行ファイルのランタイムシステムに渡す必要があるため、-J を前に付ける必要があります。例えば

<property name="patched.javac.jar"
          location="${my.patched.compiler}/dist/lib/javac.jar"/>

<presetdef name="patched.javac">
  <javac fork="yes">
    <compilerarg value="-J-Xbootclasspath/p:${patched.javac.jar}"/>
  </javac>
</presetdef>


<patched.javac srcdir="src/java" destdir="build/classes"
               debug="yes"/>

package-info.java に関する注意

package-info.java ファイルは、パッケージレベルのアノテーションを許可するために Java 5 で導入されました。コンパイル時に、.java ファイルに実行時アノテーションが含まれていない場合、対応する .class ファイルは作成されません。Ant 1.7.1 より前では、<javac> タスクが再度実行されると、タスクは package-info.java ファイルを再度コンパイルしようとします。

Ant 1.7.1 では、通常は .class ファイルを含むディレクトリのタイムスタンプを含む、異なる種類のロジックが導入されました。このロジックは、特定の設定で Ant が package-info.java を再コンパイルしないことにつながることが判明しました。

*Ant 1.8.0 以降*、Ant が package-info.java をコンパイルし、コンパイラ自体によって package-info.class ファイルが作成されていない場合、「空の」package-info.class ファイルが作成されます。