maven2をEclipseでリモートデバッグする方法

少し前にmaven2にはまってた頃に知ったんですがmaven2をEclipseでリモートデバッグする方法のご紹介。僕は正直静的にコードを読んでもあまり理解できないことが多く実際に動かしながらじゃないと辛いので重宝してます。社内のハッカーな方々はデバッガなんて必要ないそうですがシンジラレナイ…。元ネタはここ

前提

環境変数M2_HOMEにmaven2のインストールディレクトリが設定済み
環境変数PATHに%MAVEN_HOME%\binが設定済み
Windows環境(Linux環境でも勿論出来ますが説明は書きません)

mvn.batの修正

maven2の動作を確認

C:\>mvn --version
Maven version: 2.0.6

%MAVEN_HOME%\bin\mvn.batをコピーしてmvn-debug.batという名前で保存する。
mvn-debug.batを開く
30行目付近(maven2.0.6の場合は32行目)の以下の記述を

@REM set MAVEN_OPTS=-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000

コメントアウトして以下のようにする。

set MAVEN_OPTS=-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000

以下のようにして実行してみると8000番ポートで待ち受けるようになる

C:\>mvn-debug --version

C:\>set MAVEN_OPTS=-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt
_socket,server=y,suspend=y,address=8000
Listening for transport dt_socket at address: 8000

maven2 ソースコードのチェックアウト

今回の例ではmaven2.0.6なのでmaven2.0.6のソースコードをチェックアウトする
任意のディレクトリで

svn co http://svn.apache.org/repos/asf/maven/components/tags/maven-2.0.6/

Eclipseにmaven2のソースコードを読み込むための設定

Eclipseにmaven2用の変数を追加するために以下を実行(追加済みなら必要なし)

mvn -Declipse.workspace="${eclipse.workspace}" eclipse:add-maven-repo

※${eclipse.workspace}にはeclipseのworkspaceへのパスを指定

Eclipseのプロジェクトを作成。maven2のソースコードをチェックアウトしたディレクトリで

mvn eclipse:eclipse

Eclipseにmaven2のソースコードを読み込む

Eclipseの起動
maven2のプロジェクトをeclipseにインポート
- ファイル -> インポート -> 一般 -> 既存プロジェクトをワークスペースへ
- ルートディレクトリの選択で、maven2をチェックアウトしたディレクトリを選択して出てくるプロジェクトをすべて選択

コンパイルエラーが出なければOK

Eclipseでmaven2のリモートデバッグ用のプロジェクトを作成

新規 -> プロジェクト -> 一般 -> プロジェクト
プロジェクト名に「maven-debug」と入力

リモートデバッグ用の設定

「maven-debug」プロジェクトを選択状態で実行->構成及びデバッグ->リモートJavaアプリケーションを選択
右クリック->新規で新規構成を作成
名前に「maven-debug」と入力

ソースタブを選択し、追加ボタンを押して、先ほど追加したプロジェクトすべてを選択する。

リモートデバッグ実行

適当なmaven2コマンドを叩く(例 mvn install等)
8000番ポートで待ち受けてとまるのでとまったら、Eclipse側で「デバッグ」ボタン押下

最後に

こんなマニアックなネタだけどmaven2のpluginとか作るときに既存pluginの動作を追いかけるときなど役立つかも？。ちなみにmaven2のソースコードをチェックアウトした以降の手順についてスクリーンキャストを作ろうとして途中で面倒になって投げたのがあるので晒しておきます。途中まで作ったスクリーンキャスト

前提