Gradleのマルチプロジェクト構成を運用してみた

クラスパス

ただし、そのままeclipseタスクを実行すると .classpath にJARファイルのパスが直接書き込まれてしまいます。Gradle IDEを使う場合はGradle IDEがクラスパスを管理してくれるのでJARファイルの参照は不要です。これを回避するために、build.gradleに以下を追加しています：

subprojects {
  apply plugin: 'eclipse'
  eclipse {
    classpath {
      containers = [
        'org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7',
        'org.springsource.ide.eclipse.gradle.classpathcontainer'  // Gradle IDEのクラスパスコンテナ
      ]
      file {
        // .classpathファイルの出力時にクラスパスからJARエントリを除外する
        whenMerged { classpath ->
          classpath.configure classpath.entries.grep { entry ->
            !(entry instanceof org.gradle.plugins.ide.eclipse.model.Library)
          }
        }
      }
    }
  }
}

JDT設定

eclipseプラグインが対応している設定ファイルは .project や .classpath の他に .settings/org.eclipse.jdt.core.prefs があります。このファイルにはコードフォーマットなどの設定が入っています。親プロジェクトの設定ファイルを子プロジェクトにも適用するようにすると、複数のプロジェクトでコードフォーマットなどを統一できて便利です。

こんな感じ：

subprojects {
  eclipse {
    jdt {
      file {
        withProperties { properties ->
          def rootProperties = new Properties()
          new File(rootProject.projectDir, '.settings/org.eclipse.jdt.core.prefs').withReader { rootProperties.load it }
          properties.putAll rootProperties.findAll { k, v -> k.startsWith 'org.eclipse.jdt.core.formatter' }
        }
      }
    }
  }
}

もし他の設定ファイルも子プロジェクトに適用したい場合はコピーしてあげるとよいでしょう。エンコーディングや改行コードは標準でサポートしてくれてもいいのになぁと思います。

こんな感じ：

subprojects {
  def eclipsePreferenceFiles = [
    'org.eclipse.jdt.ui.prefs',
    'org.eclipse.core.resources.prefs',
    'org.eclipse.core.runtime.prefs'
  ]

  task eclipsePreferences(type: Copy) {
    description 'copy Eclipse preferences from the root project'
    from eclipsePreferenceFiles.collect { new File(rootProject.projectDir, '.settings/' + it) }
    into new File(projectDir, '.settings')
  }
  tasks.eclipse.dependsOn eclipsePreferences

  task cleanEclipsePreferences(type: Delete) {
    description 'clean up Eclipse preferences'
    delete eclipsePreferenceFiles.collect { new File(projectDir, '.settings/' + it) }
  }
  tasks.cleanEclipse.dependsOn cleanEclipsePreferences
}

JavaDoc

プロジェクト全体のJavaDocを生成するには、子プロジェクトのソースコードに対してJavadocタスクを実行します：

task javadocSubprojects(type: Javadoc) {
  description 'generates JavaDoc of sub-projects'
  source subprojects*.sourceSets.main.allJava
  destinationDir = new File(buildDir, 'javadoc')
  classpath = files(subprojects*.sourceSets.main.compileClasspath)
  options.encoding = 'UTF-8'
}

テスト

プロジェクト全体のテスト結果を生成するのは簡単にはいきませんでした。Gradleの内部APIを探してみるとそれらしいものを見つけたので、以下のようにしています。内部APIなので今後のバージョンでは動かないかもしれません。

import org.gradle.api.internal.tasks.testing.junit.report.DefaultTestReport
task testSubprojects {
  description 'generates test report of sub-projects'
  dependsOn subprojects*.tasks.test
  doFirst {
    copy {
      from { subprojects.collect { project -> new File(project.buildDir, 'test-results') } }
      into { new File(buildDir, 'test-results') }
    }
    new DefaultTestReport(
      testReportDir: new File(buildDir, 'reports/tests'),
      testResultsDir: new File(buildDir, 'test-results')).generateReport()
  }
}