アクティベーションHeroku の Java サポート

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2022年01月24日(月)

Heroku は Java のさまざまな実装での Java アプリケーションの実行に対応しており、フレーワーク固有のワークフローのためのサポートを備えています。

このドキュメントでは、Java アプリケーションの認識と実行に関連した Heroku の一般的な動作について説明します。Heroku での一般的な Java サポートとは、Play を除くすべてのフレームワークに対するサポートのことを言います。Play フレームワークのサポートについては、Play フレームワークサポートリファレンス​を参照してださい。

フレームワーク固有のチュートリアルについては、次を参照してください。

アクティベーション

Heroku での Java アプリケーション用のデフォルトのビルドシステムは Maven です。pom.xml​ を含むアプリケーションには、Maven 用の Heroku Java サポートが適用されます。

デプロイされたアプリケーションが Java アプリケーションとして認識された場合、Heroku は Java app detected​ と応答します。

$ git push heroku master
-----> Java app detected

ビルド動作

アプリをビルドするには以下のコマンドを実行します。

$ mvn -B -DskipTests clean dependency:list install

ただし、Heroku はアプリケーションのリポジトリ内に mvnw​ スクリプトを検出した場合、デフォルトの Maven インストールの代わりにこのスクリプトを実行します。この動作は Maven バージョンを明示的に設定する​ことによってオーバーライドできます。

パフォーマンスを向上させるため、Mavenリポジトリはビルド間でキャッシュされます。

環境

dyno にはブート時に次の環境変数が設定されます。

  • PORT​: Web プロセスがバインドされる HTTP ポート
  • JAVA_HOME​: JDK インストールディレクトリの場所
  • LD_LIBRARY_PATH​: JDK 共有ライブラリの場所
  • JDBC_DATABASE_URL​: ​DATABASE_URL​ 変数が存在する場合、変換された形式がこれに入力されます。詳細は、「Java を使用して Heroku でリレーショナルデータベースに接続する​」を参照してください。
  • JAVA_TOOL_OPTIONS​: dyno サイズに基づくデフォルトの Java オプション
  • JAVA_OPTS​: dyno サイズに基づくデフォルトの Java オプション (JAVA_TOOL_OPTIONS​ と同様)

JAVA_TOOL_OPTIONS について

JAVA_TOOL_OPTIONS​ は Java によって直接サポートされ、コマンドラインにアクセスできないかコマンドラインを変更できない環境でコマンドラインを拡張する​ためのものです。Heroku ではこれを dyno サイズに基づくデフォルトの Java オプションを設定するために使用します。Java ではこれが自動的に選択されるため、これを Procfile​ コマンドに含める必要はありません。

これらの設定を Procfile​ コマンドでオーバーライドすることができます (デフォルトよりも優先される)。たとえば、-Xmx300m​ のデフォルトを変更する場合は、次を渡すことができます。

web: java -Xms150M -jar target/myapp.jar

独自の JAVA_TOOL_OPTIONS​ 環境変数を設定することもできます。独自の変数を設定すると、その値は Heroku のデフォルトに追加されて、優先されます。Procfile​ コマンドやカスタムの JAVA_TOOL_OPTIONS​ でオーバーライドされない個別のオプションは、引き続き有効になります。

Java プロセスが dyno で開始されると、次の Java オプションが JAVA_TOOL_OPTIONS​ に追加され、Java によって自動的に選択されます。

  • -Dfile.encoding=UTF-8
  • -XX:+UseContainerSupport​ (Java 11 以上の場合)

dyno サイズのための環境の調整

新しい dyno タイプ​が選択されると、以下の設定が自動的に JAVA_TOOL_OPTIONS​ に追加されます。

  • Free、Hobby、または Standard-1X: ​-Xmx300m -Xss512k -XX:CICompilerCount=2
  • Standard-2X: ​-Xmx671m -XX:CICompilerCount=2​
  • Performance-M: ​-Xmx2g
  • Performance-L: ​-Xmx12g

Private Space dyno の場合、値は以下のようになります。

  • Private-S: ​-Xmx671m -XX:CICompilerCount=2​
  • Private-M: ​-Xmx2g
  • Private-L: ​-Xmx12g

リソース使用量の監視

dyno のリソース使用量を監視するために追加の JVM フラグを使用できます。リソース使用量を監視するには、次のフラグをお勧めします。

-XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintTenuringDistribution -XX:+UseConcMarkSweepGC

JVM プロセスの調整について詳しくは、トラブルシューティング​の記事を参照してください。

サポートされている Java バージョン

Heroku は現在、デフォルトで OpenJDK 8 を使用してアプリケーションを実行しています。OpenJDK バージョン 17、15、13、11、および 7 も利用可能です。選択したメジャーバージョンに応じて、アプリをデプロイするたびに、その JDK の使用可能な最新のアップデートが使用されます。

現在のデフォルトバージョンは次のとおりです。

  • Java 7 - 1.7.0_332
  • Java 8 - 1.8.0_322
  • Java 11 - 11.0.14
  • Java 13 - 13.0.10
  • Java 15 - 15.0.6
  • Java 17 - 17.0.2

アプリが使用する JDK は slug に含められ、slug のサイズに影響します。

Java バージョンの指定

ある JDK のバージョンが EOL を迎えると、セキュリティパッチが入手できなくなります。コミュニティによって積極的にサポートされている JDK のバージョンを実行することを強くお勧めします。

system.properties​ というファイルをアプリケーションに追加することによって Java バージョンを指定できます。

ファイル内の java.runtime.version​ プロパティを設定します。

java.runtime.version=11

Accepted major version values are 1.7, 1.8, 11, 13, 15, and 17. Because the default is 1.8, you don’t need this file if you would like to use Java 8.

次のような値を使用することによって、JDK アップデートバージョンを固定することもできます。

java.runtime.version=1.8.0_202

ただし、より一般的な 1.8​ 形式を使用することをお勧めします。こうすることで、あらゆるセキュリティ更新が自動的にインストールされます。

Zulu JDK の使用

標準の JDK 以外に、Heroku では Azul® Zulu® JDK​ のサポートも提供しています。Zulu は Java SE 標準との完全な互換性がある、100% オープンソース認証された OpenJDK​ のビルドです。

Zulu をアプリで使用するには、次の内容を含む system.properties​ ファイルをアプリケーションのルートディレクトリに作成し、これを Git に追加します。

java.runtime.version=zulu-1.8.0_212

Zulu JDK の詳細については、公式の Azul ドキュメント​を参照してください。

Java バージョンのアップグレード

すべての Java アプリは、デプロイされたときに限り、利用可能な最新の JDK バージョンに自動的にアップグレードされます。アプリが再デプロイされない場合、または system.properties​ ファイルに特定のバージョンが構成されていた場合、これらはアップグレードされません。

Maven バージョンの指定

Heroku では、Maven バージョンを定義するために推奨されるメカニズムである Maven Wrapper​ のサポートが提供されています。Heroku はリポジトリのルートディレクトリに mvnw​ ファイルを検出した場合、このスクリプトを使用して Maven プロセスを起動します。

また、次のように maven.version​ プロパティを設定することによって、system.properties​ ファイルで Maven バージョンを指定できます。

maven.version=3.6.2

If this property is defined, the mvnw script will be ignored.

maven.version​ で許可される値は次のとおりです。

  • 3.2.5
  • 3.3.9
  • 3.5.4
  • 3.6.2

バージョンを指定しない場合のデフォルトは 3.6.2 です。新しいバージョンに自動的にアップグレードされることはありません。現在 3.0.5 を使用していて最新バージョンにアップグレードする場合、system.properties​ ファイルを作成してバージョンを指定する必要があります。

デフォルトの Web プロセスタイプ

Java buildpack は Spring Boot​ および Thorntail​ の Web フレームワークの使用を自動的に検出します。Spring Boot の場合、次のコマンドで web​ プロセスタイプを作成します。

java -Dserver.port=$PORT $JAVA_OPTS -jar target/*.jar

Thorntail の場合、buildpack はデフォルトの web​ プロセスタイプに対して次のコマンドを使用します。

java -Dswarm.http.port=$PORT $JAVA_OPTS -jar target/*.jar

Procfile​ を使用して、これらのデフォルトをオーバーライドしたり、カスタムプロセスタイプを定義したりできます。適切なコマンドは、ご使用のアプリおよびフレームワークによって異なります。Procfile​ の設定については、いずれかの Java チュートリアル​を参照してください。

アドオン

pom.xml​ 内で Postgres JDBC ドライバー​や pgjdbc-ng ドライバー​に依存関係を持つ Java アプリケーションについては、Postgres データベースが自動的にプロビジョニングされます。これにより DATABASE_URL​ 環境変数が入力されます。

Postgres アドオンが必要ない場合、次のコマンドを実行してアドオンを削除できます。

$ heroku addons:destroy DATABASE --app sushi

参考情報