このページではJava開発の世界で広く使用されているオープンソースのビルドツールの1つ、Gradleのインストール方法と簡単な使用方法を紹介する。
目次
Gradleのインストール
Gradleのダウンロード及びインストール方法について、Windowsの環境を使う前提で紹介する。
ダウンロード
最初に行なうことは、Gradle Build Toolの公式サイト（URL: https://gradle.org）からZIPファイルをダウンロードすることだ。
公式サイトのURLを開くと次の画面が表示される。
1.Install Gradleのリンクをクリックする。
Installation（インストール手順）の画面が表示される。その画面のInstall Manuallyをクリックする。
Install manually画面が表示される。Complete, with docs and sourceのCompleteをクリックして、ダウンロードする。
MavenのZIPファイルがダウンロードされる。
インストール
インストールは、適当なディレクトリにダウンロードしたファイルを置いて、展開するだけだ。
ディレクトリをC:\gradleに作る。そこでZIPファイルを展開した例を以下に示す。
PATHの設定
WindowsのDOS窓でGradleのコマンド（gradle.exe）を起動するためにPATHを設定する必要がある。この手順について説明しよう。
コントロールパネル画面を開き、システムとセキュリティをクリックする。
システムとセキュリティ画面が開いたら、システムをクリックする。
システム画面が開いたら、システムの詳細設定をクリックする。
システムのプロパティ画面が開いたら、環境変数ボタンを押す。
環境変数画面が表示されたら、ユーザ環境変数の変数Pathを選択して編集ボタンを押す。
ユーザ変数の編集画面が表示される。変数値に既に設定されているパスの後に「;」を付けて、Gradleをインストールしたディレクトリにある実行ファイル（.exe）が格納されているサブディレクトリ（\bin）を絶対パス名で追加する。ここでは、ディレクトリC:\gradle\gradle-4.5\binを追加している。
入力が終わったら、OKボタンを押す。
環境変数の画面に戻るので、OKボタンを押す。これで、PATHの設定は終わりだ。
正しくPATHが設定されたことを確かめるために、DOS窓から
gradle -v
とコマンドを叩いて、バージョンが正しく表示されればOKだ。
これで、インストールは全て完了だ。
基本的な使い方
基本的なGradleの使い方を、シンプルなアプリケーションプロジェクトで見てみよう。
プロジェクトを作成する
最初にGradleのプロジェクトを作ってみよう。
GradleはBuild initプラグインと呼ばれるプラグインが最初から組み込まれている。このプラグインがinitと呼ばれるプロジェクトを作るためのタスクを持っているのだ。
最初にすることは、新しいプロジェクトのためのフォルダを作ってそのディレクトリに入ることだ。
次に作成したディレクトリ（フォルダ）からそのまま、
gradle init --type java-application
とコマンドを叩けばOKだ。
実行結果は次のようになる。
起動されたinitタスクは、最初にwrapperタスクを実行する。このタスクはgradlewとgradlew.bat wrapperスクリプトを作る。その後、それが次のような構造で新たなプロジェクトを作る。
これで、シンプルなJavaアプリケーションプロジェクトのために必用なコンポーネントは揃った。
では、プロジェクトファイルの中を見てみよう。
プロジェクトファイルの中を見ていくとGradleがどのようにプロジェクトの成果物をビルドしているかがわかる。
プロジェクトファイル：settings.gradleはほとんどがコメントで一行だけが意味を持つ行だ。
|
1 |
rootProject.name = 'java-demo' ① |
- この行はルートプロジェクトの名前を割り当てている。
プロジェクトファイル：build.gradleもたくさんのコメントがある。意味を持つ行だけを抜き出すと次ようになる。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
plugins { id 'java' id 'application' } mainClassName = 'App' ① dependencies { compile 'com.google.guava:guava:23.0' ② testCompile 'junit:junit:4.12' ③ } repositories { jcenter() ④ } |
- mainメソッドを持つクラス。
- Google Guavaライブラリ。
- JUnitテストライブラリ。
- Public Bintray Artifactoryリポジトリ。
プロジェクトファイル：build.gradleはjavaとアプリケーションのプラグインを追加する。アプリケーションのプラグインはmainメソッドを持つクラスとしてひとつのクラスを指定する。それは、コマンドラインからビルドによって実行することができる。このアプリケーションではそのクラスの名前はAppだ。
Javaソースファイル：App.javaを見てみよう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
public class App { public String getGreeting() { return "Hello world."; } public static void main(String[] args) { System.out.println(new App().getGreeting()); } } |
次にJUnitでテストするために作られたテストソースファイル：AppTest.javaを見てみよう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
import org.junit.Test; import static org.junit.Assert.*; public class AppTest { @Test public void testAppHasAGreeting() { App classUnderTest = new App(); assertNotNull("app should have a greeting", classUnderTest.getGreeting()); } } |
このテストクラスは、JUnitの@Testによって注釈が付けられた単一のテストを行なう。テストはgetGreetingメソッドを起動して戻り値がnullでないことを検査する例だ。
では、このプロジェクトをビルドしてみよう。
プロジェクトをビルドする
プロジェクトをビルドするためにbuildタスクを実行する。このために、通常のgradleコマンドを使うこともできる。しかし、プロジェクトがwrapperスクリプトを含んでいる場合、それに変わってgradlewコマンドを使う。
コマンドの実行は簡単だ。
作成したディレクトリ（フォルダ）からそのまま、
gradlew build
とコマンドを叩けばOKだ。
最初にbuildタスクを実行すると、Gradleは既にGuava とJUnitライブラリがダウンロードされているかどうかをチェックする。もしそうでなければ、ライブラリはダウンロードされ、保存される。2度目にbuildタスクを実行すると、キャッシュされたバージョンが使用される。
どのようにビルドが行なわれるかというと、クラスがコンパイルされ、テストが実行され、テストレポートが作成される。
テストレポートは、build/reports/tests/test/index.html.にあるHTMLファイルを開くとみることができる。
アプリケーションを実行する
Gradleビルドはアプリケーションプラグインを使っているので、コマンドラインからアプリケーションを実行できる。最初にtasksタスクを使ってどんなタスクがプラグインによって追加されたかを見てみよう。
この中のrunタスクはmainClassNameプロパティに割り当てられたクラスの中のmainメソッドを実行する。
期待通りHello worldが表示されている。
まとめ
このページでは簡単なGradleのプロジェクトを作成して実行するまでの流れを追ってみた。プロジェクトファイルを記述することでどんな複雑な処理も自動化することが可能になるので挑戦してみていただきたい。
コメント