2018-07-03 Java Web プログラミング

JettyをEclipseと連携させる（ホットデプロイ編）

前回の記事「REST アプリケーションを Jetty で動かす」では Eclipse でビルドした WAR ファイルを手動で Jetty にデプロイ（配備）する方法を説明しました。

実際の開発では動作確認のために何度もビルド→デプロイをすることになりますので、手動で WAR ファイルのコピーを繰り返していては疲れてしまいます。

今回は、 Jetty と Eclipse を連携させてビルドからデプロイまで自動化する方法を紹介します。

Jetty と Eclipse を連携させるためのプラグインもありますが、今回はプラグインを使わずに Jetty と Eclipse を連携させていきます。Buildship Gradle プロジェクトの場合、 Gradle タスクで連携させたほうが便利だからです。

ホットデプロイ

アプリケーション・サーバー（サーブレット・コンテナ）のプロセスを停止させず稼働状態のまま WAR ファイルを置き換えて再ロードする機能をホットデプロイといいます。

Jetty はデフォルトでホットデプロイが有効になっていますので、 Jetty プロセスを稼働したままでも WAR ファイルを上書きするだけで Web アプリケーションを新しいものに置き換えることができます。

以前の記事「Jersey で REST アプリケーションを作る」で作成した build.gradle では、 WAR ファイルはプロジェクトの build\libs に出力されるようになっていました。まずは、 build.gradle にタスクを追加して WAR ファイルが Jetty の webapps フォルダーにコピーされるようにします。

WARファイルをデプロイするタスク
task deploy(type: Copy, dependsOn: war) {
	setGroup('build')
	from 'build/libs'
	into 'c:/jetty-9.4.11/webapps'
}

このタスクを build.gradle に追加して、 Gradle Tasks ビューをリフレッシュすると build の中に deploy という新しいタスクが表示されます。これを右クリックして Run Gradle Tasks を実行します。

この deploy タスクは war タスクに依存させていますので自動的に WAR ファイルのリビルドもおこなわれ、そして、 build\libs の中身が C:\jetty-9.4.11\webapps にコピーされます。

WAR ファイルが C:\jetty-9.4.11\webapps にコピーされると、 Jetty プロセスが WAR ファイルが更新されたことを検出して、自動的に WAR ファイルを再読み込みしてくれます。

WARファイルの出力先を環境変数で指定する

前述の deploy タスクでは WAR ファイルのコピー先を c:/jetty-9.4.11/webapps とフルパスで記述していました。これでは開発環境に依存してしまいますのであまり良くないですね。環境変数でコピー先を指定できるようにしてみましょう。

build.gradle の deploy タスクを以下のように書き換えます。これで、環境変数 JETTY_BASE で指定されているフォルダーの webapps サブフォルダーに build\libs 内のファイルがコピーされるようになります。

WARファイルをデプロイするタスク（環境変数対応）
task deploy(type: Copy, dependsOn: war) {
	setGroup('build')
	from 'build/libs'
	into System.getenv()['JETTY_BASE'] + '/webapps'
}

build.gradle 全体は以下の通りです。

build.gradle
apply plugin: 'eclipse'
apply plugin: 'java'
apply plugin: 'war'

def defaultEncoding = 'UTF-8'
tasks.withType(AbstractCompile).each { it.options.encoding = defaultEncoding }
tasks.withType(GroovyCompile).each { it.groovyOptions.encoding = defaultEncoding }

javadoc {
	options.charSet = defaultEncoding
	options.encoding = defaultEncoding
	options.memberLevel = JavadocMemberLevel.PUBLIC
}

tasks.withType(JavaCompile) {
	options.compilerArgs << "-parameters"
}

repositories {
	mavenCentral()
	jcenter()
}

dependencies {
	compile fileTree(dir: 'lib',
		includes: ['**/*.jar'],
		excludes: ['**/*-sources.jar', '**/*-javadoc.jar'])
	providedCompile 'javax.servlet:javax.servlet-api:3.1.0'
	providedCompile 'org.glassfish.jersey.bundles:jaxrs-ri:2.0.1'
}

defaultTasks 'clean', 'build', 'war'

war {
	archiveName = "${archivesBaseName}.war"
}

task deploy(type: Copy, dependsOn: war) {
	setGroup('build')
	from 'build/libs'
	into System.getenv()['JETTY_BASE'] + '/webapps'
}

task initializeProjectFiles {
	doLast {
		if(file('src/main/java/Library.java').exists()) {
			file('src/main/resources').mkdirs()
			file('src/main/webapp/WEB-INF').mkdirs()
			file('lib').mkdir()
			delete "src/test"
			delete "src/main/java/Library.java"
		}
	}
}
tasks.eclipseClasspath.dependsOn(cleanEclipseClasspath)
tasks.eclipseClasspath.dependsOn(initializeProjectFiles)
tasks.cleanEclipseClasspath.mustRunAfter(initializeProjectFiles)