JavaのTomcatをVsCodeでデバッグ実行する方法

まえおき

現在、実務でJavaのWeb開発をしていますが、自主的にVsCodeを使っています。
eclipseと違って環境構築しなければTomcatのデバッグ等が出来ませんが、
イマイチ分かりやすい記事がなく調べた結果、海外の記事を参考にデバッグまで辿り着きました。
僕と同じように少し環境構築に苦戦している方に向けて、本記事を書きました。

環境

• VsCode
• Tomcat(バージョン問わず(本当は制約があるかもしれません))
• Java(バージョン問わず(本当は制約があるかもしれません))

手順

1. Tomcat, Javaは既にインストールされている前提とします。

2. Community Server Connectorsプラグインのインストール
   ※ よくTomcat for Javaを使用する記事を見かけますが、現在は非推奨となっています。
   

3. Extension Pack for Javaプラグインのインストール
   

4. Tomcatサーバーの追加

   1. VsCodeでエクスプローラを開きます
   2. SERVERSという欄があるので、そこを開きます。
   3. その中のCommunity Server Connectorを右クリックします。
   4. 出てきたプルダウンの中からCreate New Serverを選択します。
   5. 上部の確認ダイアログでNo, use server on diskを選択します。
   6. ローカルに存在するTomcatディレクトリを指定します。
      binフォルダ等が存在する階層
   7. Server Nameを指定してFinishを押します。

5. デバッグの準備

   1. VsCodeのエクスプローラを開きます。
   2. buildして出力されたWEB-INFフォルダを右クリックします。
   3. Debug on Serverを選択します。
   4. 画面上部でサーバーの指定を求められるので、先ほど追加したサーバーを指定します。
   5. Do you want to edit optional deployment parameters?と聞かれるので、Yes, Noを選択します。(基本Noかな？)

6. デバッグ開始

   1. VsCodeの先ほど追加したサーバーの上で右クリック
   2. Debug Serverを選択します。
   3. プロジェクト名みたいなのも求められるので特に不要であればそのままEnterを押します。
   4. あとは、ブレイクポイントを入れれば好きにデバッグできます。

参考

https://www.brandondonnelson.com/2020/06/debugging-java-web-app-in-visual-studio.html

あとがき

現場で実施したときの記憶を頼りに書いていて、少しあいまいな部分があります。
お気づきの点があればお知らせください。