ベーシスト兼ソフトウェアエンジニアのブログ Eclipse + Maven2 + Tomcat + Seasar2 の開発環境ベスト！？プラクティス

Eclipse + Maven2 + Tomcat + Seasar2 の開発環境ベスト！？プラクティス

2007年10月16日(火) 00:18

昨今、良くある（僕自身も好みの）組み合わせで、
　・IDE・・・Eclipse
　・ビルドツール・・・Maven2 及び Eclipse m2eclipseプラグイン
　・コンテナ・・・Tomcat 及び Tomcatプラグイン
　・フレームワーク・・・Seasar2 及び S2ファミリー
と言うのがあります。

しかし、開発環境構築は結構難問です。
Eclipse、Maven2、m2eclipse、Tomcatプラグイン...
それぞれ「個別の問題」にフォーカスしたツールを組み合わせようとすると、
細かいところでギャップがあって、各ツールの長所を活かしつつ、うまく連携させるには試行錯誤が必要です。

そこで、以下のような各ツールの長所を活かせる開発環境を作ってみる。

　１．Eclipse
　　・修正したソースのインクリメンタルコンパイル。
　　・その他もろもろ...

　２．Maven2
　　・pom.xmlによるプロジェクトメタ情報の定義、一元管理。
　　・ビルドの標準化。

　３．m2eclipseプラグイン
　　・pom.xmlの依存ライブラリを修正するだけで、
　　　ライブラリのダウンロード、Eclipseビルドパスを自動更新。
　　　（依存ライブラリを修正するたびに mvn eclipse:eclipse しなくて良い！）

　４．Tomcatプラグイン
　　・Eclipse上でTomcatの起動／停止。
　　・デバッグが簡単。（リモートデバッグしなくて良い！）
　　・DevLoaderを使えば、Warモジュールを作成することなく、
　　　修正したソースをTomcatに即反映可能。

　５．Seasar2 2.4.xのSMART Deploy
　　・HOT deployで、Tomcat（のコンテキスト）を再起動することなく
　　　修正したソースをTomcatに反映可能。
　　　Seasar2 2.4.x以上が必須になります。

つまり、
必要なライブラリは自動設定されて、修正したソースはTomcatに即反映されて、
Tomcat上でデバッグもできて、Mavenで一貫したビルドもでき、
しかも開発者ひとりひとりの手間を極力省くことができる、環境なのです！！（のはず）

では作り方。
ちなみに、この作業はアーキテクトだけが行う初期作業です。

　１．Eclipse
　　特に特別な手順はありません。

　２．Maven2
　　①pom.xmlを書きます。
　　　maven-eclipse-pluginの設定で、downloadSourcesとdownloadJavadocsをtrueにしておきます。

　　②Eclipseのプロジェクト作成ウィザードを使うのが面倒なので、
　　　初回だけ「mvn eclipse:eclipse」でEclipseプロジェクトを作成し、Eclipseにインポートします。
　　　この時点では、クラスパス変数M2_REPOが未定義なので、ビルドエラーになります。

　　③プロジェクトのプロパティ、Javaビルドパスから「M2_REPO/～」を
　　　全て削除します。当然、ビルドエラーになりますが、ここでは無視します。

　３．m2eclipseプラグイン
　　①m2eclipseをインストール。

　　②Eclipseの設定のMaven2で、ソースのダウンロードと、JavaDocのダウンロード
　　　を有効（チェックON）にしておきます。

　　③プロジェクトを右クリック→Maven2 で、Maven2特性を有効にします。
　　　Maven2 Dependenciesと言うクラスパスコンテナが作成されます。
　　　この時点でビルドが通るはずです。

　　　これ以降は、pom.xmlを修正すればライブラリのダウンロード～ビルドパス設定が
　　　自動的に行われます。
　　　mvn eclipse:eclipse でビルドパスを更新する必要はありません。

　４．Tomcatプラグイン
　　①Tomcatプラグインをインストールし、基本設定。
　　　
　　②dragon3さんが公開している改変版DevLoaderを入手し、
　　　Tomcatにセットアップ。

　　　TomcatプラグインにバンドルされているオリジナルのDevLoaderを使うと、
　　　pom.xmlにservlet-api-xxx.jarへの依存性が含まれていると実行時にClassCastExceptionが発生します。
　　　逆に言えば、Servlet API を使わなければ、オリジナルのDevLoaderでも構いませんが、
　　　Servlet APIを使わないということは少ないのかなと思います。

　　③プロジェクトのプロパティ、Tomcatで以下の通り設定。
　　　・Tomcatプロジェクト・・・ON。
　　　・コンテキスト名・・・任意の名前を入力。
　　　・コンテキスト定義の更新を可能にする・・・ON。
　　　・このコンテキストを再読込可能にする・・・OFF。
　　　　（ONにすると、ソースを修正するたびにコンテキストが再起動してしまいます）
　　　・Webアプリケーション・ルートとするサブディレクトリ・・・main/src/webapp
　　　・開発用クラスローダを有効にする・・・ON。
　　　　/PROJECT_NAME/target/classes、
　　　　org.maven.ide.eclipse.MAVEN2_CLASSPATH_CONTAINER をチェックON。
　　　　（個々のライブラリをチェックONにしてしまうと、.tomcatpluginに絶対パスが書かれてしまい、再配布できません）

　５．Seasar2
　　env.txt で、開発時はHOT Deployが有効になるようにしておきます。
　　こうすることで、コンテキストを再起動することなく、修正したソースをTomcatに即反映できます。

　６．配布
　　pom.xml、.classpath、.project、.tomcatplugin を含めて、プロジェクトを配布(CVSやSVNにコミット)します。
　　（通常はpom.xmlだけで、.classpath等は含めないことが多いと思いますが）

　　なお、これらのファイルに特定の環境に依存する値（絶対パスなど）が書かれていないのが、再配布可能にするミソです。

　　各開発者は、配布されたプロジェクトをEclipseにインポートするだけで、
　　特別な設定をしなくても開発できるはずです。

以上で、快適な開発環境ができる...と思います。

一応、ざっくりと動作確認していますが、うまくいかなかった場合はご容赦をm(_ _)m