Tomcat を実行しているコンテナー内で Java Web アプリケーションをデプロイしてデバッグする

サンプルプロジェクトのクローンを作成する

アプリケーションのソースコードは、https://github.com/IdeaUJetBrains/Tomcat_docker_debug(英語) の GitHub でホストされています

1. メインメニューで、ファイル | 新規 | バージョン管理からプロジェクトに移動します。

2. リポジトリの URL を指定して、クローンをクリックします。

3. 必要に応じて、クローンプロジェクトを新しいウィンドウで開くことに同意します。

WAR アーティファクトをビルドする

1. メインメニューでビルド | アーティファクトのビルドに移動します

2. tomcat_docker_debug:war が展開しましたを選択してビルドします。

ビルドされたアーティファクトは、target/ のプロジェクトルートに表示されます。

Docker Compose を使用してアプリケーションを実行する

1. docker-compose.yml を開きます。

2. services の横のガターで をクリックします。

これにより、docker-compose.yml で定義された別の Docker Compose サービスとしてコンテナー内のアプリケーションを実行する Docker Compose 実行構成が作成されます。

イメージ

このチュートリアルでは、Jakarta EE 9.1 と互換性のあるイメージ tomcat:10.0-jdk17 を使用します。アプリケーションで Jakarta EE 10 を使用している場合は、Tomcat 10.1 で実行します。Java EE 8 の場合は、Tomcat 9 以前のバージョンを使用してください。

ポート

ホストマシンからアプリケーションにアクセスするために、Docker Compose はコンテナーのポート 8080 をホストのポート 8888 として公開します。また、コンテナーのポート 5005 をデバッガーのホストのポート 5005 として公開します。

ボリューム

WAR アーティファクトをコンテナーにコピーする代わりに、Docker Compose バインドはアプリケーション出力ディレクトリ ./target をコンテナー内の Tomcat ディレクトリ /usr/local/tomcat/webapps にマウントします。

環境変数

デバッガーをアタッチするために、Docker Compose は JAVA_OPTS 環境変数を次のように設定します。

-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005

コマンド

Docker Compose は、Tomcat イメージによって宣言されたデフォルトのコマンドをオーバーライドし、それを catalina.sh run に設定します。

アプリケーションが実行されていることを確認する

1. コンテナーログを開き、Tomcat が開始したというメッセージで終了していることを確認します。

2. ブラウザーで次の URL を開きます: http://localhost:8888/Tomcat_docker_debug-1.0-SNAPSHOT/api/hello-world。Hello, World! を含むページを返す必要があります

デバッガーをアタッチする

1. デバッガーをリモート接続する remote_tomcat_debug という名前のリモート JVM デバッグ構成を実行します。

2. src/main/java/com/example/tomcat_docker_debug/HelloResource.java を開き、return "Hello, World!"; のある行の hello() メソッドにブレークポイントを設定します。

   

3. REST エンドポイントを再度リフレッシュするか、開きます: http://localhost:8888/Tomcat_docker_debug-1.0-SNAPSHOT/api/hello-world。今回は、前述のメソッド内のブレークポイントにヒットするはずです。