Gradle は、主に Java や Groovy, Kotlin, Scala などの言語でよく使われるビルドツール1である。 必要なライブラリーファイル(JAR ファイル)のダウンロードや、 コンパイル、テスト、サーバーへの配置などを自動的に行ってくれる。 また、プラグインで容易に拡張することができる。 ここでは、Web アプリケーションを開発するためのやり方を説明する。 なお Gretty という Gradle のプラグインを使うやり方はこちらで説明する。 一方、Web アプリケーションではない、一般の Java アプリケーションで Gradle を利用する場合の作り方は、 こちらのページで説明する。
1ビルドツールとは
ソースファイルなどから最終生成目的物を生成するためのツールである。
ソースの依存関係に応じて、必要なコンパイルコマンドなどを呼び出す。
有名なものに Make, Ant, Maven, Gradle などがある。
ここでは、より一般的な Gradle の Application プラグインを利用する方法を説明する。
Java のバージョンが新しすぎるなど、Java や Gradle のバージョンの組み合わせによって、
Gretty プラグインがうまく動作しないときにも有効である。
最新版の Java を使いたい場合は、この方法をお勧めする。
このやり方では、サーバーを起動する main
関数を定義し、
URL のパスと Servlet の対応を手で追加する必要がある。
(ここで使う API は Servlet の標準仕様ではなく、Jetty の独自 API である。)
Gradle のビルドの設定は Groovy もしくは Kotlin で記述する。 ここでは Kotlin 版を使用する。
いくつかの Servlet や HTML からなる単純な Web アプリケーションの場合、
以下のような 2 つの設定ファイル settings.gradle.kts と build.gradle.kts で事足りるようである。
適当なディレクトリー(以下では MyServlet
という名前だとして説明する)の直下に
settings.gradle.kts を、その app
というサブディレクトリーの下に build.gradle.kts を置く。
なお settings.gradle.kts と build.gradle.kts を同じ階層にする配置も可能だが、
将来、複数のサブプロジェクトに分割する場合に備えて build.gradle.kts をサブディレクトリー(今の場合
app
)に置くことが推奨されているようである。
ファイル settings.gradle.kts
ファイル app/build.gradle.kts
Gradle では(Maven もだが)ディレクトリーの配置に独特の慣習があり、
Java のソースファイルは app
の src/main/java/
の下(のパッケージに応じたディレクトリー)に
配置する。
Servlet は以下の例のように、アノテーション関連
「import jakarta.servlet.annotation.WebServlet;
」と
「@WebServlet("〜")
」は必要ない。(ただし、残しておいても意味がないだけで、
害になるわけではない。)
ファイル app/src/main/java/MyDate.java
面倒なときは、コマンドプロンプトを開き、次のコマンドを実行すると、 必要なディレクトリー構造(とサンプルの Servlet)が作成される。 (行頭の > はプロンプト)
> git clone https://guppy.eng.kagawa-u.ac.jp/2025/OOPL/SimpleJettyApp.git > cd SimpleJettyApp
SimpleJettyApp
ディレクトリーで
> gradle run
というコマンドを実行すると、(最初は JAR ファイルのダウンロードなども行うのでひじょうに時間がかかるかもしれないが)
Jetty が実行され、“Hit enter to stop the server.” とメッセージが出てから、ブラウザーに「http://localhost:8080/MyServlet/MyDate
」というアドレスを入力すると、
実行結果を見ることができる。
(メッセージのとおり、エンターキーを押すと実行を停止する。)
新しく Servlet のクラスを作成したときには、main
メソッドに、URL のパスと Servlet
の対応を追加する必要がある。
ファイル app/src/main/java/Main.java
この例では MyDate
と Aisatsu
と
SessionCounter
の 3 つの Servlet の対応が登録されている。
context.addServlet(MyDate.class, "/MyDate"); context.addServlet(Aisatsu.class, "/Aisatsu"); context.addServlet(SessionCounter.class, "/SessionCounter"); // ...
この 3 行にならって、この辺りで Servlet を追加する。
ポート (8080
) やパス (MyServlet
) も Main.java の中で直接変更する。
また、HTML や画像などの静的なリソースは app
の src/main/webapp/
の下に配置する。
ファイル app/src/main/webapp/Aisatsu.html
ファイル app/src/main/java/Aisatsu.java
以上のファイルを配置して、
改めて gradle run
したうえで、
ブラウザーに「http://localhost:8080/MyServlet/Aisatsu.html
」と入力すると、
以下のようなフォームが表示される。