EclipseとTomcatを最短で連携する方法

周りでeclipseとtomcatの連携で苦戦している方が多かったので、説明資料の意味も込めてここにメモっておきます。(2014/07 現在の情報です)

手順は、

1. Eclipse IDE for Java EE Developersをダウンロードする
2. Apache Tomcatをダウンロードする
3. Eclipseでサーバーランタイム環境を設定する
4. サーバービューで新規サーバー追加

ここまででeclipseの設定は完了です。
今回は動作確認として、Tomcat managerも動作するように設定します。
ということで、追加で以下の手順も。

5. server.xmlへTomcat Managerを設定
6. tomcat-user.xmlにユーザー追記

です!

１．Eclipse IDE for Java EE Developersをダウンロードする
https://www.eclipse.org/

まずは、eclipse.orgからEclipse IDE for Java EE Developersをダウンロードして、適当な場所に解凍してください。
JAVA EE パッケージの中のWTP(Web Tools Platform)というプラグインを使うことで、Eclipseとサーバーの連携をします。


2. Apache Tomcatをダウンロードする
http://tomcat.apache.org/

2014年7月2日現在、8.xが最新のようです。
適宜、必要なバージョンをダウンロードして適当な場所に解凍してください。


3. Eclipseでサーバーランタイム環境を設定する
Eclipseを起動してください。
今回先に日本語化してるEclipseなので、日本語で失礼します。
環境設定 > サーバー > ランタイム環境
を開いて、[追加]をクリック

ランタイム環境タイプの中から、先ほどダウンロードしたTomcatと同じメジャーバージョンのものを選択して、[次へ]

Tomcatインストールディレクトリーに、ダウンロードしたTomcatのルートディレクトリを指定して[完了]

これで、Tomcatのランタイム設定ができました。


4. サーバービューで新規サーバー追加
次に、
    ウィンドウ > ビューの表示 > サーバー
でサーバービューを表示してください。

ビューの中に、「使用可能なサーバーが…」というメッセージが書かれているので、これをクリック

新規サーバーの定義、という画面が開くので、ここでTomcatを選択。
バージョンは先ほどと同じく、メジャーバージョンが同じものを選びます。
更に、サーバーランタイム環境の項目は、先ほど作ったランタイムを指定して[完了]をクリック。
すると、サーバービューにTomcatが現れました。
サーバービューの右側にある再生ボタンを押すと、サーバーが起動します。


さてさて、ここまででサーバーが設定できましたが、プロジェクトが無い状態なので動作確認ができません。
今回は、Tomcat Managerを動かして、サーバーが動いている姿を確認したいと思います。
左にあるプロジェクトエクスプローラに、Serversというプロジェクトができているのにお気づきでしょうか。
これが先ほど連携させたTomcatの設定ファイルになります。
これら設定ファイルはEclipseで使っているワークスペースの中にあり、tomcat/conf の中にある設定ファイルとは別物なので、混同しないように注意が必要です。


5. server.xmlへTomcat Managerを追記

まずは、プロジェクトエクスプローラからServerプロジェクトにあるserver.xmlにTomcat Managerを追加します。
<Host></Host>タグの間のどこかに以下を追加

<Context docBase="${catalina.home}/webapps/manager" path="/manager"　privileged="true"/>

docBaseは本体のパスを指定。
pathでサーバー経由でアクセスされた時のパスを指定。
privilegedでサーブレットを使いますよーって設定。


6. tomcat-user.xmlにユーザー追記

試しに、この状態でアクセスしてみましょう。
サーバービューの再生ボタンを押して、
http://localhost:8080/manager/
へアクセスしてみましょう。

すると、ユーザー名とパスワードを求められますが、まだ設定していないので何を入れてもログインできません。
キャンセルを押すと、401エラーの画面が出ます。
ここに新たなヒントが！
真ん中辺りに、tomcat-user.xmlに以下のものを書いてね、とあります。

<role rolename="manager-gui"/>
<user username="tomcat" password="s3cret" roles="manager-gui"/>

ということで、Eclipseに戻り、プロジェクトエクスプローラからServerプロジェクト内のtomcat-user.xmlを開いてください。
で、上記の二行を<tomcat-users></tomcat-users>タグの間に貼り付けてください。
usernameとpasswordは適宜変更してください。

ここまで来たら、サーバービューからサーバーを再起動して再びhttp://localhost:8080/manager/へアクセス。

設定したユーザー名とパスワードを入力すると、Tomcat Webアプリケーションマネージャが表示されます。

以上、最短でEclipseとTomcatを連携させる方法でした。

次回は、今回作ったサーバー上に自作のwarをデプロイしてHello Worldとか表示させてみたいと思います。