複数のアプリケーションでデータモデルやビジネスロジックを共有する

個人的にはこれが最もあるかなと思います。Asakusaの場合、この中でも特にデータモデル（DMDLの定義）を複数のアプリケーションで共有したい場合が一番多いかと。

このような場合、共通のデータモデルや演算子のみを管理するプロジェクトを作成し、これを複数のアプリケーションプロジェクトから参照するという構成になります。例えばDMDLのみのプロジェクトを作る場合は、以下のようなイメージですね。

アプリケーション本体とテストを分けて管理する

先に構成のイメージ例を出すと、最もシンプルなものは以下のイメージですね。

この管理方式の使いどころはいろいろあると思いますが、いくつか紹介します。

0.準備-サンプルアプリケーションの動作確認まで

まずは環境の準備と、マルチプロジェクト化する前のサンプルアプリケーションが正常に動作することの確認をしておきましょう。

# 今回用の作業ディレクトリ
mkdir -p $HOME/advent2013/
cd $HOME/advent2013/

# サンプルアプリケーションプロジェクトを取得して展開 (バージョン 0.5.3)
wget http://www.asakusafw.com/download/gradle-plugin/asakusa-example-project-0.5.3.tar.gz
tar xf asakusa-example-project-*.tar.gz
cd asakusa-example-project

# Asakusaのインストールとサンプルアプリのフルビルド
./gradlew installAsakusafw
./gradlew build

# 成功したら、一旦cleanしておく
./gradlew clean

1.サンプルアプリケーションを分解する

サンプルアプリケーションに含むファイルを以下のように3つにばらしてマルチプロジェクトとして構築します。

• dmdl-proj

  • サンプルアプリケーションをコピーして、DMDLのみを残す。
  • Asakusa DSLとテストを削除。

• app-proj

  • サンプルアプリケーションをコピーして、アプリケーション(Asakusa DSL)のみを残す。
  • DMDLスクリプトとテストを削除。

• test-proj

  • サンプルアプリケーションをコピーして、テストクラスとテストデータのみを残す。
  • DMDLスクリプトとAsakusa DSLを削除。

上記の通りにプロジェクトを作ります。

cd $HOME/advent2013/

# DMDLプロジェクトを作成
cp -r asakusa-example-project dmdl-proj
rm -fr dmdl-proj/src/main/java/com
rm -fr dmdl-proj/src/test/java/com
rm -fr dmdl-proj/src/test/resources/com

# アプリケーションプロジェクトを作成
cp -r asakusa-example-project app-proj
rm -fr app-proj/src/main/dmdl/*
rm -fr app-proj/src/test/java/com
rm -fr app-proj/src/test/resources/com

# テストプロジェクトを作成
cp -r asakusa-example-project test-proj
rm -fr test-proj/src/main/dmdl/*
rm -fr test-proj/src/main/java/com

2.親プロジェクトの作成

マルチプロジェクト全体を管理するための親プロジェクトを作成します。

Gradleではマルチプロジェクト管理にいろいろな方式があるのですが、ここでは master という親プロジェクトを他のプロジェクトと同じ階層に作成するフラットレイアウト方式を採用します。

master プロジェクトにはGradle Wrapperを配置した上で、マルチプロジェクトに含めるプロジェクトを定義する設定ファイル settings.gradle を作成します。

では親プロジェクトの作成

cd $HOME/advent2013/

# 親プロジェクトディレクトリを作成
mkdir master

# サンプルアプリケーションからGradle Wrapperだけを持ってくる
cp -r asakusa-example-project/gradle* master

# settings.gradleの作成
echo 'includeFlat "dmdl-proj", "app-proj", "test-proj"' > master/settings.gradle

settings.gradle にはマルチプロジェクトに含めるプロジェクト名を定義します。今回はDMDL, アプリケーション, テスト用のプロジェクトの3つですね。 settings.gradle に記述していないプロジェクトは、同階層に存在してもビルド時には無視されます。

master/settings.gradle

includeFlat "dmdl-proj", "app-proj", "test-proj"

3. DMDLプロジェクト

ここからは各プロジェクト設定を見ていきます。 まずは DMDLのみを持つプロジェクトです。アプリケーションから参照される側のプロジェクトですね。

cd $HOME/advent2013/dmdl-proj

# マーカーファイルの作成
mkdir -p src/main/resources/META-INF/asakusa
touch src/main/resources/META-INF/asakusa/fragment

# ビルド
./gradlew build

4.アプリケーションプロジェクト

Asakusa DSLで記述するアプリケーションのみを持つプロジェクトです。DMDLプロジェクトで作成したデータモデルクラスを利用します。

dependencies {
    ...

    // DMDLプロジェクトを参照
    compile project(':dmdl-proj')
}

cd $HOME/advent2013/app-proj

# ビルド
./gradlew build

5.テストプロジェクト

Asakusa DSLに対するテストクラスとそのテストで利用するテストデータ定義のみを持つプロジェクトです。アプリケーションプロジェクトで作成したアプリケーションを利用します。

dependencies {
    ...

    // アプリケーションプロジェクトを参照
    compile project(':app-proj')
}

cd $HOME/advent2013/test-proj

# ビルド
./gradlew build

6.フルビルド

マルチプロジェクトに含むプロジェクト全体をビルドしたい場合には、 master プロジェクト上でビルドします。

cd $HOME/advent2013/master

# ビルド
./gradlew clean build

補足.親プロジェクトで依存関係をまとめて設定

4.アプリケーションプロジェクト や 5.テストプロジェクト では各プロジェクト個別に依存関係を設定しましたが、 Gradleでは親プロジェクト側でマルチプロジェクトに属する依存関係をまとめて設定することも出来ます。

親プロジェクト側でサブプロジェクトの依存関係を設定するには、 master プロジェクトに build.gradle を作成し、以下のように記述します。

master/build.gradle

project(':app-proj') {
    afterEvaluate {
        dependencies {
            compile project(':dmdl-proj')
        }
    }
}

project(':test-proj') {
    afterEvaluate {
        dependencies {
            testCompile project(':app-proj')
        }
    }
}

この方法だと、マルチプロジェクトに属するプロジェクト全体の依存関係が1ファイルに集約されているのでプロジェクト構成の全体像が把握しやすいかも。

Gradleではこの他にもいろいろなビルドの定義方法が可能で、例えば親プロジェクトのビルド定義のみですべてのプロジェクトの設定を行う、といったことも可能です。興味があればどのような記述方法がよいかいろいろ検討してみて下さい。かくいう私もこのあたりはまだ試行錯誤してます。Gradleはなかなか奥が深い...。