はじめに (対象読者・この記事でわかること)

この記事は、Java開発においてEclipseを日常的に利用している方、特に実行可能JARファイルを作成する際に、Eclipseの実行構成で設定したVM引数がどのように扱われるのか疑問に思っている方を対象としています。

この記事を読むことで、以下の点が明確になります。

  • Eclipseの実行構成で設定したVM引数が、実行可能JARファイル作成時に自動的に含まれるわけではないこと。
  • JARファイルにVM引数を含めるための代替手段とその方法。
  • なぜVM引数が直接引き継がれないのか、その背景にあるJavaの仕組み。
  • 外部からJVMオプションを指定してJARファイルを実行する一般的な方法。

JARファイル単体で完結させたい、あるいは開発環境と実行環境で異なるJVMオプションを設定したいという場合に、この記事が問題解決の一助となれば幸いです。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

  • Javaの基本的な文法と開発経験
  • Eclipse IDEの基本的な操作（プロジェクト作成、実行構成の設定など）
  • 実行可能JARファイル（Executable JAR）の概念
  • JVM（Java Virtual Machine）の基本的な役割と、JVMオプション（-Xmx、-Dなど）の概要

【Eclipse】実行構成のVM引数はjarファイル作成時に情報として含まれるのか？

EclipseでJavaアプリケーションを開発する際、実行構成（Run Configurations）に「VM引数」（VM arguments）を設定することで、JVMに渡すオプションを指定できます。例えば、メモリ割り当てを増やすために-Xmx1024mを指定したり、システムプロパティを設定するために-Dmy.property=my.valueのように記述したりします。

しかし、この実行構成で設定したVM引数が、そのまま実行可能JARファイル（Executable JAR）の内部に「情報」として埋め込まれ、JARファイル単体で実行した際に自動的に適用されるわけではない、という点は意外と見落としがちです。

結論から申し上げると、Eclipseの実行構成で設定したVM引数は、実行可能JARファイルを作成する際に、そのJARファイル自体のメタデータとして自動的に書き込まれるわけではありません。

これは、JARファイルが単なるコンテナであり、実行方法（JVMへの指示）はJARファイルの外側で定義されるのが一般的であるためです。Javaの実行可能JARファイルは、META-INF/MANIFEST.MFというマニフェストファイルを含んでいますが、このマニフェストファイルは主にエントリポイント（Main-Class）やクラスパスなどを定義するために使用され、JVMオプションを直接指定するための標準的なフィールドは持っていません。

そのため、JARファイルを作成し、それをコマンドラインから実行する際には、java -jar your_app.jar のように実行しますが、このコマンドに直接 -Xmx や -D といったJVMオプションを付加する必要があります。

例えば、以下のようなコマンドで実行します。

Bash

java -Xmx1024m -Dmy.property=my.value -jar your_app.jar

この挙動を理解することは、デプロイメントや実行環境でのアプリケーションの振る舞いを予測し、適切に制御するために非常に重要です。

なぜVM引数はJARファイルに直接含まれないのか？

この挙動の背景には、Javaの実行モデルとJARファイルの役割があります。

  1. JARファイルはデータコンテナ: JARファイルは、コンパイルされたJavaクラスファイル、リソースファイル、そしてMETA-INF/MANIFEST.MFといったメタデータを含むアーカイブファイルです。これは、プログラムのコードやリソースをまとめて配布するための「パッケージ」であり、実行環境そのものではありません。
  2. 実行はJVMが行う: Javaプログラムを実行するのはJVMです。JVMは、JARファイルからクラスをロードし、MANIFEST.MFファイルに記述されたMain-Classエントリポイントからアプリケーションの実行を開始します。
  3. JVMオプションは実行時の指示: -Xmxや-DといったJVMオプションは、JVMに対して「どのようにプログラムを実行するか」という指示を与えます。これは、JVMがプログラムをロード・実行する「前」に、JVM自体に渡されるべき情報です。JARファイルが作成された後に、そのJARファイル自体が「実行方法」を自己定義する仕組みは、標準では用意されていません。
  4. Manifest-Additions: EclipseのJARエクスポート機能（「JARファイル」ではなく「実行可能JARファイル」を選択した場合）では、META-INF/MANIFEST.MFファイルに Main-Class 属性などを記述し、実行可能JARとして扱えるようにしています。しかし、ここにもJVMオプションを直接記述する標準的な方法は存在しません。

もし、JARファイル単体で実行した際に特定のJVMオプションが自動的に適用されるようにしたい場合、それは標準的なJavaの機能ではなく、何らかのラッパー（シェルスクリプトや別のJavaプログラム）を作成して、その中でJVMオプションを指定しながらターゲットJARを実行する、といった工夫が必要になります。

実行可能JARファイル作成時のEclipseの挙動

Eclipseで「実行可能JARファイルのエクスポート」を行う際、いくつかのオプションがあります。

  • JARファイル: これは単なるアーカイブであり、通常はjava -jarで実行できません。
  • 実行可能JARファイル: こちらを選択すると、MANIFEST.MFにMain-Classが記述され、java -jarで直接実行できるようになります。

この「実行可能JARファイル」をエクスポートする際、Eclipseはプロジェクトのビルドパスや実行構成の設定を元にJARファイルを作成しますが、実行構成で設定されたVM引数が、エクスポートされるJARファイル内に直接埋め込まれるわけではありません。

したがって、Eclipse上でアプリケーションをデバッグ実行する際にVM引数を設定していたとしても、エクスポートしたJARファイルをコマンドラインから java -jar your_app.jar と実行しただけでは、それらのVM引数は適用されません。

JARファイル実行時にJVMオプションを渡す方法

前述の通り、実行可能JARファイルを作成した後、JVMオプションを渡すには、Javaコマンド自体にオプションを付加するのが標準的な方法です。

1. コマンドラインから直接指定

これが最も一般的で、どのような環境でも利用できる方法です。

Bash

# メモリ制限を2GBに設定し、カスタムプロパティmy.config.fileをyour_config.propertiesに設定して実行
java -Xmx2g -Dmy.config.file=your_config.properties -jar my_application.jar
  • -Xmx: JVMが使用できる最大ヒープサイズを指定します。
  • -D: システムプロパティを設定します。キーと値のペアで指定します。

2. シェルスクリプト（またはバッチファイル）を利用する

頻繁に同じJVMオプションで実行する場合や、複数のオプションをまとめたい場合は、シェルスクリプト（Linux/macOS）やバッチファイル（Windows）を作成するのが便利です。

例 (Linux/macOS - run.sh)

Bash

#!/bin/bash

# JVMオプションを定義
JAVA_OPTS="-Xmx2g -Dmy.config.file=your_config.properties -Djava.util.logging.config.file=logging.properties"

# Javaコマンドを実行
java $JAVA_OPTS -jar my_application.jar "$@" # "$@"はスクリプトに渡された引数をすべて引き継ぐ

このスクリプトを実行するには、chmod +x run.sh で実行権限を付与した後、./run.sh のように実行します。

例 (Windows - run.bat)

Bat

@echo off
REM JVMオプションを定義
set JAVA_OPTS=-Xmx2g -Dmy.config.file=your_config.properties -Djava.util.logging.config.file=logging.properties

REM Javaコマンドを実行
java %JAVA_OPTS% -jar my_application.jar %*

このバッチファイルを実行するには、run.bat のようにコマンドプロンプトで入力します。%* は、バッチファイルに渡された引数をすべて引き継ぎます。

3. マニフェストファイルにClass-Pathなどを記述する

MANIFEST.MFファイルにはClass-Path属性を記述することで、依存するJARファイルのパスを指定できます。しかし、これはJVMオプションの指定とは異なります。

4. MavenやGradleなどのビルドツールを利用する

MavenやGradleのようなビルドツールを使用している場合、これらのツールは依存関係の管理だけでなく、実行タスクの定義もサポートしています。

  • Maven: pom.xmlのmaven-jar-pluginやmaven-exec-plugin、あるいはmaven-assembly-pluginなどで、実行可能JARの作成や実行時のJVMオプション指定が可能です。maven-jar-pluginのmanifestセクションでaddClasspathやaddArchivedなどを設定することで、依存JARを含んだ実行可能JARを作成できます。
  • Gradle: build.gradleファイルでjarタスクのmanifestブロックや、applicationプラグインのapplicationDefaultJvmArgsプロパティなどでJVMオプションを指定できます。

これらのビルドツールを使うと、より宣言的にJARファイルとその実行方法を定義できるため、複雑なアプリケーションでは非常に強力な手段となります。

実行構成で設定したVM引数をJARファイルに反映させるための「代替手段」

Eclipseの実行構成で設定したVM引数を、JARファイル単体で実行した際に「自動的に」適用されるように直接埋め込む標準的な方法はありませんが、目的に応じた代替手段は存在します。

  • ラッパーバッチ/シェルスクリプトの作成: 最も一般的で実用的な方法です。前述したように、JARファイルを実行する際に必要なJVMオプションを記述したシェルスクリプトやバッチファイルを作成し、そのスクリプトを実行することで、指定したオプションが適用された状態でJARファイルが起動します。これは、実行環境を統一したり、運用を容易にしたりする上で非常に有効です。
  • 「fat JAR」または「uber JAR」の作成: Mavenのmaven-shade-pluginやGradleのshadowJarプラグインなどを使用すると、アプリケーション本体のクラスだけでなく、依存するライブラリのクラスもすべて一つのJARファイルにまとめた「fat JAR」を作成できます。この際、プラグインの設定によっては、マニフェストファイルに特定の属性（例：Main-Class）を付与できますが、JVMオプションを直接埋め込む機能は標準ではありません。しかし、このfat JARを作成するプロセスの一環として、JVMオプションを含むシェルスクリプトを同時に生成・配布する、というワークフローを構築することは可能です。
  • 外部設定ファイルや環境変数: アプリケーション側で、JVMオプションではなく、設定ファイル（.properties、.yamlなど）や環境変数を読み込むように実装し、その設定ファイルや環境変数を実行時に指定するという方法もあります。例えば、java -Dconfig.file=app.properties -jar my_app.jar のように実行し、app.propertiesファイル内でメモリサイズやその他の設定を記述しておきます。このアプローチは、JVMオプションの指定とは異なりますが、実行時の挙動を外部から制御するという目的は達成できます。

これらの代替手段を理解し、プロジェクトの要件やデプロイメントのシナリオに合わせて最適な方法を選択することが重要です。

まとめ

本記事では、Eclipseで設定した実行構成のVM引数が、実行可能JARファイル作成時に直接情報として含まれるわけではない、という事実とその背景について解説しました。

  • Eclipseの実行構成VM引数は、JARファイルに直接埋め込まれない: JARファイルはデータコンテナであり、実行方法（JVMオプション）はJARファイルの外側で指定するのが標準です。
  • JAR実行時のJVMオプション指定: java -jar your_app.jar コマンドに直接オプションを付加するか、シェルスクリプト/バッチファイルを利用するのが一般的です。
  • 代替手段の活用: ラッパーバッチ/シェルスクリプトや、ビルドツールの機能（Maven/Gradle）を利用することで、実行環境の管理やオプション適用を効率化できます。

この記事を通して、Eclipseでの開発からデプロイメントまでの流れにおける、JVMオプションの扱い方についての理解が深まったことと思います。 今後は、MavenやGradleなどのビルドツールを使った、より高度なJARファイル生成や実行方法についても記事にする予定です。

参考資料