Gradle User Guide

Version 2.2-20140924021627+0000

Translated by

Hayashi Masatoshi [FAMILY Given]

Sekiya Kazuchika [FAMILY Given]

Sue Nobuhiro [FAMILY Given]

Mochida Shinya [FAMILY Given]

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

このドキュメントは、個人利用目的および第三者に配布するためにコピーして使用できます。ただし、印刷するにせよ電子媒体を使用するにせよ、以下の点に留意してください。どのような形態であれ使用料を課さないこと。また、このコピーライト条項を配布物に含めること。

目次

翻訳版について
1. はじめにIntroduction
1.1. このユーザーガイドについてAbout this user guide
2. 概要Overview
2.1. 特長Features
2.2. なぜGroovyなのか?Why Groovy?
3. チュートリアルTutorials
3.1. 始めてみようGetting Started
4. GradleのインストールInstalling Gradle
4.1. 必要環境Prerequisites
4.2. ダウンロードDownload
4.3. 解凍Unpacking
4.4. 環境変数Environment variables
4.5. 正しくインストールされたことをテストするRunning and testing your installation
4.6. JVMオプションJVM options
5. トラブルシューティング Troubleshooting
5.1. トラブルに対処する Working through problems
5.2. ヘルプを求めるには Getting help
6. ビルドスクリプトの基本Build Script Basics
6.1. プロジェクトとタスクProjects and tasks
6.2. Hello world
6.3. タスク定義のショートカットA shortcut task definition
6.4. ビルドスクリプトはコードですBuild scripts are code
6.5. タスクの依存関係Task dependencies
6.6. 動的なタスクDynamic tasks
6.7. 既存のタスクを操作するManipulating existing tasks
6.8. 略記法Shortcut notations
6.9. 拡張タスクプロパティ Extra task properties
6.10. Antタスクの使用Using Ant Tasks
6.11. メソッドの使用Using methods
6.12. デフォルトタスクDefault tasks
6.13. DAGによる設定Configure by DAG
6.14. 次のステップは?Where to next?
7. JavaクイックスタートJava Quickstart
7.1. JavaプラグインThe Java plugin
7.2. 基本的なJavaプロジェクトA basic Java project
7.3. マルチプロジェクトのJavaビルドMulti-project Java build
7.4. 次のステップは?Where to next?
8. 依存関係管理の基本 Dependency Management Basics
8.1. 依存関係の管理とは What is dependency management?
8.2. 依存関係の宣言 Declaring your dependencies
8.3. 依存関係のコンフィグレーション Dependency configurations
8.4. 外部依存関係 External dependencies
8.5. リポジトリ Repositories
8.6. アーティファクトの公開 Publishing artifacts
8.7. 次のステップは? Where to next?
9. GroovyクイックスタートGroovy Quickstart
9.1. 基本的なGroovyプロジェクトA basic Groovy project
9.2. まとめSummary
10. WebアプリケーションクイックスタートWeb Application Quickstart
10.1. WARファイルのビルドBuilding a WAR file
10.2. Webアプリケーションの実行Running your web application
10.3. まとめSummary
11. Gradleのコマンドラインを使う Using the Gradle Command-Line
11.1. 複数のタスクを実行するExecuting multiple tasks
11.2. タスクを除外してビルドするExcluding tasks
11.3. エラー発生時にビルドを継続する Continuing the build when a failure occurs
11.4. タスク名の省略Task name abbreviation
11.5. ビルドスクリプトを指定して実行するSelecting which build to execute
11.6. ビルドに関する情報を取得するObtaining information about your build
11.7. 空実行Dry Run
11.8. まとめSummary
12. GradleのGUIを使うUsing the Gradle Graphical User Interface
12.1. Task Tree(タスク・ツリー)Task Tree
12.2. Favorites(お気に入り)Favorites
12.3. Command Line(コマンドライン)Command Line
12.4. Setup(セットアップ)Setup
13. ビルドスクリプトの記述Writing Build Scripts
13.1. Gradleビルド言語The Gradle build language
13.2. プロジェクトAPIThe Project API
13.3. スクリプトAPIThe Script API
13.4. 変数の宣言 Declaring variables
13.5. Groovyの基本 Some Groovy basics
14. 色々なチュートリアル Tutorial - 'This and That'
14.1. ディレクトリの作成 Directory creation
14.2. GradleプロパティとシステムプロパティGradle properties and system properties
14.3. 外部のビルドスクリプトをプロジェクトに取り込むConfiguring the project using an external build script
14.4. 任意のオブジェクトを組み立てる Configuring arbitrary objects
14.5. 外部スクリプトで任意のオブジェクトを組み立てる Configuring arbitrary objects using an external script
14.6. キャッシング Caching
15. タスク詳解More about Tasks
15.1. タスクの定義Defining tasks
15.2. タスクを配置するLocating tasks
15.3. タスクの設定を変更するConfiguring tasks
15.4. タスクに依存関係を追加するAdding dependencies to a task
15.5. Ordering tasks
15.6. タスクに説明書きを追加するAdding a description to a task
15.7. タスクの置き換えReplacing tasks
15.8. タスクをスキップするSkipping tasks
15.9. 更新されていないタスクをスキップするSkipping tasks that are up-to-date
15.10. タスクルールTask rules
15.11. Finalizer tasks
15.12. まとめSummary
16. ファイルを取り扱う Working With Files
16.1. ファイルを参照する Locating files
16.2. ファイルコレクション File collections
16.3. ファイルツリー File trees
16.4. アーカイブの内容をファイルツリーとして使う Using the contents of an archive as a file tree
16.5. 入力ファイルセットを指定する Specifying a set of input files
16.6. ファイルをコピーする Copying files
16.7. Syncタスクを使う Using the Sync task
16.8. アーカイブを作成する Creating archives
17. GradleからAntを使うUsing Ant from Gradle
17.1. ビルドでのAntタスクとタイプの利用Using Ant tasks and types in your build
17.2. AntビルドのインポートImporting an Ant build
17.3. AntプロパティとリファレンスAnt properties and references
17.4. APIAPI
18. ロギングLogging
18.1. ログレベルの選択Choosing a log level
18.2. ログメッセージを書くWriting your own log messages
18.3. 外部ツールやライブラリからのログについてLogging from external tools and libraries
18.4. Gradleがロギングするものを変更するChanging what Gradle logs
19. Gradleデーモン The Gradle Daemon
19.1. デーモン入門 Enter the daemon
19.2. デーモンの再利用と期限切れ Reusing and expiration of daemons
19.3. 使い方とトラブルシューティング Usage and troubleshooting
19.4. デーモンの設定 Configuring the daemon
20. ビルド環境 The Build Environment
20.1. gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties
20.2. プロクシ経由のWebアクセスAccessing the web via a proxy
21. Gradleのプラグインについて Gradle Plugins
21.1. Types of plugins
21.2. プラグインの適用 Applying plugins
21.3. Applying plugins with the plugins DSL
21.4. Finding community plugins
21.5. プラグインがすること What plugins do
21.6. 規約 Conventions
21.7. プラグインをさらに詳しく知るには More on plugins
22. 標準GradleプラグインStandard Gradle plugins
22.1. 言語プラグインLanguage plugins
22.2. 試験的な言語プラグイン Incubating language plugins
22.3. 統合プラグインIntegration plugins
22.4. 試験的な統合プラグイン Incubating integration plugins
22.5. ソフトウェア開発プラグイン Software development plugins
22.6. 試験的なソフトウェア開発プラグイン Incubating software development plugins
22.7. ベースプラグイン Base plugins
22.8. サードパーティプラグインThird party plugins
23. JavaプラグインThe Java Plugin
23.1. 使用方法Usage
23.2. ソースセットSource sets
23.3. タスクTasks
23.4. プロジェクトレイアウトProject layout
23.5. 依存関係の管理Dependency management
23.6. 規約プロパティConvention properties
23.7. ソースセットの利用Working with source sets
23.8. JavadocJavadoc
23.9. CleanClean
23.10. リソースResources
23.11. CompileJavaCompileJava
23.12. Incremental Java compilation
23.13. テストTest
23.14. JarJar
23.15. アップロードUploading
24. GroovyプラグインThe Groovy Plugin
24.1. 使用方法Usage
24.2. タスクTasks
24.3. プロジェクトレイアウトProject layout
24.4. 依存関係の管理 Dependency management
24.5. Groovyクラスパスの自動設定 Automatic configuration of groovyClasspath
24.6. 規約プロパティConvention properties
24.7. ソースセットプロパティSource set properties
24.8. GroovyCompile
25. Scalaプラグイン The Scala Plugin
25.1. 使用方法 Usage
25.2. タスク Tasks
25.3. プロジェクトレイアウト Project layout
25.4. 依存関係の管理 Dependency management
25.5. scalaClasspathの自動設定 Automatic configuration of scalaClasspath
25.6. 規約プロパティ Convention properties
25.7. ソースセットプロパティ Source set properties
25.8. Fast Scala Compiler
25.9. 別プロセスでコンパイルする Compiling in external process
25.10. インクリメンタルコンパイル Incremental compilation
25.11. Eclipse Integration
25.12. IntelliJ IDEA Integration
26. War プラグインThe War Plugin
26.1. 使用方法Usage
26.2. タスクTasks
26.3. プロジェクトレイアウトProject layout
26.4. 依存関係の管理Dependency management
26.5. 規約プロパティConvention properties
26.6. War
26.7. カスタマイズCustomizing
27. EarプラグインThe Ear Plugin
27.1. 使用方法Usage
27.2. タスクTasks
27.3. プロジェクトレイアウトProject layout
27.4. 依存関係の管理Dependency management
27.5. 規約プロパティConvention properties
27.6. Ear
27.7. カスタマイズCustomizing
27.8. カスタムのディスクリプタファイルを使うUsing custom descriptor file
28. Jetty プラグインThe Jetty Plugin
28.1. 使用方法Usage
28.2. タスクTasks
28.3. プロジェクトレイアウトProject layout
28.4. 依存関係の管理Dependency management
28.5. 規約プロパティConvention properties
29. CheckstyleプラグインThe Checkstyle Plugin
29.1. 使用方法Usage
29.2. タスクTasks
29.3. プロジェクトレイアウトProject layout
29.4. 依存関係の管理Dependency management
29.5. 設定

Configuration

30. CodeNarcプラグインThe CodeNarc Plugin
30.1. 使用方法Usage
30.2. タスクTasks
30.3. プロジェクトレイアウトProject layout
30.4. 依存関係の管理Dependency management
30.5. 設定

Configuration

31. FindBugsプラグインThe FindBugs Plugin
31.1. 使用方法Usage
31.2. タスクTasks
31.3. 依存関係の管理Dependency management
31.4. 設定

Configuration

32. JDependプラグインThe JDepend Plugin
32.1. 使用方法Usage
32.2. タスクTasks
32.3. 依存関係の管理Dependency management
32.4. 設定

Configuration

33. PMDプラグインThe PMD Plugin
33.1. 使用方法Usage
33.2. タスクTasks
33.3. 依存関係の管理Dependency management
33.4. 設定

Configuration

34. The JaCoCo Plugin
34.1. Getting Started
34.2. Configuring the JaCoCo Plugin
34.3. JaCoCo Report configuration
34.4. JaCoCo specific task configuration
34.5. Tasks
34.6. Dependency management
35. SonarプラグインThe Sonar Plugin
35.1. 使用方法 Usage
35.2. マルチプロジェクトビルドの解析 Analyzing Multi-Project Builds
35.3. カスタムソースセットの解析 Analyzing Custom Source Sets
35.4. Java言語以外の解析 Analyzing languages other than Java
35.5. カスタムSonarプロパティの設定 Setting Custom Sonar Properties
35.6. コマンドラインでSonarの設定を行う Configuring Sonar Settings from the Command Line
35.7. タスク Tasks
36. The Sonar Runner Plugin
36.1. Sonar Runner version and compatibility
36.2. Getting started
36.3. Configuring the Sonar Runner
36.4. Specifying the Sonar Runner version
36.5. Analyzing Multi-Project Builds
36.6. Analyzing Custom Source Sets
36.7. Analyzing languages other than Java
36.8. More on configuring Sonar properties
36.9. Setting Sonar Properties from the Command Line
36.10. Controlling the Sonar Runner process
36.11. Tasks
37. OSGiプラグインThe OSGi Plugin
37.1. 使用方法Usage
37.2. 暗黙的に適用されるプラグインImplicitly applied plugins
37.3. タスクTasks
37.4. 依存関係の管理Dependency management
37.5. 規約オブジェクトConvention object
37.6.
38. Eclipse プラグインThe Eclipse Plugin
38.1. 使用方法Usage
38.2. タスクTasks
38.3. 設定Configuration
38.4. 生成されたファイルをカスタマイズするCustomizing the generated files
39. IDEAプラグイン The IDEA Plugin
39.1. Usage 使用方法
39.2. タスク Tasks
39.3. 設定 Configuration
39.4. 生成するファイルのカスタマイズ Customizing the generated files
39.5. その他の注意事項 Further things to consider
40. ANTLRプラグイン The ANTLR Plugin
40.1. 使用方法 Usage
40.2. タスク Tasks
40.3. プロジェクトレイアウト Project layout
40.4. 依存関係管理 Dependency management
40.5. 規約プロパティ Convention properties
40.6. ソースセットプロパティ Source set properties
41. プロジェクトレポートプラグインThe Project Report Plugin
41.1. 使用法 Usage
41.2. タスク Tasks
41.3. プロジェクトレイアウト Project layout
41.4. 依存関係 Dependency management
41.5. 規約プロパティ Convention properties
42. 通知プラグイン The Announce Plugin
42.1. 使用方法 Usage
42.2. 設定 Configuration
43. ビルド通知プラグインThe Build Announcements Plugin
43.1. 使用方法Usage
44. The Distribution Plugin
44.1. Usage
44.2. Tasks
44.3. Distribution contents
45. アプリケーション プラグインThe Application Plugin
45.1. 使用方法Usage
45.2. タスクTasks
45.3. 規約プロパティConvention properties
45.4. ディストリビューションに他のリソースを含める Including other resources in the distribution
46. The Java Library Distribution Plugin
46.1. Usage
46.2. Tasks
46.3. Including other resources in the distribution
47. Build Init Plugin
47.1. Tasks
47.2. What to set up
47.3. Build init types
48. Wrapper Plugin
48.1. Usage
48.2. Tasks
49. The Build Dashboard Plugin
49.1. Usage
49.2. Tasks
49.3. Project layout
49.4. Dependency management
49.5. Configuration
50. The Java Gradle Plugin Development Plugin
50.1. Usage
51. 依存関係の管理 Dependency Management
51.1. はじめに Introduction
51.2. 依存関係管理のベストプラクティス Dependency Management Best Practices
51.3. 依存関係のコンフィギュレーション Dependency configurations
51.4. 依存関係の定義方法 How to declare your dependencies
51.5. 依存関係を使った作業 Working with dependencies
51.6. リポジトリ Repositories
51.7. 依存関係解決の仕組み How dependency resolution works
51.8. 依存関係解決処理の微調整 Fine-tuning the dependency resolution process
51.9. 依存関係のキャッシュ The dependency cache
51.10. 推移的依存関係を管理するための戦略 Strategies for transitive dependency management
52. アーティファクトの公開 Publishing artifacts
52.1. はじめにIntroduction
52.2. アーティファクトとコンフィギュレーションArtifacts and configurations
52.3. アーティファクトの宣言 Declaring artifacts
52.4. アーティファクトの公開 Publishing artifacts
52.5. プロジェクトライブラリについての追記事項More about project libraries
53. MavenプラグインThe Maven Plugin
53.1. 使用方法Usage
53.2. タスクTasks
53.3. 依存関係管理Dependency management
53.4. 規約プロパティConvention properties
53.5. 規約メソッドConvention methods
53.6. Mavenリポジトリとの相互作用Interacting with Maven repositories
54. 署名プラグイン The Signing Plugin
54.1. 使用方法 Usage
54.2. 署名者の資格情報 Signatory credentials
54.3. 署名対象を指定する Specifying what to sign
54.4. 署名を公開する Publishing the signatures
54.5. POMファイルに署名する Signing POM files
55. Building native binaries
55.1. Supported languages
55.2. Tool chain support
55.3. Tool chain installation
55.4. Component model
55.5. Building a library
55.6. Building an executable
55.7. Tasks
55.8. Finding out more about your project
55.9. Language support
55.10. Configuring the compiler, assembler and linker
55.11. Windows Resources
55.12. Library Dependencies
55.13. Native Binary Variants
55.14. Tool chains
55.15. Visual Studio IDE integration
55.16. CUnit support
56. ビルドのライフサイクルThe Build Lifecycle
56.1. ビルドフェーズBuild phases
56.2. 設定ファイルSettings file
56.3. マルチプロジェクトのビルドMulti-project builds
56.4. 初期化Initialization
56.5. シングルプロジェクトの設定と実行Configuration and execution of a single project build
56.6. ライフサイクルからの通知に応答するResponding to the lifecycle in the build script
57. マルチプロジェクトのビルドMulti-project Builds
57.1. クロスプロジェクト設定Cross project configuration
57.2. サブプロジェクトの設定Subproject configuration
57.3. マルチプロジェクトのビルド実行ルールExecution rules for multi-project builds
57.4. 絶対パスによるタスクの実行Running tasks by their absolute path
57.5. プロジェクトとタスクのパスProject and task paths
57.6. 依存関係 - なんの依存関係?Dependencies - Which dependencies?
57.7. プロジェクト依存関係Project lib dependencies
57.8. Parallel project execution
57.9. 分離されたプロジェクト Decoupled Projects
57.10. マルチプロジェクトのビルドとテスティングMulti-Project Building and Testing
57.11. Multi Project and buildSrc
57.12. プロパティとメソッドの継承Property and method inheritance
57.13. まとめSummary
58. カスタムタスクの作成Writing Custom Task Classes
58.1. タスククラスのパッケージングPackaging a task class
58.2. 単純タスクの作成Writing a simple task class
58.3. スタンドアロンプロジェクトA standalone project
58.4. Incremental tasks
59. カスタムプラグインの作成Writing Custom Plugins
59.1. プラグインのパッケージングPackaging a plugin
59.2. シンプルなプラグインの作成Writing a simple plugin
59.3. ビルドから入力を得るGetting input from the build
59.4. カスタムタスクやプラグインでファイルを扱うWorking with files in custom tasks and plugins
59.5. スタンドアロンプロジェクトA standalone project
59.6. 複数のドメインオブジェクトの管理Maintaining multiple domain objects
60. ビルドロジックの体系化Organizing Build Logic
60.1. プロパティとメソッドの継承Inherited properties and methods
60.2. 設定のインジェクションInjected configuration
60.3. buildSrcプロジェクトのソースをビルドするBuild sources in the buildSrc project
60.4. 別のGradleビルドを、現在のビルドから呼び出して実行するRunning another Gradle build from a build
60.5. ビルドスクリプトで外部ライブラリを使うときの依存関係設定External dependencies for the build script
60.6. Antオプショナルタスクの依存関係Ant optional dependencies
60.7. まとめSummary
61. 初期化スクリプトInitialization Scripts
61.1. 基本的な使い方Basic usage
61.2. 初期化スクリプトを使う Using an init script
61.3. 初期化スクリプトを記述する Writing an init script
61.4. 初期化スクリプトの外部依存関係External dependencies for the init script
61.5. Init script plugins
62. Gradleラッパー The Gradle Wrapper
62.1. 設定Configuration
62.2. Unixファイルパーミッション Unix file permissions
63. Embedding Gradle
63.1. Introduction to the Tooling API
63.2. Tooling API and the Gradle Build Daemon
63.3. Quickstart
64. Comparing Builds
64.1. Definition of terms
64.2. Current Capabilities
64.3. Comparing Gradle Builds
65. Ivy Publishing (new)
65.1. The “ivy-publish” Plugin
65.2. Publications
65.3. Repositories
65.4. Performing a publish
65.5. Generating the Ivy module descriptor file without publishing
65.6. Complete example
65.7. Future features
66. Maven Publishing (new)
66.1. The “maven-publish” Plugin
66.2. Publications
66.3. Repositories
66.4. Performing a publish
66.5. Publishing to Maven Local
66.6. Generating the POM file without publishing
A. Gradleサンプル集 Gradle Samples
A.1. サンプル Sample customBuildLanguage
A.2. サンプル Sample customDistribution
A.3. サンプル Sample customPlugin
A.4. サンプル Sample java/multiproject
B. 陥りがちな罠 Potential Traps
B.1. Groovyスクリプトの変数 Groovy script variables
B.2. 設定フェーズと実行フェーズ Configuration and execution phase
C. 機能のライフサイクル The Feature Lifecycle
C.1. 状態 States
C.2. 後方互換性ポリシー Backwards Compatibility Policy
D. Gradle コマンドラインGradle Command Line
D.1. デーモン コマンドラインオプション:Daemon command-line options:
D.2. システムプロパティSystem properties
D.3. 環境変数Environment variables
E. IDE対応の現状と、IDEによらない開発支援Existing IDE Support and how to cope without it
E.1. IntelliJ
E.2. Eclipse
E.3. IDEサポートなしでGradleを使うUsing Gradle without IDE support
用語集 / Glossary

例目次

6.1. 初めてのビルドスクリプト
6.2. ビルドスクリプトの実行
6.3. タスク定義のショートカット
6.4. GradleタスクでGroovyを使う
6.5. GradleタスクでGroovyを使う
6.6. タスク間の依存関係を宣言する
6.7. 遅延評価のdependsOn - タスクがまだ宣言されていない場合
6.8. 動的なタスク定義
6.9. APIからタスクにアクセスする - 依存関係の追加
6.10. APIからタスクにアクセスする - アクションの追加
6.11. ビルドスクリプトのプロパティとして既存のタスクにアクセスする
6.12. 拡張プロパティをタスクに追加する
6.13. AntBuilderを使ってant.loadfileターゲットを実行する
6.14. メソッドを抽出してビルドロジックを整理する
6.15. デフォルトタスクの定義
6.16. 選択したタスクによって異なる結果を得る
7.1. Javaプラグインの使用
7.2. Javaプロジェクトのビルド
7.3. Mavenリポジトリの追加
7.4. 依存関係の追加
7.5. MANIFEST.MFのカスタマイズ
7.6. テスト用システムプロパティの追加
7.7. JARファイルの公開
7.8. Eclipseプラグイン
7.9. Javaの例 - 完全なビルドファイル
7.10. マルチプロジェクトビルド - 階層レイアウト
7.11. マルチプロジェクトビルド - settings.gradleファイル
7.12. マルチプロジェクトビルド - 共通設定
7.13. マルチプロジェクトビルド - プロジェクト間の依存関係
7.14. マルチプロジェクトビルド - 配布ファイル
8.1. 依存関係の宣言
8.2. 外部依存関係の定義
8.3. 外部依存関係定義のショートカット形式
8.4. Mavenセントラルリポジトリの使用
8.5. リモートMavenリポジトリの使用
8.6. リモートIvyリポジトリの使用
8.7. ローカルのIvyディレクトリを使う
8.8. Ivyリポジトリに公開する
8.9. Mavenリポジトリへの公開
9.1. Groovyプラグイン
9.2. Dependency on Groovy
9.3. Groovy用のビルドファイル(全体)
10.1. Warプラグイン
10.2. JettyプラグインによるWebアプリケーションの実行
11.1. 複数のタスクの実行
11.2. タスクの除外
11.3. タスク名の省略
11.4. キャメルケースのタスク名を省略
11.5. ビルドスクリプトを指定してビルドするプロジェクトを選択する
11.6. プロジェクトディレクトリを使ってプロジェクトを選択する
11.7. プロジェクトに関する情報を取得する
11.8. プロジェクトに説明を添付する
11.9. タスクに関する情報を取得する
11.10. タスクレポートの内容を変更する
11.11. タスクに関してもっと多くの情報を取得する
11.12. タスクについて詳細なヘルプ情報を取得する
11.13. 依存関係の情報を取得する
11.14. 依存関係のレポートをコンフィギュレーションでフィルタする
11.15. 個別の依存関係に対する解析情報を取得する
11.16. プロパティに関する情報
12.1. GUIの起動Launching the GUI
13.1. Projectオブジェクトへのアクセス
13.2. ローカル変数を使用する
13.3. 拡張プロパティを使用する
13.4. Groovy JDKのメソッド
13.5. プロパティアクセサ
13.6. カッコなしのメソッド呼び出し
13.7. マップリテラル、リストリテラル
13.8. メソッドのクロージャ引数
13.9. クロージャのdelegate
14.1. mkdirでディレクトリを作成する
14.2. gradle.propertiesでプロパティを設定する
14.3. 外部のビルドスクリプトファイルでプロジェクトの設定を行う
14.4. 任意のオブジェクトを組み立てる
14.5. 外部スクリプトで任意のオブジェクトを組み立てる
15.1. タスクを定義する
15.2. タスクを定義する - タスク名に文字列を使用
15.3. その他のタスク定義方法
15.4. タスクにプロパティとしてアクセスする
15.5. tasksコレクションからタスクにアクセスする
15.6. パスを使ってタスクにアクセスする
15.7. copyタスクの作成
15.8. タスクの設定 - 様々な方法
15.9. タスクの設定 - クロージャの使用
15.10. クロージャを伴うタスク定義
15.11. 別プロジェクトのタスクとの依存関係を定義する
15.12. taskオブジェクトを使った依存関係定義
15.13. クロージャを使った依存関係定義
15.14. Adding a 'must run after' task ordering
15.15. Adding a 'should run after' task ordering
15.16. Task ordering does not imply task execution
15.17. A 'should run after' task ordering is ignored if it introduces an ordering cycle
15.18. タスクに説明書きを追加する
15.19. タスクの上書き
15.20. 述語でタスクをスキップ
15.21. StopExecutionExceptionでタスクをスキップ
15.22. タスクの有効化と無効化
15.23. 生成タスク
15.24. タスクの入力と出力を宣言
15.25. タスクルール
15.26. ルールベース・タスクの依存関係
15.27. Adding a task finalizer
15.28. Task finalizer for a failing task
16.1. ファイルを参照する
16.2. ファイルコレクションの作成
16.3. ファイルコレクションを使う
16.4. ファイルコレクションを実装する
16.5. ファイルツリーを作成する
16.6. ファイルツリーを使う
16.7. アーカイブをファイルツリーとして使う
16.8. ファイルセットを指定する
16.9. ファイルセットを指定する
16.10. Copyタスクでファイルをコピーする
16.11. Copyタスクのコピー元と宛先を指定する
16.12. コピーするファイルを選択する
16.13. copy()メソッドで更新チェックせずにファイルをコピーする
16.14. copy()メソッドで更新チェックを実施してファイルをコピーする
16.15. コピー時にファイルをリネームする
16.16. コピー時にファイルをフィルタリングする
16.17. 入れ子構造のコピー仕様
16.18. Syncタスクで依存関係をコピーする
16.19. ZIPアーカイブの作成
16.20. ZIPアーカイブの作成
16.21. アーカイブタスクの設定 - カスタムアーカイブ名
16.22. アーカイブタスクの設定 - appendix & classifier
17.1. Antタスクの利用
17.2. Antタスクにネストされたテキストを渡す
17.3. Antタスクにネストされた要素を渡す
17.4. Antタイプの利用
17.5. カスタムAntタスクの利用
17.6. カスタムAntタスクに対するクラスパスの宣言
17.7. カスタムAntタスクと依存関係管理を併用
17.8. Antビルドのインポート
17.9. Antターゲットに依存するタスク
17.10. Antターゲットにふるまいを追加
17.11. Ant target that depends on Gradle task
17.12. Renaming imported Ant targets
17.13. Antプロパティの設定
17.14. Antプロパティの取得
17.15. Antリファレンスの設定
17.16. Antリファレンスの取得
18.1. ログに標準出力を使う
18.2. 自分でログメッセージを書く
18.3. SLF4Jでログを出力する
18.4. 標準出力のキャプチャ設定
18.5. タスク実行時の標準出力キャプチャ設定
18.6. Gradleがロギングするものを変更する
20.1. HTTPプロクシの設定Configuring an HTTP proxy
20.2. HTTPSプロクシの設定Configuring an HTTPS proxy
21.1. プラグインの適用
21.2. Applying a script plugin
21.3. Applying a binary plugin
21.4. Applying a binary plugin by type
21.5. 型でプラグインを適用する
21.6. Applying a community plugin
21.7. プラグインにより追加されたタスク
21.8. プラグインのデフォルトを変更する
21.9. プラグインの規約オブジェクト
23.1. Javaプラグインの使用
23.2. Javaソースレイアウトのカスタマイズ
23.3. ソースセットへのアクセス
23.4. ソースセットのソースディレクトリの設定
23.5. ソースセットの定義
23.6. ソースセットの依存関係定義
23.7. ソースセットのコンパイル
23.8. ソースセットのJARを生成
23.9. ソースセットのJavadocを生成
23.10. ソースセットのテストを実行
23.11. Filtering tests in the build script
23.12. JUnit Categories
23.13. Grouping TestNG tests
23.14. Creating a unit test report for subprojects
23.15. MANIFEST.MFのカスタマイズ
23.16. manifestオブジェクトの作成
23.17. 特定のアーカイブ用にMANIFEST.MFを分離
23.18. 特定のアーカイブ用にMANIFEST.MFを分離
24.1. Groovyプラグインの使用
24.2. Groovyソースレイアウトのカスタマイズ
24.3. Groovyプラグインの設定
24.4. Groovyテスト用の依存関係設定
24.5. 同梱のGroovyを使用する依存関係設定
24.6. Groovyをファイル依存関係で設定する
25.1. Scalaプラグインを使う
25.2. Scalaソースレイアウトのカスタマイズ
25.3. 製品コードに使うScalaへの依存関係の宣言
25.4. テストコードに使うScalaへの依存関係の宣言
25.5. Fast Scala Compilerを有効にする
25.6. メモリ設定の調整
25.7. Zincベースのコンパイラを有効にする
26.1. Using the War plugin
26.2. Customization of war plugin
27.1. Earプラグインの利用
27.2. Earプラグインのカスタマイズ
28.1. Using the Jetty plugin
29.1. Checkstyleプラグインの使用
30.1. CodeNarcプラグインの使用
31.1. FindBugsプラグインの使用
32.1. JDependプラグインの使用
33.1. PMDプラグインの使用
34.1. Applying the JaCoCo plugin
34.2. Configuring JaCoCo plugin settings
34.3. Configuring test task
34.4. Configuring test task
34.5. Using application plugin to generate code coverage data
34.6. Coverage reports generated by applicationCodeCoverageReport
35.1. Sonarプラグインの適用
35.2. Sonar接続設定のコンフィグレーション
35.3. Sonarプロジェクト設定のコンフィグレーション
35.4. マルチプロジェクトビルドにおけるグローバルコンフィグレーション
35.5. マルチプロジェクトビルドにおける共通のプロジェクトコンフィグレーション
35.6. マルチプロジェクトビルドにおけるプロジェクト個別コンフィグレーション
35.7. 解析対象の言語のコンフィグレーション
35.8. プロパティ文法の利用
35.9. カスタムソースセットの解析
35.10. Java言語以外の解析
35.11. カスタムグローバルプロパティ設定
35.12. カスタムプロジェクトプロパティ設定
35.13. カスタムのコマンドラインプロパティを実装する
36.1. Applying the Sonar Runner plugin
36.2. Configuring Sonar connection settings
36.3. Configuring Sonar runner version
36.4. Global configuration settings
36.5. Shared configuration settings
36.6. Individual configuration settings
36.7. Skipping analysis of a project
36.8. Analyzing custom source sets
36.9. Analyzing languages other than Java
36.10. setting custom Sonar Runner fork options
37.1. OSGiプラグインの利用
37.2. OSGiのMANIFEST.MFファイルの設定
38.1. Eclipseプラグインの使用方法
38.2. classpath の一部を上書き
38.3. project の一部を上書き
38.4. 依存関係のエクスポート
38.5. 依存関係のエクスポート
38.6. XML のカスタマイズ
38.7. XML のカスタマイズCustomizing the XML
39.1. IDEAプラグインを使う
39.2. モジュールの部分的な上書き
39.3. プロジェクトの部分的な上書き
39.4. Export Dependencies
39.5. XMLをカスタマイズする
40.1. ANTLRプラグインの利用
40.2. ANTLRバージョン宣言
42.1. 通知プラグインを使用する
42.2. 通知プラグインの設定
42.3. 通知プラグインを使用する
43.1. ビルド通知プラグインの利用
43.2. 初期化スクリプトからビルド通知プラグインを使う
44.1. Using the distribution plugin
44.2. Adding extra distributions
44.3. Configuring the main distribution
45.1. Using the application plugin
45.2. Configure the application main class
45.3. Configure default JVM settings
45.4. 他タスクの出力をアプリケーションのディストリビューションに含める
45.5. ディストリビューションのファイルを自動的に作成する
46.1. Using the Java library distribution plugin
46.2. Configure the distribution name
46.3. Include files in the distribution
49.1. Using the Build Dashboard plugin
50.1. Using the Java Gradle Plugin Development plugin
51.1. コンフィギュレーションの定義
51.2. コンフィギュレーションへのアクセス
51.3. コンフィギュレーションの設定変更
51.4. モジュール依存関係
51.5. アーティファクトオンリー記法
51.6. 分類子付きの依存関係
51.7. あるコンフィグレーションの内部を列挙する
51.8. クライアントモジュール依存関係 - 推移的な依存関係
51.9. プロジェクト依存関係
51.10. ファイル依存関係
51.11. 生成されるファイルへの依存関係
51.12. Gradle API依存関係
51.13. Gradleに同梱されているGroovyへの依存関係
51.14. 推移的な依存関係の除外
51.15. 依存関係のオプション属性
51.16. 依存関係定義のコレクション、配列
51.17. 依存するコンフィギュレーションの指定
51.18. 依存するプロジェクトのコンフィギュレーション
51.19. Configuration.copy
51.20. 宣言した依存関係にアクセスする
51.21. Configuration.files
51.22. フィルター付きConfiguration.files
51.23. Configuration.copy
51.24. Configuration.copy vs. Configuration.files
51.25. Declaring a Maven and Ivy repository
51.26. Providing credentials to a Maven and Ivy repository
51.27. Mavenセントラルリポジトリを追加する
51.28. BintrayのJCenter Mavenリポジトリを追加する
51.29. Using Bintrays's JCenter with HTTP
51.30. Mavenのローカルキャッシュをリポジトリとして追加する
51.31. カスタムMavenリポジトリを追加する
51.32. JARファイル用の追加リポジトリを設定する
51.33. パスワード保護されたMavenリポジトリへのアクセス
51.34. フラットディレクトリ・リゾルバ
51.35. Ivyリポジトリ
51.36. Ivy repository with named layout
51.37. パターンレイアウトを指定したIvyリポジトリ
51.38. Maven互換レイアウトのIvyリポジトリ
51.39. Ivy repository with pattern layout
51.40. Ivy repository with multiple custom patterns
51.41. Ivy repository with Maven compatible layout
51.42. パスワードで保護されたIvyリポジトリ
51.43. リポジトリ定義へのアクセス
51.44. リポジトリの設定変更
51.45. カスタムリポジトリの定義
51.46. あるグループのライブラリ全てで一貫したバージョンを使用するよう強制する
51.47. 独自のバージョニング体制を実装する
51.48. バージョンのブラックリスト指定と差し替
51.49. 解決時に依存関係のグループ名や名前を変更する
51.50. Declaring module replacement
51.51. 動的解決モードを有効にする
51.52. 'Latest' version selector
51.53. Custom status scheme
51.54. Ivy component metadata rule
51.55. Component selection rule
51.56. Component selection rule with module target
51.57. Component selection rule with metadata
51.58. 動的バージョンのキャッシュ制御
51.59. 変更性モジュールのキャッシュ制御
52.1. アーカイブタスクを使ってアーティファクトを宣言する
52.2. アーティファクトをファイルで宣言する
52.3. アーティファクトのカスタマイズ
52.4. ファイルでアーティファクトを宣言するMapスタイルの文法
52.5. アップロードタスクの設定
53.1. Mavenプラグインの利用
53.2. スタンドアロンPOMの生成
53.3. リモートMavenリポジトリへのファイルアップロード
53.4. SSH経由でのファイルアップロード
53.5. pomのカスタマイズ
53.6. ビルダースタイルでpomをカスタマイズする
53.7. 自動生成された内容を変更する
53.8. Mavenインストーラーのカスタマイズ
53.9. 複数POMの生成
53.10. マッピングコンフィグレーションへのアクセス
54.1. 署名プラグインの使用
54.2. コンフィグレーションに署名する
54.3. コンフィグレーションの出力に署名する
54.4. タスクを署名する
54.5. タスクの出力に署名する
54.6. 条件付き署名
54.7. Signing a POM for deployment
55.1. Defining a library component
55.2. Defining executable components
55.3. The components report
55.4. The 'cpp' plugin
55.5. C++ source set
55.6. The 'c' plugin
55.7. C source set
55.8. The 'assembler' plugin
55.9. The 'objective-c' plugin
55.10. The 'objective-cpp' plugin
55.11. Settings that apply to all binaries
55.12. Settings that apply to all shared libraries
55.13. Settings that apply to all binaries produced for the 'main' executable component
55.14. Settings that apply only to shared libraries produced for the 'main' library component
55.15. The 'windows-resources' plugin
55.16. Configuring the location of Windows resource sources
55.17. Building a resource-only dll
55.18. Providing a library dependency to the source set
55.19. Providing a library dependency to the binary
55.20. Declaring project dependencies
55.21. Defining build types
55.22. Configuring debug binaries
55.23. Defining platforms
55.24. Defining flavors
55.25. Targeting a component at particular platforms
55.26. Building all possible variants
55.27. Defining tool chains
55.28. Reconfigure tool arguments
55.29. Defining target platforms
55.30. Registering CUnit tests
55.31. Registering CUnit tests
55.32. Running CUnit tests
56.1. シングルプロジェクトのビルド
56.2. 階層構造のレイアウト
56.3. フラットなレイアウト
56.4. プロジェクト・ツリーの属性を変更する
56.5. プロジェクトツリーの属性を変更する
56.6. 特定プロパティを持つプロジェクトにタスクを追加する
56.7. 通知
56.8. すべてのタスクにプロパティ値を設定する
56.9. タスク実行の開始時および終了時にロギングを行う
57.1. マルチプロジェクト・ツリー - warter & bluewhale プロジェクト
57.2. water(親プロジェクト)のビルドスクリプト
57.3. マルチプロジェクトツリー - water, bluewhaleそしてkrill
57.4. Waterプロジェクトのビルドスクリプト
57.5. サブプロジェクト共通の振る舞いとすべてのプロジェクト共通の振る舞いをそれぞれ定義する
57.6. プロジェクト個別の振る舞いを定義する
57.7. krillプロジェクトに個別の振る舞いを定義する
57.8. プロジェクトに振る舞いを追加する(プロジェクト名によるフィルタリング)
57.9. プロジェクトに振る舞いを追加する(プロパティによるフィルタリング)
57.10. サブプロジェクトからビルドを実行する
57.11. プロジェクトの評価と実行
57.12. プロジェクトの評価と実行
57.13. 絶対パスによるタスクの実行
57.14. 依存関係とビルド実行順序
57.15. 依存関係とビルド実行順序
57.16. 依存関係とビルド実行順序
57.17. 依存関係を宣言する
57.18. 依存関係を宣言する
57.19. プロジェクトにまたがるタスク間の依存関係
57.20. 評価順序の依存関係
57.21. 評価順序の依存関係 - evaluationDependsOn
57.22. 評価順序の依存関係
57.23. 依存関係 - 実生活の例 - クロスプロジェクト設定
57.24. プロジェクト依存関係
57.25. プロジェクト依存関係
57.26. 細かい依存関係の制御
57.27. シングルプロジェクトのビルドとテスト
57.28. シングルプロジェクトの部分ビルドとテスト
57.29. 依存プロジェクトのビルドとテスト
57.30. 依存されているプロジェクトのビルドとテスト
58.1. カスタムタスクの定義
58.2. hello worldタスク
58.3. カスタマイズ可能なhello worldタスク
58.4. カスタムタスクのビルド
58.5. カスタムタスク
58.6. カスタムタスクを別のプロジェクトで使う
58.7. カスタムタスクのテスト
58.8. Defining an incremental task action
58.9. Running the incremental task for the first time
58.10. Running the incremental task with unchanged inputs
58.11. Running the incremental task with updated input files
58.12. Running the incremental task with an input file removed
58.13. Running the incremental task with an output file removed
58.14. Running the incremental task with an input property changed
59.1. カスタムプラグイン
59.2. カスタムプラグインのextension
59.3. コンフィグレーションクロージャ付きのカスタムプラグイン
59.4. ファイルプロパティの遅延評価
59.5. カスタムプラグインに対するビルド
59.6. カスタムプラグインに対するワイヤリング
59.7. 別のプロジェクトでカスタムプラグインを使う
59.8. Applying a community plugin with the plugins DSL
59.9. カスタムプラグインのテスト
59.10. Using the Java Gradle Plugin Development plugin
59.11. ドメインオブジェクトの管理
60.1. プロパティとメソッドの継承を使う
60.2. プロパティとメソッドのインジェクション
60.3. カスタムbuildSrcビルドスクリプト
60.4. buildSrcルートプロジェクトにサブプロジェクトを追加する
60.5. 別のビルドを呼び出す
60.6. ビルドスクリプトのクラスパスを宣言する
60.7. 外部ライブラリをビルドスクリプトで使用する
60.8. Ant optional dependencies
61.1. プロジェクト評価前に初期化スクリプトで追加的な設定を行う
61.2. 初期化スクリプトの外部依存関係定義
61.3. 外部依存関係を持つ初期化スクリプト
61.4. Using plugins in init scripts
62.1. ラッパータスク
62.2. ラッパーにより生成されるファイル
65.1. Applying the “ivy-publish” plugin
65.2. Publishing a Java module to Ivy
65.3. Publishing additional artifact to Ivy
65.4. customizing the publication identity
65.5. Customizing the module descriptor file
65.6. Publishing multiple modules from a single project
65.7. Declaring repositories to publish to
65.8. Choosing a particular publication to publish
65.9. Publishing all publications via the “publish” lifecycle task
65.10. Generating the Ivy module descriptor file
65.11. Publishing a Java module
65.12. Example generated ivy.xml
66.1. Applying the 'maven-publish' plugin
66.2. Adding a MavenPublication for a Java component
66.3. Adding additional artifact to a MavenPublication
66.4. customizing the publication identity
66.5. Modifying the POM file
66.6. Publishing multiple modules from a single project
66.7. Declaring repositories to publish to
66.8. Publishing a project to a Maven repository
66.9. Publish a project to the Maven local repository
66.10. Generate a POM file without publishing
B.1. 変数のスコープ:ローカルスコープとスクリプトスコープ
B.2. 設定フェーズと実行フェーズの区別

翻訳版について

本ドキュメントは、Gradleユーザーガイドを非公式に日本語に翻訳したものです。翻訳作業はgithub上のプロジェクトで行っていますので、誤訳、不自然な点など発見されましたらプロジェクトサイト上からご連絡ください。

なお、原文は添付の代替スタイルシート(original)を使用すれば表示されます。

第1章 はじめにIntroduction

We would like to introduce Gradle to you, a build system that we think is a quantum leap for build technology in the Java (JVM) world. Gradle provides:

Gradleは、Java(JVM)環境におけるビルドシステムであり、従来のビルド技術を大きく躍進させるものです。Gradleが提供している機能、特長には以下のようなものがあります。

  • A very flexible general purpose build tool like Ant.

    あらゆる目的に使用できる汎用ビルドツールです。GradleはAntと同じような目的で使うことができます。

  • Switchable, build-by-convention frameworks a la Maven. But we never lock you in!

    その一方でMavenのような規約によるビルドフレームワークを提供します。その規約も、気に入らないところは変更可能です。

  • Very powerful support for multi-project builds.

    マルチプロジェクトを強力にサポートします。

  • Very powerful dependency management (based on Apache Ivy).

    強力な依存関係管理 (Apache Ivy ベース)を提供します。

  • Full support for your existing Maven or Ivy repository infrastructure.

    Maven/Ivyリポジトリを完全にサポートします。

  • Support for transitive dependency management without the need for remote repositories or pom.xml and ivy.xml files.

    リモートリポジトリやpom.xmlivy.xmlを使用しなくても推移的な依存関係を管理できます。

  • Ant tasks and builds as first class citizens.

    Antのタスクとプロジェクトがファーストクラス・オブジェクトとして組み込まれており、デフォルトで使用可能です。

  • Groovy build scripts.

    Groovyでビルドスクリプトを記述します。

  • A rich domain model for describing your build.

    ビルドを記述する際、オブジェクト指向のリッチなドメインモデルを使用可能です。

In 2章概要Overview you will find a detailed overview of Gradle. Otherwise, the tutorials are waiting, have fun :)

2章概要OverviewでGradleの概要について記述しています。チュートリアルも用意しているので楽しんでいってください(^^)

1.1. このユーザーガイドについてAbout this user guide

This user guide, like Gradle itself, is under very active development. Some parts of Gradle aren't documented as completely as they need to be. Some of the content presented won't be entirely clear or will assume that you know more about Gradle than you do. We need your help to improve this user guide. You can find out more about contributing to the documentation at the Gradle web site.

このユーザーガイドは、Gradle同様、現在活発に更新されているところです。まだGradleについて必要な部分がすべてドキュメント化されているわけではありません。 また、記載内容には明確でない部分やGradleについて読者が知っている以上の知識を要求する部分があるかもしれません。 このガイドを改良していくため、力を貸してください。 ドキュメンテーションへ参加、貢献していただける方はGradleのウェブサイトをご参照ください。

Throughout the user guide, you will find some diagrams that represent dependency relationships between Gradle tasks. These use something analogous to the UML dependency notation, which renders an arrow from one task to the task that the first task depends on.

第2章 概要Overview

2.1. 特長Features

Here is a list of some of Gradle's features.

Gradleの特長は以下の通りです。

宣言的なビルドの記述と規約によるビルドDeclarative builds and build-by-convention

At the heart of Gradle lies a rich extensible Domain Specific Language (DSL) based on Groovy. Gradle pushes declarative builds to the next level by providing declarative language elements that you can assemble as you like. Those elements also provide build-by-convention support for Java, Groovy, OSGi, Web and Scala projects. Even more, this declarative language is extensible. Add your own new language elements or enhance the existing ones, thus providing concise, maintainable and comprehensible builds.

Gradleの核となっているのは、拡張性豊富なGroovyベースのDSLです。 それは、好きなように組み立てて記述できる、ビルド用の宣言型プログラミング言語とも言えるものであり、従来の宣言的なビルド記述をさらに上の段階へ推し進めます。 そのプログラミング言語には、JavaやGroovy、OSGi、WebそしてScalaなどのプロジェクトを一般的な方法でビルドする機能も備わっています。 さらに、このプログラミング言語はとても拡張性豊富なものです。 新たな言語機能を追加したり、既存の言語機能を拡張したりすることで、簡潔でメンテナンス性の良い、分かりやすいビルドシステムを作ることができるでしょう。

タスクグラフ用のプログラミング言語Language for dependency based programming

The declarative language lies on top of a general purpose task graph, which you can fully leverage in your builds. It provides utmost flexibility to adapt Gradle to your unique needs.

Gradleの提供する宣言型プログラミング言語は、グラフ構造をもつ汎用のタスク群の上に構築されています。 皆さんのビルドシステムには様々なニーズがあると思いますが、Gradleは、それらに適合できる、究極的な柔軟性を持っているのです。

ビルドの構造化Structure your build

The suppleness and richness of Gradle finally allows you to apply common design principles to your build. For example, it is very easy to compose your build from reusable pieces of build logic. Inline stuff where unnecessary indirections would be inappropriate. Don't be forced to tear apart what belongs together (e.g. in your project hierarchy). Avoid smells like shotgun changes or divergent change that turn your build into a maintenance nightmare. At last you can create a well structured, easily maintained, comprehensible build.

Gradleは柔軟性があり機能が豊富なので、ビルドを記述する際にプログラミングにおける一般的な設計の原則を適用できます。たとえば、ビルド用のロジックを利用可能な単位に細かく分割し、そのロジックを組み立ててビルドを構築することも簡単にできます。ロジックの呼び出しがむやみに複雑になってきたときはインライン化しましょう。同じプロジェクト階層に属しているなど、本来一カ所にあるべきロジックを、無理にいろんなところに書く必要もありません。変更が発散したり分岐したりして、ビルドのメンテナンスが悪夢に変わり果てるのを防ぎ、構造化されたメンテナンス性の良い分かりやすいビルドを記述できます。

深いAPIDeep API

From being a pleasure to be used embedded to its many hooks over the whole lifecycle of build execution, Gradle allows you to monitor and customize its configuration and execution behavior to its very core.

ビルドが実行されるライフサイクル全体に、たくさんのフックを埋め込むことができます。 なので、非常に深い部分までGradleの設定や振る舞いをモニタリングしたりカスタマイズしたりすることが可能です。

ビルドの分割Gradle scales

Gradle scales very well. It significantly increases your productivity, from simple single project builds up to huge enterprise multi-project builds. This is true for structuring the build. With the state-of-art incremental build function, this is also true for tackling the performance pain many large enterprise builds suffer from.

Gradleでは、ビルドの分割を強力にサポートしています。このことは、単純なシングルプロジェクトでもエンタープライズレベルの巨大なマルチプロジェクトでも生産性の大きな向上につながります。ビルドを構造化できますし、最先端のインクリメンタルビルドで、たくさんの大きなプロジェクトをビルドするときのパフォーマンスを改善することもできるからです。

マルチプロジェクトのビルドMulti-project builds

Gradle's support for multi-project build is outstanding. Project dependencies are first class citizens. We allow you to model the project relationships in a multi-project build as they really are for your problem domain. Gradle follows your layout not vice versa.

Gradleは突出したマルチプロジェクトのサポートが特長です。プロジェクト間の依存関係はGradleのファーストクラス・オブジェクトであり、ごく普通に取り扱うことができます。世の中にはいろいろなビルドがありますが、Gradleではそれぞれのビルドに特有の問題点、課題にしたがってマルチプロジェクト、またプロジェクトの関係をモデリングできます。つまり、Gradleがあなたのプロジェクト構造に従うのであって、その逆ではありません。

Gradle provides partial builds. If you build a single subproject Gradle takes care of building all the subprojects that subproject depends on. You can also choose to rebuild the subprojects that depend on a particular subproject. Together with incremental builds this is a big time saver for larger builds.

Gradleでは部分ビルドが可能です。一つのサブプロジェクトをビルドすれば、Gradleはそのプロジェクトに依存しているすべてのプロジェクトもビルドします。また、依存しているプロジェクトのうち、どのプロジェクトを再ビルドするか選択することもできます。大きなプロジェクトの場合、これはインクリメンタルビルドと同様、大きな時間の節約になるでしょう。

依存関係を管理する多くの方法Many ways to manage your dependencies

Different teams prefer different ways to manage their external dependencies. Gradle provides convenient support for any strategy. From transitive dependency management with remote Maven and Ivy repositories to jars or directories on the local file system.

外部ライブラリの解決には、チームごとにさまざまな方法があるものです。リモートのMavenやIvyのリポジトリを使った推移的な依存関係の管理から、ローカルファイルシステム上のjarやディレクトリまで、どのような方法をとるにせよGradleはそれらを強力にサポートします。

他のビルドツールとの統合Gradle is the first build integration tool

Ant tasks are first class citizens. Even more interesting, Ant projects are first class citizens as well. Gradle provides a deep import for any Ant project, turning Ant targets into native Gradle tasks at runtime. You can depend on them from Gradle, you can enhance them from Gradle, you can even declare dependencies on Gradle tasks in your build.xml. The same integration is provided for properties, paths, etc ...

Gradleでは、Antのタスクはファーストクラス・オブジェクトです。さらにおもしろいことに、Antのプロジェクトもまたファーストクラス・オブジェクトなのです。Gradleでは、Antプロジェクトをインポートして、実行時にAntのターゲットをGradleネイティブのタスクへ変換できます。もちろんインポートしたタスクへの依存関係を定義できますし、拡張もできます。それどころか、build.xmlの中でGradleのタスクへの依存関係を宣言することさえ可能です。プロパティやパス、その他諸々についても同じレベルで統合されています。

Gradle fully supports your existing Maven or Ivy repository infrastructure for publishing and retrieving dependencies. Gradle also provides a converter for turning a Maven pom.xml into a Gradle script. Runtime imports of Maven projects will come soon.

Gradleは、既存のMaven/Ivyリポジトリのインフラ、依存関係の定義や解決といった機能を完全にサポートしています。さらに、Mavenのpom.xmlをGradleのスクリプトに変換するコンバーターも用意されています。実行時にその変換を行う機能も近いうちに提供される予定です。

容易に移行可能Ease of migration

Gradle can adapt to any structure you have. Therefore you can always develop your Gradle build in the same branch where your production build lives and both can evolve in parallel. We usually recommend to write tests that make sure that the produced artifacts are similar. That way migration is as less disruptive and as reliable as possible. This is following the best-practices for refactoring by applying baby steps.

Gradleは、どんな構造のプロジェクトにも適用できます。なので、今製品のビルドを行っているブランチがあるなら、それと同じブランチ上で平行してGradleのビルドを開発していくことができます。私たちは常より、成果物を作成するときには、いつもと同様のものができているか確認するようなテストを書くことを推奨していました。この方法で移行すれば、既存のものを破壊するような可能性は少ないし、可能な限りの安全性を確保できます。これは、小さな変更を積み重ねていくという、リファクタリング上のベストプラクティスなのです。

Groovy

Gradle's build scripts are written in Groovy, not XML. But unlike other approaches this is not for simply exposing the raw scripting power of a dynamic language. That would just lead to a very difficult to maintain build. The whole design of Gradle is oriented towards being used as a language, not as a rigid framework. And Groovy is our glue that allows you to tell your individual story with the abstractions Gradle (or you) provide. Gradle provides some standard stories but they are not privileged in any form. This is for us a major distinguishing feature compared to other declarative build systems. Our Groovy support is not just sugar coating. The whole Gradle API is fully Groovy-ized. Adding Groovy results in an enjoyable and productive experience.

GradleのビルドスクリプトはXMLではなくGroovyで記述します。しかし、それは単純に動的言語のスクリプト機能を生で使わせるということではありません。それではビルドのメンテナンスがむやみに難しくなるだけです。Gradleは、硬直したフレームワークとしてではなく、一つの言語として使用されることを想定してデザインされています。Groovyは、Gradle(またはあなた自身)が提供する抽象性と個々のビルドがもつ独自の筋書きとをくっつける接着剤となっているのです。Gradleでは、いくつかの標準的なビルドの筋書きを用意していますが、それら筋書きが何かの特別な扱いを受けているというわけではありません。別のビルドシステムと比較したとき、このことはGradleの主な特徴の一つになると考えています。GradleのGroovyサポートはただの構文糖衣ではありません。すべてのAPIは完全にGroovy化されていて、楽にGroovyを使うことができ、生産性を向上させています。

GradleラッパーThe Gradle wrapper

The Gradle Wrapper allows you to execute Gradle builds on machines where Gradle is not installed. This is useful for example for some continuous integration servers. It is also useful for an open source project to keep the barrier low for building it. The wrapper is also very interesting for the enterprise. It is a zero administration approach for the client machines. It also enforces the usage of a particular Gradle version thus minimizing support issues.

Gradleラッパーを使うと、Gradleをインストールしていないマシンでビルドを実行できます。たとえば、CIサーバー上でビルドしたり、オープンソースプロジェクトを簡単にビルドできるようにしたりするのに便利です。また、これはクライアントマシンの管理維持作業を省く(zero administration)というアプローチでもあり、企業向けと考えてもとても面白いものだといえます。使用させるGradleのバージョンを固定し、サポートしなければならないような問題の発生を最小限に抑えることもできます。

フリーかつオープンソースFree and open source

Gradle is an open source project, and is licensed under the ASL.

Gradleはオープンソースプロジェクトであり、ASLのもとで公開されています。

2.2. なぜGroovyなのか?Why Groovy?

We think the advantages of an internal DSL (based on a dynamic language) over XML are tremendous when used in build scripts. There are a couple of dynamic languages out there. Why Groovy? The answer lies in the context Gradle is operating in. Although Gradle is a general purpose build tool at its core, its main focus are Java projects. In such projects the team members will be very familiar with Java. We think a build should be as transparent as possible to all team members.

ビルドスクリプトを記述するということを考えたとき、XMLに対する内部DSL(動的言語ベース)のアドバンテージというのは途方もなく大きいものです。 ただ、動的な言語はいくつかあるのに、なぜGroovyなのでしょうか。 その答えは、Gradleが想定しているシチュエーション、環境にあります。 Gradleは本質的に言えば一般的な利用が可能な汎用のビルドツールですが、メインとしてフォーカスしているのはJavaのプロジェクトです。 そのようなプロジェクトの場合、チームのメンバーがJavaに習熟しているのは明らかでしょう。 私たちは、ビルドはすべてのチームメンバーに対してできるだけ分かりやすいものであるべきだと考えています。

In that case, you might argue why we don't just use Java as the language for build scripts. We think this is a valid question. It would have the highest transparency for your team and the lowest learning curve, but because of the limitations of Java, such a build language would not be as nice, expressive and powerful as it could be. [1] Languages like Python, Groovy or Ruby do a much better job here. We have chosen Groovy as it offers by far the greatest transparency for Java people. Its base syntax is the same as Java's as well as its type system, its package structure and other things. Groovy provides much more on top of that, but with the common foundation of Java.

それならGroovyでなくJavaを使えばいいのにと思われるかもしれません。それはもっともな疑問です。 ビルド用の言語にJavaを使えば、開発チームにとって最高に分かりやすく、学習曲線が最小限緩やかなビルドとなるでしょう。 しかし、Javaはビルド用の言語として使うには表現力や機能に限界があるのです。 [2] このような用途には、PythonやGroovy、Rubyのような言語の方が向いています。 私たちは、Java世界の住人にとって断然飛び抜けた分かりやすさを提供するGroovyを選択しました。 Groovyの文法は、型システム、パッケージ構造、その他諸々についてJavaをベースにしています。Groovyはその上に様々な機能を構築していますが、土台はJavaと同じなのです。

For Java developers with Python or Ruby knowledge or the desire to learn them, the above arguments don't apply. The Gradle design is well-suited for creating another build script engine in JRuby or Jython. It just doesn't have the highest priority for us at the moment. We happily support any community effort to create additional build script engines.

Javaの開発者であっても、PythonやRubyの知識を持っていたり、それらを楽しく学んでいるのなら上記の議論は当てはまりません。 Gradleはビルドスクリプト・エンジンとしてJRubyやJythonを使えるよう適切にデザインされています。 私達にとって、目下のところはそれらの優先度は高くありませんが。 私たちは、そういった追加のビルドスクリプトエンジンを作っていただけるあらゆるコミュニティを喜んでサポートします。



[1] At http://www.defmacro.org/ramblings/lisp.html you find an interesting article comparing Ant, XML, Java and Lisp. It's funny that the 'if Java had that syntax' syntax in this article is actually the Groovy syntax.

[2] http://www.defmacro.org/ramblings/lisp.htmlに、AntとXML、Java、Lispを比較している興味深い記事が載っています。 「もしJavaがこの文法を持っていたら」という前提で書かれている構文が、まさにGroovyの文法になっているのが面白いところです。

第3章 チュートリアルTutorials

3.1. 始めてみようGetting Started

The following tutorials introduce some of the basics of Gradle, to help you get started.

次のチュートリアルはGradleの基本機能を紹介しているものです。Gradleを始める手助けになるでしょう。

4章GradleのインストールInstalling Gradle

Describes how to install Gradle.

Gradleのインストール方法について

6章ビルドスクリプトの基本Build Script Basics

Introduces the basic build script elements: projects and tasks.

ビルドスクリプトの基本要素、プロジェクトタスクの紹介

7章JavaクイックスタートJava Quickstart

Shows how to start using Gradle's build-by-convention support for Java projects.

Javaプロジェクトにおける、Gradleの規約によるビルドのチュートリアル

8章依存関係管理の基本 Dependency Management Basics

Shows how to start using Gradle's dependency management.

Gradleの依存関係管理のチュートリアル

9章GroovyクイックスタートGroovy Quickstart

Using Gradle's build-by-convention support for Groovy projects.

Groovyプロジェクトにおける、Gradleの規約によるビルドのチュートリアル

10章WebアプリケーションクイックスタートWeb Application Quickstart

Using Gradle's build-by-convention support for Web applications.

Webアプリケーションプロジェクトにおける、Gradleの規約によるビルドのチュートリアル

第4章 GradleのインストールInstalling Gradle

4.1. 必要環境Prerequisites

Gradle requires a Java JDK or JRE to be installed, version 6 or higher (to check, use java -version). Gradle ships with its own Groovy library, therefore Groovy does noot need to be installed. Any existing Groovy installation is ignored by Gradle.

Gradleを使用するには、バージョン6以上のJava JDKもしくはJREが必要です(java -versionで確認してください)。 GradleにはGroovyライブラリが同梱されているので、別途Groovyをインストールする必要はありません。すでにインストールされていたとしても、Gradleでは既存のGroovyは使用されません。

Gradle uses whatever JDK it finds in your path. Alternatively, you can set the JAVA_HOME environment variable to point to the installation directory of the desired JDK.

Gradleは、システムのパス上にあるJDKを使用します。 パス上のJDKの代わりに、環境変数JAVA_HOMEにJDKをインストールしたディレクトリをセットして、使用したいJDKを指定することもできます。

4.2. ダウンロードDownload

You can download one of the Gradle distributions from the Gradle web site.

Gradleはウェブサイトからダウンロードできます。

4.3. 解凍Unpacking

The Gradle distribution comes packaged as a ZIP. The full distribution contains:

Gradleの配布物はZIPで圧縮されています。Gradleのフルパッケージには以下のものが含まれています。

  • The Gradle binaries.

    Gradleのバイナリ

  • The user guide (HTML and PDF).

    ユーザーガイド(HTMLとPDF)

  • The DSL reference guide.

    DSLのリファレンスガイド

  • The API documentation (Javadoc and Groovydoc).

    APIドキュメント(JavadocとGroovydoc)

  • Extensive samples, including the examples referenced in the user guide, along with some complete and more complex builds you can use as a starting point for your own build.

    ユーザーガイドから参照されているサンプルを含め、大量のサンプルが同梱されています。複雑なビルドのサンプルが完全な形で置かれており、自分自身のビルドを記述するためのとっかかりとすることができます。

  • The binary sources. This is for reference only. If you want to build Gradle you need to download the source distribution or checkout the sources from the source repository. See the Gradle web site for details.

    Gradleバイナリのソースコード。これは参照専用のものです。Gradleをビルドするには、ソースを別途ダウンロードするかリポジトリからチェックアウトする必要があります。詳しくはGradleのウェブサイトを参照してください。

4.4. 環境変数Environment variables

For running Gradle, add GRADLE_HOME/bin to your PATH environment variable. Usually, this is sufficient to run Gradle.

GRADLE_HOME/binを環境変数PATHに追加してください。Gradleの実行に必要な環境変数の設定は、通常これだけです。

4.5. 正しくインストールされたことをテストするRunning and testing your installation

You run Gradle via the gradle command. To check if Gradle is properly installed just type gradle -v. The output shows the Gradle version and also the local environment configuration (Groovy, JVM version, OS, etc.). The displayed Gradle version should match the distribution you have downloaded.

Gradleは、gradleコマンドで実行します。Gradleが正しくインストールされていることを確認するには、gradle -vと入力してください。Gradleのバージョンとローカルの実行環境(groovyやjvmのバージョンなど)が表示されます。表示されたgradleのバージョンが、ダウンロードした配布物のバージョンと一致していることを確認してください。

4.6. JVMオプションJVM options

JVM options for running Gradle can be set via environment variables. You can use either GRADLE_OPTS or JAVA_OPTS, or both. JAVA_OPTS is by convention an environment variable shared by many Java applications. A typical use case would be to set the HTTP proxy in JAVA_OPTS and the memory options in GRADLE_OPTS. Those variables can also be set at the beginning of the gradle or gradlew script.

Gradle実行時に引き渡すJVMオプションは、環境変数GRADLE_OPTSJAVA_OPTSで設定します。両方一緒に使うこともできます。 JAVA_OPTSに設定したオプションは、慣習により多くのJavaアプリケーションで共有されるものです。 典型的な例で言えば、HTTPプロキシはJAVA_OPTSに設定し、使用メモリに関する設定はGRADLE_OPTSにセットする、といった使い分けが考えられるでしょう。 これらの設定はgradlegradlewスクリプトの頭に記述することもできます。

Note that it's not currently possible to set JVM options for Gradle on the command line.

第5章 トラブルシューティング Troubleshooting

This chapter is currently a work in progress.

この章は現在執筆途中です。

When using Gradle (or any software package), you can run into problems. You may not understand how to use a particular feature, or you may encounter a defect. Or, you may have a general question about Gradle.

Gradleを使っていると(他のソフトウェアでも同じですが)、問題に突き当たる可能性が常にあります。 ある機能をどうやって使えばいいのか分からなかったり、バグに遭遇したりといった場合もありますし、FAQに頭を抱えているかもしれません。

This chapter gives some advice for troubleshooting problems and explains how to get help with your problems.

この章ではトラブルシューティングのためのアドバイスや、突き当たった問題に対して手助けを求める方法について記載します。

5.1. トラブルに対処する Working through problems

If you are encountering problems, one of the first things to try is using the very latest release of Gradle. New versions of Gradle are released frequently with bug fixes and new features. The problem you are having may have been fixed in a new release.

何かトラブルが起こったとき、まず試すことができるのは、最新版のGradleを使ってみることです。Gradleの新バージョンはバグフィックスや新機能追加のため頻繁にリリースされています。その問題は、新しいバージョンでは修正されているかもしれません。

If you are using the Gradle Daemon, try temporarily disabling the daemon (you can pass the command line switch --no-daemon). More information about troubleshooting the daemon process is located in 19章Gradleデーモン The Gradle Daemon.

Gradleデーモンを使っているなら、一時的にデーモンを停止してみてください(--no--daemonオプションをつけて実行)。 デーモン使用時のトラブルシューティングについて、詳しくは19章Gradleデーモン The Gradle Daemonを参照してください。

5.2. ヘルプを求めるには Getting help

The place to go for help with Gradle is http://forums.gradle.org. The Gradle Forums is the place where you can report problems and ask questions of the Gradle developers and other community members.

Gradleに関して手助けを求めたいときは、http://forums.gradle.orgに行ってみましょう。 Gradleフォーラムでは、Gradleのデベロッパーやコミュニティメンバーに問題を報告したり、質問したりすることができます。

If something's not working for you, posting a question or problem report to the forums is the fastest way to get help. It's also the place to post improvement suggestions or new ideas. The development team frequently posts news items and announces releases via the forum, making it a great way to stay up to date with the latest Gradle developments.

何か問題が発生したら、フォーラムに質問や報告を投げるのが最も早く手助けを得られる方法です。 フォーラムでは、改善のための提案や新しいアイデアを投稿することもできます。 また、Gradleの開発チームが頻繁にニュースやリリースのアナウンスを投稿していますので、Gradle開発の最前線に触れるという意味でもフォーラムはとても便利です。

第6章 ビルドスクリプトの基本Build Script Basics

6.1. プロジェクトとタスクProjects and tasks

Everything in Gradle sits on top of two basic concepts: projects and tasks.

Gradleの根本にあるのは、プロジェクトタスクという二つの基本的な概念です。

Every Gradle build is made up of one or more projects. What a project represents depends on what it is that you are doing with Gradle. For example, a project might represent a library JAR or a web application. It might represent a distribution ZIP assembled from the JARs produced by other projects. A project does not necessarily represent a thing to be built. It might represent a thing to be done, such as deploying your application to staging or production environments. Don't worry if this seems a little vague for now. Gradle's build-by-convention support adds a more concrete definition for what a project is.

Gradleによるビルドは、一つ以上のプロジェクトから構成されます。プロジェクトとは、ビルドされるソフトウェアを構成するコンポーネントのことですが、正確な意味は何をビルドするかによって変わります。たとえば、あるプロジェクトはライブラリjarやWebアプリケーションをビルドするものかもしれません。または、別のプロジェクトによってビルドされたjarを集めて配布用のzipファイルを作成するものかもしれません。何か具体的なものを組み立てるのではなく、処理を行うだけというプロジェクトもありえます。アプリケーションを本番環境にステージするというプロジェクトがその一例です。今は少しあいまいな印象を受けられるかもしれませんが、心配する必要はありません。Gradleは規約によるビルドをサポートしており、プロジェクトの定義については明確に規定されています。

Each project is made up of one or more tasks. A task represents some atomic piece of work which a build performs. This might be compiling some classes, creating a JAR, generating Javadoc, or publishing some archives to a repository.

それぞれのプロジェクトは、一つ以上のタスクから構成されます。タスクとは、分割不能な何らかの作業単位を表す概念です。たとえば、クラスをコンパイルしたり、JARファイルを作成したり、Javadocを生成したり、アーカイブをリポジトリに公開したりするタスクが考えられます。

For now, we will look at defining some simple tasks in a build with one project. Later chapters will look at working with multiple projects and more about working with projects and tasks.

では、実際にプロジェクト上でいくつか簡単なタスクを定義してビルドしてみましょう。マルチプロジェクトでのビルド例やプロジェクト/タスクのもっと詳しい情報については後の章をご参照ください。

6.2. Hello world

You run a Gradle build using the gradle command. The gradle command looks for a file called build.gradle in the current directory. [3] We call this build.gradle file a build script, although strictly speaking it is a build configuration script, as we will see later. The build script defines a project and its tasks.

Gradleのビルドは、gradleコマンドで実行します。gradleコマンドはカレントディレクトリのbuild.gradleファイルを参照してビルドを行います。[4]このファイルは、一般的にはビルドスクリプトと呼ばれます(後述しますが、正確には「ビルドの設定を行うスクリプト」です)。Gradleのプロジェクトとタスクは、このビルドスクリプトで定義されます。

To try this out, create the following build script named build.gradle.

次のようなスクリプトを、build.gradleという名前で作成して試してみてください。

例6.1 初めてのビルドスクリプト

build.gradle

task hello {
    doLast {
        println 'Hello world!'
    }
}

In a command-line shell, move to the containing directory and execute the build script with gradle -q hello:

コンソールを開いてこのbuild.gradleのあるディレクトリに移動して、gradle -q helloと打ち込んでください。ビルドスクリプトが実行され、以下のように出力されるはずです。

-qオプションって何?What does -q do?

Most of the examples in this user guide are run with the -q command-line option. This suppresses Gradle's log messages, so that only the output of the tasks is shown. This keeps the example output in this user guide a little clearer. You don't need to use this option if you don't want to. See 18章ロギングLogging for more details about the command-line options which affect Gradle's output.

このユーザーガイドでは、ほぼすべての例で-qをつけてコマンドを実行しています。このオプションはGradleのログメッセージを抑制するもので、タスクによる出力のみが表示されるようになります。おかげでユーザーガイドの出力例はちょっとすっきりしていますが、もちろん使いたくなければこのオプションを使う必要はありません。Gradleの出力に関係するオプションについては、18章ロギングLoggingにもっと詳しく記載されています。

例6.2 ビルドスクリプトの実行

gradle -q hello の出力

> gradle -q hello
Hello world!

What's going on here? This build script defines a single task, called hello, and adds an action to it. When you run gradle hello, Gradle executes the hello task, which in turn executes the action you've provided. The action is simply a closure containing some Groovy code to execute.

何が起こったのでしょう。ビルドスクリプトは、helloというタスクを一つ定義していて、このタスクにアクションを一つ追加しています。gradle helloと実行することで、Gradleがこのhelloを実行し、helloに追加したアクションが実行されたのです。アクションはGroovyコードを含む単なるクロージャです。

If you think this looks similar to Ant's targets, well, you would be right. Gradle tasks are the equivalent to Ant targets, but as you will see, they are much more powerful. We have used a different terminology than Ant as we think the word task is more expressive than the word target. Unfortunately this introduces a terminology clash with Ant, as Ant calls its commands, such as javac or copy, tasks. So when we talk about tasks, we always mean Gradle tasks, which are the equivalent to Ant's targets. If we talk about Ant tasks (Ant commands), we explicitly say Ant task.

Antのtargetに似ているなと思われたかもしれません。実際、GradleのtaskはAntでいえばtargetに相当するものです。ただ、これから見ていきますがGradleのtaskはAntのtargetよりもずっと強力なものです。Gradleではtaskという、Antとは異なる用語を採用しました。これはtaskという言葉が、targetという言葉よりも実態に合った表現だと考えたためです。しかし、残念ながらtaskという用語はAntでもcopyjavacといったコマンドを示すものとして使われており、Gradleのtaskと競合してしまいます。このため、Antのtaskについて述べるときには常にant taskと明示的にいい、単にtaskとしたときはGradleのタスクのことを示すものとします。

6.3. タスク定義のショートカットA shortcut task definition

There is a shorthand way to define a task like our hello task above, which is more concise.

タスク定義は、実際にはもっと短く書けます。先ほどのhelloタスクも、次のように簡潔に書くことができます。

例6.3 タスク定義のショートカット

build.gradle

task hello << {
    println 'Hello world!'
}

Again, this defines a task called hello with a single closure to execute. We will use this task definition style throughout the user guide.

この例も先ほどと同様、実行するクロージャを一つだけもったhelloを定義するものです。このユーザーガイドではこちらの定義方法を使用します。

6.4. ビルドスクリプトはコードですBuild scripts are code

Gradle's build scripts give you the full power of Groovy. As an appetizer, have a look at this:

GradleのビルドスクリプトではGroovyの機能をすべて使うことができます。手始めに次の例をご覧ください。

例6.4 GradleタスクでGroovyを使う

build.gradle

task upper << {
    String someString = 'mY_nAmE'
    println "Original: " + someString 
    println "Upper case: " + someString.toUpperCase()
}

gradle -q upper の出力

> gradle -q upper
Original: mY_nAmE
Upper case: MY_NAME

or

さらに

例6.5 GradleタスクでGroovyを使う

build.gradle

task count << {
    4.times { print "$it " }
}

gradle -q count の出力

> gradle -q count
0 1 2 3

6.5. タスクの依存関係Task dependencies

As you probably have guessed, you can declare tasks that depend on other tasks.

ご想像の通り、タスク間の依存関係を宣言できます。

例6.6 タスク間の依存関係を宣言する

build.gradle

task hello << {
    println 'Hello world!'
}
task intro(dependsOn: hello) << {
    println "I'm Gradle"
}

gradle -q intro の出力

> gradle -q intro
Hello world!
I'm Gradle

To add a dependency, the corresponding task does not need to exist.

依存関係にタスクを追加するときは、そのタスクがその時点で宣言されていなくてもかまいません。

例6.7 遅延評価のdependsOn - タスクがまだ宣言されていない場合

build.gradle

task taskX(dependsOn: 'taskY') << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}

gradle -q taskX の出力

> gradle -q taskX
taskY
taskX

The dependency of taskX to taskY is declared before taskY is defined. This is very important for multi-project builds. Task dependencies are discussed in more detail in 「タスクに依存関係を追加するAdding dependencies to a task.

taskXtaskYに依存していることが宣言されていますが、宣言した時点ではtaskYの定義文はありません。このことは、マルチプロジェクトのビルドで非常に重要になってきます。タスク間の依存関係については、「タスクに依存関係を追加するAdding dependencies to a taskでさらに詳しく述べられています。

Please notice, that you can't use a shortcut notation (see 「略記法Shortcut notations) when referring to a task that is not yet defined.

なお、未定義のタスクを参照する場合、略記法(「略記法Shortcut notations参照)は使えませんので注意してください。

6.6. 動的なタスクDynamic tasks

The power of Groovy can be used for more than defining what a task does. For example, you can also use it to dynamically create tasks.

Groovyが力を発揮するのは、タスクが実行するアクションを記述するときだけではありません。たとえば、次のようにタスクを動的に定義することもできます。

例6.8 動的なタスク定義

build.gradle

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}

gradle -q task1 の出力

> gradle -q task1
I'm task number 1

6.7. 既存のタスクを操作するManipulating existing tasks

Once tasks are created they can be accessed via an API. For instance, you could use this to dynamically add dependencies to a task, at runtime. Ant doesn't allow anything like this.

タスクが公開しているAPIを使えば、既存のタスクにアクセスして定義内容を操作することができます。これはAntと異なるGradleの特長の一つです。たとえば、次のように後からタスクの依存関係を追加することができます。

例6.9 APIからタスクにアクセスする - 依存関係の追加

build.gradle

4.times { counter ->
    task "task$counter" << {
        println "I'm task number $counter"
    }
}
task0.dependsOn task2, task3

gradle -q task0 の出力

> gradle -q task0
I'm task number 2
I'm task number 3
I'm task number 0

Or you can add behavior to an existing task.

また、既存のタスクにアクションを追加することもできます。

例6.10 APIからタスクにアクセスする - アクションの追加

build.gradle

task hello << {
    println 'Hello Earth'
}
hello.doFirst {
    println 'Hello Venus'
}
hello.doLast {
    println 'Hello Mars'
}
hello << {
    println 'Hello Jupiter'
}

gradle -q hello の出力

> gradle -q hello
Hello Venus
Hello Earth
Hello Mars
Hello Jupiter

The calls doFirst and doLast can be executed multiple times. They add an action to the beginning or the end of the task's actions list. When the task executes, the actions in the action list are executed in order. The << operator is simply an alias for doLast.

doFirstdoLastは何回でも呼び出すことができ、既存のタスクが実行する一連のアクションの最初や最後に、新しいアクションを追加します。タスクに追加されたアクションは、タスクが実行されたときに順番に実行されます。<<doLastの単なるエイリアスです。

6.8. 略記法Shortcut notations

As you might have noticed in the previous examples, there is a convenient notation for accessing an existing task. Each task is available as a property of the build script:

先ほどの例をみたとき、おやっと思われたかもしれません。既存のタスクにアクセスするときは、便利な略記法を使うことができます。ただのプロパティとしてすべてのタスクにアクセスできるのです。

例6.11 ビルドスクリプトのプロパティとして既存のタスクにアクセスする

build.gradle

task hello << {
    println 'Hello world!'
}
hello.doLast {
    println "Greetings from the $hello.name task."
}

gradle -q hello の出力

> gradle -q hello
Hello world!
Greetings from the hello task.

This enables very readable code, especially when using the tasks provided by the plugins, like the compile task.

この略記法は、コードをとても読みやすいものにします。特に、プラグインなどで外部から提供されるタスク(たとえばcompile)にアクセスするときには威力を発揮します。

6.9. 拡張タスクプロパティ Extra task properties

You can add your own properties to a task. To add a property named myProperty, set ext.myProperty to an initial value. From that point on, the property can be read and set like a predefined task property.

独自のプロパティをタスクに追加することができます。例えば、myPropertyというプロパティを追加するには、ext.myPropertyに初期値を設定してください。 その時点で、このプロパティを定義済みのプロパティと同じように読み書きできるようになります。

例6.12 拡張プロパティをタスクに追加する

build.gradle

task myTask {
    ext.myProperty = "myValue"
}

task printTaskProperties << {
    println myTask.myProperty
}

gradle -q printTaskProperties の出力

> gradle -q printTaskProperties
myValue

Extra properties aren't limited to tasks. You can read more about them in 「拡張プロパティ Extra properties.

拡張プロパティを追加できるのは、タスクだけではありません。詳細については、「拡張プロパティ Extra propertiesを参照してください。

6.10. Antタスクの使用Using Ant Tasks

Ant tasks are first-class citizens in Gradle. Gradle provides excellent integration for Ant tasks by simply by relying on Groovy. Groovy is shipped with the fantastic AntBuilder. Using Ant tasks from Gradle is as convenient and more powerful than using Ant tasks from a build.xml file. From the example below, you can learn how to execute Ant tasks and how to access Ant properties:

AntのタスクはGradleのファーストクラス・オブジェクトであり、デフォルトで使用できるようになっています。Groovyの持つ機能のおかげで、GradleはAntを非常に高いレベルで統合しています。Groovyには素晴らしきAntBuilderが組み込まれているのです。Antのタスクは、build.xmlで使うよりGradleで使ったほうが便利で強力です。次の例を見てください。Antのタスクを実行する方法やAntのプロパティにアクセスする方法を示しています。

例6.13 AntBuilderを使ってant.loadfileターゲットを実行する

build.gradle

task loadfile << {
    def files = file('../antLoadfileResources').listFiles().sort()
    files.each { File file ->
        if (file.isFile()) {
            ant.loadfile(srcFile: file, property: file.name)
            println " *** $file.name ***"
            println "${ant.properties[file.name]}"
        }
    }
}

gradle -q loadfile の出力

> gradle -q loadfile
*** agile.manifesto.txt ***
Individuals and interactions over processes and tools
Working software over comprehensive documentation
Customer collaboration  over contract negotiation
Responding to change over following a plan
 *** gradle.manifesto.txt ***
Make the impossible possible, make the possible easy and make the easy elegant.
(inspired by Moshe Feldenkrais)

There is lots more you can do with Ant in your build scripts. You can find out more in 17章GradleからAntを使うUsing Ant from Gradle.

Antのタスクを使ってできることはもっとたくさんあります。17章GradleからAntを使うUsing Ant from Gradleをご参照ください。

6.11. メソッドの使用Using methods

Gradle scales in how you can organize your build logic. The first level of organizing your build logic for the example above, is extracting a method.

Gradleでは、段階的にビルドロジックを体系化していくことができます。最初の一歩として、上の例をメソッドの抽出を使ってリファクタリングしてみましょう。

例6.14 メソッドを抽出してビルドロジックを整理する

build.gradle

task checksum << {
    fileList('../antLoadfileResources').each {File file ->
        ant.checksum(file: file, property: "cs_$file.name")
        println "$file.name Checksum: ${ant.properties["cs_$file.name"]}"
    }
}

task loadfile << {
    fileList('../antLoadfileResources').each {File file ->
        ant.loadfile(srcFile: file, property: file.name)
        println "I'm fond of $file.name"
    }
}

File[] fileList(String dir) {
    file(dir).listFiles({file -> file.isFile() } as FileFilter).sort()
}

gradle -q loadfile の出力

> gradle -q loadfile
I'm fond of agile.manifesto.txt
I'm fond of gradle.manifesto.txt

Later you will see that such methods can be shared among subprojects in multi-project builds. If your build logic becomes more complex, Gradle offers you other very convenient ways to organize it. We have devoted a whole chapter to this. See 60章ビルドロジックの体系化Organizing Build Logic.

後でマルチプロジェクトの各プロジェクトでメソッドを共有する方法について学びます。それでもビルドロジックが複雑になってくることもあるでしょう。Gradleでは、ロジックを体系化する便利な方法をいくつも用意しています。ビルドロジックの体系化については一つの章をすべて割り当てて取り扱っていますのでご参照ください。(60章ビルドロジックの体系化Organizing Build Logic)

6.12. デフォルトタスクDefault tasks

Gradle allows you to define one or more default tasks for your build.

Gradleでは、ビルドに一つ以上のデフォルトタスクを定義することができます。

例6.15 デフォルトタスクの定義

build.gradle

defaultTasks 'clean', 'run'

task clean << {
    println 'Default Cleaning!'
}

task run << {
    println 'Default Running!'
}

task other << {
    println "I'm not a default task!"
}

gradle -q の出力

> gradle -q
Default Cleaning!
Default Running!

This is equivalent to running gradle clean run. In a multi-project build every subproject can have its own specific default tasks. If a subproject does not specify default tasks, the default tasks of the parent project are used (if defined).

これは、gradle clean runと入力するのと同じです。マルチプロジェクトのビルドでは、すべてのサブプロジェクトが個別にデフォルトタスクを持つことができます。サブプロジェクトにデフォルトタスクが定義されていない時は、(定義されていれば)親プロジェクトの定義が使用されます。

6.13. DAGによる設定Configure by DAG

As we later describe in full detail (See 56章ビルドのライフサイクルThe Build Lifecycle) Gradle has a configuration phase and an execution phase. After the configuration phase, Gradle knows all tasks that should be executed. Gradle offers you a hook to make use of this information. A use-case for this would be to check if the release task is among the tasks to be executed. Depending on this, you can assign different values to some variables.

詳しくは56章ビルドのライフサイクルThe Build Lifecycleで説明しますが、Gradleのビルドはいくつかのフェーズに分かれて実行されます。Gradleはどのタスクを実行するのかを設定フェーズで決定しますが、この情報を使うためのフックが提供されています。実行タスクにあるタスクが含まれるかどうかによって、変数に別の値を割り当てたりできるわけです。ユースケースとしては、releaseタスクが実行されるタスクに入っているかどうかチェックするといったものが考えられるでしょう。

In the following example, execution of the distribution and release tasks results in different value of the version variable.

次の例では、distributionタスクを実行するかreleaseタスクを実行するかでversion変数に違う値を割り当てています。

例6.16 選択したタスクによって異なる結果を得る

build.gradle

task distribution << {
    println "We build the zip with version=$version"
}

task release(dependsOn: 'distribution') << {
    println 'We release now'
}

gradle.taskGraph.whenReady {taskGraph ->
    if (taskGraph.hasTask(release)) {
        version = '1.0'
    } else {
        version = '1.0-SNAPSHOT'
    }
}

gradle -q distribution の出力

> gradle -q distribution
We build the zip with version=1.0-SNAPSHOT

gradle -q release の出力

> gradle -q release
We build the zip with version=1.0
We release now

The important thing is that whenReady affects the release task before the release task is executed. This works even when the release task is not the primary task (i.e., the task passed to the gradle command).

ここで大事なことは、releaseタスクが実行予定にあるという事実を、releaseタスクが実行される前に利用できる点です。releaseタスクがプライマリタスク、つまりgradleコマンドに引き渡されているタスクでなくてもかまいません。

6.14. 次のステップは?Where to next?

In this chapter, we have had a first look at tasks. But this is not the end of the story for tasks. If you want to jump into more of the details, have a look at 15章タスク詳解More about Tasks.

この章で、私たちは初めてタスクというものに触れました。しかし、タスクについての話はこれで全部ではありません。さらに詳しくタスクについて知りたい場合は、15章タスク詳解More about Tasksを見てみてください。

Otherwise, continue on to the tutorials in 7章JavaクイックスタートJava Quickstart and 8章依存関係管理の基本 Dependency Management Basics.

そうでなければ、7章JavaクイックスタートJava Quickstart8章依存関係管理の基本 Dependency Management Basicsに進み、チュートリアルを続けてください。


[3] There are command line switches to change this behavior. See 付録D Gradle コマンドラインGradle Command Line)

[4] この動作はコマンドラインスイッチを使用して変更できます。付録D Gradle コマンドラインGradle Command Lineを参照してください。

第7章 JavaクイックスタートJava Quickstart

7.1. JavaプラグインThe Java plugin

As we have seen, Gradle is a general-purpose build tool. It can build pretty much anything you care to implement in your build script. Out-of-the-box, however, it doesn't build anything unless you add code to your build script to do so.

ここまで見てきたように、Gradleは汎用のビルドツールです。ビルドスクリプトで実装したいと思うようなものはほぼ何でもビルドできます。しかし、初期状態では、ビルドスクリプトに何かを行うためのコードを追加しない限り、何もビルドはしません。

Most Java projects are pretty similar as far as the basics go: you need to compile your Java source files, run some unit tests, and create a JAR file containing your classes. It would be nice if you didn't have to code all this up for every project. Luckily, you don't have to. Gradle solves this problem through the use of plugins. A plugin is an extension to Gradle which configures your project in some way, typically by adding some pre-configured tasks which together do something useful. Gradle ships with a number of plugins, and you can easily write your own and share them with others. One such plugin is the Java plugin. This plugin adds some tasks to your project which will compile and unit test your Java source code, and bundle it into a JAR file.

多くのJavaプロジェクトは、基本的な部分では非常に似通っています。つまり、Javaソースファイルをコンパイルし、ユニットテストを実行し、クラスを含んだJARファイルを生成する必要があります。すべてのプロジェクトで、これらをいちいちコーディングするのは面倒です。幸運にもその必要はありません。Gradleはプラグインによってこの問題を解決します。プラグインは、何らかの方法(よくあるのは設定済みの一連の有用なタスクの追加)によってプロジェクトを構成する、Gradleの拡張です。Gradleには多くのプラグインが同梱されており、さらに自作のプラグインを書き、共有することも簡単にできます。こういったプラグインの一つがJavaプラグインです。このプラグインは、Javaソースコードのコンパイルやユニットテスト、JARファイルの作成などを行うタスクをプロジェクトに追加します。

The Java plugin is convention based. This means that the plugin defines default values for many aspects of the project, such as where the Java source files are located. If you follow the convention in your project, you generally don't need to do much in your build script to get a useful build. Gradle allows you to customize your project if you don't want to or cannot follow the convention in some way. In fact, because support for Java projects is implemented as a plugin, you don't have to use the plugin at all to build a Java project, if you don't want to.

Javaプラグインは規約ベースです。すなわち、このプラグインはプロジェクトのさまざまな点、例えばJavaソースファイルを置く場所などについてデフォルト値を定義しています。プロジェクトがこの規約に従う限り、大抵はビルドスクリプトであまり多くのことを行わなくても有用なビルドを行うことができます。何らかの事情で規約に従いたくない、または従えない場合、Gradleはプロジェクトのカスタマイズも許しています。実際、Javaプロジェクトのサポートがプラグインとして実現されているので、希望しない場合には、Javaプロジェクトのビルドであってもこのプラグインをまったく使わないことも可能です。

We have in-depth coverage with many examples about the Java plugin, dependency management and multi-project builds in later chapters. In this chapter we want to give you an initial idea of how to use the Java plugin to build a Java project.

Javaプラグイン、依存関係の管理、マルチプロジェクトのビルドについては、後の章で多くの実例付きで詳しく扱います。この章では、JavaプロジェクトをビルドするためのJavaプラグインの使い方について、まず基本的な知識を提供したいと思います。

7.2. 基本的なJavaプロジェクトA basic Java project

Let's look at a simple example. To use the Java plugin, add the following to your build file:

シンプルな例から見ていきましょう。Javaプラグインを使うためには、ビルドファイルに以下を加えます:

例7.1 Javaプラグインの使用

build.gradle

apply plugin: 'java'

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/java/quickstart


This is all you need to define a Java project. This will apply the Java plugin to your project, which adds a number of tasks to your project.

Javaプロジェクトの定義に必要なのはこれだけです。これでプロジェクトにJavaプラグインが適用され、多くのタスクが追加されます。

どんなタスクが利用可能?What tasks are available?

You can use gradle tasks to list the tasks of a project. This will let you see the tasks that the Java plugin has added to your project.

gradle tasksを使えば、プロジェクトのタスクを一覧することができます。これによって、Javaプラグインがプロジェクトに追加したタスクを見ることができるでしょう。

Gradle expects to find your production source code under src/main/java and your test source code under src/test/java. In addition, any files under src/main/resources will be included in the JAR file as resources, and any files under src/test/resources will be included in the classpath used to run the tests. All output files are created under the build directory, with the JAR file ending up in the build/libs directory.

Gradleは、製品のソースコードがsrc/main/javaに、テストのソースコードがsrc/test/javaにあることを想定しています。さらに、src/main/resourcesの下にあるファイルはすべてリソースとしてJARに入れられ、またsrc/test/resourcesにあるファイルはテスト実行時に使われるクラスパスに入れられます。すべての出力ファイルはbuildディレクトリの下に作られ、最終的にbuild/libsディレクトリにJARファイルが作られます。

7.2.1. プロジェクトのビルドBuilding the project

The Java plugin adds quite a few tasks to your project. However, there are only a handful of tasks that you will need to use to build the project. The most commonly used task is the build task, which does a full build of the project. When you run gradle build, Gradle will compile and test your code, and create a JAR file containing your main classes and resources:

Javaプラグインはかなり多くのタスクをプロジェクトに追加します。しかし、プロジェクトをビルドするのに必要なタスクはほんの一握りです。最もよく使われるのはプロジェクトのフルビルドを行うbuildタスクです。gradle buildを実行すると、Gradleはコードをコンパイルしてテストし、メインクラスやリソースを含んだJARファイルを生成します:

例7.2 Javaプロジェクトのビルド

gradle build の出力

> gradle build
:compileJava
:processResources
:classes
:jar
:assemble
:compileTestJava
:processTestResources
:testClasses
:test
:check
:build

BUILD SUCCESSFUL

Total time: 1 secs

Some other useful tasks are:

他にも便利なタスクがあります:

clean

Deletes the build directory, removing all built files.

buildディレクトリを削除し、ビルドしたすべてのファイルを削除します。

assemble

Compiles and jars your code, but does not run the unit tests. Other plugins add more artifacts to this task. For example, if you use the War plugin, this task will also build the WAR file for your project.

コードをコンパイルしJARを生成しますが、ユニットテストは実行しません。他のプラグインはこのタスクにより多くのアーティファクトを追加します。例えばWarプラグインを使う場合、このタスクはプロジェクトのWARファイルも生成します。

check

Compiles and tests your code. Other plugins add more checks to this task. For example, if you use the checkstyle plugin, this task will also run Checkstyle against your source code.

コードをコンパイルし、テストします。他のプラグインはこのタスクにより多くの検査項目を追加します。例えばCode-qualityプラグインを使う場合、このタスクはソースコードに対してCheckstyleも実行します。

7.2.2. External dependencies

Usually, a Java project will have some dependencies on external JAR files. To reference these JAR files in the project, you need to tell Gradle where to find them. In Gradle, artifacts such as JAR files, are located in a repository. A repository can be used for fetching the dependencies of a project, or for publishing the artifacts of a project, or both. For this example, we will use the public Maven repository:

Javaプロジェクトは外部のJARファイルに依存することが普通です。プロジェクトで使うこういったJARファイルを参照するため、Gradleにそれらの場所を伝える必要があります。Gradleでは、JARファイルのようなアーティファクトはリポジトリに置かれます。リポジトリは、プロジェクトが依存するものを取得したり、プロジェクトのアーティファクトを公開したり、あるいはその両方のために利用することができます。この例では、公開Mavenリポジトリを使います:

例7.3 Mavenリポジトリの追加

build.gradle

repositories {
    mavenCentral()
}

Let's add some dependencies. Here, we will declare that our production classes have a compile-time dependency on commons collections, and that our test classes have a compile-time dependency on junit:

依存関係をいくつか追加してみましょう。製品クラスはコンパイル時にcommonsコレクションに依存し、テストクラスはコンパイル時にjunitに依存することを宣言します:

例7.4 依存関係の追加

build.gradle

dependencies {
    compile group: 'commons-collections', name: 'commons-collections', version: '3.2'
    testCompile group: 'junit', name: 'junit', version: '4.+'
}

You can find out more in 8章依存関係管理の基本 Dependency Management Basics.

詳しい説明は51章依存関係の管理 Dependency Managementをご覧ください。

7.2.3. プロジェクトのカスタマイズCustomizing the project

The Java plugin adds a number of properties to your project. These properties have default values which are usually sufficient to get started. It's easy to change these values if they don't suit. Let's look at this for our sample. Here we will specify the version number for our Java project, along with the Java version our source is written in. We also add some attributes to the JAR manifest.

Javaプラグインは多くのプロパティをプロジェクトに追加します。こういったプロパティには普通、十分適切なデフォルト値が設定されています。不適切な場合、これらの値を変更するのは簡単です。では、実例を見てみましょう。ここでは、ソースの書かれたJavaバージョンとともに、Javaプロジェクトのバージョン番号を指定しています。また、JAR manifestにいくつか属性を追加しています。

例7.5 MANIFEST.MFのカスタマイズ

build.gradle

sourceCompatibility = 1.5
version = '1.0'
jar {
    manifest {
        attributes 'Implementation-Title': 'Gradle Quickstart',
                   'Implementation-Version': version
    }
}

どんなプロパティが利用可能?What properties are available?

You can use gradle properties to list the properties of a project. This will allow you to see the properties added by the Java plugin, and their default values.

gradle propertiesを使えば、プロジェクトのプロパティを一覧することができます。これによって、Javaプラグインが追加したプロパティとそのデフォルト値を見ることができるでしょう。

The tasks which the Java plugin adds are regular tasks, exactly the same as if they were declared in the build file. This means you can use any of the mechanisms shown in earlier chapters to customize these tasks. For example, you can set the properties of a task, add behaviour to a task, change the dependencies of a task, or replace a task entirely. In our sample, we will configure the test task, which is of type Test, to add a system property when the tests are executed:

Javaプラグインが追加するタスクはごく普通のタスクで、ビルドファイルで宣言されるものとまったく同等のものです。つまり、これらのタスクは、ここまでの章で説明したあらゆるメカニズムを使ってカスタマイズすることが可能だということです。例えば、タスクのプロパティを設定したり、タスクに振る舞いを追加したり、タスクの依存関係を変更したり、あるはタスク全体を完全に置き換えることすら可能です。以下の例では、Test型であるtestタスクを設定して、テスト実行時のシステムプロパティを追加しています:

例7.6 テスト用システムプロパティの追加

build.gradle

test {
    systemProperties 'property': 'value'
}

7.2.4. JARファイルの公開Publishing the JAR file

Usually the JAR file needs to be published somewhere. To do this, you need to tell Gradle where to publish the JAR file. In Gradle, artifacts such as JAR files are published to repositories. In our sample, we will publish to a local directory. You can also publish to a remote location, or multiple locations.

通常は、JARファイルをどこかに公開する必要があるでしょう。このため、GradleにJARファイルの公開先を教える必要があります。Gradleでは、JARファイルのようなアーティファクトはリポジトリに置かれます。以下の例ではローカルディレクトリに公開します。リモートな場所や、複数の場所に公開することも可能です。

例7.7 JARファイルの公開

build.gradle

uploadArchives {
    repositories {
       flatDir {
           dirs 'repos'
       }
    }
}

To publish the JAR file, run gradle uploadArchives.

JARファイルを公開するには、gradle uploadArchivesを実行してください。

7.2.5. Eclipseプロジェクトの作成Creating an Eclipse project

To create the Eclipse-specific descriptor files, like .project, you need to add another plugin to your build file:

.projectのようなEclipse固有の設定ファイルを生成するには、別のプラグインをビルドファイルに追加する必要があります:

例7.8 Eclipseプラグイン

build.gradle

apply plugin: 'eclipse'

Now execute gradle eclipse command to generate Eclipse project files. More information about the eclipse task can be found in 38章Eclipse プラグインThe Eclipse Plugin.

これでgradle eclipseコマンドを実行すればEclipseのプロジェクトファイルが生成されます。Eclipseタスクの詳細は38章Eclipse プラグインThe Eclipse Pluginをご覧ください。

7.2.6. まとめSummary

Here's the complete build file for our sample:

これまでの例の完全なビルドファイルを以下に示します:

例7.9 Javaの例 - 完全なビルドファイル

build.gradle

apply plugin: 'java'
apply plugin: 'eclipse'

sourceCompatibility = 1.5
version = '1.0'
jar {
    manifest {
        attributes 'Implementation-Title': 'Gradle Quickstart',
                   'Implementation-Version': version
    }
}

repositories {
    mavenCentral()
}

dependencies {
    compile group: 'commons-collections', name: 'commons-collections', version: '3.2'
    testCompile group: 'junit', name: 'junit', version: '4.+'
}

test {
    systemProperties 'property': 'value'
}

uploadArchives {
    repositories {
       flatDir {
           dirs 'repos'
       }
    }
}

7.3. マルチプロジェクトのJavaビルドMulti-project Java build

Now let's look at a typical multi-project build. Below is the layout for the project:

さて、ここで典型的なマルチプロジェクトのビルドを見てみましょう。プロジェクトのレイアウトは以下の通りです:

例7.10 マルチプロジェクトビルド - 階層レイアウト

Build layout

multiproject/
  api/
  services/webservice/
  shared/
  services/shared/

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/java/multiproject


Here we have four projects. Project api produces a JAR file which is shipped to the client to provide them a Java client for your XML webservice. Project webservice is a webapp which returns XML. Project shared contains code used both by api and webservice. Project services/shared has code that depends on the shared project.

この例には三つのプロジェクトがあります。プロジェクトapiは、このwebサービス用のJavaクライアントを提供するために顧客に出荷されるJARファイルを生成します。プロジェクトwebserviceはXMLを返すwebアプリケーションです。プロジェクトsharedは、apiwebserviceの両方で使われる共通コードです。

7.3.1. マルチプロジェクトビルドの定義Defining a multi-project build

To define a multi-project build, you need to create a settings file. The settings file lives in the root directory of the source tree, and specifies which projects to include in the build. It must be called settings.gradle. For this example, we are using a simple hierarchical layout. Here is the corresponding settings file:

マルチプロジェクトのビルドを定義するためには、settingsファイルを作成する必要があります。settingsファイルはソースツリーのルートディレクトリに置かれ、このビルドにどのプロジェクトが含まれるかを指定します。名前はsettings.gradleでなければなりません。この例では、シンプルな階層レイアウトを使っています。対応するsettingsファイルは以下のようになります:

例7.11 マルチプロジェクトビルド - settings.gradleファイル

settings.gradle

include "shared", "api", "services:webservice", "services:shared"

You can find out more about the settings file in 57章マルチプロジェクトのビルドMulti-project Builds.

settingsファイルの詳細は57章マルチプロジェクトのビルドMulti-project Buildsをご覧ください。

7.3.2. 共通設定Common configuration

For most multi-project builds, there is some configuration which is common to all projects. In our sample, we will define this common configuration in the root project, using a technique called configuration injection. Here, the root project is like a container and the subprojects method iterates over the elements of this container - the projects in this instance - and injects the specified configuration. This way we can easily define the manifest content for all archives, and some common dependencies:

大抵のマルチプロジェクトビルドでは、すべてのプロジェクトに共通な設定があります。この例では、設定のインジェクションと呼ばれる技法を使い、こういった共通設定をルートプロジェクトで定義します。ここでは、ルートプロジェクトはコンテナのようなもので、subprojectsメソッドはコンテナの全要素、すなわちこの実例の中の全プロジェクト、に対して反復しつつ指定された設定をインジェクトします。このようにして、全アーカイブのmanifestコンテンツや共通の依存関係を簡単に定義できます:

例7.12 マルチプロジェクトビルド - 共通設定

build.gradle

subprojects {
    apply plugin: 'java'
    apply plugin: 'eclipse-wtp'

    repositories {
       mavenCentral()
    }

    dependencies {
        testCompile 'junit:junit:4.11'
    }

    version = '1.0'

    jar {
        manifest.attributes provider: 'gradle'
    }
}

Notice that our sample applies the Java plugin to each subproject. This means the tasks and configuration properties we have seen in the previous section are available in each subproject. So, you can compile, test, and JAR all the projects by running gradle build from the root project directory.

この例で、各サブプロジェクトにJavaプラグインが適用されていることに注意してください。 これは、前の節で述べたタスクや設定プロパティが各サブプロジェクトでも利用可能であることを意味しています。 そんなわけで、ルートプロジェクトディレクトリからgradle buildを実行することによって、 すべてのプロジェクトをコンパイルし、テストし、JARを生成できるのです。

Also note that these plugins are only applied within the subprojects section, not at the root level, so the root build will not expect to find Java source files in the root project, only in the subprojects.

7.3.3. プロジェクト間の依存関係Dependencies between projects

You can add dependencies between projects in the same build, so that, for example, the JAR file of one project is used to compile another project. In the api build file we will add a dependency on the shared project. Due to this dependency, Gradle will ensure that project shared always gets built before project api.

同じビルド内のプロジェクト間の依存関係を追加することもできます。したがって例えば、一つのプロジェクトのJARファイルを別のプロジェクトのコンパイルのために利用することもできます。ここでは、apiのビルドファイルにsharedプロジェクトが作るJARへの依存関係を追加します。この依存関係のため、Gradleはsharedプロジェクトがapiプロジェクトより前にビルドされることを確実にします。

例7.13 マルチプロジェクトビルド - プロジェクト間の依存関係

api/build.gradle

dependencies {
    compile project(':shared')
}

See 「依存プロジェクトをビルドしないようにするDisabling the build of dependency projects for how to disable this functionality.

この機能を無効にする方法については「依存プロジェクトをビルドしないようにするDisabling the build of dependency projectsを参照してください。

7.3.4. 配布物の作成Creating a distribution

We also add a distribution, that gets shipped to the client:

顧客に出荷する配布物も追加しておきましょう:

例7.14 マルチプロジェクトビルド - 配布ファイル

api/build.gradle

task dist(type: Zip) {
    dependsOn spiJar
    from 'src/dist'
    into('libs') {
        from spiJar.archivePath
        from configurations.runtime
    }
}

artifacts {
   archives dist
}

7.4. 次のステップは?Where to next?

In this chapter, you have seen how to do some of the things you commonly need to build a Java based project. This chapter is not exhaustive, and there are many other things you can do with Java projects in Gradle. You can find out more about the Java plugin in 23章JavaプラグインThe Java Plugin, and you can find more sample Java projects in the samples/java directory in the Gradle distribution.

この章では、Javaベースのプロジェクトをビルドするときに、一般的に必要になる作業のやり方を見てきました。この章は、Javaプロジェクトについて完全に網羅しているわけではありません。Gradleでできることはもっとたくさんあります。Javaプロジェクトについて更に掘り下げたい場合は、23章JavaプラグインThe Java Pluginで詳しく知ることができます。また、Gradleの配布物に含まれるsample/javaにはもっと多くのサンプルがあります。

Otherwise, continue on to 8章依存関係管理の基本 Dependency Management Basics.

そうでない場合は、続けて8章依存関係管理の基本 Dependency Management Basicsに進んでください。

第8章 依存関係管理の基本 Dependency Management Basics

This chapter introduces some of the basics of dependency management in Gradle.

本章では、Gradleにおける依存関係の管理について、基本的なところを紹介します。

8.1. 依存関係の管理とは What is dependency management?

Very roughly, dependency management is made up of two pieces. Firstly, Gradle needs to know about the things that your project needs to build or run, in order to find them. We call these incoming files the dependencies of the project. Secondly, Gradle needs to build and upload the things that your project produces. We call these outgoing files the publications of the project. Let's look at these two pieces in more detail:

おおざっぱに言って、依存関係の管理とは二つの部分に分けられます。まず、Gradleは、あなたのプロジェクトをビルドしたり実行したりするのに必要なファイルが何かを判定し、それらを見つけてこなければなりません。これらの入力ファイルを、プロジェクトの依存関係と呼びます。 次に、Gradleはあなたのプロジェクトをビルドし、生成されたものをアップロードする必要があります。これらの出力ファイルを、プロジェクトの公開物と呼びます。

Most projects are not completely self-contained. They need files built by other projects in order to be compiled or tested and so on. For example, in order to use Hibernate in my project, I need to include some Hibernate jars in the classpath when I compile my source. To run my tests, I might also need to include some additional jars in the test classpath, such as a particular JDBC driver or the Ehcache jars.

ほとんどのプロジェクトは、完全に自己完結しているわけではありません。コンパイル、テスト、その他諸々のために、他のプロジェクトがビルドするファイルを必要とするものです。例えば、Hibernateを自分のプロジェクトで使うために、ソースコードのコンパイル時にHibernateのjarファイルをいくつか取り込む、といった具合です。テストをするためには、さらにいくつかのjarファイル、JDBCドライバやEhcacheのjarをテスト時クラスパスに追加する必要があるかもしれません。

These incoming files form the dependencies of the project. Gradle allows you to tell it what the dependencies of your project are, so that it can take care of finding these dependencies, and making them available in your build. The dependencies might need to be downloaded from a remote Maven or Ivy repository, or located in a local directory, or may need to be built by another project in the same multi-project build. We call this process dependency resolution.

これらの入力ファイルは、プロジェクトの依存関係から読み込まれます。 Gradleにプロジェクトの依存関係を教えて、プロジェクトが依存しているファイルを見つけたり、ビルド時にそれらを使えるようにできます。 依存ファイルは、リモートのMavenやIvyのリポジトリからダウンロードされるかもしれませんし、ローカルのディレクトリにあるかもしれません。また、マルチプロジェクトの場合、別のプロジェクトにビルドさせる必要があることもあります。

Note that this feature provides a major advantage over Ant. With Ant, you only have the ability to specify absolute or relative paths to specific jars to load. With Gradle, you simply declare the “names” of your dependencies, and other layers determine where to get those dependencies from. You can get similar behavior from Ant by adding Apache Ivy, but Gradle does it better.

Often, the dependencies of a project will themselves have dependencies. For example, Hibernate core requires several other libraries to be present on the classpath with it runs. So, when Gradle runs the tests for your project, it also needs to find these dependencies and make them available. We call these transitive dependencies.

また、依存しているファイルが、それ自身の依存関係を持っていることが多々あります。例えば、Hibernateコアは、実行時にいくつかの別のライブラリをクラスパスに含めなければなりません。なので、Gradleがあなたのプロジェクトのテストを走らせるときには、それらの依存関係も見つけてきて、使用できるようにしなければならないのです。これを、推移的な依存関係と呼びます。

The main purpose of most projects is to build some files that are to be used outside the project. For example, if your project produces a Java library, you need to build a jar, and maybe a source jar and some documentation, and publish them somewhere.

ほとんどのプロジェクトは、ファイルを作成し、それらをプロジェクトの外部で使うということを主な目的としています。 例えば、もしあなたのプロジェクトがJavaライブラリを作成するものならば、あなたはjarを作成し、ときにはソースjarやドキュメントも作成し、どこかにそれらを公開しなければなりません。

These outgoing files form the publications of the project. Gradle also takes care of this important work for you. You declare the publications of your project, and Gradle take care of building them and publishing them somewhere. Exactly what “publishing” means depends on what you want to do. You might want to copy the files to a local directory, or upload them to a remote Maven or Ivy repository. Or you might use the files in another project in the same multi-project build. We call this process publication.

ファイルの公開は、プロジェクトの公開設定から読み込まれて行われます。Gradleは、この重要な仕事も引き受けてくれます。プロジェクトが公開するファイルを宣言すれば、Gradleがそれらをビルドし、任意の場所へ公開します。 「公開する」ということの正確な意味は、何をしたいのかによって異なります。ローカルディレクトリにファイルをコピーしたいかもしれませんし、リモートのMavenやIvyのリポジトリにアップロードしたいかもしれません。また、マルチプロジェクトの場合、別プロジェクトからそのファイルを使いたいという場合もあります。 これらの処理を、公開と呼んでいます。

8.2. 依存関係の宣言 Declaring your dependencies

Let's look at some dependency declarations. Here's a basic build script:

さて、では依存関係の宣言についていくつか見ていきましょう。ここに、ある基本的なビルドスクリプトがあります。

例8.1 依存関係の宣言

build.gradle

apply plugin: 'java'

repositories {
    mavenCentral()
}

dependencies {
    compile group: 'org.hibernate', name: 'hibernate-core', version: '3.6.7.Final'
    testCompile group: 'junit', name: 'junit', version: '4.+'
}

What's going on here? This build script says a few things about the project. Firstly, it states that Hibernate core 3.6.7.Final is required to compile the project's production source. By implication, Hibernate core and its dependencies are also required at runtime. The build script also states that any junit >= 4.0 is required to compile the project's tests. It also tells Gradle to look in the Maven central repository for any dependencies that are required. The following sections go into the details.

一体、何が起きるでしょうか。このビルドスクリプトにはそれほど多くの情報はありません。まず、このプロジェクトはソースコードをコンパイルするためにHibernate core 3.6.7を使用すると言っています。それはすなわち、実行時にHibernate coreとその依存関係が必要になるということでもあります。 このスクリプトはまた、バージョン4.0以上のJUnitのどれかを、プロジェクトのテストをコンパイルするのに必要とするとも言っています。さらに、Gradleに、全ての依存関係を見つけるのにMavenのセントラルリポジトリを探すように指示しています。次の節で、それぞれの詳細について見ていきましょう。

8.3. 依存関係のコンフィグレーション Dependency configurations

In Gradle dependencies are grouped into configurations. A configuration is simply a named set of dependencies. We will refer to them as dependency configurations. You can use them to declare the external dependencies of your project. As we will see later, they are also used to declare the publications of your project.

Gradleでは、依存関係は、コンフィグレーションによってグループ化されます。コンフィグレーションとは、単なる名前の付いた依存関係の集まりです。コンフィグレーションは依存関係設定として参照されます。プロジェクトが外部に依存しているものを宣言するのに使われ、また後で見るように、プロジェクトが外部に公開するものを宣言するためにも使用されます。

The Java plugin defines a number of standard configurations. These configurations represent the classpaths that the Java plugin uses. Some are listed below, and you can find more details in 表23.5「Javaプラグイン - 依存関係のコンフィギュレーションJava plugin - dependency configurations.

Javaプラグインは、いくつかの標準コンフィグレーションを定義します。これらのコンフィグレーションは、Javaプラグインが使用するクラスパスを表すものです。いくつかを以下にリストしました。詳細については、表23.5「Javaプラグイン - 依存関係のコンフィギュレーションJava plugin - dependency configurationsを参照してください。

compile

The dependencies required to compile the production source of the project.

プロジェクトのプロダクトコードをコンパイルするのに必要な依存関係

runtime

The dependencies required by the production classes at runtime. By default, also includes the compile time dependencies.

プロダクトのクラスを実行するときに必要になる依存関係。デフォルトで、コンパイル時の依存関係もここに含まれる。

testCompile

The dependencies required to compile the test source of the project. By default, also includes the compiled production classes and the compile time dependencies.

プロジェクトのテストコードをコンパイルするのに必要な依存関係。デフォルトで、コンパイルされたプロダクトクラスと、コンパイル時の依存関係も含まれる。

testRuntime

The dependencies required to run the tests. By default, also includes the compile, runtime and test compile dependencies.

テストを実行するのに必要な依存関係。デフォルトで、compile、runtime、testCompileの各依存関係もここに含まれる。

Various plugins add further standard configurations. You can also define your own custom configurations to use in your build. Please see 「依存関係のコンフィギュレーション Dependency configurations for the details of defining and customizing dependency configurations.

多くのプラグインが、このような標準コンフィグレーションを追加します。また、自分のビルドに使うためのカスタムコンフィギュレーションを独自に定義することもできます。依存関係のコンフィグレーション定義やカスタマイズの詳細については、「依存関係のコンフィギュレーション Dependency configurationsを参照してください。

8.4. 外部依存関係 External dependencies

There are various types of dependencies that you can declare. One such type is an external dependency. This a dependency on some files built outside the current build, and stored in a repository of some kind, such as Maven central, or a corporate Maven or Ivy repository, or a directory in the local file system.

定義できる依存関係には、さまざまなタイプがあります。そのうちの一つが、外部依存関係です。これは、今のビルドとは別に作られ、MavenセントラルリポジトリやIvyリポジトリ、ローカルファイルシステムなどに保存されているファイルへの依存関係です。

To define an external dependency, you add it to a dependency configuration:

外部依存関係を定義するには、それを依存関係のコンフィグレーションに追加します。

例8.2 外部依存関係の定義

build.gradle

dependencies {
    compile group: 'org.hibernate', name: 'hibernate-core', version: '3.6.7.Final'
}

An external dependency is identified using group, name and version attributes. Depending on which kind of repository you are using, group and version may be optional.

外部依存関係は、group属性、name属性、そしてversion属性を用いて定義します。 使用しているリポジトリの種類によっては、group属性とversion属性はオプショナルになるかもしれません。

The shortcut form for declaring external dependencies looks like “group:name:version”.

There is a shortcut form for declaring external dependencies, which uses a string of the form "group:name:version".

外部依存関係を定義するときは、ショートカット形式を使うこともできます。"group:name:version"という文字列を使う形式です。

例8.3 外部依存関係定義のショートカット形式

build.gradle

dependencies {
    compile 'org.hibernate:hibernate-core:3.6.7.Final'
}

To find out more about defining and working with dependencies, have a look at 「依存関係の定義方法 How to declare your dependencies.

依存関係を定義して取り扱う方法について、詳しくは「依存関係の定義方法 How to declare your dependenciesを見てください。

8.5. リポジトリ Repositories

How does Gradle find the files for external dependencies? Gradle looks for them in a repository. A repository is really just a collection of files, organized by group, name and version. Gradle understands several different repository formats, such as Maven and Ivy, and several different ways of accessing the repository, such as using the local file system or HTTP.

Gradleは、どうやって外部依存関係を見つけるのでしょうか? Gradleは、それらをリポジトリから探します。リポジトリの実体は、ただのファイルの集合です。それらのファイルは、グループ名前、そしてバージョンによって分類されています。Gradleは、MavenやIvyなど、様々なリポジトリ形式に対応できます。また、ローカルファイルシステムやHTTPなど、リポジトリにアクセスするための手段についても様々なものを使うことができます。

By default, Gradle does not define any repositories. You need to define at least one before you can use external dependencies. One option is use the Maven central repository:

デフォルトでは、Gradleはリポジトリを一切定義していません。外部依存関係を使うには、少なくとも一つのリポジトリを定義する必要があります。 選択肢の一つは、Mavenのセントラルリポジトリを使うことです。

例8.4 Mavenセントラルリポジトリの使用

build.gradle

repositories {
    mavenCentral()
}

Or a remote Maven repository:

または、別のMavenリモートリポジトリを使います。

例8.5 リモートMavenリポジトリの使用

build.gradle

repositories {
    maven {
        url "http://repo.mycompany.com/maven2"
    }
}

Or a remote Ivy repository:

または、リモートのIvyリポジトリを使います。

例8.6 リモートIvyリポジトリの使用

build.gradle

repositories {
    ivy {
        url "http://repo.mycompany.com/repo"
    }
}

You can also have repositories on the local file system. This works for both Maven and Ivy repositories.

さらに、ローカルファイルシステム上にリポジトリを持つこともできます。これは、Maven、Ivy双方のリポジトリ形式で動作します。

例8.7 ローカルのIvyディレクトリを使う

build.gradle

repositories {
    ivy {
        // URL can refer to a local directory
        url "../local-repo"
    }
}

A project can have multiple repositories. Gradle will look for a dependency in each repository in the order they are specified, stopping at the first repository that contains the requested module.

一つのプロジェクトが、複数のリポジトリを持つことができます。Gradleは、それぞれのリポジトリを、指定された順序で順に探しに行きます。要求されたモジュールが含まれる、最初のリポジトリを見つけるまで走査を続けます。

To find out more about defining and working with repositories, have a look at 「リポジトリ Repositories.

リポジトリを定義し、取り扱う方法について、詳しくは「リポジトリ Repositoriesを参照してください。

8.6. アーティファクトの公開 Publishing artifacts

Dependency configurations are also used to publish files.[5] We call these files publication artifacts, or usually just artifacts.

依存関係のコンフィグレーションは、ファイルを公開するのにも使用します。[6] これらのファイルを、公開アーティファクト、大体は単にアーティファクトと呼びます。

The plugins do a pretty good job of defining the artifacts of a project, so you usually don't need to do anything special to tell Gradle what needs to be published. However, you do need to tell Gradle where to publish the artifacts. You do this by attaching repositories to the uploadArchives task. Here's an example of publishing to a remote Ivy repository:

プラグインが非常に適切にプロジェクトのアーティファクトを定義してくれるので、何を公開したいかGradleに教えるのに、特別何かする必要はほとんどの場合ありません。ただ、どこに公開したいかはGradleに教えてやる必要があります。これは、リポジトリをuploadArchivesタスクに結びつけることで行います。次のコードは、リモートのIvyリポジトリに公開する例です。

例8.8 Ivyリポジトリに公開する

build.gradle

uploadArchives {
    repositories {
        ivy {
            credentials {
                username "username"
                password "pw"
            }
            url "http://repo.mycompany.com"
        }
    }
}

Now, when you run gradle uploadArchives, Gradle will build and upload your Jar. Gradle will also generate and upload an ivy.xml as well.

これでgradle uploadArchivesを走らせれば、Gradleがjarをビルドしてアップロードしてくれます。 さらに、ivy.xmlも生成されてアップロードされます。

You can also publish to Maven repositories. The syntax is slightly different.[7] Note that you also need to apply the Maven plugin in order to publish to a Maven repository. when this is in place, Gradle will generate and upload a pom.xml.

Mavenリポジトリに公開することもできますが、その文法はすこし異なります[8]。 また、Mavenリポジトリへ公開するには、Mavenプラグインを使う必要もあるので注意してください。この場合、Gradleはpom.xmlも生成してアップロードします。

例8.9 Mavenリポジトリへの公開

build.gradle

apply plugin: 'maven'

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: "file://localhost/tmp/myRepo/")
        }
    }
}

To find out more about publication, have a look at 52章アーティファクトの公開 Publishing artifacts.

アーティファクトの公開について、詳しくは52章アーティファクトの公開 Publishing artifactsをご参照ください。

8.7. 次のステップは? Where to next?

For all the details of dependency resolution, see 51章依存関係の管理 Dependency Management, and for artifact publication see 52章アーティファクトの公開 Publishing artifacts.

依存関係解決については、51章依存関係の管理 Dependency Managementに全て詳細に載っています。そして、アーティファクトの公開については52章アーティファクトの公開 Publishing artifactsに載っています。

If you are interested in the DSL elements mentioned here, have a look at Project.configurations{}, Project.repositories{} and Project.dependencies{}.

本章で使ったDSLに興味があるのであれば、Project.configurations{}Project.repositories{}Project.dependencies{}を見てください。

Otherwise, continue on to some of the other tutorials.

それ以外の場合は、チュートリアルから他のチュートリアルを進めてください。



[5] We think this is confusing, and we are gradually teasing apart the two concepts in the Gradle DSL.

[6] 私たちは、これは混乱の元になると考えています。そのため、GradleのDSLでは、段階的に二つに概念に分けていくつもりです。

[7] We are working to make the syntax consistent for resolving from and publishing to Maven repositories.

[8] 私たちは、Mavenリポジトリからの取得とMavenリポジトリへの公開を一貫した文法で行えるよう作業しているところです。

第9章 GroovyクイックスタートGroovy Quickstart

To build a Groovy project, you use the Groovy plugin. This plugin extends the Java plugin to add Groovy compilation capabilities to your project. Your project can contain Groovy source code, Java source code, or a mix of the two. In every other respect, a Groovy project is identical to a Java project, which we have already seen in 7章JavaクイックスタートJava Quickstart.

Groovyプロジェクトをビルドするのには、Groovyプラグインを使います。このプラグインはJavaプラグインを拡張して、Groovyのコンパイル能力をプロジェクトに加えます。 プロジェクトはGroovyソースコード、Javaソースコード、またはこれらの両方を含むことができます。これ以外の点では、Groovyプロジェクトは7章JavaクイックスタートJava Quickstartですでに見たJavaプロジェクトを同じです。

9.1. 基本的なGroovyプロジェクトA basic Groovy project

Let's look at an example. To use the Groovy plugin, add the following to your build file:

実例を見てみましょう。Groovyプラグインを使うためには、ビルドファイルに以下を記述を追加します:

例9.1 Groovyプラグイン

build.gradle

apply plugin: 'groovy'

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/groovy/quickstart


This will also apply the Java plugin to the project, if it has not already been applied. The Groovy plugin extends the compile task to look for source files in directory src/main/groovy, and the compileTest task to look for test source files in directory src/test/groovy. The compile tasks use joint compilation for these directories, which means they can contain a mixture of Java and Groovy source files.

これにより、(もしまだなら)プロジェクトにはJavaプラグインも適用されます。Groovyプラグインはcompileタスクを拡張してsrc/main/groovyディレクトリにあるソースファイルも参照するようにし、またcompileTestタスクを拡張してsrc/test/groovyディレクトリにあるテスト用ソースファイルも参照するようにします。compileタスクはこれらのディレクトリに対してジョイントコンパイルを使うので、javaとgroovyのソースファイルが混在していてもかまいません。

To use the Groovy compilation tasks, you must also declare the Groovy version to use and where to find the Groovy libraries. You do this by adding a dependency to the groovy configuration. The compile configuration inherits this dependency, so the Groovy libraries will be included in classpath when compiling Groovy and Java source. For our sample, we will use Groovy 2.2.0 from the public Maven repository:

Groovy用のcompileタスクを使うには、GroovyのバージョンとGroovyライブラリを探してくる場所を宣言する必要があります。これは、compileコンフィギュレーションに依存関係を追加することによって行います。この例では、Groovy 2.2.0を使用します。

例9.2 Dependency on Groovy

build.gradle

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.6'
}

Here is our complete build file:

以下にビルドファイルの全体を示します:

例9.3 Groovy用のビルドファイル(全体)

build.gradle

apply plugin: 'eclipse'
apply plugin: 'groovy'

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.6'
    testCompile 'junit:junit:4.11'
}

Running gradle build will compile, test and JAR your project.

gradle buildを実行すれば、プロジェクトがコンパイル、テストされ、JARが生成されます。

9.2. まとめSummary

This chapter describes a very simple Groovy project. Usually, a real project will require more than this. Because a Groovy project is a Java project, whatever you can do with a Java project, you can also do with a Groovy project.

この章では非常にシンプルなGroovyプロジェクトについて説明しました。通常、実プロジェクトではこの例よりもっと複雑な記述が必要でしょう。GroovyプロジェクトはJavaプロジェクトでもあるので、Javaプロジェクトで可能なことなら何でもGroovyプロジェクトでも可能です。

You can find out more about the Groovy plugin in 24章GroovyプラグインThe Groovy Plugin, and you can find more sample Groovy projects in the samples/groovy directory in the Gradle distribution.

24章GroovyプラグインThe Groovy Pluginでは、Groovyプラグインをより詳しく説明しています。また、Gradle配布物のsamples/groovyディレクトリには、Groovyプロジェクトの実例が多く含まれています。

第10章 WebアプリケーションクイックスタートWeb Application Quickstart

This chapter is a work in progress.

この章は執筆途中です。

This chapter introduces the Gradle support for web applications. Gradle provides two plugins for web application development: the War plugin and the Jetty plugin. The War plugin extends the Java plugin to build a WAR file for your project. The Jetty plugin extends the War plugin to allow you to deploy your web application to an embedded Jetty web container.

この章ではGradleのWebアプリケーションサポートについて紹介します。 GradleはWebアプリケーション開発に対応する2つのプラグイン、WarプラグインとJettyプラグインを提供しています。 WarプラグインはJavaプラグインを拡張して、プロジェクトでWARファイルのビルドができるようにします。 JettyプラグインはWarプラグインを拡張して、組み込みJettyコンテナにWebアプリケーションをデプロイできるようにします。

10.1. WARファイルのビルドBuilding a WAR file

To build a WAR file, you apply the War plugin to your project:

WARファイルをビルドするために、プロジェクトにWarプラグインを適用します:

例10.1 Warプラグイン

build.gradle

apply plugin: 'war'

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/webApplication/quickstart


This also applies the Java plugin to your project. Running gradle build will compile, test and WAR your project. Gradle will look for the source files to include in the WAR file in src/main/webapp. Your compiled classes and their runtime dependencies are also included in the WAR file, in the WEB-INF/classes and WEB-INF/lib directories, respectively.

これにより、プロジェクトにはJavaプラグインも適用されます。 gradle buildを実行すれば、プロジェクトがコンパイル、テストされ、WARが生成されます。 Gradleはsrc/main/webappにあるファイルからWARに含めるものを探します。 コンパイル済みクラスや実行時に必要となる依存ライブラリもWARに追加されます。

Groovy WebアプリケーションGroovy web applications

You can combine multiple plugins in a single project, so you can use the War and Groovy plugins together to build a Groovy based web application. The appropriate Groovy libraries will be added to the WAR file for you.

単一のプロジェクト内で複数のプラグインを組み合わせることができるので、 GroovyベースのWebアプリケーションをビルドするためにWarプラグインとGroovyプラグインを同時に使えます。 その場合、適切なGroovyライブラリがWARファイルに追加されます。

10.2. Webアプリケーションの実行Running your web application

To run your web application, you apply the Jetty plugin to your project:

Webアプリケーションを実行するためには、プロジェクトにJettyプラグインを適用します:

例10.2 JettyプラグインによるWebアプリケーションの実行

build.gradle

apply plugin: 'jetty'

This also applies the War plugin to your project. Running gradle jettyRun will run your web application in an embedded Jetty web container. Running gradle jettyRunWar will build the WAR file, and then run it in an embedded web container.

これにより、プロジェクトにはWarプラグインも適用されます。 gradle jettyRunを実行すれば、組み込みJettyコンテナ上でWebアプリケーションが実行されます。 gradle jettyRunWarを実行するとWARファイルが生成され、その後組み込みWebコンテナで実行されます。

TODO: which url, configure port, uses source files in place and can edit your files and reload.

TODO: URLの確認方法、ポートの設定、ソースファイルの編集と動的リロードの方法など

10.3. まとめSummary

You can find out more about the War plugin in 26章War プラグインThe War Plugin and the Jetty plugin in 28章Jetty プラグインThe Jetty Plugin. You can find more sample Java projects in the samples/webApplication directory in the Gradle distribution.

Warプラグインについての詳細は26章War プラグインThe War Plugin、 Jettyプラグインの詳細については28章Jetty プラグインThe Jetty Pluginを参照してください。 Gradle配布物のsamples/webApplicationディレクトリにサンプルJavaプロジェクトがあります。

第11章 Gradleのコマンドラインを使う Using the Gradle Command-Line

This chapter introduces the basics of the Gradle command-line. You run a build using the gradle command, which you have already seen in action in previous chapters.

本章では、Gradleのコマンドラインについて基本的な部分を紹介します。これまで動かしてきたように、Gradleのビルドはgradleコマンドで実行します。

11.1. 複数のタスクを実行するExecuting multiple tasks

You can execute multiple tasks in a single build by listing each of the tasks on the command-line. For example, the command gradle compile test will execute the compile and test tasks. Gradle will execute the tasks in the order that they are listed on the command-line, and will also execute the dependencies for each task. Each task is executed once only, regardless of how it came to be included in the build: whether it was specified on the command-line, or as a dependency of another task, or both. Let's look at an example.

一回のビルドで、複数のタスクを実行することができます。ビルドを実行するときに、タスクを並べて指定してください。たとえば、gradle compile testというコマンドを実行すれば、compileタスクとtestタスクが実行されます。Gradleはタスクを列挙された順に実行するほか、それらが依存しているタスクも実行します。また、タスクが実行されるのはそれぞれ一度だけです。コマンドラインで明示的に指定されたタスクも、それらに依存して実行されるタスクも、またその両方に含まれるタスクも同様です。次の例を見てください。

Below four tasks are defined. Both dist and test depend on the compile task. Running gradle dist test for this build script results in the compile task being executed only once.

この例では、四つのタスクが定義されており、disttestはどちらもcompileタスクに依存しています。このビルドスクリプトを呼び出してgradle dist testと実行しても、実行された二つのタスクから依存されているcompileタスクは一度だけしか実行されません。

図11.1 Task間の依存関係Task dependencies

Task間の依存関係Task dependencies

例11.1 複数のタスクの実行

build.gradle

task compile << {
    println 'compiling source'
}

task compileTest(dependsOn: compile) << {
    println 'compiling unit tests'
}

task test(dependsOn: [compile, compileTest]) << {
    println 'running unit tests'
}

task dist(dependsOn: [compile, test]) << {
    println 'building the distribution'
}

gradle dist test の出力

> gradle dist test
:compile
compiling source
:compileTest
compiling unit tests
:test
running unit tests
:dist
building the distribution

BUILD SUCCESSFUL

Total time: 1 secs

Each task is executed only once only, so gradle test test is exactly the same as gradle test.

タスクが一度だけ実行されるということは、gradle test testと打ち込んでもgradle testと打ち込んでも、実行される処理は全く同じだということです。

11.2. タスクを除外してビルドするExcluding tasks

You can exclude a task from being executed using the -x command-line option and providing the name of the task to exclude. Let's try this with the sample build file above.

-xオプションでタスクの名前を指定することで、そのタスクを除外してビルドを実行することができます。先ほどのサンプルで試してみましょう。

例11.2 タスクの除外

gradle dist -x test の出力

> gradle dist -x test
:compile
compiling source
:dist
building the distribution

BUILD SUCCESSFUL

Total time: 1 secs

You can see from the output of this example, that the test task is not executed, even though it is a dependency of the dist task. You will also notice that the test task's dependencies, such as compileTest are not executed either. Those dependencies of test that are required by another task, such as compile, are still executed.

distタスクはtestに依存しているのですが、この例ではtestタスクは実行されていないことが分かります。また、testタスクが依存しているタスク、たとえばcompileTestタスクもやはり実行されていません。しかし、testタスクが依存しているタスクのうち、test以外からも依存されているタスク、つまりcompileタスクは実行されているのです。

11.3. エラー発生時にビルドを継続する Continuing the build when a failure occurs

By default, Gradle will abort execution and fail the build as soon as any task fails. This allows the build to complete sooner, but hides other failures that would have occurred. In order to discover as many failures as possible in a single build execution, you can use the --continue option.

デフォルトでは、タスクが失敗するとすぐにGradleは実行を中止してビルドを失敗させます。これはビルドの完了は早くなりますが、発生するかもしれない他のエラーを隠してしまうかもしれません。 一回のビルド実行でできるだけ多くのエラーを発見するには、--continueオプションを使用します。

When executed with --continue, Gradle will execute every task to be executed where all of the dependencies for that task completed without failure, instead of stopping as soon as the first failure is encountered. Each of the encountered failures will be reported at the end of the build.

--continueオプションをつけてビルドすると、エラー発生時に即ビルドが停止されるのではなく、失敗せずに完了したタスクに依存するタスクは全て実行されるようになります。 また、ビルド中に発生したエラーはビルド終了時に全てレポートされます。

If a task fails, any subsequent tasks that were depending on it will not be executed, as it is not safe to do so. For example, tests will not run if there is a compilation failure in the code under test; because the test task will depend on the compilation task (either directly or indirectly).

タスクが失敗した場合、依存関係上の後続タスクは安全に実行できないため行われません。 例えば、テストの際、コードのコンパイルでエラーが発生するとテストは実施されません。テストタスクはコンパイルタスクに直接的、間接的に依存しているからです。

11.4. タスク名の省略Task name abbreviation

When you specify tasks on the command-line, you don't have to provide the full name of the task. You only need to provide enough of the task name to uniquely identify the task. For example, in the sample build above, you can execute task dist by running gradle d:

タスク名をコマンドラインで指定するとき、タスク名をすべて入力する必要はありません。タスク名を一つに決定できるだけの文字を入力すればよいのです。先ほどの例で言えば、gradle dと入力すればdistを実行できます。

例11.3 タスク名の省略

gradle di の出力

> gradle di
:compile
compiling source
:compileTest
compiling unit tests
:test
running unit tests
:dist
building the distribution

BUILD SUCCESSFUL

Total time: 1 secs

You can also abbreviate each word in a camel case task name. For example, you can execute task compileTest by running gradle compTest or even gradle cT

キャメルケースで分割されたそれぞれの単語を省略することもできます。たとえば、compileTestというタスクだと、gradle compTestと入力したり、gradle cTと入力したりすることで実行できます。

例11.4 キャメルケースのタスク名を省略

gradle cT の出力

> gradle cT
:compile
compiling source
:compileTest
compiling unit tests

BUILD SUCCESSFUL

Total time: 1 secs

You can also use these abbreviations with the -x command-line option.

-xオプションで除外タスクを指定するときにも、同じようにタスク名を省略できます。

11.5. ビルドスクリプトを指定して実行するSelecting which build to execute

When you run the gradle command, it looks for a build file in the current directory. You can use the -b option to select another build file. If you use -b option then settings.gradle file is not used. Example:

gradleコマンドは、デフォルトではカレントディレクトリにあるビルドスクリプトを探して実行しますが、-bオプションを使えば別のビルドスクリプトを指定することもできます。次の例を見てください。 なお、-bを使うと、settings.gradleファイルは使用されなくなります。

例11.5 ビルドスクリプトを指定してビルドするプロジェクトを選択する

subdir/myproject.gradle

task hello << {
    println "using build file '$buildFile.name' in '$buildFile.parentFile.name'."
}

gradle -q -b subdir/myproject.gradle hello の出力

> gradle -q -b subdir/myproject.gradle hello
using build file 'myproject.gradle' in 'subdir'.

Alternatively, you can use the -p option to specify the project directory to use. For multi-project builds you should use -p option instead of -b option.

別の方法として、-pオプションを指定して、使用するプロジェクトディレクトリを変更することもできます。 マルチプロジェクトの場合は、-bオプションでなく-pオプションを使用するべきです。

例11.6 プロジェクトディレクトリを使ってプロジェクトを選択する

gradle -q -p subdir hello の出力

> gradle -q -p subdir hello
using build file 'build.gradle' in 'subdir'.

11.6. ビルドに関する情報を取得するObtaining information about your build

Gradle provides several built-in tasks which show particular details of your build. This can be useful for understanding the structure and dependencies of your build, and for debugging problems.

ビルドに関する様々な情報を表示するために、組み込みのタスクがいくつか用意されています。自分の作ったビルドが今どんな構造になっているのか調べたり、何か問題が起こったときにデバッグしたりするのに役立つはずです。

In addition to the built-in tasks shown below, you can also use the project report plugin to add tasks to your project which will generate these reports.

この組み込みタスクに加えて、プロジェクトレポートプラグインというプラグインを使うこともできます。このプラグインは、これらの情報をレポートに保存するタスクをプロジェクトに追加してくれます。

11.6.1. プロジェクトの一覧Listing projects

Running gradle projects gives you a list of the sub-projects of the selected project, displayed in a hierarchy. Here is an example:

gradle projectsを実行すると、指定したプロジェクトのサブプロジェクトを一覧できます。プロジェクトの一覧は階層構造で表示されます。次の例をご覧ください。

例11.7 プロジェクトに関する情報を取得する

gradle -q projects の出力

> gradle -q projects
------------------------------------------------------------
Root project
------------------------------------------------------------

Root project 'projectReports'
+--- Project ':api' - The shared API for the application
\--- Project ':webapp' - The Web application implementation

To see a list of the tasks of a project, run gradle <project-path>:tasks
For example, try running gradle :api:tasks

The report shows the description of each project, if specified. You can provide a description for a project by setting the description property:

このレポートは、プロジェクトに説明書きが添付されている場合、その説明も表示されます。プロジェクトの説明は、プロジェクトのプロパティで設定してください。

例11.8 プロジェクトに説明を添付する

build.gradle

description = 'The shared API for the application'

11.6.2. タスクの一覧Listing tasks

Running gradle tasks gives you a list of the main tasks of the selected project. This report shows the default tasks for the project, if any, and a description for each task. Below is an example of this report:

gradle tasksを実行すると、プロジェクトに設定されているメインタスクの一覧とデフォルトタスクを表示します。さらに、タスクに説明書きが添付されていれば、その説明も表示されます。

例11.9 タスクに関する情報を取得する

gradle -q tasks の出力

> gradle -q tasks
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------

Default tasks: dists

Build tasks
-----------
clean - Deletes the build directory (build)
dists - Builds the distribution
libs - Builds the JAR

Build Setup tasks
-----------------
init - Initializes a new Gradle build. [incubating]
wrapper - Generates Gradle wrapper files. [incubating]

Help tasks
----------
components - Displays the components produced by root project 'projectReports'.
dependencies - Displays all dependencies declared in root project 'projectReports'.
dependencyInsight - Displays the insight into a specific dependency in root project 'projectReports'.
help - Displays a help message.
projects - Displays the sub-projects of root project 'projectReports'.
properties - Displays the properties of root project 'projectReports'.
tasks - Displays the tasks runnable from root project 'projectReports' (some of the displayed tasks may belong to subprojects).

To see all tasks and more detail, run with --all.

By default, this report shows only those tasks which have been assigned to a task group. You can do this by setting the group property for the task. You can also set the description property, to provide a description to be included in the report.

デフォルトでは、このレポートは何らかのタスクグループに属しているタスクしか表示されません。タスクのgroupプロパティを設定することでタスクにグループを割り当てることができます。また、このレポートでタスクに関する説明書きを表示させるには、タスクのdescriptionプロパティに説明書きを設定してください。

例11.10 タスクレポートの内容を変更する

build.gradle

dists {
    description = 'Builds the distribution'
    group = 'build'
}

You can obtain more information in the task listing using the --all option. With this option, the task report lists all tasks in the project, grouped by main task, and the dependencies for each task. Here is an example:

--allオプションを追加すると、タスクリストについてもっと多くの情報を取得できます。プロジェクトにあるすべてのメインタスクとタスク間の依存関係が表示されます。次の表示例をご覧ください。

例11.11 タスクに関してもっと多くの情報を取得する

gradle -q tasks --all の出力

> gradle -q tasks --all
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------

Default tasks: dists

Build tasks
-----------
clean - Deletes the build directory (build)
api:clean - Deletes the build directory (build)
webapp:clean - Deletes the build directory (build)
dists - Builds the distribution [api:libs, webapp:libs]
    docs - Builds the documentation
api:libs - Builds the JAR
    api:compile - Compiles the source files
webapp:libs - Builds the JAR [api:libs]
    webapp:compile - Compiles the source files

Build Setup tasks
-----------------
init - Initializes a new Gradle build. [incubating]
wrapper - Generates Gradle wrapper files. [incubating]

Help tasks
----------
components - Displays the components produced by root project 'projectReports'.
api:components - Displays the components produced by project ':api'.
webapp:components - Displays the components produced by project ':webapp'.
dependencies - Displays all dependencies declared in root project 'projectReports'.
api:dependencies - Displays all dependencies declared in project ':api'.
webapp:dependencies - Displays all dependencies declared in project ':webapp'.
dependencyInsight - Displays the insight into a specific dependency in root project 'projectReports'.
api:dependencyInsight - Displays the insight into a specific dependency in project ':api'.
webapp:dependencyInsight - Displays the insight into a specific dependency in project ':webapp'.
help - Displays a help message.
api:help - Displays a help message.
webapp:help - Displays a help message.
projects - Displays the sub-projects of root project 'projectReports'.
api:projects - Displays the sub-projects of project ':api'.
webapp:projects - Displays the sub-projects of project ':webapp'.
properties - Displays the properties of root project 'projectReports'.
api:properties - Displays the properties of project ':api'.
webapp:properties - Displays the properties of project ':webapp'.
tasks - Displays the tasks runnable from root project 'projectReports' (some of the displayed tasks may belong to subprojects).
api:tasks - Displays the tasks runnable from project ':api'.
webapp:tasks - Displays the tasks runnable from project ':webapp'.

11.6.3. タスクの使い方を詳しく表示する Show task usage details

Running gradle help --task someTask gives you detailed information about a specific task or multiple tasks matching the given task name in your multiproject build. Below is an example of this detailed information:

gradle help --task someTaskを実行すると、ある特定のタスク、マルチプロジェクトの場合は指定した名前にマッチする全てのタスクについての詳細な情報が表示されます。 表示される情報の例は以下の通りです。

例11.12 タスクについて詳細なヘルプ情報を取得する

gradle -q help --task libs の出力

> gradle -q help --task libs
Detailed task information for libs

Paths
     :api:libs
     :webapp:libs

Type
     Task (org.gradle.api.Task)

Description
     Builds the JAR

This information includes the full task path, the task type, possible commandline options and the description of the given task.

上記の通り、表示される情報にはタスクのフルパス、使用可能なコマンドラインオプション、またタスクの説明が含まれています。

11.6.4. プロジェクトの依存関係一覧Listing project dependencies

Running gradle dependencies gives you a list of the dependencies of the selected project, broken down by configuration. For each configuration, the direct and transitive dependencies of that configuration are shown in a tree. Below is an example of this report:

gradle dependenciesはプロジェクトの依存関係をコンフィギュレーションごとに一覧表示します。プロジェクトに直接設定されている依存関係と推移的依存関係が、コンフィギュレーション別のツリー構造で表示されます。

例11.13 依存関係の情報を取得する

gradle -q dependencies api:dependencies webapp:dependencies の出力

> gradle -q dependencies api:dependencies webapp:dependencies
------------------------------------------------------------
Root project
------------------------------------------------------------

No configurations

------------------------------------------------------------
Project :api - The shared API for the application
------------------------------------------------------------

compile
\--- org.codehaus.groovy:groovy-all:2.3.6

testCompile
\--- junit:junit:4.11
     \--- org.hamcrest:hamcrest-core:1.3

------------------------------------------------------------
Project :webapp - The Web application implementation
------------------------------------------------------------

compile
+--- project :api
|    \--- org.codehaus.groovy:groovy-all:2.3.6
\--- commons-io:commons-io:1.2

testCompile
No dependencies

Since a dependency report can get large, it can be useful to restrict the report to a particular configuration. This is achieved with the optional --configuration parameter:

依存関係のレポートは巨大になることもあるので、レポート内容を特定のコンフィギュレーションのみに限定できれば便利です。 これは、オプションの--configurationを指定することで実現できます。

例11.14 依存関係のレポートをコンフィギュレーションでフィルタする

gradle -q api:dependencies --configuration testCompile の出力

> gradle -q api:dependencies --configuration testCompile
------------------------------------------------------------
Project :api - The shared API for the application
------------------------------------------------------------

testCompile
\--- junit:junit:4.11
     \--- org.hamcrest:hamcrest-core:1.3

11.6.5. 個別の依存関係に対する解析情報を取得する Getting the insight into a particular dependency

Running gradle dependencyInsight gives you an insight into a particular dependency (or dependencies) that match specified input. Below is an example of this report:

gradle dependencyInsightを実行すると、個別の、または複数の依存関係を指定して、それぞれに対する解析情報を取得することができます。以下がそのレポートの例です。

例11.15 個別の依存関係に対する解析情報を取得する

gradle -q webapp:dependencyInsight --dependency groovy --configuration compile の出力

> gradle -q webapp:dependencyInsight --dependency groovy --configuration compile
org.codehaus.groovy:groovy-all:2.3.6
\--- project :api
     \--- compile

This task is extremely useful for investigating the dependency resolution, finding out where certain dependencies are coming from and why certain versions are selected. For more information please see the DependencyInsightReportTask class in the API documentation.

dependencyInsightは、依存関係がどのように解決されているか調査するときにとても便利なタスクです。ある依存関係がどこから来て、なぜそのバージョンが選択されているのか調べることができます。 詳細については、DependencyInsightReportTaskを参照してください。

The built-in dependencyInsight task is a part of the 'Help' tasks group. The task needs to configured with the dependency and the configuration. The report looks for the dependencies that match the specified dependency spec in the specified configuration. If Java related plugin is applied, the dependencyInsight task is pre-configured with 'compile' configuration because typically it's the compile dependencies we are interested in. You should specify the dependency you are interested in via the command line '--dependency' option. If you don't like the defaults you may select the configuration via '--configuration' option. For more information see the DependencyInsightReportTask class in the API documentation.

組み込みのdependencyInsightタスクは、Helpグループに属しています。 このタスクは、依存関係およびコンフィグレーションを指定しないと使用できません。 レポートが出力される際は、指定されたコンフィグレーションの指定された依存関係を探しに行きます。 Java関連のプラグインが適用されていれば、dependencyInsightタスクは既にcompileコンフィグレーションに対して設定されています。一般的に言って、よく調べたくなる依存関係はこのコンフィグレーションに属しているからです。 また、調査対象の依存関係を「--dependency」オプションで指定しなければなりません。 さらに、デフォルトのコンフィグレーションが気に入らないときは「--configuration」オプションで明示的にコンフィグレーションを指定します。 詳しくはDependencyInsightReportTaskを参照してください。

11.6.6. プロジェクトのプロパティ一覧Listing project properties

Running gradle properties gives you a list of the properties of the selected project. This is a snippet from the output:

gradle propertiesはプロジェクトのプロパティを一覧表示します。出力例の一部を以下に示します。

例11.16 プロパティに関する情報

gradle -q api:properties の出力

> gradle -q api:properties
------------------------------------------------------------
Project :api - The shared API for the application
------------------------------------------------------------

allprojects: [project ':api']
ant: org.gradle.api.internal.project.DefaultAntBuilder@12345
antBuilderFactory: org.gradle.api.internal.project.DefaultAntBuilderFactory@12345
artifacts: org.gradle.api.internal.artifacts.dsl.DefaultArtifactHandler_Decorated@12345
asDynamicObject: org.gradle.api.internal.ExtensibleDynamicObject@12345
baseClassLoaderScope: org.gradle.api.internal.initialization.DefaultClassLoaderScope@12345
buildDir: /home/user/gradle/samples/userguide/tutorial/projectReports/api/build
buildFile: /home/user/gradle/samples/userguide/tutorial/projectReports/api/build.gradle

11.6.7. ビルドのプロファイリングProfiling a build

The --profile command line option will record some useful timing information while your build is running and write a report to the build/reports/profile directory. The report will be named using the time when the build was run.

コマンドラインオプションで--profileをつけてビルドを実行すると、ビルドに要した時間のうち有用と思われるいくつかの情報を計測して、結果をbuild/reports/profileディレクトリを出力します。レポート名には、ビルドを行った時刻が付加されます。

This report lists summary times and details for both the configuration phase and task execution. The times for configuration and task execution are sorted with the most expensive operations first. The task execution results also indicate if any tasks were skipped (and the reason) or if tasks that were not skipped did no work.

このレポートでは、ビルド時間に関する概要のほか、設定フェーズとタスク実行に要した時間がタスクごとに表示されます。設定フェーズ、タスク実行に関するレポートは必要時間の降順でソートされており、さらにタスク実行については、タスクがスキップされたかどうか、作業が発生したかどうかみることができるようになっています。

Builds which utilize a buildSrc directory will generate a second profile report for buildSrc in the buildSrc/build directory.

なお、buildSrcディレクトリを使っている場合、buildSrc/buildbuildSrcのレポートが別途出力されます。

11.7. 空実行Dry Run

Sometimes you are interested in which tasks are executed in which order for a given set of tasks specified on the command line, but you don't want the tasks to be executed. You can use the -m option for this. For example, if you run “gradle -m clean compile”, you'll see all the tasks that would be executed as part of the clean and compile tasks. This is complementary to the tasks task, which shows you the tasks which are available for execution.

コマンドラインにタスク名を並べて実行したときに、どのタスクがどの順番で実行されるのか知りたくなることがあります。しかしそのために実際にタスクを実行したくはありません。このような場合、-mオプションをつけて実行してください。たとえば、gradle -m clean compileと実行すれば、cleanタスクとcompileタスクの実行にあたって実際に実行されるすべてのタスクが実行順に表示されます。これは、実行可能なタスクの一覧を表示するtasksタスクの補足にもなります。

11.8. まとめSummary

In this chapter, you have seen some of the things you can do with Gradle from the command-line. You can find out more about the gradle command in 付録D Gradle コマンドラインGradle Command Line.

この章では、コマンドラインで使えるGradleの機能をいくつか見てきました。gradleコマンドについては付録D Gradle コマンドラインGradle Command Lineにも記載してあります。

第12章 GradleのGUIを使うUsing the Gradle Graphical User Interface

In addition to supporting a traditional command line interface, Gradle offers a graphical user interface. This is a stand alone user interface that can be launched with the --gui option.

伝統的なコマンドラインインターフェースに加え、Gradleはグラフィカルユーザーインターフェースも提供しています。これはスタンドアローンのインターフェースで、--guiオプションを使って起動できます。

例12.1 GUIの起動Launching the GUI

gradle --gui

Note that this command blocks until the Gradle GUI is closed. Under *nix it is probably preferable to run this as a background task (gradle --gui&)

このコマンドは、GUIをクローズするまでブロックされることに注意してください。*nixでは、バックグラウンドタスク(gradle --gui&)で実行した方がいいかもしれません。

If you run this from your Gradle project working directory, you should see a tree of tasks.

このコマンドをgradleプロジェクトの作業ディレクトリで実行すると、タスクのツリーが表示されることが分かります。

図12.1 GUI Task Tree

GUI Task Tree

It is preferable to run this command from your Gradle project directory so that the settings of the UI will be stored in your project directory. However, you can run it then change the working directory via the Setup tab in the UI.

このコマンドは、自分のgradleプロジェクトのディレクトリで実行した方がいいでしょう。そうすれば、UI設定がプロジェクトのディレクトリに保存されるからです。しかし、コマンドを実行してから、UIのSetupタブで作業ディレクトリを変更することもできます。

The UI displays 4 tabs along the top and an output window along the bottom.

UIには上部に4つのタブがあり、下部には出力を表示するウィンドウがあります。

12.1. Task Tree(タスク・ツリー)Task Tree

The Task Tree shows a hierarchical display of all projects and their tasks. Double clicking a task executes it.

Task Treeは、すべてのプロジェクトとタスクの階層構造を表示します。タスクをダブルクリックすると、そのタスクが実行されます。

There is also a filter so that uncommon tasks can be hidden. You can toggle the filter via the Filter button. Editing the filter allows you to configure which tasks and projects are shown. Hidden tasks show up in red. Note: newly created tasks will show up by default (versus being hidden by default).

また、フィルターも用意されているので、一般的でないタスクは非表示にすることができます。フィルターを有効にするかどうかはFilterボタンで切り替えできます。 フィルター編集画面では、どのタスクとプロジェクトを表示するかを設定します。非表示に設定されたタスクは赤色で強調されます。 注意: 新しく作成されたタスクは、デフォルトでは表示に設定されます(デフォルトで非表示に設定されるのではなく)。

The Task Tree context menu provides the following options:

タスクツリーのコンテキストメニューでは、以下の機能も使うことができます。

  • Execute ignoring dependencies. This does not require dependent projects to be rebuilt (same as the -a option).

    依存関係を無視したタスクの実行する。依存プロジェクトを再ビルドしません(-aオプションと同じ)。

  • Add tasks to the favorites (see Favorites tab)

    タスクをお気に入りに追加する(Favoritesを参照してください)。

  • Hide the selected tasks. This adds them to the filter.

    選択したタスクを隠す。タスクをフィルターに追加します。

  • Edit the build.gradle file. Note: this requires Java 1.6 or higher and requires that you have .gradle files associated in your OS.

    build.gradleファイルの編集。注意: この機能を使うには、1.6以上のバージョンのJavaが必要です。また、OS上で.gradleファイルの関連づけを設定しなければなりません。

12.2. Favorites(お気に入り)Favorites

The Favorites tab is a good place to store commonly-executed commands. These can be complex commands (anything that's legal to Gradle) and you can provide them with a display name. This is useful for creating, say, a custom build command that explicitly skips tests, documentation, and samples that you could call “fast build”.

Favoriteタブでは、よく実行するコマンドをお気に入りとして保存できます。保存するコマンドは複雑なもの(Gradleにとって正しいものならなんでもかまいません)でもよく、わかりやすい表示名をつけることもできます。お気に入りは、テストやドキュメンテーション、サンプル作成などを明示的にスキップする、"急速なビルド"と呼べるようなカスタムビルドを作成するのに便利だと言えます。

You can reorder favorites to your liking and even export them to disk so they can imported by others. If you edit them, you are given options to “Always Show Live Output”. This only applies if you have “Only Show Output When Errors Occur”. This override always forces the output to be shown.

お気に入りは、好きなように並び替えることができます。また、お気に入りをディスクにエクスポートしたり、そこから逆にインポートしたりすることも可能です。 お気に入りを追加、編集するとき、"Always Show Live Output"というオプションがあるはずです。 これは、'Only Show Output When Errors Occur'(エラー発生時のみ出力を表示する)設定を有効にしているときのみ適用されるオプションです。 このオプションを有効にすると、その設定を上書きし常に出力が表示されるようになります。

12.3. Command Line(コマンドライン)Command Line

The Command Line tab is where you can to execute a single Gradle command directly. Just enter whatever you would normally enter after 'gradle' on the command line. This also provides a place to try out commands before adding them to favorites.

Command Lineタブでは、ひとつのgradleコマンドを直接実行できます。いつも'gradle'のあとに入力しているコマンドを入力するだけです。お気に入りにコマンドを追加する前に、試しにそのコマンドを実行してみることもできます。

12.4. Setup(セットアップ)Setup

The Setup tab allows configuration of some general settings.

Setupタブは、一般的な設定を行うところです。

図12.2 GUI Setup

GUI Setup

  • Current Directory

    Defines the root directory of your Gradle project (typically where build.gradle is located).

    gradleプロジェクトのルートディレクトリを設定します(典型的には、build.gradleが置かれているディレクトリになります)。

  • Stack Trace Output

    This determines how much information to write out in stack traces when errors occur. Note: if you specify a stack trace level on either the Command Line or Favorites tab, it will override this stack trace level.

    ここでは、エラーが発生したとき、どれだけの情報をスタックトレースに書き出すかを設定します。注意: スタックトレースレベルをCommand LineタブやFavoritesタブで指定している場合、ここで設定したスタックトレースレベルは上書きされます。

  • Only Show Output When Errors Occur

    Enabling this option hides any output when a task is executed unless the build fails.

    有効にすると、ビルドに失敗しない限り出力が表示されないようになります。

  • Use Custom Gradle Executor - Advanced feature

    Use Custom Gradle Executor - 高度な機能

    This provides you with an alternate way to launch Gradle commands. This is useful if your project requires some extra setup that is done inside another batch file or shell script (such as specifying an init script).

    gradleコマンドの実行方法を変更できます。これは、自分のプロジェクトが、バッチファイルやシェルスクリプトの中で追加的なセットアップをしてからgradleを呼び出しているときに便利です。

第13章 ビルドスクリプトの記述Writing Build Scripts

This chapter looks at some of the details of writing a build script.

本章では、ビルドスクリプトの記述についてもう少し詳しく見ていきます。

13.1. Gradleビルド言語The Gradle build language

Gradle provides a domain specific language, or DSL, for describing builds. This build language is based on Groovy, with some additions to make it easier to describe a build.

Gradleは、ビルドシステムを記述するためのドメイン特化言語(DSL)を提供します。 このビルド用言語は、Groovyをベースに、ビルドシステムの記述を簡単にするための機能をいくつか追加したものです。

A build script can contain any Groovy language element. [9] Gradle assumes that each build script is encoded using UTF-8.

13.2. プロジェクトAPIThe Project API

In the tutorial in 7章JavaクイックスタートJava Quickstart we used, for example, the apply() method. Where does this method come from? We said earlier that the build script defines a project in Gradle. For each project in the build, Gradle creates an object of type Project and associates this Project object with the build script. As the build script executes, it configures this Project object:

例えば、7章JavaクイックスタートJava Quickstartのチュートリアルで使用したapply()メソッド、このメソッドはどこから来たのでしょうか。まず、前述のようにビルドスクリプトはGradleのプロジェクトを定義します。 ビルドに含まれるプロジェクトそれぞれに対し、Project型のインスタンスが一つ作られ、ビルドスクリプトと関連づけられます。ビルドが実行されると、このプロジェクト・インスタンスは以下のように振る舞います。

ビルドスクリプトのリファレンスを見たいときはGetting help writing build scripts

Don't forget that your build script is simply Groovy code that drives the Gradle API. And the Project interface is your starting point for accessing everything in the Gradle API. So, if you're wondering what 'tags' are available in your build script, you can start with the documentation for the Project interface.

ビルドスクリプトは、GradleのAPIを呼び出しているだけの単なるGroovyスクリプトだということを忘れないでください。Projectインターフェースが、GradleのAPIを呼び出すときのスタートポイントです。なので、ビルドスクリプトでどんな「文言」が使えるか分からないときはProjectインターフェースのドキュメントを見ることから始めるといいでしょう。

  • Any method you call in your build script which is not defined in the build script, is delegated to the Project object.

    ビルドスクリプトで呼び出されたメソッドのうち、そのスクリプトで定義されていないものはProjectオブジェクトに委譲されます。

  • Any property you access in your build script, which is not defined in the build script, is delegated to the Project object.

    ビルドスクリプトでのプロパティアクセスも、そのスクリプトで定義されていないプロパティについてはProjectオブジェクトに委譲されます。

Let's try this out and try to access the name property of the Project object.

プロジェクトオブジェクトのnameプロパティにアクセスして試してみましょう。

例13.1 Projectオブジェクトへのアクセス

build.gradle

println name
println project.name

gradle -q check の出力

> gradle -q check
projectApi
projectApi

Both println statements print out the same property. The first uses auto-delegation to the Project object, for properties not defined in the build script. The other statement uses the project property available to any build script, which returns the associated Project object. Only if you define a property or a method which has the same name as a member of the Project object, would you need to use the project property.

どちらのprintlnも出力結果は同じです。最初のprintlnは、ビルドスクリプトで定義されていないプロパティへのアクセスを、暗黙のうちにプロジェクトオブジェクトに委譲しています。もう一方の例では、プロジェクトオブジェクトを返すprojectプロパティを使って、nameにアクセスしています。projectプロパティには、ビルドスクリプトのどこからでもアクセスできます。プロジェクトオブジェクトのプロパティやメソッドと同名のものをビルドスクリプトに定義している場合は、projectプロパティからアクセスすることになるでしょう。

13.2.1. 標準のプロジェクトプロパティStandard project properties

The Project object provides some standard properties, which are available in your build script. The following table lists a few of the commonly used ones.

プロジェクトオブジェクトは標準でいくつかのプロパティを提供しており、ビルドスクリプトでこれらのプロパティにアクセスできます。次の表によく使うプロパティを少しですが載せてみました。

表13.1 プロジェクトプロパティProject Properties

プロパティ名Name Type デフォルト値Default Value
project Project ProjectインスタンスThe Project instance
name String プロジェクトディレクトリの名前The name of the project directory.
path String プロジェクトの絶対パスThe absolute path of the project.
description String プロジェクトの説明A description for the project.
projectDir File ビルドスクリプトのあるディレクトリThe directory containing the build script.
buildDir File projectDir/build
group Object 未設定unspecified
version Object 未設定unspecified
ant AntBuilder AntBuilderインスタンスAn AntBuilder instance

13.3. スクリプトAPIThe Script API

When Gradle executes a script, it compiles the script into a class which implements Script. This means that all of the properties and methods declared by the Script interface are available in your script.

ビルドスクリプトが実行されるときは、スクリプトはScriptを実装したクラスにコンパイルされます。つまり、ビルドスクリプトではScriptインターフェースで宣言されているプロパティとメソッドを全て使うことができるということです。

13.4. 変数の宣言 Declaring variables

There are two kinds of variables that can be declared in a build script: local variables and extra properties.

ビルドスクリプトでは、二つの方法で変数を宣言できます。ローカル変数と拡張プロパティです。

13.4.1. ローカル変数 Local variables

Local variables are declared with the def keyword. They are only visible in the scope where they have been declared. Local variables are a feature of the underlying Groovy language.

ローカル変数は、defキーワードで宣言する変数です。変数のスコープは、変数が宣言されている場所に制限されます。なお、ローカル変数はGroovy言語に依る機能です。

例13.2 ローカル変数を使用する

build.gradle

def dest = "dest"

task copy(type: Copy) {
    from "source"
    into dest
}

13.4.2. 拡張プロパティ Extra properties

All enhanced objects in Gradle's domain model can hold extra user-defined properties. This includes, but is not limited to, projects, tasks, and source sets. Extra properties can be added, read and set via the owning object's ext property. Alternatively, an ext block can be used to add multiple properties at once.

Gradleのドメインモデルを構成する全ての拡張オブジェクトには、ユーザー定義のプロパティ、拡張プロパティを新たに追加することができます。 拡張プロパティを追加できるオブジェクトには、projects、tasks、source setsを始め、様々なオブジェクトがあります。 拡張プロパティをセットしたり読み込んだりするには、対象オブジェクトのextプロパティを使用して下さい。また、extブロックを使って複数のプロパティを一気に追加することもできます。

例13.3 拡張プロパティを使用する

build.gradle

apply plugin: "java"

ext {
    springVersion = "3.1.0.RELEASE"
    emailNotification = "build@master.org"
}

sourceSets.all { ext.purpose = null }

sourceSets {
    main {
        purpose = "production"
    }
    test {
        purpose = "test"
    }
    plugin {
        purpose = "production"
    }
}

task printProperties << {
    println springVersion
    println emailNotification
    sourceSets.matching { it.purpose == "production" }.each { println it.name }
}

gradle -q printProperties の出力

> gradle -q printProperties
3.1.0.RELEASE
build@master.org
main
plugin

In this example, an ext block adds two extra properties to the project object. Additionally, a property named purpose is added to each source set by setting ext.purpose to null (null is a permissible value). Once the properties have been added, they can be read and set like predefined properties.

この例では、extブロックで二つの拡張プロパティをprojectオブジェクトに追加しています。 さらに、ext.purposenullをセットすることで(nullでも構いません)、全てのソースセットにpurposeという拡張プロパティを追加しています。 一度プロパティが追加されれば、定義済みのプロパティと同じように読み込んだり書き込んだりすることができるようになります。

By requiring special syntax for adding a property, Gradle can fail fast when an attempt is made to set a (predefined or extra) property but the property is misspelled or does not exist. Extra properties can be accessed from anywhere their owning object can be accessed, giving them a wider scope than local variables. Extra properties on a project are visible from its subprojects.

For further details on extra properties and their API, see the ExtraPropertiesExtension class in the API documentation.

13.5. Groovyの基本 Some Groovy basics

Groovy provides plenty of features for creating DSLs, and the Gradle build language takes advantage of these. Understanding how the build language works will help you when you write your build script, and in particular, when you start to write custom plugins and tasks.

GroovyにはDSLを作るための機能が豊富に用意されていて、Gradleもその長所を活用しています。Gradleビルド言語がどういう仕組みで動いているか理解すれば、ビルドスクリプトを書くのに、特にカスタムプラグインやタスクを作り始めたときには役に立つはずです。

13.5.1. Groovy JDK

Groovy adds lots of useful methods to the standard Java classes. For example, Iterable gets an each method, which iterates over the elements of the Iterable:

Groovyは、たくさんの便利なメソッドをJavaの標準クラスに追加しています。たとえば、Iterableにはeachというメソッドが追加されていて、要素を走査するときに次のように書くことができます。

例13.4 Groovy JDKのメソッド

build.gradle

// Iterable gets an each() method
configurations.runtime.each { File f -> println f }

Have a look at http://groovy.codehaus.org/groovy-jdk/ for more details.

詳細はhttp://groovy.codehaus.org/groovy-jdk/をご参照ください。

13.5.2. プロパティのアクセサProperty accessors

Groovy automatically converts a property reference into a call to the appropriate getter or setter method.

Groovyは、プロパティ参照を自動的にゲッター/セッターメソッドの呼び出しに変換してくれます。

例13.5 プロパティアクセサ

build.gradle

// Using a getter method
println project.buildDir
println getProject().getBuildDir()

// Using a setter method
project.buildDir = 'target'
getProject().setBuildDir('target')

13.5.3. メソッド呼び出し時のカッコを省略できるOptional parentheses on method calls

Parentheses are optional for method calls.

Groovyではメソッド呼び出しのカッコは省略できます。

例13.6 カッコなしのメソッド呼び出し

build.gradle

test.systemProperty 'some.prop', 'value'
test.systemProperty('some.prop', 'value')

13.5.4. リストリテラル、マップリテラルList and map literals

Groovy provides some shortcuts for defining List and Map instances. Both kinds of literals are straightforward, but map literals have some interesting twists.

Groovyでは、ListMapのインスタンスを作るときにショートカット記法が使えます。

For instance, the “apply” method (where you typically apply plugins) actually takes a map parameter. However, when you have a line like “apply plugin:'java'”, you aren't actually using a map literal, you're actually using “named parameters”, which have almost exactly the same syntax as a map literal (without the wrapping brackets). That named parameter list gets converted to a map when the method is called, but it doesn't start out as a map.

例13.7 マップリテラル、リストリテラル

build.gradle

// List literal
test.includes = ['org/gradle/api/**', 'org/gradle/internal/**']

List<String> list = new ArrayList<String>()
list.add('org/gradle/api/**')
list.add('org/gradle/internal/**')
test.includes = list

// Map literal.
Map<String, String> map = [key1:'value1', key2: 'value2']

// Groovy will coerce named arguments
// into a single map argument
apply plugin: 'java'

13.5.5. メソッド引数の最後にクロージャを使うClosures as the last parameter in a method

The Gradle DSL uses closures in many places. You can find out more about closures here. When the last parameter of a method is a closure, you can place the closure after the method call:

GradleのDSLでは、クロージャ(詳細はこちら)を多用します。Groovyでは、メソッドの最後の引数がクロージャになっている場合、そのメソッドをクロージャをつけて呼び出すことができます。

例13.8 メソッドのクロージャ引数

build.gradle

repositories {
    println "in a closure"
}
repositories() { println "in a closure" }
repositories({ println "in a closure" })

13.5.6. クロージャのdelegateオブジェクトClosure delegate

Each closure has a delegate object, which Groovy uses to look up variable and method references which are not local variables or parameters of the closure. Gradle uses this for configuration closures, where the delegate object is set to the object to be configured.

すべてのクロージャは、delegateオブジェクトを持っています。クロージャ内では、(クロージャ引数やローカル変数以外の)変数やメソッドはdelegateオブジェクトから検索されます。Gradleの設定用クロージャでは、delegateオブジェクトに設定対象のオブジェクトがセットされています。

例13.9 クロージャのdelegate

build.gradle

dependencies {
    assert delegate == project.dependencies
    testCompile('junit:junit:4.11')
    delegate.testCompile('junit:junit:4.11')
}



[9] Any language element except for statement labels.

第14章 色々なチュートリアル Tutorial - 'This and That'

14.1. ディレクトリの作成 Directory creation

There is a common situation where multiple tasks depend on the existence of a directory. Of course you can deal with this by adding a mkdir to the beginning of those tasks, but it's almost always a bad idea to repeat a sequence of code that you only need once (Look up the DRY principle). A better solution would use the dependsOn relationship between tasks to reuse the task to create the directory:

複数のタスクが、ある一つのディレクトリが存在していることを前提としている、ということがよくあります。 それらのタスク全てでmkdirを呼ぶことももちろんできますが、それではやはり冗長です。 この場合、次のように、ディレクトリを必要とするタスクにdependsOn関係を追加するのが良い方法です。

例14.1 mkdirでディレクトリを作成する

build.gradle

def classesDir = new File('build/classes')

task resources << {
    classesDir.mkdirs()
    // do something
}
task compile(dependsOn: 'resources') << {
    if (classesDir.isDirectory()) {
        println 'The class directory exists. I can operate'
    }
    // do something
}

gradle -q compile の出力

> gradle -q compile
The class directory exists. I can operate

14.2. GradleプロパティとシステムプロパティGradle properties and system properties

Gradle offers a variety of ways to add properties to your build. With the -D command line option you can pass a system property to the JVM which runs Gradle. The -D option of the gradle command has the same effect as the -D option of the java command.

Gradleでは、さまざまな方法でビルドにプロパティ値を渡すことができます。 -Dオプションを使えばGradleを実行しているJVMにシステムプロパティを渡すことができます。 gradleコマンドは-Dオプションをjavaコマンドへの-Dオプションと同じように処理します。

You can also directly add properties to your project objects using properties files. You can place a gradle.properties file in the Gradle user home directory (defined by the “GRADLE_USER_HOME” environment variable, which if not set defaults to USER_HOME/.gradle) or in your project directory. For multi-project builds you can place gradle.properties files in any subproject directory. The properties set in a gradle.properties file can be accessed via the project object. The properties file in the user's home directory has precedence over property files in the project directories.

propertiesファイルを記述することで、projectオブジェクトに直接プロパティを追加することもできます。 このプロパティファイルgradle.propertiesはGradleのホームディレクトリ (デフォルトではUSER_HOME/.gradle)かプロジェクトディレクトリに作成します。 マルチプロジェクトの場合、gradle.properteisはすべてのサブプロジェクトディレクトリに置くことができます。 gradle.propertiesに記述されたプロパティはprojectオブジェクトからアクセスすることができます。 なお、ホームディレクトリのgradle.propertiesは、プロジェクトディレクトリのgradle.propertiesの定義を上書きし、優先的に使用されます。

You can also add properties directly to your project object via the -P command line option.

projectオブジェクトに追加するプロパティは、コマンドラインオプションの-Pオプションで直接設定することもできます。

Gradle can also set project properties when it sees specially-named system properties or environment variables. This feature is very useful when you don't have admin rights to a continuous integration server and you need to set property values that should not be easily visible, typically for security reasons. In that situation, you can't use the -P option, and you can't change the system-level configuration files. The correct strategy is to change the configuration of your continuous integration build job, adding an environment variable setting that matches an expected pattern. This won't be visible to normal users on the system. [10]

projectオブジェクトに追加するプロパティは、コマンドラインオプションの-Pオプションで設定することもできます。また、さらにエキゾチックな使い方に備えて、環境変数やシステムプロパティからプロパティを直接取り込む機能もあります。たとえば、管理権限のないマシン上のCIサーバーで継続的なビルドを行う場合について考えてみましょう。自分のビルドスクリプトに、他人から見られたくない値をプロパティとして設定する必要がある場合、-Pオプションは使えません。このときは、プロジェクトの管理者のみアクセスできるようなCIサーバー上のページで環境変数を設定することで、ビルドスクリプトにプロパティを渡すことができます。 [11] ここで設定する環境変数名にはあるパターンがあり、ORG_GRADLE_PROJECT_propertyName=somevalueという環境変数を設定した場合propertyNameというプロパティがプロジェクトに設定されます。また、システムプロパティでも同様のメカニズムを実装しています。パターンがorg.gradle.project.propertyNameとなっていること以外は環境変数の場合と同じです。

If the environment variable name looks like ORG_GRADLE_PROJECT_prop=somevalue, then Gradle will set a prop property on your project object, with the value of somevalue. Gradle also supports this for system properties, but with a different naming pattern, which looks like org.gradle.project.prop.

You can also set system properties in the gradle.properties file. If a property name in such a file has the prefix “systemProp.”, like “systemProp.propName”, then the property and its value will be set as a system property, without the prefix. In a multi project build, “systemProp.” properties set in any project except the root will be ignored. That is, only the root project's gradle.properties file will be checked for properties that begin with the “systemProp.” prefix.

gradle.propertiesファイルでもシステムプロパティを設定することができます。 ファイル内でプレフィックスにsystemPropをつけてプロパティを設定することで、プレフィックス部分をのぞいたプロパティ名でシステムプロパティに追加されます。

例14.2 gradle.propertiesでプロパティを設定する

gradle.properties

gradlePropertiesProp=gradlePropertiesValue
sysProp=shouldBeOverWrittenBySysProp
envProjectProp=shouldBeOverWrittenByEnvProp
systemProp.system=systemValue

build.gradle

task printProps << {
    println commandLineProjectProp
    println gradlePropertiesProp
    println systemProjectProp
    println envProjectProp
    println System.properties['system']
}

gradle -q -PcommandLineProjectProp=commandLineProjectPropValue -Dorg.gradle.project.systemProjectProp=systemPropertyValue printProps の出力

> gradle -q -PcommandLineProjectProp=commandLineProjectPropValue -Dorg.gradle.project.systemProjectProp=systemPropertyValue printProps
commandLineProjectPropValue
gradlePropertiesValue
systemPropertyValue
envPropertyValue
systemValue

14.2.1. プロジェクトプロパティの確認Checking for project properties

You can access a project property in your build script simply by using its name as you would use a variable. If this property does not exist, an exception will be thrown and the build will fail. If your build script relies on optional properties the user might set, perhaps in a gradle.properties file, you need to check for existence before you access them. You can do this by using the method hasProperty('propertyName') which returns true or false.

プロジェクトに設定されたプロパティは、ビルドスクリプト内では単にプロパティ名でアクセスできます。この場合、アクセスしたプロパティがプロジェクトに設定されてなければ、例外が発生してビルドは失敗します。プロパティをオプションにして、必要なときのみgradle.propertiesなどでユーザーにプロパティをセットさせたい場合などは、アクセスする前にプロパティがセットされているかどうか確認しなければなりません。hasProperty('propertyName')がtrueやfalseを返すので、それでプロパティの存在を確認できます。

14.3. 外部のビルドスクリプトをプロジェクトに取り込むConfiguring the project using an external build script

You can configure the current project using an external build script. All of the Gradle build language is available in the external script. You can even apply other scripts from the external script.

外部のビルドスクリプトを取り込んでプロジェクトを設定することができます。取り込む外部スクリプト内では、Gradleの文法がすべて使用できます。その外部スクリプトから、さらに別の外部スクリプトを取り込むことさえ可能です。

例14.3 外部のビルドスクリプトファイルでプロジェクトの設定を行う

build.gradle

apply from: 'other.gradle'

other.gradle

println "configuring $project"
task hello << {
    println 'hello from other script'
}

gradle -q hello の出力

> gradle -q hello
configuring root project 'configureProjectUsingScript'
hello from other script

14.4. 任意のオブジェクトを組み立てる Configuring arbitrary objects

You can configure arbitrary objects in the following very readable way.

次のような非常に読みやすい方法で、あらゆるオブジェクトを設定することができます。

例14.4 任意のオブジェクトを組み立てる

build.gradle

task configure << {
    def pos = configure(new java.text.FieldPosition(10)) {
        beginIndex = 1
        endIndex = 5
    }
    println pos.beginIndex
    println pos.endIndex
}

gradle -q configure の出力

> gradle -q configure
1
5

14.5. 外部スクリプトで任意のオブジェクトを組み立てる Configuring arbitrary objects using an external script

You can also configure arbitrary objects using an external script.

外部スクリプトを使って、任意のオブジェクトを組み立てることもできます。

例14.5 外部スクリプトで任意のオブジェクトを組み立てる

build.gradle

task configure << {
    def pos = new java.text.FieldPosition(10)
    // Apply the script
    apply from: 'other.gradle', to: pos
    println pos.beginIndex
    println pos.endIndex
}

other.gradle

gradle -q configure の出力

> gradle -q configure
1
5

14.6. キャッシング Caching

To improve responsiveness Gradle caches all compiled scripts by default. This includes all build scripts, initialization scripts, and other scripts. The first time you run a build for a project, Gradle creates a .gradle directory in which it puts the compiled script. The next time you run this build, Gradle uses the compiled script, if the script has not changed since it was compiled. Otherwise the script gets compiled and the new version is stored in the cache. If you run Gradle with the --recompile-scripts option, the cached script is discarded and the script is compiled and stored in the cache. This way you can force Gradle to rebuild the cache.

応答速度を上げるため、Gradleはコンパイル済みのスクリプトをデフォルトですべてキャッシュします。キャッシュ対象には、すべてのビルドスクリプトや初期化スクリプトなどが含まれます。最初にプロジェクトをビルドしたとき、Gradleは.gradleディレクトリをプロジェクトディレクトリに作成します。そこにコンパイル済みのスクリプトが保存され、次回のビルドからは、そのコンパイル済みのスクリプトが使用されるのです。もし前回コンパイルしたときからスクリプトが変更されていれば、キャッシュは再度コンパイルされます。--recompile-scriptsオプションをつけてGradleを実行すれば、キャッシュはすべて破棄され、再度コンパイル、保存されます。これにより、Gradleにキャッシュを再構築させることができます。



[10] Jenkins, Teamcity, or Bamboo are some CI servers which offer this functionality.

[11] TeamcityBambooといったCIサーバーがこの機能を持っています。

第15章 タスク詳解More about Tasks

In the introductory tutorial (6章ビルドスクリプトの基本Build Script Basics) you learned how to create simple tasks. You also learned how to add additional behavior to these tasks later on, and you learned how to create dependencies between tasks. This was all about simple tasks, but Gradle takes the concept of tasks further. Gradle supports enhanced tasks, which are tasks that have their own properties and methods. This is really different from what you are used to with Ant targets. Such enhanced tasks are either provided by you or built into Gradle.

6章ビルドスクリプトの基本Build Script Basics」の入門的なチュートリアルでは、簡単なタスクの作り方や、後からタスクにアクションを追加する方法について学びました。 さらに、タスク間の依存関係を定義する方法についても学びました。 単純なタスクについてはこんなところですが、Gradleはタスクという概念をもっと進化させています。 拡張タスク、つまり自身のプロパティやメソッドを持ったタスクを使うことができるのです。 これは、今まで使われてきたAntのターゲットとは全く異なる概念です。 拡張タスクは、Gradleがデフォルトで用意しているものもありますし、自分自身で新たに作成することもできます。

15.1. タスクの定義Defining tasks

We have already seen how to define tasks using a keyword style in 6章ビルドスクリプトの基本Build Script Basics. There are a few variations on this style, which you may need to use in certain situations. For example, the keyword style does not work in expressions.

6章ビルドスクリプトの基本Build Script Basics」で、キーワードを使ったタスク定義を紹介しましたが、タスクの定義方法は他にも少しあります。ときには、それらの方法が必要になることもあるでしょう。たとえば、式の中ではキーワード形式の定義方法を使うことができません。

例15.1 タスクを定義する

build.gradle

task(hello) << {
    println "hello"
}

task(copy, type: Copy) {
    from(file('srcDir'))
    into(buildDir)
}

You can also use strings for the task names:

タスク名に文字列を使うこともできます。

例15.2 タスクを定義する - タスク名に文字列を使用

build.gradle

task('hello') <<
{
    println "hello"
}

task('copy', type: Copy) {
    from(file('srcDir'))
    into(buildDir)
}

There is an alternative syntax for defining tasks, which you may prefer to use:

他にもいくつかシンタックスが用意されています。もしかすると、これらのシンタックスの方が好みに合うという人もいるかもしれません。

例15.3 その他のタスク定義方法

build.gradle

tasks.create(name: 'hello') << {
    println "hello"
}

tasks.create(name: 'copy', type: Copy) {
    from(file('srcDir'))
    into(buildDir)
}

Here we add tasks to the tasks collection. Have a look at TaskContainer for more variations of the create() method.

この例では、tasksコレクションにタスクを追加しています。create()メソッドのバリエーションについてはTaskContainerをご参照ください。

15.2. タスクを配置するLocating tasks

You often need to locate the tasks that you have defined in the build file, for example, to configure them or use them for dependencies. There are a number of ways of doing this. Firstly, each task is available as a property of the project, using the task name as the property name:

ビルドファイルから、定義済みのタスクを探して取得したい、というケースがよくあります。例えば、既存のタスクの設定を変更したり、依存関係を定義するために参照したいといった場面です。タスクを取得する方法はたくさんありますが、まずはプロジェクトのプロパティとしてアクセスする方法を見てみましょう。タスク名がプロパティ名として使用できます。

例15.4 タスクにプロパティとしてアクセスする

build.gradle

task hello

println hello.name
println project.hello.name

Tasks are also available through the tasks collection.

tasksコレクションからタスクを持ってくることもできます。

例15.5 tasksコレクションからタスクにアクセスする

build.gradle

task hello

println tasks.hello.name
println tasks['hello'].name

You can access tasks from any project using the task's path using the tasks.getByPath() method. You can call the getByPath() method with a task name, or a relative path, or an absolute path.

tasks.getByPath()を使えば、あらゆるプロジェクトのタスクにアクセスできます。getByPath()にはタスク名のほか、タスクの相対パスや絶対パスを渡すことが可能です。

例15.6 パスを使ってタスクにアクセスする

build.gradle

project(':projectA') {
    task hello
}

task hello

println tasks.getByPath('hello').path
println tasks.getByPath(':hello').path
println tasks.getByPath('projectA:hello').path
println tasks.getByPath(':projectA:hello').path

gradle -q hello の出力

> gradle -q hello
:hello
:hello
:projectA:hello
:projectA:hello

Have a look at TaskContainer for more options for locating tasks.

そのほかの方法については、TaskContainerをご参照ください。

15.3. タスクの設定を変更するConfiguring tasks

As an example, let's look at the Copy task provided by Gradle. To create a Copy task for your build, you can declare in your build script:

例として、Gradleに用意されているCopyタスクを見てみましょう。Copyタスクを自分のビルドで作成するには、ビルドスクリプトで次のように宣言します。

例15.7 copyタスクの作成

build.gradle

task myCopy(type: Copy)

This creates a copy task with no default behavior. The task can be configured using its API (see Copy). The following examples show several different ways to achieve the same configuration.

作成されたコピータスクには、デフォルトでは何の動作も設定されていません。 タスクは、タスクのAPI(Copy参照)を使って設定することができます。 次のいくつかの例は、どれも同じ設定を行うものです。

Just to be clear, realize that the name of this task is “myCopy”, but it is of typeCopy”. You can have multiple tasks of the same type, but with different names. You'll find this gives you a lot of power to implement cross-cutting concerns across all tasks of a particular type.

例15.8 タスクの設定 - 様々な方法

build.gradle

Copy myCopy = task(myCopy, type: Copy)
myCopy.from 'resources'
myCopy.into 'target'
myCopy.include('**/*.txt', '**/*.xml', '**/*.properties')

This is similar to the way we would configure objects in Java. You have to repeat the context (myCopy) in the configuration statement every time. This is a redundancy and not very nice to read.

これは、普段私たちがJavaオブジェクトを設定するのと同じ方法で設定する方法です。この方法では、設定処理を呼び出すたびに同じコンテキスト(myCopy)を何度も書く必要があります。これは冗長だし、あまり可読性もよくありません。

There is another way of configuring a task. It also preserves the context and it is arguably the most readable. It is usually our favorite.

タスクの設定には別の方法があります。この方法でも同様にコンテキストは保持されますし、おそらく最も可読性の高い方法です。私たちは、普段この方法を好んで使っています。

例15.9 タスクの設定 - クロージャの使用

build.gradle

task myCopy(type: Copy)

myCopy {
   from 'resources'
   into 'target'
   include('**/*.txt', '**/*.xml', '**/*.properties')
}

This works for any task. Line 3 of the example is just a shortcut for the tasks.getByName() method. It is important to note that if you pass a closure to the getByName() method, this closure is applied to configure the task, not when the task executes.

この方法は、あらゆるタスクで使用できます。3行目のコードは、tasks.getByName()の単なるショートカットです。大事なことは、getByName()メソッドにクロージャを渡すと、そのクロージャがタスクが実行されるときではなく、設定されるときに適用されるという点です。

You can also use a configuration closure when you define a task.

また、タスクを定義するときに、同時に設定クロージャを使うこともできます。

例15.10 クロージャを伴うタスク定義

build.gradle

task copy(type: Copy) {
   from 'resources'
   into 'target'
   include('**/*.txt', '**/*.xml', '**/*.properties')
}

Don't forget about the build phases

A task has both configuration and actions. When using the <<, you are simply using a shortcut to define an action. Code defined in the configuration section of your task will get executed during the configuration phase of the build regardless of what task was targeted. See 56章ビルドのライフサイクルThe Build Lifecycle for more details about the build lifecycle.

15.4. タスクに依存関係を追加するAdding dependencies to a task

There are several ways you can define the dependencies of a task. In 「タスクの依存関係Task dependencies you were introduced to defining dependencies using task names. Task names can refer to tasks in the same project as the task, or to tasks in other projects. To refer to a task in another project, you prefix the name of the task with the path of the project it belongs to. The following is an example which adds a dependency from projectA:taskX to projectB:taskY:

タスクの依存関係を定義する方法はいくつかあります。「タスクの依存関係Task dependenciesでは、タスク名を使って依存関係を定義する方法を紹介しました。タスク名を使うと、同じプロジェクトのタスク、または別のプロジェクトのタスクも参照できます。別のプロジェクトのタスクを参照するには、タスク名に、そのタスクが属しているプロジェクトのパスをプレフィックスとして付けてください。次の例では、projectA:taskXからprojectB:taskYへの依存関係を定義しています。

例15.11 別プロジェクトのタスクとの依存関係を定義する

build.gradle

project('projectA') {
    task taskX(dependsOn: ':projectB:taskY') << {
        println 'taskX'
    }
}

project('projectB') {
    task taskY << {
        println 'taskY'
    }
}

gradle -q taskX の出力

> gradle -q taskX
taskY
taskX

Instead of using a task name, you can define a dependency using a Task object, as shown in this example:

タスク名を使う代わりに、次の例のように、Taskオブジェクトを使って依存関係を定義することも出来ます。

例15.12 taskオブジェクトを使った依存関係定義

build.gradle

task taskX << {
    println 'taskX'
}

task taskY << {
    println 'taskY'
}

taskX.dependsOn taskY

gradle -q taskX の出力

> gradle -q taskX
taskY
taskX

For more advanced uses, you can define a task dependency using a closure. When evaluated, the closure is passed the task whose dependencies are being calculated. The closure should return a single Task or collection of Task objects, which are then treated as dependencies of the task. The following example adds a dependency from taskX to all the tasks in the project whose name starts with lib:

より上級ユーザー向けの方法として、クロージャを使って依存関係を定義することが出来ます。評価フェーズ時に、そのクロージャは、依存関係を算出中のタスクに渡されます。そのクロージャは、一つのTaskオブジェクトかTaskオブジェクトのコレクションを返さなければなりません。返されたタスクが依存タスクとして設定されます。次の例では、taskXから、名前がlibで始まる全てのタスクへの依存関係を設定しています。

例15.13 クロージャを使った依存関係定義

build.gradle

task taskX << {
    println 'taskX'
}

taskX.dependsOn {
    tasks.findAll { task -> task.name.startsWith('lib') }
}

task lib1 << {
    println 'lib1'
}

task lib2 << {
    println 'lib2'
}

task notALib << {
    println 'notALib'
}

gradle -q taskX の出力

> gradle -q taskX
lib1
lib2
taskX

For more information about task dependencies, see the Task API.

さらにタスクの依存関係に関する情報を得るには、Task APIを参照してください。

15.5. Ordering tasks

Task ordering is an incubating feature. Please be aware that this feature may change in later Gradle versions.

In some cases it is useful to control the order in which 2 tasks will execute, without introducing an explicit dependency between those tasks. The primary difference between a task ordering and a task dependency is that an ordering rule does not influence which tasks will be executed, only the order in which they will be executed.

Task ordering can be useful in a number of scenarios:

  • Enforce sequential ordering of tasks: eg. 'build' never runs before 'clean'.
  • Run build validations early in the build: eg. validate I have the correct credentials before starting the work for a release build.
  • Get feedback faster by running quick verification tasks before long verification tasks: eg. unit tests should run before integration tests.
  • A task that aggregates the results of all tasks of a particular type: eg. test report task combines the outputs of all executed test tasks.

There are two ordering rules available: “must run after” and “should run after”.

When you use the “must run after” ordering rule you specify that taskB must always run after taskA, whenever both taskA and taskB will be run. This is expressed as taskB.mustRunAfter(taskA). The “should run after” ordering rule is similar but less strict as it will be ignored in two situations. Firstly if using that rule introduces an ordering cycle. Secondly when using parallel execution and all dependencies of a task have been satisfied apart from the “should run after” task, then this task will be run regardless of whether its “should run after” dependencies have been run or not. You should use “should run after” where the ordering is helpful but not strictly required.

With these rules present it is still possible to execute taskA without taskB and vice-versa.

例15.14 Adding a 'must run after' task ordering

build.gradle

task taskX << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}
taskY.mustRunAfter taskX

gradle -q taskY taskX の出力

> gradle -q taskY taskX
taskX
taskY

例15.15 Adding a 'should run after' task ordering

build.gradle

task taskX << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}
taskY.shouldRunAfter taskX

gradle -q taskY taskX の出力

> gradle -q taskY taskX
taskX
taskY

In the examples above, it is still possible to execute taskY without causing taskX to run:

例15.16 Task ordering does not imply task execution

gradle -q taskY の出力

> gradle -q taskY
taskY

To specify a “must run after” or “should run after” ordering between 2 tasks, you use the Task.mustRunAfter() and Task.shouldRunAfter() methods. These methods accept a task instance, a task name or any other input accepted by Task.dependsOn().

Note that “B.mustRunAfter(A)” or “B.shouldRunAfter(A)” does not imply any execution dependency between the tasks:

  • It is possible to execute tasks A and B independently. The ordering rule only has an effect when both tasks are scheduled for execution.
  • When run with --continue, it is possible for B to execute in the event that A fails.

As mentioned before, the “should run after” ordering rule will be ignored if it introduces an ordering cycle:

例15.17 A 'should run after' task ordering is ignored if it introduces an ordering cycle

build.gradle

task taskX << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}
task taskZ << {
    println 'taskZ'
}
taskX.dependsOn taskY
taskY.dependsOn taskZ
taskZ.shouldRunAfter taskX

gradle -q taskX の出力

> gradle -q taskX
taskZ
taskY
taskX

15.6. タスクに説明書きを追加するAdding a description to a task

You can add a description to your task. This description is displayed when executing gradle tasks.

定義したタスクに、説明書きを追加できます。追加した説明は、たとえばgradle tasksを実行したときなどに表示されます。

例15.18 タスクに説明書きを追加する

build.gradle

task copy(type: Copy) {
   description 'Copies the resource directory to the target directory.'
   from 'resources'
   into 'target'
   include('**/*.txt', '**/*.xml', '**/*.properties')
}

15.7. タスクの置き換えReplacing tasks

Sometimes you want to replace a task. For example, if you want to exchange a task added by the Java plugin with a custom task of a different type. You can achieve this with:

ときには、タスクを置き換えたくなることがあります。例えば、Javaプラグインによって追加されたタスクを、別のタイプのカスタムタスクに入れ替えたいといった場合です。これは、次のようにして実現できます。

例15.19 タスクの上書き

build.gradle

task copy(type: Copy)

task copy(overwrite: true) << {
    println('I am the new one.')
}

gradle -q copy の出力

> gradle -q copy
I am the new one.

This will replace a task of type Copy with the task you've defined, because it uses the same name. When you define the new task, you have to set the overwrite property to true. Otherwise Gradle throws an exception, saying that a task with that name already exists.

ここでは、Copyタイプのタスクを、シンプルな別のタスクに置き換えています。タスクを作成するときに、overwriteプロパティをtrueにセットしなければなりません。そうしないと、Gradleは例外を投げ、すでに同名のタスクが定義済みだと警告してきます。

15.8. タスクをスキップするSkipping tasks

Gradle offers multiple ways to skip the execution of a task.

Gradleは、タスクの実行をスキップする方法を複数用意しています。

15.8.1. 述語を使うUsing a predicate

You can use the onlyIf() method to attach a predicate to a task. The task's actions are only executed if the predicate evaluates to true. You implement the predicate as a closure. The closure is passed the task as a parameter, and should return true if the task should execute and false if the task should be skipped. The predicate is evaluated just before the task is due to be executed.

onlyIf()メソッドを使って、タスクに述語を付けることができます。タスクは、付加された述語がtrueと評価されたときのみ実行されます。述語は、一つのクロージャとして実装します。そのクロージャには、対象のタスクが引数に渡されます。タスクが実行されるべきならこのクロージャはtrueを返し、スキップされるべきならfalseを返さなければなりません。述語は、タスクが実行される直前に評価されます。

例15.20 述語でタスクをスキップ

build.gradle

task hello << {
    println 'hello world'
}

hello.onlyIf { !project.hasProperty('skipHello') }

gradle hello -PskipHello の出力

> gradle hello -PskipHello
:hello SKIPPED

BUILD SUCCESSFUL

Total time: 1 secs

15.8.2. StopExecutionExceptionを使うUsing StopExecutionException

If the logic for skipping a task can't be expressed with predicate, you can use the StopExecutionException. If this exception is thrown by an action, the further execution of this action as well as the execution of any following action of this task is skipped. The build continues with executing the next task.

タスクスキップのルールが述語で表現できない場合、StopExecutionExceptionを使うことができます。この例外がタスクのアクションから投げられたら、実行中のアクション、およびそのタスクの残りのアクションはすべてスキップされます。ビルド自体は継続されるので、次のタスクが実行されることになります。

例15.21 StopExecutionExceptionでタスクをスキップ

build.gradle

task compile << {
    println 'We are doing the compile.'
}

compile.doFirst {
    // Here you would put arbitrary conditions in real life.
    // But this is used in an integration test so we want defined behavior.
    if (true) { throw new StopExecutionException() }
}
task myTask(dependsOn: 'compile') << {
   println 'I am not affected'
}

gradle -q myTask の出力

> gradle -q myTask
I am not affected

This feature is helpful if you work with tasks provided by Gradle. It allows you to add conditional execution of the built-in actions of such a task. [12]

この機能は、Gradleが標準提供しているタスクが絡んでいるときに役に立ちます。このようなビルドインのタスクを、条件付きで実行させることができるのです。 [13]

15.8.3. タスクの有効化と無効化Enabling and disabling tasks

Every task has an enabled flag which defaults to true. Setting it to false prevents the execution of any of the task's actions.

すべてのタスクは、enabledフラグを持っており、デフォルトではtrueに設定されています。このフラグをfalseにすると、そのタスクのすべてのアクションが実行されなくなります。

例15.22 タスクの有効化と無効化

build.gradle

task disableMe << {
    println 'This should not be printed if the task is disabled.'
}
disableMe.enabled = false

gradle disableMe の出力

> gradle disableMe
:disableMe SKIPPED

BUILD SUCCESSFUL

Total time: 1 secs

15.9. 更新されていないタスクをスキップするSkipping tasks that are up-to-date

If you are using one of the tasks that come with Gradle, such as a task added by the Java plugin, you might have noticed that Gradle will skip tasks that are up-to-date. This behaviour is also available for your tasks, not just for built-in tasks.

JavaプラグインのようなGradleが提供しているタスクを使ったとき、Gradleが未更新(UP-TO-DATE)のタスクをスキップすることに気づかれたかもしれません。この動作は、ビルドインのタスクだけでなく、任意のタスクに組み込むことができます。

15.9.1. タスクの入力物と出力物を宣言するDeclaring a task's inputs and outputs

Let's have a look at an example. Here our task generates several output files from a source XML file. Let's run it a couple of times.

一つ例を見てみましょう。ここでは、定義したタスクが、XMLのソースファイルを元にいくつかのファイルを出力しています。このタスクを、何度か実行してみます。

例15.23 生成タスク

build.gradle

task transform {
    ext.srcFile = file('mountains.xml')
    ext.destDir = new File(buildDir, 'generated')
    doLast {
        println "Transforming source file."
        destDir.mkdirs()
        def mountains = new XmlParser().parse(srcFile)
        mountains.mountain.each { mountain ->
            def name = mountain.name[0].text()
            def height = mountain.height[0].text()
            def destFile = new File(destDir, "${name}.txt")
            destFile.text = "$name -> ${height}\n"
        }
    }
}

gradle transform の出力

> gradle transform
:transform
Transforming source file.

gradle transform の出力

> gradle transform
:transform
Transforming source file.

Notice that Gradle executes this task a second time, and does not skip the task even though nothing has changed. Our example task was defined using an action closure. Gradle has no idea what the closure does and cannot automatically figure out whether the task is up-to-date or not. To use Gradle's up-to-date checking, you need to declare the inputs and outputs of the task.

タスクを2回目に実行したとき、なにも変更されていないにもかかわらず、タスクの実行がスキップされなかったことに注目してください。この例にあるタスクでは、ひとつのクロージャを使ってアクションを定義していますが、Gradleにはこのクロージャが何をしているか知る手段がなく、タスクがUP-TO-DATEなのかどうかを自動的に決定することができないのです。GradleのUP-TO-DATEチェックを使うには、タスクの入力と出力を宣言する必要があります。

Each task has an inputs and outputs property, which you use to declare the inputs and outputs of the task. Below, we have changed our example to declare that it takes the source XML file as an input and produces output to a destination directory. Let's run it a couple of times.

すべてのタスクにはinputsプロパティとoutputsプロパティがあります。これが入力と出力を宣言するために使うプロパティです。次の例では、先ほどの例を修正し、このタスクがXMLのソースファイルを入力とし、あるディレクトリに出力ファイルを生成することを宣言しています。

例15.24 タスクの入力と出力を宣言

build.gradle

task transform {
    ext.srcFile = file('mountains.xml')
    ext.destDir = new File(buildDir, 'generated')
    inputs.file srcFile
    outputs.dir destDir
    doLast {
        println "Transforming source file."
        destDir.mkdirs()
        def mountains = new XmlParser().parse(srcFile)
        mountains.mountain.each { mountain ->
            def name = mountain.name[0].text()
            def height = mountain.height[0].text()
            def destFile = new File(destDir, "${name}.txt")
            destFile.text = "$name -> ${height}\n"
        }
    }
}

gradle transform の出力

> gradle transform
:transform
Transforming source file.

gradle transform の出力

> gradle transform
:transform UP-TO-DATE

Now, Gradle knows which files to check to determine whether the task is up-to-date or not.

これで、GradleはタスクがUP-TO-DATEなのかどうかを決定するため、どのファイルをチェックするべきか知ることができます。

The task's inputs property is of type TaskInputs. The task's outputs property is of type TaskOutputs.

タスクのinputsプロパティはTaskInputs型、outputsプロパティはTaskOutputs型です。

A task with no defined outputs will never be considered up-to-date. For scenarios where the outputs of a task are not files, or for more complex scenarios, the TaskOutputs.upToDateWhen() method allows you to calculate programmatically if the tasks outputs should be considered up to date.

A task with only outputs defined will be considered up-to-date if those outputs are unchanged since the previous build.

15.9.2. どのように動作するのか?How does it work?

Before a task is executed for the first time, Gradle takes a snapshot of the inputs. This snapshot contains the set of input files and a hash of the contents of each file. Gradle then executes the task. If the task completes successfully, Gradle takes a snapshot of the outputs. This snapshot contains the set of output files and a hash of the contents of each file. Gradle persists both snapshots for the next time the task is executed.

タスクが初回に実行されるとき、実行前にGradleは入力物のスナップショットをとります。このスナップショットには、入力ファイルのセットと、それぞれのファイル内容のハッシュが含まれています。Gradleは、その後、タスクを実行します。もしタスクが正常に終了すれば、Gradleは出力物のスナップショットを保存します。このスナップショットには、やはり出力ファイルのセットと、それぞれのファイル内容のハッシュが含まれていて、Gradleが、出力ディレクトリ内でファイルが作成または変更、削除されたことを検知するために使用されます。Gradleは、次回そのタスクが実行されたときのために、双方のスナップショットを保管します。

Each time after that, before the task is executed, Gradle takes a new snapshot of the inputs and outputs. If the new snapshots are the same as the previous snapshots, Gradle assumes that the outputs are up to date and skips the task. If they are not the same, Gradle executes the task. Gradle persists both snapshots for the next time the task is executed.

この後は、タスクが実行される前に毎回、入力物と出力物のスナップショットを新しく作成します。 もし、新しいスナップショットが、前回のスナップショットと同じなら、Gradleは出力がUP-TO-DATEだと見なし、タスクをスキップします。 スナップショットが異なっていれば、Gradleはタスクを実行し、次回実行されるときのためにスナップショットを保存しなおします。

Note that if a task has an output directory specified, any files added to that directory since the last time it was executed are ignored and will NOT cause the task to be out of date. This is so unrelated tasks may share an output directory without interfering with each other. If this is not the behaviour you want for some reason, consider using TaskOutputs.upToDateWhen()

15.10. タスクルールTask rules

Sometimes you want to have a task whose behavior depends on a large or infinite number value range of parameters. A very nice and expressive way to provide such tasks are task rules:

ときには、広範囲、または無限大な範囲のパラメータに応じた動作を行うタスクを定義したくなることがあります。このようなタスクを定義するための、表現力のあるよい方法がタスクルールです。

例15.25 タスクルール

build.gradle

tasks.addRule("Pattern: ping<ID>") { String taskName ->
    if (taskName.startsWith("ping")) {
        task(taskName) << {
            println "Pinging: " + (taskName - 'ping')
        }
    }
}

gradle -q pingServer1 の出力

> gradle -q pingServer1
Pinging: Server1

The String parameter is used as a description for the rule, which is shown with gradle tasks.

文字列が引数に渡されていますが、これはルールの説明として使用されます。例えば、gradle tasksを実行したときなどに表示されます。

Rules not only used when calling tasks from the command line. You can also create dependsOn relations on rule based tasks:

ルールは、ただコマンドラインからのタスク呼び出しにのみ使えるものではありません。dependsOnによる依存関係定義のときも、ルールベースのタスクを使うことができます。

例15.26 ルールベース・タスクの依存関係

build.gradle

tasks.addRule("Pattern: ping<ID>") { String taskName ->
    if (taskName.startsWith("ping")) {
        task(taskName) << {
            println "Pinging: " + (taskName - 'ping')
        }
    }
}

task groupPing {
    dependsOn pingServer1, pingServer2
}

gradle -q groupPing の出力

> gradle -q groupPing
Pinging: Server1
Pinging: Server2

If you run “gradle -q tasks” you won't find a task named “pingServer1” or “pingServer2”, but this script is executing logic based on the request to run those tasks.

15.11. Finalizer tasks

Finalizers tasks are an incubating feature (see 「試験的 Incubating).

Finalizer tasks are automatically added to the task graph when the finalized task is scheduled to run.

例15.27 Adding a task finalizer

build.gradle

task taskX << {
    println 'taskX'
}
task taskY << {
    println 'taskY'
}

taskX.finalizedBy taskY

gradle -q taskX の出力

> gradle -q taskX
taskX
taskY

Finalizer tasks will be executed even if the finalized task fails.

例15.28 Task finalizer for a failing task

build.gradle

task taskX << {
    println 'taskX'
    throw new RuntimeException()
}
task taskY << {
    println 'taskY'
}

taskX.finalizedBy taskY

gradle -q taskX の出力

> gradle -q taskX
taskX
taskY

On the other hand, finalizer tasks are not executed if the finalized task didn't do any work, for example if it is considered up to date or if a dependent task fails.

Finalizer tasks are useful in situations where the build creates a resource that has to be cleaned up regardless of the build failing or succeeding. An example of such a resource is a web container that is started before an integration test task and which should be always shut down, even if some of the tests fail.

To specify a finalizer task you use the Task.finalizedBy() method. This method accepts a task instance, a task name, or any other input accepted by Task.dependsOn().

15.12. まとめSummary

If you are coming from Ant, an enhanced Gradle task like Copy seems like a cross between an Ant target and an Ant task. Although Ant's tasks and targets are really different entities, Gradle combines these notions into a single entity. Simple Gradle tasks are like Ant's targets, but enhanced Gradle tasks also include aspects of Ant tasks. All of Gradle's tasks share a common API and you can create dependencies between them. These tasks are much easier to configure than an Ant task. They make full use of the type system, and are more expressive and easier to maintain.

以前にAntを使ったことがあれば、Copyのような拡張タスクは、Antのターゲットとタスクの間をとったようなものに見えるでしょう。 Antのタスクとターゲットは実際には異なるエンティティですが、Gradleはこれらの記法を1つのエンティティにまとめています。 単純なGradleのタスクはAntのターゲットのようなものだし、拡張タスクはAntタスクの性質を含んでいます。 すべてのGradleタスクは、同じのAPIを共有していて、タスク間の依存関係を定義することができます。 このため、GradleのタスクはAntタスクに比べて、より設定しやすいものになっているでしょう。 Gradleのタスクは、型システムをフル活用しており、より表現力豊かで、メンテナンス性もよくなっています。



[12] You might be wondering why there is neither an import for the StopExecutionException nor do we access it via its fully qualified name. The reason is, that Gradle adds a set of default imports to your script. These imports are customizable (see 付録E IDE対応の現状と、IDEによらない開発支援Existing IDE Support and how to cope without it).

[13] なぜimport文も完全修飾名も使用せずStopExecutionExceptionにアクセスできているのか不思議に思われたかもしれません。これは、Gradleがデフォルトでスクリプトにいくつかのimportを追加しているからです。このimportのセットはカスタマイズ可能です(付録E IDE対応の現状と、IDEによらない開発支援Existing IDE Support and how to cope without it参照)。

第16章 ファイルを取り扱う Working With Files

Most builds work with files. Gradle adds some concepts and APIs to help you achieve this.

ファイルの取り扱いは、ほとんどのビルドで発生する作業です。なので、それを補助するため、Gradleはいくつかの概念とAPIを導入しています。

16.1. ファイルを参照する Locating files

You can locate a file relative to the project directory using the Project.file() method.

Project.file() メソッドで、プロジェクトディレクトリからの相対参照でファイルを取得できます。

例16.1 ファイルを参照する

build.gradle

// Using a relative path
File configFile = file('src/config.xml')

// Using an absolute path
configFile = file(configFile.absolutePath)

// Using a File object with a relative path
configFile = file(new File('src/config.xml'))

You can pass any object to the file() method, and it will attempt to convert the value to an absolute File object. Usually, you would pass it a String or File instance. If this path is an absolute path, it is used to construct a File instance. Otherwise, a File instance is constructed by prepending the project directory path to the supplied path. The file() method also understands URLs, such as file:/some/path.xml.

file()メソッドには、あらゆるオブジェクトを渡すことができます。渡したオブジェクトは、絶対参照のFileに変換されます。大抵はStringFileのインスタンスを渡すことになるでしょう。渡されたオブジェクトのtoString()が呼ばれ、その返値がファイルパスとして使われます。もしそのパスが絶対パスだった場合、そのパスでFileインスタンスが構築されます。そうでなければ、プロジェクトディレクリのパスを先頭に追加してからFileインスタンスが構築されます。また、file()メソッドはfile:/some/path.xmlのようなURLにも対応しています。

Using this method is a useful way to convert some user provided value into an absolute File. It is preferable to using new File(somePath), as file() always evaluates the supplied path relative to the project directory, which is fixed, rather than the current working directory, which can change depending on how the user runs Gradle.

このメソッドを使って、ユーザーが指定した値を簡単に絶対参照のFileインスタンスに変換できます。 これは、new File(somePath)を使うよりもよい方法でしょう。file()メソッドは、常にプロジェクトディレクリからの相対参照で解決されるからです。ワーキングディレクトリはGradleをどう実行したかによって変化しうるわけですが、それに依存せずにファイルを参照できます。

16.2. ファイルコレクション File collections

A file collection is simply a set of files. It is represented by the FileCollection interface. Many objects in the Gradle API implement this interface. For example, dependency configurations implement FileCollection.

ファイルコレクションは、単なるファイルの集合です。これは、FileCollectionインターフェースで表現されます。Gradle APIに含まれる多くのオブジェクトがこのインターフェースを実装しています。例えば、依存関係のコンフィグレーションもこのFileCollectionインターフェースを実装しています。

One way to obtain a FileCollection instance is to use the Project.files() method. You can pass this method any number of objects, which are then converted into a set of File objects. The files() method accepts any type of object as its parameters. These are evaluated relative to the project directory, as per the file() method, described in 「ファイルを参照する Locating files. You can also pass collections, iterables, maps and arrays to the files() method. These are flattened and the contents converted to File instances.

FileCollectionを取得する方法の一つは、Project.files()メソッドを使うことです。このメソッドには任意の数のオブジェクトを渡すことができ、渡したオブジェクトはFileオブジェクトの集合に変換されます。これらのオブジェクトは、「ファイルを参照する Locating filesで述べたfile()メソッドと同じように、プロジェクトディレクトリからの相対参照で解決されます。 また、コレクション、イテレーブル、マップ、配列を渡すこともできます。これらは、フラット化されてから、各要素がFileインスタンスに変換されます。

例16.2 ファイルコレクションの作成

build.gradle

FileCollection collection = files('src/file1.txt',
                                  new File('src/file2.txt'),
                                  ['src/file3.txt', 'src/file4.txt'])

A file collection is iterable, and can be converted to a number of other types using the as operator. You can also add 2 file collections together using the + operator, or subtract one file collection from another using the - operator. Here are some examples of what you can do with a file collection.

ファイルコレクションはイテレーブルです。さらに、as演算子で様々な型に変換することができます。 また、二つのファイルコレクションを+演算子で合成したり、-演算子でファイルコレクションから別のファイルコレクションの要素を取り除いたりすることができます。 次の例は、ファイルコレクションでどのようなことができるかを示すものです。

例16.3 ファイルコレクションを使う

build.gradle

// Iterate over the files in the collection
collection.each {File file ->
    println file.name
}

// Convert the collection to various types
Set set = collection.files
Set set2 = collection as Set
List list = collection as List
String path = collection.asPath
File file = collection.singleFile
File file2 = collection as File

// Add and subtract collections
def union = collection + files('src/file3.txt')
def different = collection - files('src/file3.txt')

You can also pass the files() method a closure or a Callable instance. This is called when the contents of the collection are queried, and its return value is converted to a set of File instances. The return value can be an object of any of the types supported by the files() method. This is a simple way to 'implement' the FileCollection interface.

files()メソッドには、クロージャやCallableのインスタンスを渡すこともできます。 これはそのファイルコレクションの内容が要求されたときに実行され、返値がFileインスタンスの集合に変換されます。返値はfiles()に渡すことができるオブジェクトならなんでも構いません。これは、FileCollectionインタフェースを簡単に「実装する」方法とも言えます。

例16.4 ファイルコレクションを実装する

build.gradle

task list << {
    File srcDir

    // Create a file collection using a closure
    collection = files { srcDir.listFiles() }

    srcDir = file('src')
    println "Contents of $srcDir.name"
    collection.collect { relativePath(it) }.sort().each { println it }

    srcDir = file('src2')
    println "Contents of $srcDir.name"
    collection.collect { relativePath(it) }.sort().each { println it }
}

gradle -q list の出力

> gradle -q list
Contents of src
src/dir1
src/file1.txt
Contents of src2
src2/dir1
src2/dir2

Some other types of things you can pass to files():

他にもいくつかfiles()メソッドに渡せる型があります。

FileCollection

These are flattened and the contents included in the file collection.

フラット化されてから、その内容がファイルコレクションに追加される。

Task

The output files of the task are included in the file collection.

タスクの出力ファイルがファイルコレクションに追加される。

TaskOutputs

The output files of the TaskOutputs are included in the file collection.

TaskOutputsの出力ファイルがファイルコレクションに追加される。

It is important to note that the content of a file collection is evaluated lazily, when it is needed. This means you can, for example, create a FileCollection that represents files which will be created in the future by, say, some task.

留意すべき重要な点は、ファイルコレクションの内容は、必要になったときに遅延評価されるということです。 これはつまり、例えば未来にタスクなどによって作られるであろうファイル群を表すFileCollectionを作ることもできる、ということを意味します。

16.3. ファイルツリー File trees

A file tree is a collection of files arranged in a hierarchy. For example, a file tree might represent a directory tree or the contents of a ZIP file. It is represented by the FileTree interface. The FileTree interface extends FileCollection, so you can treat a file tree exactly the same way as you would a file collection. Several objects in Gradle implement the FileTree interface, such as source sets.

ファイルツリーは、階層構造を持つファイルの集合です。例えば、ディレクトリツリーやZIPの中身を表すことができます。ファイルツリーはFileTreeインターフェースによって表現されます。FileTreeインターフェースはFileCollectionインターフェースを継承しています。なので、FileTreeはFileCollectionと全く同じ方法で取り扱うことができます。 いくつかのGradleオブジェクトはFileTreeを実装しています。例えば、ソースセットなどです。

One way to obtain a FileTree instance is to use the Project.fileTree() method. This creates a FileTree defined with a base directory, and optionally some Ant-style include and exclude patterns.

FileTreeインスタンスを取得する方法の一つは、Project.fileTree()メソッドを使用することです。 このメソッドは、ベースディレクトリとAntスタイルのinclude/excludeパターンを指定してFileTreeを構築します。

例16.5 ファイルツリーを作成する

build.gradle

// Create a file tree with a base directory
FileTree tree = fileTree(dir: 'src/main')

// Add include and exclude patterns to the tree
tree.include '**/*.java'
tree.exclude '**/Abstract*'

// Create a tree using path
tree = fileTree('src').include('**/*.java')

// Create a tree using closure
tree = fileTree('src') {
    include '**/*.java'
}

// Create a tree using a map
tree = fileTree(dir: 'src', include: '**/*.java')
tree = fileTree(dir: 'src', includes: ['**/*.java', '**/*.xml'])
tree = fileTree(dir: 'src', include: '**/*.java', exclude: '**/*test*/**')

You use a file tree in the same way you use a file collection. You can also visit the contents of the tree, and select a sub-tree using Ant-style patterns:

ファイルツリーは、ファイルコレクションと同じ方法で使うことができます。さらに、ツリー構造を辿ったり、Antスタイルのパターンを指定してサブツリーを選択することも可能です。

例16.6 ファイルツリーを使う

build.gradle

// Iterate over the contents of a tree
tree.each {File file ->
    println file
}

// Filter a tree
FileTree filtered = tree.matching {
    include 'org/gradle/api/**'
}

// Add trees together
FileTree sum = tree + fileTree(dir: 'src/test')

// Visit the elements of the tree
tree.visit {element ->
    println "$element.relativePath => $element.file"
}

16.4. アーカイブの内容をファイルツリーとして使う Using the contents of an archive as a file tree

You can use the contents of an archive, such as a ZIP or TAR file, as a file tree. You do this using the Project.zipTree() and Project.tarTree() methods. These methods return a FileTree instance which you can use like any other file tree or file collection. For example, you can use it to expand the archive by copying the contents, or to merge some archives into another.

ZIPやTARファイルなどのアーカイブを、ファイルツリーとして使うことができます。そのためのメソッドが、Project.zipTree()Project.tarTree()です。これらのメソッドは、FileTreeインスタンスを返すもので、返されたインスタンスは、他のファイルツリーやファイルコレクションと同様に扱うことができます。 例えば、内容をコピーすることでアーカイブを解凍したり、別のアーカイブとマージしたりできます。

例16.7 アーカイブをファイルツリーとして使う

build.gradle

// Create a ZIP file tree using path
FileTree zip = zipTree('someFile.zip')

// Create a TAR file tree using path
FileTree tar = tarTree('someFile.tar')

//tar tree attempts to guess the compression based on the file extension
//however if you must specify the compression explicitly you can:
FileTree someTar = tarTree(resources.gzip('someTar.ext'))

16.5. 入力ファイルセットを指定する Specifying a set of input files

Many objects in Gradle have properties which accept a set of input files. For example, the JavaCompile task has a source property, which defines the source files to compile. You can set the value of this property using any of the types supported by the files() method, which was shown above. This means you can set the property using, for example, a File, String, collection, FileCollection or even a closure. Here are some examples:

多くのGradleオブジェクトが入力ファイルセットを格納できるプロパティを持っています。例えば、JavaCompileタスクにはsourceプロパティがあり、コンパイルするべきソースファイルの集合をそこに定義します。 このプロパティの値には、files()でサポートされている、上記の全ての型が使用可能です。 つまり、FileString、コレクション、FileCollection、クロージャでさえセット可能ということです。次の例を見てください。

例16.8 ファイルセットを指定する

build.gradle

// Use a File object to specify the source directory
compile {
    source = file('src/main/java')
}

// Use a String path to specify the source directory
compile {
    source = 'src/main/java'
}

// Use a collection to specify multiple source directories
compile {
    source = ['src/main/java', '../shared/java']
}

// Use a FileCollection (or FileTree in this case) to specify the source files
compile {
    source = fileTree(dir: 'src/main/java').matching { include 'org/gradle/api/**' }
}

// Using a closure to specify the source files.
compile {
    source = {
        // Use the contents of each zip file in the src dir
        file('src').listFiles().findAll {it.name.endsWith('.zip')}.collect { zipTree(it) }
    }
}

Usually, there is a method with the same name as the property, which appends to the set of files. Again, this method accepts any of the types supported by the files() method.

大抵、そのプロパティと同名のメソッドも定義されていて、そのメソッドでファイルセットを追加できるようになっています。このメソッドにもfiles()でサポートされている全ての型を渡すことができます。

例16.9 ファイルセットを指定する

build.gradle

compile {
    // Add some source directories use String paths
    source 'src/main/java', 'src/main/groovy'

    // Add a source directory using a File object
    source file('../shared/java')

    // Add some source directories using a closure
    source { file('src/test/').listFiles() }
}

16.6. ファイルをコピーする Copying files

You can use the Copy task to copy files. The copy task is very flexible, and allows you to, for example, filter the contents of the files as they are copied, and map to the file names.

Copyタスクを使ってファイルをコピーできます。このタスクはとても柔軟で、コピーしたファイルの内容をフィルターにかけたり、ファイル名をマッピングで変換したりできます。

To use the Copy task, you must provide a set of source files to copy, and a destination directory to copy the files to. You may also specify how to transform the files as they are copied. You do all this using a copy spec. A copy spec is represented by the CopySpec interface. The Copy task implements this interface. You specify the source files using the CopySpec.from() method. To specify the destination directory, use the CopySpec.into() method.

Copyタスクを使うには、コピーすべきソースファイルと、コピー先のディレクトリを指定しなければなりません。また、コピー時にファイルを編集する場合は、それについても指定します。これらの指定は全て、Copy仕様を使って行います。Copy仕様は、CopySpecインターフェースで表現されており、Copyタスクはこのインターフェースを実装したものです。ソースファイルの指定には、CopySpec.from()メソッドを使います。コピー先ディレクトリの指定には、CopySpec.into()メソッドを使います。

例16.10 Copyタスクでファイルをコピーする

build.gradle

task copyTask(type: Copy) {
    from 'src/main/webapp'
    into 'build/explodedWar'
}

The from() method accepts any of the arguments that the files() method does. When an argument resolves to a directory, everything under that directory (but not the directory itself) is recursively copied into the destination directory. When an argument resolves to a file, that file is copied into the destination directory. When an argument resolves to a non-existing file, that argument is ignored. If the argument is a task, the output files (i.e. the files the task creates) of the task are copied and the task is automatically added as a dependency of the Copy task. The into() accepts any of the arguments that the file() method does. Here is another example:

from()メソッドが受け付ける型は、files()メソッドと同じです。ディレクトリパスに解決されるような引数を渡した場合、そのディレクトリ以下の全て(ただし、そのディレクトリ自身は除く)が再帰的にターゲットディレクトリにコピーされます。渡した引数がファイルパスに解決された場合は、そのファイルが目的のディレクトリにコピーされます。 もし、引数に渡したパスにファイルがない場合、その引数は無視されます。 引数にタスクを渡した場合、そのタスクの出力ファイル(タスクが作成するファイル)がコピーされ、そのタスクは自動的にCopyタスクが依存しているタスクとして設定されます。 into()メソッドは、file()と同じ型を引数に取ります。以下にもう一つ例を挙げます。

例16.11 Copyタスクのコピー元と宛先を指定する

build.gradle

task anotherCopyTask(type: Copy) {
    // Copy everything under src/main/webapp
    from 'src/main/webapp'
    // Copy a single file
    from 'src/staging/index.html'
    // Copy the output of a task
    from copyTask
    // Copy the output of a task using Task outputs explicitly.
    from copyTaskWithPatterns.outputs
    // Copy the contents of a Zip file
    from zipTree('src/main/assets.zip')
    // Determine the destination directory later
    into { getDestDir() }
}

You can select the files to copy using Ant-style include or exclude patterns, or using a closure:

Antスタイルのinclude/excludeパターンかクロージャを用いて、コピーするファイルを選択することができます。

例16.12 コピーするファイルを選択する

build.gradle

task copyTaskWithPatterns(type: Copy) {
    from 'src/main/webapp'
    into 'build/explodedWar'
    include '**/*.html'
    include '**/*.jsp'
    exclude { details -> details.file.name.endsWith('.html') &&
                         details.file.text.contains('staging') }
}

You can also use the Project.copy() method to copy files. It works the same way as the task with some major limitations though. First, the copy() is not incremental (see 「更新されていないタスクをスキップするSkipping tasks that are up-to-date).

また、Project.copy()メソッドでファイルをコピーすることもできます。これはタスクの場合と大体同じように動作しますが、いくつかの大きな制限もあります。まず、copy()メソッドはインクリメンタルには実施されません(「更新されていないタスクをスキップするSkipping tasks that are up-to-date参照)。

例16.13 copy()メソッドで更新チェックせずにファイルをコピーする

build.gradle

task copyMethod << {
    copy {
        from 'src/main/webapp'
        into 'build/explodedWar'
        include '**/*.html'
        include '**/*.jsp'
    }
}

Secondly, the copy() method can not honor task dependencies when a task is used as a copy source (i.e. as an argument to from()) because it's a method and not a task. As such, if you are using the copy() method as part of a task action, you must explicitly declare all inputs and outputs in order to get the correct behavior.

次に、タスクがコピー元として使われる場合(from()メソッドの引数になる場合)でも、copy()メソッドはタスクの依存関係を考慮しません。copy()はあくまでメソッドであってタスクではないからです。 よって、copy()メソッドをタスクアクションの中で呼び出す場合は、正しく動作させるために明示的に全ての入力と出力を宣言する必要があります。

例16.14 copy()メソッドで更新チェックを実施してファイルをコピーする

build.gradle

task copyMethodWithExplicitDependencies{
    // up-to-date check for inputs, plus add copyTask as dependency
    inputs.file copyTask
    outputs.dir 'some-dir' // up-to-date check for outputs
    doLast{
        copy {
            // Copy the output of copyTask
            from copyTask
            into 'some-dir'
        }
    }
}

It is preferable to use the Copy task wherever possible, as it supports incremental building and task dependency inference without any extra effort on your part. The copy() method can be used to copy files as part of a task's implementation. That is, the copy method is intended to be used by custom tasks (see 58章カスタムタスクの作成Writing Custom Task Classes) that need to copy files as part of their function. In such a scenario, the custom task should sufficiently declare the inputs/outputs relevant to the copy action.

できるだけCopyタスクのほうを使用するようにしてください。そうすれば、余計な手間をかけずにインクリメンタルビルドやタスク依存関係の恩恵を受けることができます。 一方、copy()メソッドは、あるタスクの実装の一部としてファイルコピーを組み込むことができます。 つまり、copy()メソッドはカスタムタスク(58章カスタムタスクの作成Writing Custom Task Classes参照)の機能でファイルコピーが必要になった場合に使用されることを想定しています。 そのカスタムタスクでは、ファイルコピーの実際の仕様に基づいて適切に入力と出力が宣言されていなければなりません。

16.6.1. ファイルをリネームする Renaming files

例16.15 コピー時にファイルをリネームする

build.gradle

task rename(type: Copy) {
    from 'src/main/webapp'
    into 'build/explodedWar'
    // Use a closure to map the file name
    rename { String fileName ->
        fileName.replace('-staging-', '')
    }
    // Use a regular expression to map the file name
    rename '(.+)-staging-(.+)', '$1$2'
    rename(/(.+)-staging-(.+)/, '$1$2')
}

16.6.2. ファイルをフィルタリングする Filtering files

例16.16 コピー時にファイルをフィルタリングする

build.gradle

import org.apache.tools.ant.filters.FixCrLfFilter
import org.apache.tools.ant.filters.ReplaceTokens

task filter(type: Copy) {
    from 'src/main/webapp'
    into 'build/explodedWar'
    // Substitute property tokens in files
    expand(copyright: '2009', version: '2.3.1')
    expand(project.properties)
    // Use some of the filters provided by Ant
    filter(FixCrLfFilter)
    filter(ReplaceTokens, tokens: [copyright: '2009', version: '2.3.1'])
    // Use a closure to filter each line
    filter { String line ->
        "[$line]"
    }
}

A “token” in a source file that both the “expand” and “filter” operations look for, is formatted like “@tokenName@” for a token named “tokenName”.

16.6.3. CopySpecクラスを使う Using the CopySpec class

Copy specs form a hierarchy. A copy spec inherits its destination path, include patterns, exclude patterns, copy actions, name mappings and filters.

コピー仕様は階層構造を構成でき、宛先パス、include/excludeパターン、コピー動作、ファイル名のマッピング、フィルターを継承できます。

例16.17 入れ子構造のコピー仕様

build.gradle

task nestedSpecs(type: Copy) {
    into 'build/explodedWar'
    exclude '**/*staging*'
    from('src/dist') {
        include '**/*.html'
    }
    into('libs') {
        from configurations.runtime
    }
}

16.7. Syncタスクを使う Using the Sync task

The Sync task extends the Copy task. When it executes, it copies the source files into the destination directory, and then removes any files from the destination directory which it did not copy. This can be useful for doing things such as installing your application, creating an exploded copy of your archives, or maintaining a copy of the project's dependencies.

SyncCopyタスクを継承したタスクです。このタスクは、宛先ディレクトリにファイルをコピーし、その後、コピーしたファイル以外の全ファイルを宛先ディレクトリから削除します。これは、アプリケーションをインストールしたり、アーカイブを解凍したり、プロジェクトの依存関係のコピーをメンテナンスしたりするのに便利です。

Here is an example which maintains a copy of the project's runtime dependencies in the build/libs directory.

次の例では、build/libsにある実行時依存関係のコピーをメンテナンスしています。

例16.18 Syncタスクで依存関係をコピーする

build.gradle

task libs(type: Sync) {
    from configurations.runtime
    into "$buildDir/libs"
}

16.8. アーカイブを作成する Creating archives

A project can have as many as JAR archives as you want. You can also add WAR, ZIP and TAR archives to your project. Archives are created using the various archive tasks: Zip, Tar, Jar, War, and Ear. They all work the same way, so let's look at how you create a ZIP file.

一つのプロジェクトで、JARファイルを好きなだけ作成することができます。WAR、ZIP、TARなどのアーカイブをプロジェクトに加えることもできます。 アーカイブは、 ZipTarJarWarEarなどのアーカイブタスクを使って作成します。 これらは全て同じ使い方なので、ここではZIPファイルの作成方法を見てみましょう。

例16.19 ZIPアーカイブの作成

build.gradle

apply plugin: 'java'

task zip(type: Zip) {
    from 'src/dist'
    into('libs') {
        from configurations.runtime
    }
}

なぜJavaプラグインを使うのですか? Why are you using the Java plugin?

The Java plugin adds a number of default values for the archive tasks. You can use the archive tasks without using the Java plugin, if you like. You will need to provide values for some additional properties.

Javaプラグインは、アーカイブタスクに多くのデフォルト値を追加します。必要なら、Javaプラグインなしでアーカイブタスクを使うことも可能です。その場合、いくつかのプロパティを自分で定義する必要があるでしょう。

The archive tasks all work exactly the same way as the Copy task, and implement the same CopySpec interface. As with the Copy task, you specify the input files using the from() method, and can optionally specify where they end up in the archive using the into() method. You can filter the contents of file, rename files, and all the other things you can do with a copy spec.

アーカイブタスクは、全てCopyタスクと全く同じように動作します。これらのタスクは、Copyタスク同様、CopySpecインターフェースを実装しています。Copyタスクと同じようにfrom()メソッドで入力ファイルを指定し、必須ではありませんがinto()メソッドで最終的にアーカイブが出力される場所を指定します。ファイルのフィルタリング、リネーム、その他コピー仕様で使える全てのオプションを使うことができます。

16.8.1. アーカイブのネーミング Archive naming

The format of projectName-version.type is used for generated archive file names. For example:

作成されるアーカイブの名前は、デフォルトではprojectName-version.typeです。例えば、

例16.20 ZIPアーカイブの作成

build.gradle

apply plugin: 'java'

version = 1.0

task myZip(type: Zip) {
    from 'somedir'
}

println myZip.archiveName
println relativePath(myZip.destinationDir)
println relativePath(myZip.archivePath)

gradle -q myZip の出力

> gradle -q myZip
zipProject-1.0.zip
build/distributions
build/distributions/zipProject-1.0.zip

This adds a Zip archive task with the name myZip which produces ZIP file zipProject-1.0.zip. It is important to distinguish between the name of the archive task and the name of the archive generated by the archive task. The default name for archives can be changed with the archivesBaseName project property. The name of the archive can also be changed at any time later on.

ここでは、myZipという名前のZipアーカイブタスクが、zipProject-1.-.zipというZIPファイルを作成しています。大事なことは、アーカイブタスクの名前と、そのタスクで作成したアーカイブ名に関連がないことです。デフォルトのアーカイブ名は、プロジェクトのarchivesBaseNameプロパティで変更できます。そのアーカイブ名も、後からいつでも変更可能です。

There are a number of properties which you can set on an archive task. These are listed below in 表16.1「アーカイブタスク - ネーミングプロパティ Archive tasks - naming properties. You can, for example, change the name of the archive:

アーカイブタスクにセットできるプロパティはたくさんあります。それらを下の表16.1「アーカイブタスク - ネーミングプロパティ Archive tasks - naming propertiesにリストしました。例えば、アーカイブの名前を変更したい場合は次のようにします。

例16.21 アーカイブタスクの設定 - カスタムアーカイブ名

build.gradle

apply plugin: 'java'
version = 1.0

task myZip(type: Zip) {
    from 'somedir'
    baseName = 'customName'
}

println myZip.archiveName

gradle -q myZip の出力

> gradle -q myZip
customName-1.0.zip

You can further customize the archive names:

アーカイブ名をさらにカスタマイズすることもできます。

例16.22 アーカイブタスクの設定 - appendix & classifier

build.gradle

apply plugin: 'java'
archivesBaseName = 'gradle'
version = 1.0

task myZip(type: Zip) {
    appendix = 'wrapper'
    classifier = 'src'
    from 'somedir'
}

println myZip.archiveName

gradle -q myZip の出力

> gradle -q myZip
gradle-wrapper-1.0-src.zip

表16.1 アーカイブタスク - ネーミングプロパティ Archive tasks - naming properties

プロパティ名 Property name Type デフォルト値 Default value 説明 Description
archiveName String baseName-appendix-version-classifier.extension

If any of these properties is empty the trailing - is not added to the name.

プロパティが空だった場合、それに伴う-も追加されない。

生成されるアーカイブのベースファイル名 The base file name of the generated archive
archivePath File destinationDir/archiveName 生成されるアーカイブの絶対パス The absolute path of the generated archive.
destinationDir File アーカイブの種類に依存する。JAR、WARの場合はproject.buildDir/libraries。ZIP、TARの場合はproject.buildDir/distributionsDepends on the archive type. JARs and WARs are generated into project.buildDir/libraries. ZIPs and TARs are generated into project.buildDir/distributions. アーカイブが生成されるディレクトリ The directory to generate the archive into
baseName String project.name アーカイブ名の「ベース名」部 The base name portion of the archive file name.
appendix String null アーカイブ名の「付加」部 The appendix portion of the archive file name.
version String project.version アーカイブ名の「バージョン」部 The version portion of the archive file name.
classifier String null アーカイブ名の「分類子」部 The classifier portion of the archive file name,
extension String アーカイブの種類に依存する。TARファイルの場合、圧縮方法にも依存する。Depends on the archive type, and for TAR files, the compression type as well: zip, jar, war, tar, tgz or tbz2. アーカイブ名の拡張子 The extension of the archive file name.

16.8.2. 複数のアーカイブで中身を共有する Sharing content between multiple archives

You can use the Project.copySpec() method to share content between archives.

Project.copySpec()メソッドを使ってアーカイブ間で中身を共有できます。

Often you will want to publish an archive, so that it is usable from another project. This process is described in 52章アーティファクトの公開 Publishing artifacts

アーカイブを別のプロジェクトで使えるようにするために、そのアーカイブを公開したくなることがよくあります。この処理については、52章アーティファクトの公開 Publishing artifactsに記載されています。

第17章 GradleからAntを使うUsing Ant from Gradle

Gradle provides excellent integration with Ant. You can use individual Ant tasks or entire Ant builds in your Gradle builds. In fact, you will find that it's far easier and more powerful using Ant tasks in a Gradle build script, than it is to use Ant's XML format. You could even use Gradle simply as a powerful Ant task scripting tool.

Gradleは優れたAntとの統合機能を提供しています。 Gradleビルドの中で、個別のAntタスクや、Antビルド全体を利用することができます。 実際、AntのXMLフォーマットを利用するよりも、Gradleビルドの中でAntタスクを使う方がはるかに簡単でより強力であることに気づくでしょう。 Gradleを単に強力なAntスクリプティングツールとして使ってもよいくらいです。

Ant can be divided into two layers. The first layer is the Ant language. It provides the syntax for the build.xml, the handling of the targets, special constructs like macrodefs, and so on. In other words, everything except the Ant tasks and types. Gradle understands this language, and allows you to import your Ant build.xml directly into a Gradle project. You can then use the targets of your Ant build as if they were Gradle tasks.

Antは二つのレイヤーに分割できます。 第一のレイヤーはAnt言語で、build.xmlの文法やターゲットの取り扱い、およびmacrodefのような特別な構成要素などを提供します。 別の言い方では、Antタスクとタイプを除くすべてのものです。 Gradleはこの言語を理解し、GradleプロジェクトにAntのbuild.xmlを直接インポートすることを可能にしています。 そのため、AntビルドのターゲットをGradleのタスクであるかのように利用することができます。

The second layer of Ant is its wealth of Ant tasks and types, like javac, copy or jar. For this layer Gradle provides integration simply by relying on Groovy, and the fantastic AntBuilder.

Antの第二のレイヤーは、javaccopyjarといった豊富なAntタスクやタイプの資産です。 このレイヤーに対してはGroovyのすばらしいAntBuilderが利用できるため、Gradleはシンプルな統合機能を提供するのみです。

Finally, since build scripts are Groovy scripts, you can always execute an Ant build as an external process. Your build script may contain statements like:"ant clean compile".execute(). [14]

最後に、ビルドスクリプトはGroovyスクリプトなので、いつでもAntビルドを外部プロセスとして実行できます。 ビルドスクリプトは"ant clean compile".execute()のような実行文を含んでいてもかまいません。 [15]

You can use Gradle's Ant integration as a path for migrating your build from Ant to Gradle. For example, you could start by importing your existing Ant build. Then you could move your dependency declarations from the Ant script to your build file. Finally, you could move your tasks across to your build file, or replace them with some of Gradle's plugins. This process can be done in parts over time, and you can have a working Gradle build during the entire process.

GradleのAnt統合機能を、AntからGradleへのビルド移行パスとして利用することもできます。 例えば、既存のAntビルドをインポートするところから始めてもよいでしょう。 それから、依存関係の宣言をAntスクリプトから新しいビルドファイルへ移動していきます。 最後に、タスクを新しいビルドファイルへ移動するか、Gradleプラグインで置き換えます。 このプロセスは一部分づつ段階的に実施でき、プロセス全体を通してGradleによるビルドを利用できます。

17.1. ビルドでのAntタスクとタイプの利用Using Ant tasks and types in your build

In your build script, a property called ant is provided by Gradle. This is a reference to an AntBuilder instance. This AntBuilder is used to access Ant tasks, types and properties from your build script. There is a very simple mapping from Ant's build.xml format to Groovy, which is explained below.

ビルドスクリプトではGradleによってプロパティantが提供されます。 これはAntBuilderインスタンスへの参照です。 このAntBuilderはビルドスクリプトからAntタスクやタイプ、プロパティへのアクセスに利用します。 Antのbuild.xmlフォーマットからGroovyへのマッピングは非常に簡単です。 以下で説明します。

You execute an Ant task by calling a method on the AntBuilder instance. You use the task name as the method name. For example, you execute the Ant echo task by calling the ant.echo() method. The attributes of the Ant task are passed as Map parameters to the method. Below is an example of the echo task. Notice that we can also mix Groovy code and the Ant task markup. This can be extremely powerful.

Antタスクを実行するには、AntBuilderインスタンスのメソッドを呼び出します。 Antタスク名がメソッド名になります。 例えば、Antのechoタスクを実行する場合は、ant.echo()メソッドを呼び出します。 Antタスクの属性は、メソッドにMap型のパラメータとして渡します。 以下はechoタスクを実行するサンプルです。 GroovyコードとAntタスクのマークアップを混在できることに注意してください。 これは非常に強力です。

例17.1 Antタスクの利用

build.gradle

task hello << {
    String greeting = 'hello from Ant'
    ant.echo(message: greeting)
}

gradle hello の出力

> gradle hello
:hello
[ant:echo] hello from Ant

BUILD SUCCESSFUL

Total time: 1 secs

You pass nested text to an Ant task by passing it as a parameter of the task method call. In this example, we pass the message for the echo task as nested text:

Antタスクのメソッド呼び出しのパラメータとして渡してやることで、ネストされたテキストをAntタスクに渡すことができます。 この例では、echoタスクに対するメッセージをネストされたテキストとして渡しています。

例17.2 Antタスクにネストされたテキストを渡す

build.gradle

task hello << {
    ant.echo('hello from Ant')
}

gradle hello の出力

> gradle hello
:hello
[ant:echo] hello from Ant

BUILD SUCCESSFUL

Total time: 1 secs

You pass nested elements to an Ant task inside a closure. Nested elements are defined in the same way as tasks, by calling a method with the same name as the element we want to define.

Antタスクにネストされた要素を渡す場合はクロージャの内部に記述します。 ネストされた要素はタスクと同じように、指定したい要素名と同じメソッドを呼び出すことで指定できます。

例17.3 Antタスクにネストされた要素を渡す

build.gradle

task zip << {
    ant.zip(destfile: 'archive.zip') {
        fileset(dir: 'src') {
            include(name: '**.xml')
            exclude(name: '**.java')
        }
    }
}

You can access Ant types in the same way that you access tasks, using the name of the type as the method name. The method call returns the Ant data type, which you can then use directly in your build script. In the following example, we create an Ant path object, then iterate over the contents of it.

Antタスクにアクセスするのと同じ方法、すなわちタイプ名をメソッド名として利用することでAntタイプにアクセスできます。 メソッド呼び出しの戻り値はAntデータ型なので、ビルドスクリプトの中で直接利用できます。 次の例では、Antのpathオブジェクトを生成し、その内容をすべてイテレートしています。

例17.4 Antタイプの利用

build.gradle

task list << {
    def path = ant.path {
        fileset(dir: 'libs', includes: '*.jar')
    }
    path.list().each {
        println it
    }
}

More information about AntBuilder can be found in 'Groovy in Action' 8.4 or at the Groovy Wiki

AntBuilderに関する詳細は「Groovy in Action」の8.4節、ないしはGroovy Wikiを参照してください。

17.1.1. ビルドでカスタムAntタスクを使うUsing custom Ant tasks in your build

To make custom tasks available in your build, you can use the taskdef (usually easier) or typedef Ant task, just as you would in a build.xml file. You can then refer to the custom Ant task as you would a built-in Ant task.

ビルドでカスタムタスクを有効にするためには、 build.xmlファイルと同じくAntタスクのtaskdef(大抵はこちらの方が簡単です)かtypedefを利用します。 これにより組み込みのAntタスクと同様にカスタムAntタスクが参照できるようになります。

例17.5 カスタムAntタスクの利用

build.gradle

task check << {
    ant.taskdef(resource: 'checkstyletask.properties') {
        classpath {
            fileset(dir: 'libs', includes: '*.jar')
        }
    }
    ant.checkstyle(config: 'checkstyle.xml') {
        fileset(dir: 'src')
    }
}

You can use Gradle's dependency management to assemble the classpath to use for the custom tasks. To do this, you need to define a custom configuration for the classpath, then add some dependencies to the configuration. This is described in more detail in 「依存関係の定義方法 How to declare your dependencies.

カスタムタスクを利用するために必要なクラスパスの設定には、Gradleの依存関係管理機能が利用できます。 このために、クラスパスに対するカスタムコンフィグレーションを定義して、コンフィグレーションに対する依存関係を追加する必要があります。 詳細については「依存関係の定義方法 How to declare your dependenciesに記述されています。

例17.6 カスタムAntタスクに対するクラスパスの宣言

build.gradle

configurations {
    pmd
}

dependencies {
    pmd group: 'pmd', name: 'pmd', version: '4.2.5'
}

To use the classpath configuration, use the asPath property of the custom configuration.

クラスパスを設定するには、カスタムコンフィグレーションのasPathプロパティを利用します。

例17.7 カスタムAntタスクと依存関係管理を併用

build.gradle

task check << {
    ant.taskdef(name: 'pmd',
                classname: 'net.sourceforge.pmd.ant.PMDTask',
                classpath: configurations.pmd.asPath)
    ant.pmd(shortFilenames: 'true',
            failonruleviolation: 'true',
            rulesetfiles: file('pmd-rules.xml').toURI().toString()) {
        formatter(type: 'text', toConsole: 'true')
        fileset(dir: 'src')
    }
}

17.2. AntビルドのインポートImporting an Ant build

You can use the ant.importBuild() method to import an Ant build into your Gradle project. When you import an Ant build, each Ant target is treated as a Gradle task. This means you can manipulate and execute the Ant targets in exactly the same way as Gradle tasks.

ant.importBuild()メソッドを利用して、GradleプロジェクトにAntビルドをインポートできます。 Antビルドをインポートした場合、各AntターゲットはGradleのタスクとして扱われます。 つまり、AntターゲットとGradleタスクをまったく同一の方法で操作することができるということです。

例17.8 Antビルドのインポート

build.gradle

ant.importBuild 'build.xml'

build.xml

<project>
    <target name="hello">
        <echo>Hello, from Ant</echo>
    </target>
</project>

gradle hello の出力

> gradle hello
:hello
[ant:echo] Hello, from Ant

BUILD SUCCESSFUL

Total time: 1 secs

You can add a task which depends on an Ant target:

Antターゲットに依存するタスクを追加することもできます:

例17.9 Antターゲットに依存するタスク

build.gradle

ant.importBuild 'build.xml'

task intro(dependsOn: hello) << {
    println 'Hello, from Gradle'
}

gradle intro の出力

> gradle intro
:hello
[ant:echo] Hello, from Ant
:intro
Hello, from Gradle

BUILD SUCCESSFUL

Total time: 1 secs

Or, you can add behaviour to an Ant target:

Antターゲットにふるまいを追加することも可能です:

例17.10 Antターゲットにふるまいを追加

build.gradle

ant.importBuild 'build.xml'

hello << {
    println 'Hello, from Gradle'
}

gradle hello の出力

> gradle hello
:hello
[ant:echo] Hello, from Ant
Hello, from Gradle

BUILD SUCCESSFUL

Total time: 1 secs

It is also possible for an Ant target to depend on a Gradle task:

Gradleタスクに依存するAntターゲットを定義することも可能です:

例17.11 Ant target that depends on Gradle task

build.gradle

ant.importBuild 'build.xml'

task intro << {
    println 'Hello, from Gradle'
}

build.xml

<project>
    <target name="hello" depends="intro">
        <echo>Hello, from Ant</echo>
    </target>
</project>

gradle hello の出力

> gradle hello
:intro
Hello, from Gradle
:hello
[ant:echo] Hello, from Ant

BUILD SUCCESSFUL

Total time: 1 secs

Sometimes it may be necessary to “rename” the task generated for an Ant target to avoid a naming collision with existing Gradle tasks. To do this, use the AntBuilder.importBuild() method.

例17.12 Renaming imported Ant targets

build.gradle

ant.importBuild('build.xml') { antTargetName ->
    'a-' + antTargetName
}

build.xml

<project>
    <target name="hello">
        <echo>Hello, from Ant</echo>
    </target>
</project>

gradle a-hello の出力

> gradle a-hello
:a-hello
[ant:echo] Hello, from Ant

BUILD SUCCESSFUL

Total time: 1 secs

Note that while the second argument to this method should be a Transformer, when programming in Groovy we can simply use a closure instead of an anonymous inner class (or similar) due to Groovy's support for automatically coercing closures to single-abstract-method types.

17.3. AntプロパティとリファレンスAnt properties and references

There are several ways to set an Ant property, so that the property can be used by Ant tasks. You can set the property directly on the AntBuilder instance. The Ant properties are also available as a Map which you can change. You can also use the Ant property task. Below are some examples of how to do this.

Antタスクで利用できるようにAntプロパティを設定する方法は複数あります。 AntBuilderインスタンスのプロパティを直接設定できます。 Antプロパティは変更可能なMapとしても利用可能です。 Antのpropertyタスクも利用できます。 以下はこれらをどのように実行するのかを示すサンプルです。

例17.13 Antプロパティの設定

build.gradle

ant.buildDir = buildDir
ant.properties.buildDir = buildDir
ant.properties['buildDir'] = buildDir
ant.property(name: 'buildDir', location: buildDir)

build.xml

<echo>buildDir = ${buildDir}</echo>

Many Ant tasks set properties when they execute. There are several ways to get the value of these properties. You can get the property directly from the AntBuilder instance. The Ant properties are also available as a Map. Below are some examples.

多くのAntタスクは実行時にプロパティを設定します。 これらのプロパティを取得する方法も複数あります。 AntBuilderインスタンスからプロパティを直接取得できます。 AntプロパティはMapとしても参照可能です。 以下はサンプルです。

例17.14 Antプロパティの取得

build.xml

<property name="antProp" value="a property defined in an Ant build"/>

build.gradle

println ant.antProp
println ant.properties.antProp
println ant.properties['antProp']

There are several ways to set an Ant reference:

Antリファレンスを設定する方法は複数あります:

例17.15 Antリファレンスの設定

build.gradle

ant.path(id: 'classpath', location: 'libs')
ant.references.classpath = ant.path(location: 'libs')
ant.references['classpath'] = ant.path(location: 'libs')

build.xml

<path refid="classpath"/>

There are several ways to get an Ant reference:

Antリファレンスを取得する方法も複数あります:

例17.16 Antリファレンスの取得

build.xml

<path id="antPath" location="libs"/>

build.gradle

println ant.references.antPath
println ant.references['antPath']

17.4. APIAPI

The Ant integration is provided by AntBuilder.

Ant統合機能はAntBuilderによって提供されています。



[14] In Groovy you can execute Strings. To learn more about executing external processes with Groovy have a look in 'Groovy in Action' 9.3.2 or at the Groovy wiki

[15] Groovyでは文字列をコマンドとして実行できます。 外部プロセスの実行について詳しく学ぶには、「Groovy in Action」の9.3.2節か、Groovy Wikiを参照してください。

第18章 ロギングLogging

The log is the main 'UI' of a build tool. If it is too verbose, real warnings and problems are easily hidden by this. On the other hand you need the relevant information for figuring out if things have gone wrong. Gradle defines 6 log levels, as shown in 表18.1「ログレベルLog levels. There are two Gradle-specific log levels, in addition to the ones you might normally see. Those levels are QUIET and LIFECYCLE. The latter is the default, and is used to report build progress.

ログは、ビルドツールのユーザーインターフェースとも言えるものです。あまりにくどいと本当に重要な警告や問題が埋もれてしまいますが、何かおかしくなったとき、その原因を突き止めるための情報はとてもありがたいものです。Gradleでは、6つのログレベル(表18.1「ログレベルLog levels)を規定しています。だいたいはどこか見たことのあるログレベルだと思いますが、QUIETLIFECYCLEの2つはGradle特有のものです。LIFECYCLEはデフォルトのログレベルで、ビルドプロセスの進行状況をレポートするために使われます。

表18.1 ログレベルLog levels

レベルLevel 用途Used for
ERROR エラーメッセージError messages
QUIET 重要な情報メッセージImportant information messages
WARNING 警告メッセージWarning messages
LIFECYCLE 進行状況を示す情報メッセージProgress information messages
INFO 情報メッセージInformation messages
DEBUG デバッグメッセージDebug messages

18.1. ログレベルの選択Choosing a log level

You can use the command line switches shown in 表18.2「ログレベルに関するコマンドラインオプションLog level command-line options to choose different log levels. In 表18.3「スタックトレースに関するコマンドラインオプションStacktrace command-line options you find the command line switches which affect stacktrace logging.

表示させるログレベルは、コマンドラインオプション(表18.2「ログレベルに関するコマンドラインオプションLog level command-line options)で変更できます。表18.3「スタックトレースに関するコマンドラインオプションStacktrace command-line optionsには、スタックトレースログをどうするか指定する方法を載せています。

表18.2 ログレベルに関するコマンドラインオプションLog level command-line options

オプションOption 出力ログレベルOutputs Log Levels
ロギングオプション未指定no logging options LIFECYCLE以上LIFECYCLE and higher
-q または --quiet QUIET以上QUIET and higher
-i または --info INFO以上INFO and higher
-d または --debug DEBUG以上(要するに全部)DEBUG and higher (that is, all log messages)

表18.3 スタックトレースに関するコマンドラインオプションStacktrace command-line options

オプションOption 意味Meaning
スタックトレースオプション未指定No stacktrace options ビルドエラー(コンパイルエラーとか)のスタックトレースはコンソールに表示されず、内部からの例外のみスタックトレースが表示される。ただし、ログレベルオプションで-dが指定されている場合、切り詰められたスタックトレースが常に表示される。No stacktraces are printed to the console in case of a build error (e.g. a compile error). Only in case of internal exceptions will stacktraces be printed. If the DEBUG log level is chosen, truncated stacktraces are always printed.
-s または --stacktrace 切り詰められたスタックトレースが表示される。Groovyのフルスタックトレースはあまりに冗長(動的言語としての呼び出しメカニズムが色々出力され、自分のコードのどこがダメなのか有用な情報がでてこない)ので、こちらの切り詰め済みスタックトレースを推奨します。Truncated stacktraces are printed. We recommend this over full stacktraces. Groovy full stacktraces are extremely verbose (Due to the underlying dynamic invocation mechanisms. Yet they usually do not contain relevant information for what has gone wrong in your code.)
-S または --full-stacktrace フルスタックトレースを表示する。The full stacktraces are printed out.

18.2. ログメッセージを書くWriting your own log messages

A simple option for logging in your build file is to write messages to standard output. Gradle redirects anything written to standard output to it's logging system at the QUIET log level.

ログメッセージを書く簡単な方法は、標準出力に書き込むことです。Gradleは、標準出力に書かれたすべてのメッセージを、GradleのロギングシステムにQUIETレベルでリダイレクトします。

例18.1 ログに標準出力を使う

build.gradle

println 'A message which is logged at QUIET level'

Gradle also provides a logger property to a build script, which is an instance of Logger. This interface extends the SLF4J Logger interface and adds a few Gradle specific methods to it. Below is an example of how this is used in the build script:

また、ビルドスクリプト内ではloggerプロパティも使えます。このプロパティには、Logger(SLF4JのLoggerインターフェースにGradle特有のメソッドを少し追加したもの)のインスタンスがセットされています。使い方は以下の例をご覧ください。

例18.2 自分でログメッセージを書く

build.gradle

logger.quiet('An info log message which is always logged.')
logger.error('An error log message.')
logger.warn('A warning log message.')
logger.lifecycle('A lifecycle info log message.')
logger.info('An info log message.')
logger.debug('A debug log message.')
logger.trace('A trace log message.')

You can also hook into Gradle's logging system from within other classes used in the build (classes from the buildSrc directory for example). Simply use an SLF4J logger. You can use this logger the same way as you use the provided logger in the build script.

さらに、ビルドで使っている別のクラス(たとえばbuildSrcディレクトリのクラス)の中から、Gradleのロギングシステムへログを出力することもできます。やり方も、ただSLF4Jのロガーを使えばいいだけです。このロガーは、ビルドスクリプトで使えるロガーと全く同じように使うことができます。

例18.3 SLF4Jでログを出力する

build.gradle

import org.slf4j.Logger
import org.slf4j.LoggerFactory

Logger slf4jLogger = LoggerFactory.getLogger('some-logger')
slf4jLogger.info('An info log message logged using SLF4j')

18.3. 外部ツールやライブラリからのログについてLogging from external tools and libraries

Internally, Gradle uses Ant and Ivy. Both have their own logging system. Gradle redirects their logging output into the Gradle logging system. There is a 1:1 mapping from the Ant/Ivy log levels to the Gradle log levels, except the Ant/Ivy TRACE log level, which is mapped to Gradle DEBUG log level. This means the default Gradle log level will not show any Ant/Ivy output unless it is an error or a warning.

内部的には、GradleはAntとIvyを使っています。どちらも、自身で独自のロギングシステムを持っています。Gradleはそれらのログ出力をGradleのロギングシステムにリダイレクトしているのです。Ant、Ivyのログレベルは、基本的にGradleのログレベルと1対1で対応しています(TRACEだけはGradleのDEBUGに対応)。つまり、Gradleのデフォルトログレベルだと、Ant、Ivyのメッセージはエラーやワーニングでないと出力されないと言うことです。

There are many tools out there which still use standard output for logging. By default, Gradle redirects standard output to the QUIET log level and standard error to the ERROR level. This behavior is configurable. The project object provides a LoggingManager, which allows you to change the log levels that standard out or error are redirected to when your build script is evaluated.

ログに標準出力を使っているツールは、いまだにたくさんあります。デフォルトでは、Gradleは標準出力をQUIETレベルログに、標準エラーをERRORレベルログにリダイレクトします。また、この動作は設定で変更可能です。プロジェクトオブジェクトのLoggingManagerを使えば、ビルドスクリプト実行時の標準出力、標準エラーをどのログレベルにリダイレクトするか変更できるようになっています。

例18.4 標準出力のキャプチャ設定

build.gradle

logging.captureStandardOutput LogLevel.INFO
println 'A message which is logged at INFO level'

To change the log level for standard out or error during task execution, tasks also provide a LoggingManager.

さらに、タスク実行時のログリダイレクト設定も変更できるよう、タスクにもLoggingManagerがあります。

例18.5 タスク実行時の標準出力キャプチャ設定

build.gradle

task logInfo {
    logging.captureStandardOutput LogLevel.INFO
    doFirst {
        println 'A task message which is logged at INFO level'
    }
}

Gradle also provides integration with the Java Util Logging, Jakarta Commons Logging and Log4j logging toolkits. Any log messages which your build classes write using these logging toolkits will be redirected to Gradle's logging system.

Gradleは、Java標準のロギング実装や、Jakarta CommonsのCommons Logging、Log4jも統合しています。ビルドで使っているクラスが、これらのツールキットでログメッセージを出力すれば、すべてGradleのロギングシステムにリダイレクトされるでしょう。

18.4. Gradleがロギングするものを変更するChanging what Gradle logs

You can replace much of Gradle's logging UI with your own. You might do this, for example, if you want to customize the UI in some way - to log more or less information, or to change the formatting. You replace the logging using the Gradle.useLogger() method. This is accessible from a build script, or an init script, or via the embedding API. Note that this completely disables Gradle's default output. Below is an example init script which changes how task execution and build completion is logged.

GradleのロギングUIを、独自のものに差し替えることができます。もっと多くの情報を出したい場合、また、逆に出力される情報を減らしたい場合、さらにログフォーマットを変えたいときなどに検討してください。ロギングを差し替えるには、ビルドスクリプトや初期化スクリプト、組み込みAPIからアクセスできるGradle.useLogger()メソッドを使います。次の例では、初期化スクリプトを使って、タスク実行、ビルドの完了をロギングする方法を変更しています。

例18.6 Gradleがロギングするものを変更する

init.gradle

useLogger(new CustomEventLogger())

class CustomEventLogger extends BuildAdapter implements TaskExecutionListener {

    public void beforeExecute(Task task) {
        println "[$task.name]"
    }

    public void afterExecute(Task task, TaskState state) {
        println()
    }
    
    public void buildFinished(BuildResult result) {
        println 'build completed'
        if (result.failure != null) {
            result.failure.printStackTrace()
        }
    }
}

gradle -I init.gradle build の出力

> gradle -I init.gradle build
[compile]
compiling source

[testCompile]
compiling test source

[test]
running unit tests

[build]

build completed

Your logger can implement any of the listener interfaces listed below. When you register a logger, only the logging for the interfaces that it implements is replaced. Logging for the other interfaces is left untouched. You can find out more about the listener interfaces in 「ライフサイクルからの通知に応答するResponding to the lifecycle in the build script. 独自ロガーは、以下にリストしたリスナーインターフェースを実装できます。登録したロガーのインターフェースに対応したロギングのみ差し替えられ、その他のロギングは変更されません。リスナーインターフェースの詳細については「ライフサイクルからの通知に応答するResponding to the lifecycle in the build scriptをご参照ください。

第19章 Gradleデーモン The Gradle Daemon

19.1. デーモン入門 Enter the daemon

The Gradle daemon (sometimes referred as the build daemon) aims to improve the startup and execution time of Gradle.

Gradleデーモン(ビルドデーモンと呼ばれることもあります)はGradleの起動と実行の速度を改善します。

We came up with several use cases where the daemon is very useful. For some workflows, the user invokes Gradle many times to execute a small number of relatively quick tasks. For example: デーモン実行が非常に有用だと思われるユースケースをいくつか考えてみました。 例えば、少数の、比較的実行が早く終わるようなタスクを、何度も実行しなければならないような場面があります。

  • When using test driven development, where the unit tests are executed many times. テスト駆動開発にて、ユニットテストを度々実行するような場合
  • When developing a web application, where the application is assembled many times. Webアプリケーション開発にて、アプリケーションを何度も構築する場合
  • When discovering what a build can do, where gradle tasks is executed a number of times. ビルドの挙動を調べるために、gradle tasksを何度も実行する場合

For these workflows, it is important that the startup cost of invoking Gradle is as small as possible. これらの場合、Gradleを起動・実行するための時間は出来る限り短いことが重要でしょう。

In addition, user interfaces can provide some interesting features if the Gradle model can be built relatively quickly. For example, the daemon might be useful for the following scenarios: さらに、Gradleモデルがより素早く構築されるようになれば、ユーザーインターフェースが面白い機能を実装できる可能性があります。 例えば、次のようなケースでデーモンが役に立つかもしれません。

  • Content assistance in the IDE 統合開発環境で入力補完する場合
  • Live visualisation of the build in a GUI GUIでビルド状況を表示する場合
  • Tab completion in a CLI コマンドラインインターフェースでのタブ補完する場合

In general, snappy behavior of the build tool is always handy. If you try using the daemon for your local builds, you won't want to go back.

一般的にいって、ビルドツールが軽快に動作して困るということはありません。 ローカル環境のビルドでデーモンを試してみてください。デーモンを使わない普通のビルドにはもう戻れなくなるでしょう。

The Tooling API (see Chapter 63, Embedding Gradle) uses the daemon all the time, e.g. you cannot officially use the Tooling API without the daemon. This means that whenever you are using the STS Gradle plugin for Eclipse or the Gradle support in Intellij IDEA, you're already using the Gradle Daemon.

ツールAPI (参照 Chapter 63, Embedding Gradle)は常にデーモンを使用します。つまり、通常、デーモンなしでツールAPIは使えません。 したがって、EclipseのSTS GradleプラグインやIntelliJ IDEAのGradleサポートを使っているときは、常にデーモンが背後で起動しています。

In future, there are plans for more features in the daemon: 今後は下記の機能が追加される予定です。

  • Snappy up-to-date checks: use native file system change notifications (e.g. via jdk7 nio.2) to preemptively perform up-to-date analysis. 軽快な更新チェック: ファイルシステムネイティブの変更通知を(jdk7 nio.2経由などで)使い、プロジェクトが更新されたかどうか前もって解析する
  • Even faster builds: preemptively evaluate projects, so that the model is ready when the user next invokes Gradle. 更なるビルドの高速化: あらかじめプロジェクトを評価し、次回のGradle実行時にプロジェクトモデルを準備しておく
  • Did we mention faster builds? The daemon can potentially preemptively download dependencies or check for new versions of snapshot dependencies. 更なるビルドの高速化、はもう言いましたっけ、とにかく、デーモンは潜在的にはあらかじめ依存関係をダウンロードしたり、スナップショットに依存している場合はその最新バージョンをチェックしておくといったことが可能です。
  • Utilize a pool of reusable processes available for compilation and testing. For example, both the Groovy and Scala compilers have a large startup cost. The build daemon could maintain a process with Groovy and/or Scala already loaded. 再利用可能なプロセスのプールを活用して、コンパイル、テストを実施する。 例えばGroovyとScalaコンパイラーの起動にはどちらも多大なコストがかかります。 しかし、ビルドデーモンは、GroovyやScalaが既にロードされたプロセスを維持しておくことができます。
  • Preemptive execution of certain tasks, for example compilation. Quicker feedback. コンパイルなど、ある種のタスクは事前に実行しておく。より早いフィードバックが可能になります。
  • Fast and accurate bash tab completion. 速くて正確なbash上のタブ補完
  • Periodically garbage collect the Gradle caches. Gradleキャッシュを定期的にガーベージコレクトする

19.2. デーモンの再利用と期限切れ Reusing and expiration of daemons

The basic idea is that the Gradle command forks a daemon process, which performs the actual build. Subsequent invocations of the Gradle command will reuse the daemon, avoiding the startup costs. Sometimes we cannot use an existing daemon because it is busy or its Java version or jvm arguments are different. For exact details on when exactly a new daemon process is forked read the dedicated section below. The daemon process automatically expires after 3 hours of idle time.

デーモン実行の基本にある考え方は、gradleコマンドがデーモンプロセスを起動して、そのデーモンが実際のビルドを実行するというものです。 そうすれば、後続のgradleコマンドがそのデーモンプロセスを再利用でき、起動に掛かるコストを抑えることができます。 しかし、既存のデーモンプロセスが使用できないこともあります。例えば、プロセスがビジーだったり、要求されたJavaのバージョンやJVM引数が違うといった場合です。 新しいデーモンプロセスが、正確にはいつ起動されるかの詳細については、以下を参照してください。 デーモンプロセスは、アイドル状態で3時間経過すると自動的に期限切れになります。

Here are all situations in which we fork a new daemon process: デーモンプロセスが新しく起動される場面を全て列挙すると、

  • If the daemon process is currently busy running some job, a brand new daemon process will be started. 既存のデーモンがある処理を実行中の場合、新たなデーモンが起動されます。
  • We fork a separate daemon process per Java home. So even if there is some idle daemon waiting for build requests but you happen to run a build with a different Java home then a brand new daemon will be forked. デーモンプロセスは、java homeごとに起動されます。アイドル状態のデーモンがビルドリクエストを待機していたとしても、別のjava homeからビルドを実行した場合デーモンプロセスが新しく起動されます。
  • We fork a separate daemon process if the jvm arguments for the build are sufficiently different. For example we will not fork a new daemon if a some system property has changed. However if the -Xmx memory setting changed or some fundamental immutable system property changed (e.g. file.encoding) then a new daemon will be forked. ビルドのJVM引数が大きく異なる場合、デーモンプロセスが新しく起動されます。いくつかのシステムプロパティに関しては、変更されても新プロセスを立ち上げないこともあります。しかし、-Xmxメモリ設定や、その他の基本的で変更できないシステムプロパティ(file.encodingなど)が変更された場合、プロセスが新しく起動されます。
  • At the moment the daemon is coupled with a particular version of Gradle. This means that even if some daemon is idle but you are running the build with a different version of Gradle, a new daemon will be started. This also has a consequence for the --stop command line instruction: this command will only stop daemons that were started with Gradle version that is executing --stop. 起動されているデーモンは、特定のバージョンのGradleと関連づいています。 そのため、アイドル状態のデーモンが存在したとしても、それと別のバージョンのGradleでビルドを実行すると新しいデーモンが起動されます。 これは、--stopコマンドについてあることを教唆しています――つまり、--stopで停止できるデーモンは、その--stopを実行しているGradleと同じバージョンのGradleで起動されたデーモンだけだということです。

We plan to improve the functionality of managing and pooling the daemons in the future. 今後、デーモンの管理方法、プール方法の改善を行う予定です。

19.3. 使い方とトラブルシューティング Usage and troubleshooting

For command line usage, look at the dedicated section in 付録D Gradle コマンドラインGradle Command Line. If you are tired of using the same command line options again and again, take a look at 「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties. This section contains information on how to configure certain behavior of the daemon (including turning on the daemon by default) in a more 'persistent' way.

コマンドラインの利用方法については別節付録D Gradle コマンドラインGradle Command Lineを参照してください。 同じコマンドラインを何度も何度も指定してうんざりしている場合は、「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.propertiesを参照してください。 上記の節には、デーモンの振る舞いをより「永続的に」設定する方法が(デフォルトでデーモンを起動する方法を含めて)詳細に記述されています。

Some ways of troubleshooting the Gradle daemon: デーモンのトラブルシューティングについていくつか方法を示します。

  • If you have a problem with your build, try temporarily disabling the daemon (you can pass the command line switch --no-daemon). ビルドで問題が発生した場合、一時的にデーモンを無効化してみてください(コマンドラインにスイッチ--no-daemonを渡す)。
  • Occasionally, you may want to stop the daemons either via the --stop command line option or in a more forceful way.--stopオプションや、もっと強制的な方法でデーモンを停止しなければならない場面もあります。
  • There is a daemon log file, which by default is located in the Gradle user home directory. デーモンのログファイルは、デフォルトではGradleユーザーホームディレクトリーにあります。
  • You may want to start the daemon in --foreground mode to observe how the build is executed. ビルドの実行状況を見るには、--feoregroundを使ってデーモンを起動します。

19.4. デーモンの設定 Configuring the daemon

Some daemon settings, such as JVM arguments, memory settings or the Java home, can be configured. Please find more information in 「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties

デーモン設定のうち、JVM引数、メモリーの設定、Java homeなどは設定ファイルなどで変更できます。詳細については「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.propertiesを参照してください。

第20章 ビルド環境 The Build Environment

20.1. gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties

Gradle provides several options that make it easy to configure the Java process that will be used to execute your build. While it's possible to configure these in your local environment via GRADLE_OPTS or JAVA_OPTS, certain settings like JVM memory settings, Java home, daemon on/off can be more useful if they can be versioned with the project in your VCS so that the entire team can work with a consistent environment. Setting up a consistent environment for your build is as simple as placing these settings into a gradle.properties file. The configuration is applied in following order (if an option is configured in multiple locations the last one wins): (in case an option is configured in multiple locations the last one wins): Gradleでは、ビルドを実行するJavaプロセスの設定を簡単に変更するための方法が複数用意されています。 ローカルの環境変数でGRADLE_OPTSやJAVA_OPTSを使って設定することもできますが、一部の設定値、JVMメモリ設定やJava home、デーモンのオンオフなどについてはプロジェクトのVCSに格納してバージョン管理しておけば、チームメンバー全員が一貫した環境で作業することができるので便利です。 こうした一貫した設定値は、gradle.propertiesに設定値を保存するだけで実現可能です。 設定値は以下の順序で適用されます(複数箇所で設定されている場合は最後の一つが優先されます)。

  • from gradle.properties located in project build dir. プロジェクトのビルドディレクトリに置かれたgradle.properties
  • from gradle.properties located in gradle user home.gradleユーザーホームディレクトリに置かれたgradle.properties
  • from system properties, e.g. when -Dsome.property is used in the command line.-Dsome.propertyなどで指定されたシステムプロパティ

The following properties can be used to configure the Gradle build environment: 以下のプロパティがGradleのビルド環境を設定するために使用されます。

org.gradle.daemon

When set to true the Gradle daemon is used to run the build. For local developer builds this is our favorite property. The developer environment is optimized for speed and feedback so we nearly always run Gradle jobs with the daemon. We don't run CI builds with the daemon (i.e. a long running process) as the CI environment is optimized for consistency and reliability.

trueに設定するとデーモンによりビルドが実行されます。 開発者がローカルでビルドを実行する際は、このプロパティを設定することをおすすめします。開発環境ではスピードやフィードバックという点を重視したいので、私たちもほとんどいつもデーモンを使ってGradleのジョブを走らせています。 一方、CI環境では並行性、信頼性といった点を重視したいため、CIビルド(というか実行時間の長い処理)でデーモンを使うことはありません。

org.gradle.java.home

Specifies the Java home for the Gradle build process. The value can be set to either a jdk or jre location, however, depending on what your build does, jdk is safer. A reasonable default is used if the setting is unspecified.

Gradleのビルドシステムで使用するJava homeを指定します。 設定するのはjdkでもjre構いませんが、プロジェクトによってはjdkを指定した方が安全かもしれません。 指定しなければ、適当なデフォルト値が設定されます。

org.gradle.jvmargs

Specifies the jvmargs used for the daemon process. The setting is particularly useful for tweaking memory settings. At the moment the default settings are pretty generous with regards to memory.

デーモンプロセスに渡すJVM引数を指定します。 この設定はメモリ設定を調節するのに特に便利です。 デフォルト値はメモリに応じて適切に設定されます。

org.gradle.configureondemand

Enables new incubating mode that makes Gradle selective when configuring projects. Only relevant projects are configured which results in faster builds for large multi-projects. See 「Configuration on demand」.

Gradleがプロジェクトを選択的に設定する試験的なモードを有効にします。 関係のあるプロジェクトのみを評価することで、巨大なマルチプロジェクト・ビルドをより高速にビルドできるようにします。 詳しくは「Configuration on demand」を参照してください。

org.gradle.parallel

When configured, Gradle will run in incubating parallel mode.

この設定を行うと、Gradleの試験的な並列ビルドモードが有効化されます。

20.1.1. JavaプロセスのフォークForked Java processes

Many settings (like the Java version and maximum heap size) can only be specified when launching a new JVM for the build process. This means that Gradle must launch a separate JVM process to execute the build after parsing the various gradle.properties files. When running with the daemon, a JVM with the correct parameters is started once and reused for each daemon build execution. When Gradle is executed without the daemon, then a new JVM must be launched for every build execution, unless the JVM launched by the Gradle start script happens to have the same parameters.

JVMに関する設定の多く(Javaバージョンや最大ヒープサイズなど)は、新しくJVMプロセスを起動するときのみ設定できます。 これはつまり、Gradleが解析した多様なgradle.propertiesに従ってビルドを実行するには、JVMプロセスを新しく起動しなければならないということを意味します。 デーモンを実行しているときは、適切なパラメーターが設定されたJVMが起動され、デーモンごとに再利用されます。 デーモンを使用せずにビルドを実行したときは、Gradleのスタートスクリプトが起動したJVMとたまたま同じパラメーターでビルドするのでない限り、ビルドの度に新しくJVMを起動しなければなりません。

This launching of an extra JVM on every build execution is quite expensive, which is why if you are setting either org.gradle.java.home or org.gradle.jvmargs we highly recommend that you use the Gradle Daemon. See 19章Gradleデーモン The Gradle Daemon for more details.

ビルドを実行する度にJVMを余分に起動しなければならないというのは、とても大きなコストになります。なので、org.gradle.java.homeorg.gradle.jvmargsを設定しているのであればGradleデーモンを使ってビルドすることを強く推奨します。詳細については19章Gradleデーモン The Gradle Daemonを参照してください。

20.2. プロクシ経由のWebアクセスAccessing the web via a proxy

Configuring an HTTP proxy (for downloading dependencies, for example) is done via standard JVM system properties. These properties can be set directly in the build script; for example, setting the proxy host would be done with System.setProperty('http.proxyHost', 'www.somehost.org'). Alternatively, the properties can be specified in a gradle.properties file, either in the build's root directory or in the Gradle home directory.

(例えば依存関係のダウンロードするための)HTTPプロクシの設定は 標準的なJVMのシステムプロパティを使って行います。これらの設定は、直接ビルドスクリプト上で設定することが可能です。 例えばプロクシのホストの為に System.setProperty('http.proxyHost', 'www.somehost.org')と設定できます。 あるいは、ビルドのルートディレクトリ上 又は Gradleホームディレクトリ上にある gradle.propertiesファイルにそれらの値を設定できます。

例20.1 HTTPプロクシの設定Configuring an HTTP proxy

gradle.properties

systemProp.http.proxyHost=www.somehost.org
systemProp.http.proxyPort=8080
systemProp.http.proxyUser=userid
systemProp.http.proxyPassword=password
systemProp.http.nonProxyHosts=*.nonproxyrepos.com|localhost

There are separate settings for HTTPS.

HTTPS設定の分離

例20.2 HTTPSプロクシの設定Configuring an HTTPS proxy

gradle.properties

systemProp.https.proxyHost=www.somehost.org
systemProp.https.proxyPort=8080
systemProp.https.proxyUser=userid
systemProp.https.proxyPassword=password
systemProp.https.nonProxyHosts=*.nonproxyrepos.com|localhost

We could not find a good overview for all possible proxy settings. One place to look are the constants in a file from the Ant project. Here's a link to the Subversion view. The other is a Networking Properties page from the JDK docs. If anyone knows of a better overview, please let us know via the mailing list.

使用可能な全てのプロクシ設定を概観できる良い資料については残念ながら発見することができませんでした。一つの情報源は、Antプロジェクトのファイルに定義された定数です。 Subversionへのリンク を載せておきます。他には、JDKドキュメントに ネットワーク設定値のページ がありました。 その他、もっと良い資料をご存知であれば、メーリングリストでお知らせください。

20.2.1. NTLM認証NTLM Authentication

If your proxy requires NTLM authentication, you may need to provide the authentication domain as well as the username and password. There are 2 ways that you can provide the domain for authenticating to a NTLM proxy: NTLM認証が必要なプロクシを使う場合、ユーザ名とパスワードだけでなく認証ドメインを設定する必要があります。ドメインを設定する方法には以下の二つがあります。

  • Set the http.proxyUser system property to a value like domain/username. システムプロパティhttp.proxyUserに、domain/usernameのように値を設定する。
  • Provide the authentication domain via the http.auth.ntlm.domain system property. システムプロパティhttp.auth.ntlm.domainに認証ドメインを設定する。

第21章 Gradleのプラグインについて Gradle Plugins

Gradle at its core intentionally provides very little for real world automation. All of the useful features, like the ability to compile Java code, are added by plugins. Plugins add new tasks (e.g. JavaCompile), domain objects (e.g. SourceSet), conventions (e.g. Java source is located at src/main/java) as well as extending core objects and objects from other plugins.

Gradleのコア部分には、実際の自動化に役に立つような機能は含まれていません。 これは意図的なもので、Javaのコードをコンパイルしたりといった便利な機能は、全てプラグインにより追加されます。 プラグインは、コア部分のオブジェクトや他のプラグインのオブジェクトを拡張するだけでなく、新しいタスク(JavaCompileなど)やドメインオブジェクト(SourceSetなど)、規約(Javaのコードはsrc/main/javaに置く)、などをGradleに追加します。

In this chapter we will discuss how to use plugins and the terminology and concepts surrounding plugins.

この章では、プラグインを使う方法、プラグインまわりの用語や概念について議論します。

21.1. Types of plugins

There are two general types of plugins in Gradle, script plugins and binary plugins. Script plugins are additional build scripts that further configure the build and usually implement a declarative approach to manipulating the build. They are typically used within a build although they can be externalized and accessed from a remote location. Binary plugins are classes that implement the Plugin interface and adopt a programmatic approach to manipulating the build. Binary plugins can reside within a build script, within the project hierarchy or externally in a plugin jar.

21.2. プラグインの適用 Applying plugins

Plugins are said to be applied, which is done via the Project.apply() method.

プラグインの、いわゆる適用は、Project.apply()メソッドで行います。

例21.1 プラグインの適用

build.gradle

apply plugin: 'java'

21.2.1. Script plugins

例21.2 Applying a script plugin

build.gradle

apply from: 'other.gradle'

Script plugins can be applied from a script on the local filesystem or at a remote location. Filesystem locations are relative to the project directory, while remote script locations are specified with an HTTP URL. Multiple script plugins (of either form) can be applied to a given build.

21.2.2. Binary plugins

例21.3 Applying a binary plugin

build.gradle

apply plugin: 'java'

Core plugins register a short name. In the above case, we are using the short name ‘java’ to apply the JavaPlugin. Plugins also have a plugin id that takes a fully qualified form like com.github.foo.bar, although some legacy plugins may still utilize the short, unqualified form.

This method can also accept a class to identify the plugin:

例21.4 Applying a binary plugin by type

build.gradle

apply plugin: JavaPlugin

The JavaPlugin symbol in the above sample refers to the the JavaPlugin. This class does not strictly need to be import as the org.gradle.api.plugins package is automatically imported in all build scripts (see 付録E IDE対応の現状と、IDEによらない開発支援Existing IDE Support and how to cope without it). Furthermore, it is not necessary to append .class to identify a class literal in Groovy as it is in Java.

The application of plugins is idempotent. That is, a plugin can be applied multiple times. If the plugin has previously been applied, any further applications will have no effect.

21.2.2.1. Locations of binary plugins

A plugin is simply any class that implements the Plugin interface. Gradle provides the core plugins as part of its distribution so simply applying the plugin as above is all you need to do. However, non-core binary plugins need to be available to the build classpath before they can be applied. This can be achieved in a number of ways, including:

For more on defining your own plugins, see 59章カスタムプラグインの作成Writing Custom Plugins.

21.3. Applying plugins with the plugins DSL

The plugins DSL is currently incubating. Please be aware that the DSL and other configuration may change in later Gradle versions.

The new plugins DSL provides a more succinct and convenient way to declare plugin dependencies. It works with the new Gradle plugin portal to provide easy access to both core and community plugins. The plugins script block configures an instance of PluginDependenciesSpec.

プラグインは、自分自身を示す短縮名を保持、公開しています。 上の例では、短縮名'java'を使ってJavaPluginを適用しています。

We could also have used the following syntax:

以下は短縮名を使わなかった場合の例です。

例21.5 型でプラグインを適用する

build.gradle

apply plugin: JavaPlugin

To apply a community plugin from the portal, the fully qualified plugin id must be used:

例21.6 Applying a community plugin

build.gradle

plugins {
    id "com.jfrog.bintray" version "0.4.1"
}

No further configuration is necessary. Specifically, there is no need to configure the buildscript classpath. Gradle will resolve the plugin in the plugin portal, locate it, and make it available to the build.

See PluginDependenciesSpec for more information on using the Plugin DSL.

21.4. Finding community plugins

Gradle has a vibrant community of plugin developers who contribute plugins for a wide variety of capabilities. The Gradle plugin portal provides an interface for searching and exploring community plugins.

また、プラグインの作り方は59章カスタムプラグインの作成Writing Custom Pluginsに詳しく記載されています。

21.5. プラグインがすること What plugins do

Applying a plugin to the project allows the plugin to extend the project's capabilities. It can do things such as:

プラグインを適用することで、そのプロジェクトの機能を拡張することができます。例えば、

Let's check this out:

次の例を見てください。

例21.7 プラグインにより追加されたタスク

build.gradle

apply plugin: 'java'

task show << {
    println relativePath(compileJava.destinationDir)
    println relativePath(processResources.destinationDir)
}

gradle -q show の出力

> gradle -q show
build/classes/main
build/resources/main

The Java plugin has added a compileJava task and a processResources task to the project and configured the destinationDir property of both of these tasks.

Javaプラグインは、compileJavaタスクとprocessResourceタスクをプロジェクトに追加し、それぞれのタスクにdestinationDirプロパティを設定しています。

21.6. 規約 Conventions

Plugins can pre-configure the project in smart ways to support convention-over-configuration. Gradle provides mechanisms and sophisticated support and it's a key ingredient in powerful-yet-concise build scripts.

プラグインは、CoC(設定より規約)をというスマートな方法をサポートするため、プロジェクトを事前に設定しておくことができます。 Gradleにはこのメカニズムと洗練されたサポートがあり、パワフルかつ簡潔なビルドスクリプトを記述するためのカギになっています。

We saw in the example above that the Java plugins adds a task named compileJava that has a property named destinationDir (that configures where the compiled Java source should be placed). The Java plugin defaults this property to point to build/classes/main in the project directory. This is an example of convention-over-configuration via a reasonable default.

先ほどの例、JavaプラグインがcompileJavaタスクを追加し、そこにdestinationDirプロパティ(コンパイルしたソースが出力される場所)を追加したコードを思い出してください。 Javaプラグインは、デフォルトでこのプロパティが、プロジェクトディレクトリのbuild/classes/mainを指すよう設定します。これは、合理的なデフォルト値を設定するCoCの一例です。

We can change this property simply by giving it a new value.

このプロパティは、新しい値を設定するだけで簡単に変更できます。

例21.8 プラグインのデフォルトを変更する

build.gradle

apply plugin: 'java'

compileJava.destinationDir = file("$buildDir/output/classes")

task show << {
    println relativePath(compileJava.destinationDir)
}

gradle -q show の出力

> gradle -q show
build/output/classes

However, it's likely that the compileJava task is not the only task that needs to know where the class files are.

ただ、クラスファイルの出力場所が関係するタスクは、おそらくcompileJavaタスクだけではないでしょう。

The Java plugin adds the concept of source sets (see SourceSet) to describe the aspects of a set of source files, one aspect being where the class files should be written to when they are compiled. The Java plugin maps the destinationDir property of the compileJava task to this aspect of the source set.

Javaプラグインは、プロジェクトにソースセットという概念を追加します(SourceSet参照)。 ソースセットは、ソースコード一式を示す概念であり、それらがコンパイルされた際にクラスファイルが書き出される場所を示す概念でもあります。 Javaプラグインは、compileJavaタスクのdestinationDirプロパティを、ソースセットが示す出力場所にマップしているのです。

We can change where the class files are written via the source set.

クラスファイルの書き出される場所を、ソースセットで変更することができます。

例21.9 プラグインの規約オブジェクト

build.gradle

apply plugin: 'java'

sourceSets.main.output.classesDir = file("$buildDir/output/classes")

task show << {
    println relativePath(compileJava.destinationDir)
}

gradle -q show の出力

> gradle -q show
build/output/classes

In the example above, we applied the Java plugin which, among other things, did the following:

この例で、Javaプラグインは以下のようなことを含む様々な処理を行っています。

  • Added a new domain object type: SourceSet 新しいドメインオブジェクト、SourceSetを追加。
  • Configured a main source set with default (i.e. conventional) values for propertiesmainソースセットに、デフォルト値(つまり規約)を設定。
  • Configured supporting tasks to use these properties to perform work タスクがこれらのプロパティを使って動作するように設定。

All of this happened during the “apply plugin: "java"” step. In the example above, we changed the desired location of the class files after this conventional configuration had been performed. Notice by the output with the example that the value for compileJava.destinationDir also changed to reflect the configuration change.

この全てが、apply plugin: "java"のステップで行われています。例では、規定の設定が行われた後、クラスファイルの場所を変更しました。 compileJava.destinationDirの値が、設定の変更を反映して変わっていることに注目してください。

Consider the case where another task needs to consume the class files. If this task is configured to use the value from sourceSets.main.output.classesDir, then changing it in this location will update this new task in addition to the compileJava task whenever it is changed.

別のタスクが、クラスファイルを使用するケースを考えてください。そのタスクが、クラスファイルの場所をsourceSets.main.output.classesDirを参照して取得するようになっていれば、ソースセットを変更するだけでcompileJavaとそのタスク、両方の設定が更新されます。

This ability to configure properties of objects to reflect the value of another object's task at all times (i.e. even when it changes) is known as “convention mapping”. It allows Gradle to provide conciseness through convention-over-configuration and sensible defaults yet not require complete reconfiguration if a conventional default needs to be changed. Without this, in the example above, we would have had to reconfigure every object that needs to work with the class files.

他のタスクの設定値をいつでも(つまり、変更されたときでさえ)反映するよう、オブジェクトのプロパティを設定できるこの方法は、規約マッピングとして知られています。 この方法により、GradleはCoCと合理的なデフォルト値による簡潔さを達成しています。また、規定のデフォルト値を変更する場合も一部のオブジェクトを設定するだけでよくなっています。 もしこの方法を採用していなければ、クラスファイルの設定をするのに全てのオブジェクトを変更してまわらなければならなかったところです。

21.7. プラグインをさらに詳しく知るには More on plugins

This chapter aims to serve as an introduction to plugins and Gradle and the role they play. For more information on the inner workings of plugins, see 59章カスタムプラグインの作成Writing Custom Plugins.

この章は、プラグインと、プラグインがGradleで果たしている役割について簡単に紹介するためのものです。 プラグインの内部動作について、さらに詳しく知るには、59章カスタムプラグインの作成Writing Custom Pluginsを参照してください。

第22章 標準GradleプラグインStandard Gradle plugins

There are a number of plugins included in the Gradle distribution. These are listed below.

Gradleの配布物にはいくつかのプラグインが同梱されています。以下にその一覧を掲載します。

22.1. 言語プラグインLanguage plugins

These plugins add support for various languages which can be compiled for and executed in the JVM.

これらのプラグインは、Gradleに様々な言語サポートを追加します。JVMに向けたコンパイルやJVM上でのプログラム実行などを行います。

表22.1 言語プラグインLanguage plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
java java-base -

Adds Java compilation, testing and bundling capabilities to a project. It serves as the basis for many of the other Gradle plugins. See also 7章JavaクイックスタートJava Quickstart.

Javaのコンパイル、テスト、バンドル機能をプロジェクトに追加します。また、このプラグインは、他の様々なプラグインのベース機能として使用されています。7章JavaクイックスタートJava Quickstartも参照してください。

groovy java, groovy-base -

Adds support for building Groovy projects. See also 9章GroovyクイックスタートGroovy Quickstart.

Groovyプロジェクトのビルド機能を追加します。9章GroovyクイックスタートGroovy Quickstartも参照してください。

scala java, scala-base -

Adds support for building Scala projects.

Scalaプロジェクトのビルド機能を追加します。

antlr java -

Adds support for generating parsers using Antlr.

Antlrを使ったパーサーの生成をサポートします。

22.2. 試験的な言語プラグイン Incubating language plugins

These plugins add support for various languages:

これらのプラグインは、以下のような様々な言語のサポートを追加します。

表22.2 言語プラグイン Language plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
assembler - -

Adds native assembly language capabilities to a project.

c - -

Adds C source compilation capabilities to a project.

cpp - -

Adds C++ source compilation capabilities to a project.

objective-c - -

Adds Objective-C source compilation capabilities to a project.

objective-cpp - -

Adds Objective-C++ source compilation capabilities to a project.

windows-resources - -

Adds support for including Windows resources in native binaries.

22.3. 統合プラグインIntegration plugins

These plugins provide some integration with various runtime technologies.

これらのプラグインは、様々なランタイムをプロジェクトに統合して使用できるようにします。

表22.3 統合プラグインIntegration plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
application java -

Adds tasks for running and bundling a Java project as a command-line application.

プロジェクトをコマンドラインアプリケーションとしてビルド、実行するためのタスクを追加します。

ear - java

Adds support for building J2EE applications.

J2EEアプリケーションのビルド機能を追加します。

jetty war -

Deploys your web application to a Jetty web container embedded in the build. See also 10章WebアプリケーションクイックスタートWeb Application Quickstart.

組み込みのJettyウェブコンテナに、アプリケーションをデプロイできるようにします。10章WebアプリケーションクイックスタートWeb Application Quickstartも参照してください。

maven - java, war

Adds support for publishing artifacts to Maven repositories.

Mavenリポジトリにアーティファクトを公開できるようにします。

osgi java-base java

Adds support for building OSGi bundles.

OSGiバンドルのビルドをサポートします。

war java -

Adds support for assembling web application WAR files. See also 10章WebアプリケーションクイックスタートWeb Application Quickstart.

ウェブアプリケーションのWARファイルをビルドできるようにします。See also 10章WebアプリケーションクイックスタートWeb Application Quickstartも参照してください。

22.4. 試験的な統合プラグイン Incubating integration plugins

These plugins provide some integration with various runtime technologies.

これらのプラグインは、様々なランタイムをプロジェクトに統合して使用できるようにします。

表22.4 試験的な統合プラグイン Incubating integration plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
distribution - -

Adds support for building ZIP and TAR distributions.

ZIPおよびTARの配布物をビルドできるようにします。

java-library-distribution java, distribution -

Adds support for building ZIP and TAR distributions for a Java library.

JavaライブラリをZIPおよびTARの配布物としてビルドできるようにします。

ivy-publish - java, war

This plugin provides a new DSL to support publishing artifacts to Ivy repositories, which improves on the existing DSL.

Ivyリポジトリへアーティファクトを公開できるようにします。DSLが既存のものから新しく改善されています。

maven-publish - java, war

This plugin provides a new DSL to support publishing artifacts to Maven repositories, which improves on the existing DSL.

Mavenリポジトリへアーティファクトを公開できるようにします。DSLが既存のものから新しく改善されています。

22.5. ソフトウェア開発プラグイン Software development plugins

These plugins provide help with your software development process.

これらのプラグインは、ソフトウェアの開発プロセスを支援します。

表22.5 ソフトウェア開発プラグイン Software development plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
announce - -

Publish messages to your favourite platforms, such as Twitter or Growl.

TwitterやGrowlなど、任意のプラットフォーム上にメッセージを発行します。

build-announcements announce -

Sends local announcements to your desktop about interesting events in the build lifecycle.

ビルドライフサイクルの各種イベントのうち、指定したものについてデスクトップ上にローカルで通知します。

checkstyle java-base -

Performs quality checks on your project's Java source files using Checkstyle and generates reports from these checks.

Checkstyleを使ってJavaソースコードの品質をチェックし、レポートを生成します。

codenarc groovy-base -

Performs quality checks on your project's Groovy source files using CodeNarc and generates reports from these checks.

CodeNarcを使ってGroovyソースコードの品質をチェックし、レポートを生成します。

eclipse - java,groovy, scala

Generates files that are used by Eclipse IDE, thus making it possible to import the project into Eclipse. See also 7章JavaクイックスタートJava Quickstart.

Eclipse IDEが使用するファイルを生成し、プロジェクトをEclipseにインポートできるようにします。7章JavaクイックスタートJava Quickstartも参照してください。

eclipse-wtp - ear, war

Does the same as the eclipse plugin plus generates eclipse WTP (Web Tools Platform) configuration files. After importing to eclipse your war/ear projects should be configured to work with WTP. See also 7章JavaクイックスタートJava Quickstart.

eclipseプラグインが生成するファイルに加え、eclipse WTP (Web Tools Platform)の設定ファイルも生成します。 eclipseにインポートすれば、war/earプロジェクトがWTPで認識されるよう設定されているはずです。7章JavaクイックスタートJava Quickstartも参照してください。

findbugs java-base -

Performs quality checks on your project's Java source files using FindBugs and generates reports from these checks.

FindBugsを使ってプロジェクトに含まれるJavaソースコードの品質をチェックし、レポートを生成します。

idea - java

Generates files that are used by Intellij IDEA IDE, thus making it possible to import the project into IDEA.

Intellij IDEA IDEが使用するファイルを生成し、プロジェクトをIDEAにインポートできるようにします。

jdepend java-base -

Performs quality checks on your project's source files using JDepend and generates reports from these checks.

JDependを使ってソースコードの品質をチェックし、レポートを生成します。

pmd java-base -

Performs quality checks on your project's Java source files using PMD and generates reports from these checks.

PMDを使ってJavaソースコードの品質をチェックし、レポートを生成します。

project-report reporting-base -

Generates reports containing useful information about your Gradle build.

Gradleビルドに関する有用な情報が載ったレポートを生成します。

signing base -

Adds the ability to digitally sign built files and artifacts.

ビルドしたファイルとアーティファクトにデジタル署名を行う機能を追加します。

sonar - java-base, java, jacoco

Provides integration with the Sonar code quality platform. Superceeded by the sonar-runner plugin.

Sonarコード品質プラットフォームとの連携機能を提供します。今は後継としてsonar-runnerプラグインが作成されています。

22.6. 試験的なソフトウェア開発プラグイン Incubating software development plugins

These plugins provide help with your software development process.

これらのプラグインは、ソフトウェアの開発プロセスを支援します。

表22.6 ソフトウェア開発プラグイン Software development plugins

Plugin Id プラグインID Automatically applies 自動適用 Works with 協調して動作 Description 説明
build-dashboard reporting-base -

Generates build dashboard report.

build-init wrapper -

Adds support for initializing a new Gradle build. Handles converting a Maven build to a Gradle build.

cunit - -

Adds support for running CUnit tests.

jacoco reporting-base java

Provides integration with the JaCoCo code coverage library for Java.

sonar-runner - java-base, java, jacoco

Provides integration with the Sonar code quality platform. Supersedes the sonar plugin.

Sonarコード品質プラットフォームとの連携機能を提供します。sonarプラグインの後継プラグインです。

visual-studio - native language plugins

Adds integration with Visual Studio.

wrapper - -

Adds a Wrapper task for generating Gradle wrapper files.

java-gradle-plugin java

Assists with development of Gradle plugins by providing standard plugin build configuration and validation.

22.7. ベースプラグイン Base plugins

These plugins form the basic building blocks which the other plugins are assembled from. They are available for you to use in your build files, and are listed here for completeness. However, be aware that they are not yet considered part of Gradle's public API. As such, these plugins are not documented in the user guide. You might refer to their API documentation to learn more about them.

これらのプラグインは、他のプラグインを組み立てるための基本的なビルド用の部品を構成します。また、ビルドスクリプト内で自分で使うこともできます。ここにその完全な一覧を掲載しました。 しかし、これらのプラグインはまだGradleの正式な公開APIとはなっていないことに注意してください。そのため、ユーザーガイドでは解説されていません。詳細について調べたい際は、APIドキュメントが参考になるかもしれません。

表22.7 ベースプラグイン Base plugins

Plugin Id プラグインID Description 説明
base

Adds the standard lifecycle tasks and configures reasonable defaults for the archive tasks: 一般的なライフサイクルを構成するタスクを追加し、アーカイブタスクにリーズナブルなデフォルト値を設定します。

  • adds build ConfigurationName tasks. Those tasks assemble the artifacts belonging to the specified configuration. buildConfigurationNameタスクを追加します。これらのタスクは、特定のコンフィグレーションに属するアーティファクトを作成します。
  • adds upload ConfigurationName tasks. Those tasks assemble and upload the artifacts belonging to the specified configuration. uploadConfigurationNameタスクを追加します。これらのタスクは、特定のコンフィグレーション属するアーティファクトを作成し、アップロードします。
  • configures reasonable default values for all archive tasks (e.g. tasks that inherit from AbstractArchiveTask). For example, the archive tasks are tasks of types: Jar, Tar, Zip. Specifically, destinationDir, baseName and version properties of the archive tasks are preconfigured with defaults. This is extremely useful because it drives consistency across projects; the consistency regarding naming conventions of archives and their location after the build completed. 全てのアーカイブタスク(AbstractArchiveTaskを継承したタスク)に適切なデフォルト値を設定します。 例えば、JarタイプやTarタイプ、Zipタイプのタスクがアーカイブタスクです。 これらのタスクに、destinationDirbaseNameversionプロパティを前もって設定します。 これにより、アーカイブの命名規約やビルド後の配置場所に一貫性が生まれるため、とても便利です。

java-base

Adds the source sets concept to the project. Does not add any particular source sets.

プロジェクトにソースセットの概念を導入します。実際のソースセットは追加されません。

groovy-base

Adds the Groovy source sets concept to the project.

プロジェクトにGroovyソースセットの概念を導入します。

scala-base

Adds the Scala source sets concept to the project.

プロジェクトにScalaソースセットの概念を導入します。

reporting-base

Adds some shared convention properties to the project, relating to report generation.

レポート生成に関するいくつかの一般的な規約プロパティをプロジェクトに追加します。

22.8. サードパーティプラグインThird party plugins

You can find a list of external plugins at the Gradle Plugins site.

サードパーティ製のプラグインはGradleプラグインポータルで見つけることができます。

第23章 JavaプラグインThe Java Plugin

The Java plugin adds Java compilation along with testing and bundling capabilities to a project. It serves as the basis for many of the other Gradle plugins.

Javaプラグインは、プロジェクトにJavaのコンパイル、テスト、そしてビルド能力を与えます。このプラグインは、他の多くのGradleプラグインの基礎となっています。

23.1. 使用方法Usage

To use the Java plugin, include the following in your build script:

Javaプラグインを使うためには、ビルドスクリプトに下記を含めます:

例23.1 Javaプラグインの使用

build.gradle

apply plugin: 'java'

23.2. ソースセットSource sets

The Java plugin introduces the concept of a source set. A source set is simply a group of source files which are compiled and executed together. These source files may include Java source files and resource files. Other plugins add the ability to include Groovy and Scala source files in a source set. A source set has an associated compile classpath, and runtime classpath.

Javaプラグインはソースセットの概念を導入します。ソースセットは、一緒にコンパイルされ実行されるソースファイルのグループです。このソースファイルには、Javaソースファイルとリソースファイルを含むことができます。他のプラグインは、ソースセットにGroovyやScalaのソースファイルを含めることを可能にします。ソースセットは、それぞれに関連づけられたコンパイル時クラスパスと実行時クラスパスを持ちます。

One use for source sets is to group source files into logical groups which describe their purpose. For example, you might use a source set to define an integration test suite, or you might use separate source sets to define the API and implementation classes of your project.

ソースセットを使うと、ソースファイルを論理的なグループに分割し、それぞれ別個の目的を持たせることもできます。例えば、統合テストスイートやプロジェクトのAPIクラスを定義したり、異なるJavaバージョンでコンパイルする必要があるソースを分離することなどに使うことができます。

The Java plugin defines two standard source sets, called main and test. The main source set contains your production source code, which is compiled and assembled into a JAR file. The test source set contains your test source code, which is compiled and executed using JUnit or TestNG. These can be unit tests, integration tests, acceptance tests, or any combination that is useful to you.

Javaプラグインは、maintestという二つの標準ソースセットを定義します。mainソースセットは、コンパイルされJARファイルを構成する製品ソースコードを含みます。testソースセットは、コンパイルされJUnitやTestNGで実行されるユニットテストコードを含みます。

23.3. タスクTasks

The Java plugin adds a number of tasks to your project, as shown below.

Javaプラグインは、以下に示すような数多くのタスクをプロジェクトに追加します。

表23.1 Javaプラグイン - タスクJava plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
compileJava コンパイル時クラスパスを作り出すすべてのタスク。 compileコンフィギュレーションに含まれる、 プロジェクトの依存関係のためのjarタスクを含む All tasks which produce the compile classpath. This includes the jar task for project dependencies included in the compile configuration. JavaCompile javacを使って製品Javaソースファイルをコンパイルする Compiles production Java source files using javac.
processResources - Copy 製品リソースを製品クラスディレクトリにコピーする Copies production resources into the production classes directory.
classes compileJavaprocessResources。 一部のプラグインはさらにコンパイルタスクを追加する The compileJava task and the processResources task. Some plugins add additional compilation tasks. Task 製品クラスディレクトリを構築する Assembles the production classes directory.
compileTestJava compile、そしてテストのコンパイル時クラスパスを作り出すすべてのタスク compile, plus all tasks which produce the test compile classpath. JavaCompile javacを使ってテストJavaソースファイルをコンパイルする Compiles test Java source files using javac.
processTestResources - Copy テストリソースをテストクラスディレクトリにコピーする Copies test resources into the test classes directory.
testClasses compileTestJavaprocessTestResources。一部のプラグインはさらにテストコンパイルタスクを追加する compileTestJava task and processTestResources task. Some plugins add additional test compilation tasks. Task テストクラスディレクトリを構築する Assembles the test classes directory.
jar compile Jar JARファイルを構築する Assembles the JAR file
javadoc compile Javadoc Javadocを使って製品JavaソースのAPIドキュメントを生成する Generates API documentation for the production Java source, using Javadoc
test compilecompileTest、そしてテストの実行時クラスパスを作り出すすべてのタスク compile, compileTest, plus all tasks which produce the test runtime classpath. Test JUnitかTestNGを使ってユニットテストを実行する Runs the unit tests using JUnit or TestNG.
uploadArchives archivesコンフィギュレーションのアーティファクトを生成するタスク ( jarを含む) The tasks which produce the artifacts in the archives configuration, including jar. Upload archives コンフィギュレーションのアーティファクト(JARファイルを含む)をアップロードする Uploads artifacts in the archives configuration, including the JAR file.
clean - Delete プロジェクトのビルドディレクトリを削除するDeletes the project build directory.
cleanTaskName - Delete 指定したタスクが生成したファイルを削除する。 例えばcleanJarjarタスクが作ったJARファイルを削除し、cleanTesttestタスクが作ったテスト結果を削除する。 Deletes files created by specified task. cleanJar will delete the JAR file created by the jar task, and cleanTest will delete the test results created by the test task.

For each source set you add to the project, the Java plugin adds the following compilation tasks:

Javaプラグインは、プロジェクトに追加されるソースセットの各々について以下のコンパイルタスクを追加します:

表23.2 Javaプラグイン - ソースセットタスクJava plugin - source set tasks

タスク名Task name 依存先Depends on Type 説明Description
compileSourceSetJava このソースセットのコンパイル時クラスパスを作り出すすべてのタスク All tasks which produce the source set's compile classpath. JavaCompile javacを使って特定のソースセットのJavaソースファイルをコンパイルする Compiles the given source set's Java source files using javac.
processSourceSetResources - Copy 特定のソースセットのリソースをそのクラスディレクトリにコピーする Copies the given source set's resources into the classes directory.
sourceSetClasses compileSourceSetJavaprocessSourceSetResources。一部のプラグインはさらにこのソースセットのコンパイルタスクを追加する The compileSourceSetJava task and the processSourceSetResources task. Some plugins add additional compilation tasks for the source set. Task 特定のソースセットのクラスディレクトリを構築する Assembles the given source set's classes directory.

The Java plugin also adds a number of tasks which form a lifecycle for the project:

Javaプラグインは、プロジェクトのライフサイクルを構成する数多くのタスクも追加します:

表23.3 Javaプラグイン - ライフサイクルタスクJava plugin - lifecycle tasks

タスク名Task name 依存先Depends on Type 説明Description
assemble jarを含む、プロジェクトのすべてのアーカイブタスク。 一部のプラグインはプロジェクトにさらにアーカイブタスクを追加する All archive tasks in the project, including jar. Some plugins add additional archive tasks to the project. Task プロジェクトのすべてのアーカイブを構築する Assembles all the archives in the project.
check testを含む、プロジェクトのすべての検証タスク。 一部のプラグインはプロジェクトにさらに検証タスクを追加する All verification tasks in the project, including test. Some plugins add additional verification tasks to the project. Task プロジェクトのすべての検証タスクを実行する Performs all verification tasks in the project.
build checkassemble check and assemble Task プロジェクトのフルビルドを実行する Performs a full build of the project.
buildNeeded build と、testRuntimeコンフィギュレーションのプロジェクトライブラリ依存先すべての buildNeededタスク build and buildNeeded tasks in all project lib dependencies of the testRuntime configuration. Task このプロジェクトと、このプロジェクトが依存しているすべてのプロジェクトのフルビルドを実行する。 Performs a full build of the project and all projects it depends on.
buildDependents build と、testRuntimeコンフィギュレーションのプロジェクトライブラリ依存先がこのプロジェクトであるすべてのプロジェクトの buildDependentsタスク build and buildDependents tasks in all projects with a project lib dependency on this project in a testRuntime configuration. Task このプロジェクトと、このプロジェクトに依存しているすべてのプロジェクトのフルビルドを実行する。 Performs a full build of the project and all projects which depend on it.
buildConfigName ConfigNameコンフィギュレーションのアーティファクトを作り出すタスク The tasks which produce the artifacts in configuration ConfigName. Task 指定されたコンフィギュレーションのアーティファクトを構築する。 このタスクは、Javaプラグインが暗黙的に適用するBaseプラグインにより追加される。 Assembles the artifacts in the specified configuration. The task is added by the Base plugin which is implicitly applied by the Java plugin.
uploadConfigName ConfigNameコンフィギュレーションのアーティファクトをアップロードするタスク The tasks which uploads the artifacts in configuration ConfigName. Upload 指定されたコンフィギュレーションのアーティファクトを構築しアップロードする。 このタスクは、Javaプラグインが暗黙的に適用するBaseプラグインにより追加される。 Assembles and uploads the artifacts in the specified configuration. The task is added by the Base plugin which is implicitly applied by the Java plugin.

The following diagram shows the relationships between these tasks.

下の図は、上記のタスク間の関係を示しています。

図23.1 Javaプラグイン - タスクJava plugin - tasks

Javaプラグイン - タスクJava plugin - tasks

23.4. プロジェクトレイアウトProject layout

The Java plugin assumes the project layout shown below. None of these directories need exist or have anything in them. The Java plugin will compile whatever it finds, and handles anything which is missing.

Javaプラグインは、以下のようなプロジェクトレイアウトを仮定しています。これらのディレクトリは、存在しなかったり中身が空でもかまいません。Javaプラグインは、見つけたものをコンパイルし、見つからないものには適切に対処します。

表23.4 Javaプラグイン - デフォルトプロジェクトレイアウトJava plugin - default project layout

ディレクトリDirectory 意味Meaning
src/main/java 製品のJavaソースProduction Java source
src/main/resources 製品のリソースProduction resources
src/test/java テストのJavaソースTest Java source
src/test/resources テストのリソースTest resources
src/sourceSet/java 特定のソースセットのJavaソースJava source for the given source set
src/sourceSet/resources 特定のソースセットのリソースResources for the given source set

23.4.1. プロジェクトレイアウトの変更Changing the project layout

You configure the project layout by configuring the appropriate source set. This is discussed in more detail in the following sections. Here is a brief example which changes the main Java and resource source directories.

プロジェクトのレイアウトは、適切なソースセットを設定することでカスタマイズできます。これについては後続の節でより詳しく説明します。以下に、mainのJavaソースとリソースのソースディレクトリを変更する簡単な例を示します。

例23.2 Javaソースレイアウトのカスタマイズ

build.gradle

sourceSets {
    main {
        java {
            srcDir 'src/java'
        }
        resources {
            srcDir 'src/resources'
        }
    }
}

23.5. 依存関係の管理Dependency management

The Java plugin adds a number of dependency configurations to your project, as shown below. It assigns those configurations to tasks such as compileJava and test.

Javaプラグインは、以下のような多くの依存関係のコンフィギュレーションをプロジェクトに追加します。 これらのコンフィギュレーションはcompileJavatestといったタスクに割り当てられます。

表23.5 Javaプラグイン - 依存関係のコンフィギュレーションJava plugin - dependency configurations

名前Name 拡張元Extends 利用するタスクUsed by tasks 意味Meaning
compile - compileJava コンパイル時の依存関係 Compile time dependencies
runtime compile - 実行時の依存関係 Runtime dependencies
testCompile compile compileTestJava テストのコンパイル時の追加依存関係 Additional dependencies for compiling tests.
testRuntime runtime, testCompile test テストの実行時の追加依存関係 Additional dependencies for running tests only.
archives - uploadArchives このプロジェクトが生成するアーティファクト(jarファイルなど) Artifacts (e.g. jars) produced by this project.
default runtime - このプロジェクトに依存するプロジェクトが使用する、デフォルトのコンフィグレーション。アーティファクトと、このプロジェクトが実行時に要求する依存関係が含まれる。 The default configuration used by a project dependency on this project. Contains the artifacts and dependencies required by this project at runtime.

図23.2 Javaプラグイン - 依存関係のコンフィギュレーションJava plugin - dependency configurations

Javaプラグイン - 依存関係のコンフィギュレーションJava plugin - dependency configurations

For each source set you add to the project, the Java plugins adds the following dependency configurations:

プロジェクトに追加されたそれぞれのソースセットに対し、Javaプラグインは次の依存関係コンフィグレーションを追加します。

表23.6 Javaプラグイン - ソースセットの依存関係コンフィグレーションJava plugin - source set dependency configurations

名前Name 拡張元Extends 利用するタスクUsed by tasks 意味Meaning
sourceSetCompile - compileSourceSetJava 対象ソースセットのコンパイル時依存関係Compile time dependencies for the given source set
sourceSetRuntime sourceSetCompile - 対象ソースセットの実行時依存関係Runtime time dependencies for the given source set

23.6. 規約プロパティConvention properties

The Java plugin adds a number of convention properties to the project, shown below. You can use these properties in your build script as though they were properties of the project object (see 「規約 Conventions).

Javaプラグインは、以下のような多くの規約プロパティをプロジェクトに追加します。 これらは、ビルドスクリプトの中で、あたかもprojectオブジェクトのプロパティであるかのように使うことができます (「規約 Conventions参照)。

表23.7 Javaプラグイン - ディレクトリプロパティJava plugin - directory properties

プロパティ名Property name Type デフォルト値Default value 説明Description
reportsDirName String reports レポートを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate reports into, relative to the build directory.
reportsDir File (read-only) buildDir/reportsDirName レポートを生成するディレクトリ The directory to generate reports into.
testResultsDirName String test-results テスト結果の.xmlファイルを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate test result .xml files into, relative to the build directory.
testResultsDir File (read-only) buildDir/testResultsDirName テスト結果の.xmlファイルを生成するディレクトリThe directory to generate test result .xml files into.
testReportDirName String tests テストレポートを生成するディレクトリ名。レポートディレクトリへの相対パス The name of the directory to generate the test report into, relative to the reports directory.
testReportDir File (read-only) reportsDir/testReportDirName テストレポートを生成するディレクトリ The directory to generate the test report into.
libsDirName String libs ライブラリを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate libraries into, relative to the build directory.
libsDir File (read-only) buildDir/libsDirName ライブラリを生成するディレクトリ The directory to generate libraries into.
distsDirName String distributions ディストリビューションを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate distributions into, relative to the build directory.
distsDir File (read-only) buildDir/distsDirName ディストリビューションを生成するディレクトリ The directory to generate distributions into.
docsDirName String docs ドキュメントを生成するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to generate documentation into, relative to the build directory.
docsDir File (read-only) buildDir/docsDirName ドキュメントを生成するディレクトリ The directory to generate documentation into.
dependencyCacheDirName String dependency-cache ソースの依存関係情報をキャッシュするのに使用するディレクトリ名。ビルドディレクトリへの相対パス The name of the directory to use to cache source dependency information, relative to the build directory.
dependencyCacheDir File (read-only) buildDir/dependencyCacheDirName ソースの依存関係情報をキャッシュするのに使用するディレクトリ The directory to use to cache source dependency information.

表23.8 Javaプラグイン - その他のプロパティJava plugin - other properties

プロパティ名Property name Type デフォルト値Default value 説明Description
sourceSets SourceSetContainer (read-only) 非nullNot null プロジェクトのソースセット Contains the project's source sets.
sourceCompatibility JavaVersion。 StringやNumberで設定することも可能。例: '1.5'1.5 JavaVersion. Can also set using a String or a Number, e.g. '1.5' or 1.5. Value of the current used JVM Javaソースのコンパイル時に使用するJavaバージョン互換性 Java version compatibility to use when compiling Java source.
targetCompatibility JavaVersion。 StringやNumberで設定することも可能。例: '1.5'1.5 JavaVersion. Can also set using a String or Number, e.g. '1.5' or 1.5. sourceCompatibility クラス生成のターゲットJavaバージョン Java version to generate classes for.
archivesBaseName String projectName JARやZIPファイルのようなアーカイブに使用するベース名 The basename to use for archives, such as JAR or ZIP files.
manifest Manifest 空のマニフェストan empty manifest すべてのJARファイルを含むマニフェスト The manifest to include in all JAR files.

These properties are provided by convention objects of type JavaPluginConvention, and BasePluginConvention.

これらのプロパティは、JavaPluginConventionBasePluginConventionなどの型の規約オブジェクトによって提供されます。

23.7. ソースセットの利用Working with source sets

You can access the source sets of a project using the sourceSets property. This is a container for the project's source sets, of type SourceSetContainer. There is also a sourceSets { } script block, which you can pass a closure to configure the source set container. The source set container works pretty much the same way as other containers, such as tasks.

プロジェクトのソースセットには、sourceSetsプロパティを使ってアクセスすることができます。 これはプロジェクトのソースセットのコンテナで、SourceSetContainer型です。 また、sourceSets()というメソッドもあり、クロージャを渡してソースセットコンテナを設定することができます。 ソースセットコンテナは、tasksのような他のコンテナと同じように働きます。

例23.3 ソースセットへのアクセス

build.gradle

// Various ways to access the main source set
println sourceSets.main.output.classesDir
println sourceSets['main'].output.classesDir
sourceSets {
    println main.output.classesDir
}
sourceSets {
    main {
        println output.classesDir
    }
}

// Iterate over the source sets
sourceSets.all {
    println name
}

To configure an existing source set, you simply use one of the above access methods to set the properties of the source set. The properties are described below. Here is an example which configures the main Java and resources directories:

既存のソースセットを設定するには、上記のアクセスメソッドの一つを使って、そのソースセットのプロパティを設定します。 プロパティについては後述します。以下に、mainのJavaソースとリソースディレクトリを設定する例を示します:

例23.4 ソースセットのソースディレクトリの設定

build.gradle

sourceSets {
    main {
        java {
            srcDir 'src/java'
        }
        resources {
            srcDir 'src/resources'
        }
    }
}

23.7.1. ソースセットプロパティSource set properties

The following table lists some of the important properties of a source set. You can find more details in the API documentation for SourceSet.

以下の表は、ソースセットの重要なプロパティの一覧です。 さらに詳しくは、SourceSetのAPIドキュメントをご覧ください。

表23.9 Javaプラグイン - ソースセットプロパティJava plugin - source set properties

プロパティ名Property name Type デフォルト値Default value 説明Description
name String (read-only) 非nullNot null このソースセットを識別するための名前 The name of the source set, used to identify it.
output SourceSetOutput (read-only) Not null このソースセットに対する出力ファイル。コンパイルされたクラスファイルやリソースを含む。 The output files of the source set, containing its compiled classes and resources.
output.classesDir File buildDir/classes/name このソースセットのクラスを生成するディレクトリ The directory to generate the classes of this source set into.
output.resourcesDir File buildDir/resources/name このソースセットのリソースを生成するディレクトリ The directory to generate the resources of this source set into.
compileClasspath FileCollection compileSourceSetコンフィグレーション compileSourceSet configuration. このソースセットのソースファイルのコンパイル時クラスパス The classpath to use when compiling the source files of this source set.
runtimeClasspath FileCollection output + runtimeSourceSetコンフィグレーション output + runtimeSourceSet configuration. このソースセットのクラスの実行時クラスパス The classpath to use when executing the classes of this source set.
java SourceDirectorySet (read-only) 非nullNot null このソースセットのJavaソースファイル。 Javaソースディレクトリ内の.javaファイルのみを含み、その他のファイルは含まない The Java source files of this source set. Contains only .java files found in the Java source directories, and excludes all other files.
java.srcDirs Set<File>。 設定には「入力ファイルセットを指定する Specifying a set of input filesで述べる方法ならどれでも使用可 Set<File>. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. [projectDir/src/name/java] このソースセットのJavaソースファイルを含むソースディレクトリ The source directories containing the Java source files of this source set.
resources SourceDirectorySet (read-only) 非nullNot null このソースセットのリソース。 リソースのみを含み、リソースソースディレクトリ内の.javaファイルは含まない。 Groovyプラグインのような他のプラグインでは、このコレクションから除外されるタイプがさらに追加される。 The resources of this source set. Contains only resources, and excludes any .java files found in the resource source directories. Other plugins, such as the Groovy plugin, exclude additional types of files from this collection.
resources.srcDirs Set<File>。 設定には「入力ファイルセットを指定する Specifying a set of input filesで述べる方法ならどれでも使用可Set<File>. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. [projectDir/src/name/resources] このソースセットのリソースを含むソースディレクトリ The source directories containing the resources of this source set.
allJava SourceDirectorySet (read-only) java このソースセットのすべての.javaファイル。 Groovyプラグインのような一部のプラグインでは、さらに追加のJavaソースファイルがこのコレクションに追加される。 All .java files of this source set. Some plugins, such as the Groovy plugin, add additional Java source files to this collection.
allSource SourceDirectorySet (read-only) resources + java このソースセットのすべてのソースファイル。 すべてのリソースファイルとJavaソースファイルが含まれる。 Groovyプラグインのような一部のプラグインでは、さらに追加のソースファイルがこのコレクションに追加される。 All source files of this source set. This include all resource files and all Java source files. Some plugins, such as the Groovy plugin, add additional source files to this collection.

23.7.2. 新しいソースセットの定義Defining new source sets

To define a new source set, you simply reference it in the sourceSets { } block. Here's an example:

新しいソースセットは、sourceSets { }ブロックの中でそれを参照するだけで定義できます。以下がその例です。:

例23.5 ソースセットの定義

build.gradle

sourceSets {
    intTest
}

When you define a new source set, the Java plugin adds some dependency configurations for the source set, as shown in 表23.6「Javaプラグイン - ソースセットの依存関係コンフィグレーションJava plugin - source set dependency configurations. You can use these configurations to define the compile and runtime dependencies of the source set.

ソースセットを定義すると、Javaプラグインは、そのソースセットのために表23.6「Javaプラグイン - ソースセットの依存関係コンフィグレーションJava plugin - source set dependency configurationsで示した依存関係のコンフィグレーションを追加します。これらのコンフィグレーションを、そのソースセットのコンパイル時や実行時の依存関係を定義するために使うことができます。

例23.6 ソースセットの依存関係定義

build.gradle

sourceSets {
    intTest
}

dependencies {
    intTestCompile 'junit:junit:4.11'
    intTestRuntime 'org.ow2.asm:asm-all:4.0'
}

The Java plugin also adds a number of tasks which assemble the classes for the source set, as shown in 表23.2「Javaプラグイン - ソースセットタスクJava plugin - source set tasks. For example, for a source set called intTest, compiling the classes for this source set is done by running gradle intTestClasses.

また、Javaプラグインは、表23.2「Javaプラグイン - ソースセットタスクJava plugin - source set tasksに示したような、 そのソースセットのクラスを構築するためのタスクを追加します。 例えば、intTestというソースセットを追加すると、gradle intTestClassesと実行することでそのソースセットのクラスをコンパイルできるようになります。

例23.7 ソースセットのコンパイル

gradle intTestClasses の出力

> gradle intTestClasses
:compileIntTestJava
:processIntTestResources
:intTestClasses

BUILD SUCCESSFUL

Total time: 1 secs

23.7.3. ソースセットの実例Some source set examples

Adding a JAR containing the classes of a source set:

ソースセットのクラスを含んだJARを追加します:

例23.8 ソースセットのJARを生成

build.gradle

task intTestJar(type: Jar) {
    from sourceSets.intTest.output
}

Generating Javadoc for a source set:

ソースセットのJavadocを生成します:

例23.9 ソースセットのJavadocを生成

build.gradle

task intTestJavadoc(type: Javadoc) {
    source sourceSets.intTest.allJava
}

Adding a test suite to run the tests in a source set:

ソースセットに含まれるテストを実行するテストスイートを追加します:

例23.10 ソースセットのテストを実行

build.gradle

task intTest(type: Test) {
    testClassesDir = sourceSets.intTest.output.classesDir
    classpath = sourceSets.intTest.runtimeClasspath
}

23.8. JavadocJavadoc

The javadoc task is an instance of Javadoc. It supports the core Javadoc options and the options of the standard doclet described in the reference documentation of the Javadoc executable. For a complete list of supported Javadoc options consult the API documentation of the following classes: CoreJavadocOptions and StandardJavadocDocletOptions.

javadocタスクはJavadocのインスタンスです。 javadocの主なオプションと、javadocコマンドのリファレンスガイドに記載されている標準docletのオプションをサポートしています。 サポートしているjavadocオプションの完全なリストについては、次のクラスのAPIドキュメントを参照してください: CoreJavadocOptionsおよびStandardJavadocDocletOptions

表23.10 Javaプラグイン - JavadocプロパティJava plugin - Javadoc properties

プロパティ名Property name Type デフォルト値Default value
classpath FileCollection sourceSets.main.output + sourceSets.main.compileClasspath
source FileTree。 設定には「入力ファイルセットを指定する Specifying a set of input filesで述べる方法ならどれでも使用可 FileTree. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. sourceSets.main.allJava
destinationDir File docsDir/javadoc
title String プロジェクトの名前とバージョン The name and version of the project

23.9. CleanClean

The clean task is an instance of Delete. It simply removes the directory denoted by its dir property.

cleanタスクはDeleteのインスタンスです。 dirプロパティで示されるディレクトリを削除します。

表23.11 Javaプラグイン - CleanプロパティJava plugin - Clean properties

タスクプロパティProperty name Type デフォルト値Default value
dir File buildDir

23.10. リソースResources

The Java plugin uses the Copy task for resource handling. It adds an instance for each source set in the project. You can find out more about the copy task in 「ファイルをコピーする Copying files.

Javaプラグインは、リソースの処理にCopyタスクを使います。 プロジェクトの各ソースセットに対して一つのインスタンスを追加します。 copyタスクの詳細については、「ファイルをコピーする Copying filesをご覧ください。

表23.12 Javaプラグイン- processResourcesプロパティJava plugin - ProcessResources properties

タスクプロパティProperty name Type デフォルト値Default value
srcDirs Object。 設定には「入力ファイルセットを指定する Specifying a set of input filesで述べる方法ならどれでも使用可 Object. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. sourceSet.resources
destinationDir File。 設定には「ファイルを参照する Locating filesで述べる方法ならどれでも使用可 File. Can set using anything described in 「ファイルを参照する Locating files. sourceSet.output.resourcesDir

23.11. CompileJavaCompileJava

The Java plugin adds a JavaCompile instance for each source set in the project. Some of the most common configuration options are shown below.

Javaプラグインは、プロジェクトの各ソースセットに対して一つのJavaCompileインスタンスを追加します。 compileタスクは、実際のコンパイル作業をAntのjavacタスクに委譲します。 Antのjavacタスクの大部分のプロパティが設定可能です。

表23.13 Javaプラグイン - CompileプロパティJava plugin - Compile properties

タスクプロパティProperty name Type デフォルト値Default value
classpath FileCollection sourceSet.compileClasspath
source FileTree。 設定には「入力ファイルセットを指定する Specifying a set of input filesで述べる方法ならどれでも使用可 FileTree. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. sourceSet.java
destinationDir File. sourceSet.output.classesDir

By default, the Java compiler runs in the Gradle process. Setting options.fork to true causes compilation to occur in a separate process. In the case of the Ant javac task, this means that a new process will be forked for each compile task, which can slow down compilation. Conversely, Gradle's direct compiler integration (see above) will reuse the same compiler process as much as possible. In both cases, all fork options specified with options.forkOptions will be honored.

デフォルトでは、javaコンパイラはGradleプロセス上で実行されます。設定を options.forktrueにすると、 個別のプロセスでコンパイルを実行します。 Antのjavacタスクを例に挙げると, コンパイルタスクを実行するたびに新しいプロセスが実行される形で 遅延実行させることも可能です。反対に、Gradleのダイレクトコンパイラの利用を有効にした場合 (上記参照) 出来るだけ 同一のプロセスでコンパイルを実行しようとします. 両方利用するケースの場合は、全ての処理実行オプションは options.forkOptions によって指定されるでしょう。

23.12. Incremental Java compilation

Starting with Gradle 2.1, it is possible to compile Java incrementally. This feature is still incubating. See the JavaCompile task for information on how to enable it.

Main goals for incremental compilations are:

  • Avoid wasting time compiling source classes that don't have to be compiled. This means faster builds, especially when a change to a source class or a jar does not incur recompilation of many source classes that depend on the changed input.
  • Change as few output classes as possible. Classes that don't need to be recompiled remain unchanged in the output directory. An example scenario when this is really useful is using JRebel - the fewer output classes are changed the quicker the jvm can use refreshed classes.

The incremental compilation at a high level:

  • The detection of the correct set of stale classes is reliable at some expense of speed. The algorithm uses bytecode analysis and deals gracefully with compiler optimizations (inlining of non-private constants), transitive class dependencies, etc. Example: When a class with a public constant changes, we eagerly compile everything to avoid problems with constants inlined by the compiler. Down the road we will tune the algorithm and caching so that incremental Java compilation can be a default setting for every compile task.
  • To make incremental compilation fast, we cache class analysis results and jar snapshots. The initial incremental compilation can be slower due to the cold caches.

23.13. テストTest

The test task is an instance of Test. It automatically detects and executes all unit tests in the test source set. It also generates a report once test execution is complete. JUnit and TestNG are both supported. Have a look at Test for the complete API.

testタスクはTestのインスタンスです。 このタスクは、testソースセットに含まれるすべてのユニットテストを自動的に検出し、実行します。 また、テストの実行が完了するとレポートを生成します。JUnitとTestNGの両方がサポートされています。 完全なAPIについては、Testを見てください。

23.13.1. テストの実行 Test execution

Tests are executed in a separate JVM, isolated from the main build process. The Test task's API allows you some control over how this happens.

テストの実行は別のJVMで行われ、メインのビルドプロセスからは分離されます。TestタスクのAPIを使って、テストの実行を制御できます。

There are a number of properties which control how the test process is launched. This includes things such as system properties, JVM arguments, and the Java executable to use.

テストプロセスの起動を制御するための多くのプロパティが用意されています。 これにはシステムプロパティや、JVMへの引数、Java実行コマンドなどが含まれます。

You can specify whether or not to execute your tests in parallel. Gradle provides parallel test execution by running multiple test processes concurrently. Each test process executes only a single test at a time, so you generally don't need to do anything special to your tests to take advantage of this. The maxParallelForks property specifies the maximum number of test processes to run at any given time. The default is 1, that is, do not execute the tests in parallel.

テストが並列に実行されるかどうかを指定することができます。 Gradleでは、複数のテストプロセスを同時に実行する並列テスト実行が可能です。 各テストプロセスは一度に一つのテストだけを実行するので、通常、これを活用するために何か特別な準備をする必要はありません。 maxParallelForksプロパティで、同時に実行されるテストプロセスの最大個数を指定します。 デフォルトは1で、これはテストが並列実行されないということです。

The test process sets the org.gradle.test.worker system property to a unique identifier for that test process, which you can use, for example, in files names or other resource identifiers.

テストプロセスでは、そのテストプロセスの一意な識別子であるorg.gradle.test.workerシステムプロパティが設定されます。 これは例えばファイル名の一部や、その他のリソースの識別子などに利用することができます。

You can specify that test processes should be restarted after it has executed a certain number of test classes. This can be a useful alternative to giving your test process a very large heap. The forkEvery property specifies the maximum number of test classes to execute in a test process. The default is to execute an unlimited number of tests in each test process.

一定のテストクラスを実行し終わったら、そのテストプロセスが再起動されるように指定することができます。 これは、テストプロセスに巨大なヒープを割り当てることに対する便利な代替手段になりえます。 forkEveryプロパティは、一つのテストプロセス内で実行されるテストクラスの最大数を指定します。 デフォルトでは各テストプロセスで無制限な数のテストを実行できます。

The task has an ignoreFailures property to control the behavior when tests fail. The Test task always executes every test that it detects. It stops the build afterwards if ignoreFailures is false and there are failing tests. The default value of ignoreFailures is false.

このタスクは、テストが失敗したときの振る舞いを制御するignoreFailuresプロパティを持っています。 Testはいつも見つけたテストをすべて実行します。 ignoreFailuresがfalseのとき、失敗したテストがあるとそれ以降のビルドは停止されます。 ignoreFailuresのデフォルト値はfalseです。

The testLogging property allows you to configure which test events are going to be logged and at which detail level. By default, a concise message will be logged for every failed test. See TestLoggingContainer for how to tune test logging to your preferences.

testLoggingプロパティで、どのテストイベントを、どのログレベルでログに出すべきか設定することができます。 デフォルトでは、全ての失敗したテストに対して簡潔なメッセージがログ出力されます。好みに応じてテストログを設定する方法については、TestLoggingContainerを参照してください。

23.13.2. Debugging

The test task provides a Test.getDebug() property that can be set to launch to make the JVM wait for a debugger to attach to port 5005 before proceeding with test execution.

This can also be enabled at invocation time via the --debug-jvm task option (since Gradle 1.12).

23.13.3. Test filtering

Starting with Gradle 1.10, it is possible to include only specific tests, based on the test name pattern. Filtering is a different mechanism than test class inclusion / exclusion that will be described in the next few paragraphs (-Dtest.single, test.include and friends). The latter is based on files, e.g. the physical location of the test implementation class. File-level test selection does not support many interesting scenarios that are possible with test-level filtering. Some of them Gradle handles now and some will be satisfied in future releases:

  • Filtering at the level of specific test methods; executing a single test method
  • Filtering based on custom annotations (future)
  • Filtering based on test hierarchy; executing all tests that extend ceratain base class (future)
  • Filtering based on some custom runtime rule, e.g. particular value of a system property or some static state (future)

Test filtering feature has following characteristic:

  • Fully qualified class name or fully qualified method name is supported, e.g. “org.gradle.SomeTest”, “org.gradle.SomeTest.someMethod”
  • Wildcard '*' is supported for matching any characters
  • Command line option “--tests” is provided to conveniently set the test filter. Especially useful for the classic 'single test method execution' use case. When the command line option is used, the inclusion filters declared in the build script are ignored.
  • Gradle tries to filter the tests given the limitations of the test framework API. Some advanced, synthetic tests may not be fully compatible with filtering. However, the vast majority of tests and use cases should be handled neatly.
  • Test filtering supersedes the file-based test selection. The latter may be completely replaced in future. We will grow the the test filtering api and add more kinds of filters.

例23.11 Filtering tests in the build script

build.gradle

test {
    filter {
        //include specific method in any of the tests
        includeTestsMatching "*UiCheck"

        //include all tests from package
        includeTestsMatching "org.gradle.internal.*"

        //include all integration tests
        includeTestsMatching "*IntegTest"
    }
}


For more details and examples please see the TestFilter reference.

Some examples of using the command line option:

  • gradle test --tests org.gradle.SomeTest.someSpecificFeature

  • gradle test --tests *SomeTest.someSpecificFeature

  • gradle test --tests *SomeSpecificTest

  • gradle test --tests all.in.specific.package*

  • gradle test --tests *IntegTest

  • gradle test --tests *IntegTest*ui*

  • gradle someTestTask --tests *UiTest someOtherTestTask --tests *WebTest*ui

23.13.4. Single test execution via System Properties

This mechanism has been superseded by 'Test Filtering', described above.

Setting a system property of taskName.single = testNamePattern will only execute tests that match the specified testNamePattern. The taskName can be a full multi-project path like “:sub1:sub2:test” or just the task name. The testNamePattern will be used to form an include pattern of “**/testNamePattern*.class”;. If no tests with this pattern can be found an exception is thrown. This is to shield you from false security. If tests of more than one subproject are executed, the pattern is applied to each subproject. An exception is thrown if no tests can be found for a particular subproject. In such a case you can use the path notation of the pattern, so that the pattern is applied only to the test task of a specific subproject. Alternatively you can specify the fully qualified task name to be executed. You can also specify multiple patterns. Examples:

taskName.single = testNamePatternというシステムプロパティを設定すると、指定されたtestNamePatternにマッチするテストだけが実行されます。 taskNameには、":sub1:sub2:test"のような完全なマルチプロジェクトパスか、単なるタスク名が使えます。 testNamePatternは、"**/testNamePattern*.class"という形式のincludesパターンを構成するのに使われます。 このパターンでテストが一つも見つからない場合は例外が発生します。 これは手違いによる偽りの安心を防ぐためです。 複数のサブプロジェクトに対してテストが実行される場合、パターンは各サブプロジェクトに適用されます。 ある一つのサブプロジェクトでテストが見つからなかった場合でも例外が発生します。 このような場合は、パターンのパス記法を使って、パターンが特定のサブプロジェクトのtestタスクだけに適用されるようにできます。 あるいは、完全修飾タスク名を使って実行するタスクを指定することも可能です。 パターンは複数指定することもできます。以下は実例です:

  • gradle -Dtest.single=ThisUniquelyNamedTest test

  • gradle -Dtest.single=a/b/ test

  • gradle -DintegTest.single=*IntegrationTest integTest

  • gradle -Dtest.single=:proj1:test:Customer build

  • gradle -DintegTest.single=c/d/ :proj1:integTest

23.13.5. テストの検出Test detection

The Test task detects which classes are test classes by inspecting the compiled test classes. By default it scans all .class files. You can set custom includes / excludes, only those classes will be scanned. Depending on the test framework used (JUnit / TestNG) the test class detection uses different criteria.

Testタスクは、コンパイル済みのtestクラスを調べて、どのクラスがテストクラスかを見つけだします。 デフォルトでは、すべての.classファイルがスキャンされます。 カスタムの includes / excludes を設定して、特定のクラスだけをスキャンするようにもできます。 テストクラスの検出には、使用するテストフレームワーク(JUnit / TestNG)によって異なる基準が使われます。

When using JUnit, we scan for both JUnit 3 and 4 test classes. If any of the following criteria match, the class is considered to be a JUnit test class:

JUnitを使っている場合は、JUnit 3と4両方のテストクラスをスキャンします。 以下のいずれかの基準に合致する場合、そのクラスはJUnitのテストクラスだと見なされます:

  • Class or a super class extends TestCase or GroovyTestCase

    そのクラスまたはスーパークラスが TestCaseGroovyTestCaseをextendsしている

  • Class or a super class is annotated with @RunWith

    そのクラスまたはスーパークラスに @RunWithアノテーションが付いている

  • Class or a super class contain a method annotated with @Test

    そのクラスまたはスーパークラスが@Testアノテーションが付いたメソッドを含んでいる

When using TestNG, we scan for methods annotated with @Test.

TestNGを使っている場合は、@Testアノテーションが付いたメソッドをスキャンします。

Note that abstract classes are not executed. Gradle also scans up the inheritance tree into jar files on the test classpath.

抽象クラスは実行されないことに注意してください。 Gradleは、testクラスパス上のjarファイルに含まれる継承ツリーもスキャンします。

If you don't want to use test class detection, you can disable it by setting scanForTestClasses to false. This will make the test task only use includes / excludes to find test classes. If scanForTestClasses is false and no include / exclude patterns are specified, the defaults are “**/*Tests.class”, “**/*Test.class” and “**/Abstract*.class” for include and exclude, respectively.

上記のテストクラス検出を使いたくないときは、scanForTestClassesをfalseに設定することで、これを無効にすることができます。 この場合、testタスクがテストクラスを探すときにはincludes / excludesだけが使われます。 scanForTestClassesが無効になっていて、かつincludesやexcludesパターンが指定されていないときは、 デフォルトとしてincludesには"**/*Tests.class", "**/*Test.class"、 そしてexcludesには"**/Abstract*.class"が使われます。

23.13.6. Test grouping

JUnit and TestNG allows sophisticated groupings of test methods.

For grouping JUnit test classes and methods JUnit 4.8 introduces the concept of categories. [16] The test task allows the specification of the JUnit categories you want to include and exclude.

例23.12 JUnit Categories

build.gradle

test {
    useJUnit {
        includeCategories 'org.gradle.junit.CategoryA'
        excludeCategories 'org.gradle.junit.CategoryB'
    }
}

The TestNG framework has a quite similar concept. In TestNG you can specify different test groups. [17] The test groups that should be included or excluded from the test execution can be configured in the test task.

例23.13 Grouping TestNG tests

build.gradle

test {
    useTestNG {
        excludeGroups 'integrationTests'
        includeGroups 'unitTests'
    }
}

23.13.7. Test reporting

The Test task generates the following results by default.

  • An HTML test report.

  • The results in an XML format that is compatible with the Ant JUnit report task. This format is supported by many other tools, such as CI servers.

  • Results in an efficient binary format. The task generates the other results from these binary results.

There is also a stand-alone TestReport task type which can generate the HTML test report from the binary results generated by one or more Test task instances. To use this task type, you need to define a destinationDir and the test results to include in the report. Here is a sample which generates a combined report for the unit tests from subprojects:

例23.14 Creating a unit test report for subprojects

build.gradle

subprojects {
    apply plugin: 'java'

    // Disable the test report for the individual test task
    test {
        reports.html.enabled = false
    }
}

task testReport(type: TestReport) {
    destinationDir = file("$buildDir/reports/allTests")
    // Include the results from the `test` task in all subprojects
    reportOn subprojects*.test
}

You should note that the TestReport type combines the results from multiple test tasks and needs to aggregate the results of individual test classes. This means that if a given test class is executed by multiple test tasks, then the test report will include executions of that class, but it can be hard to distinguish individual executions of that class and their output.

23.13.7.1. TestNG parameterized methods and reporting

TestNG supports parameterizing test methods, allowing a particular test method to be executed multiple times with different inputs. Gradle includes the parameter values in its reporting of the test method execution.

Given a parameterized test method named aTestMethod that takes two parameters, it will be reported with the name: aTestMethod(toStringValueOfParam1, toStringValueOfParam2). This makes identifying the parameter values for a particular iteration easy.

23.13.8. 規約値Convention values

表23.14 Javaプラグイン - テストプロパティJava plugin - test properties

タスクプロパティProperty name Type デフォルト値Default value
testClassesDir File sourceSets.test.output.classesDir
classpath FileCollection sourceSets.test.runtimeClasspath
testResultsDir File testResultsDir
testReportDir File testReportDir
testSrcDirs List<File> sourceSets.test.java.srcDirs

23.14. JarJar

The jar task creates a JAR file containing the class files and resources of the project. The JAR file is declared as an artifact in the archives dependency configuration. This means that the JAR is available in the classpath of a dependent project. If you upload your project into a repository, this JAR is declared as part of the dependency descriptor. You can learn more about how to work with archives in 「アーカイブを作成する Creating archives and artifact configurations in 52章アーティファクトの公開 Publishing artifacts.

jarタスクは、プロジェクトのクラスファイルとリソースを含んだJARファイルを生成します。このJARファイルはarchivesという依存関係のコンフィギュレーションで、アーティファクトとして宣言されています。 これは、(このプロジェクトに)依存しているプロジェクトのクラスパスでこのJARが利用可能ということです。 プロジェクトをリポジトリにアップロードする場合、このJARは依存関係のディスクリプタの一部として宣言されます。 アーカイブの扱いについては「アーカイブを作成する Creating archives、アーティファクトの設定については52章アーティファクトの公開 Publishing artifactsで、さらに詳しく学ぶことができます。

23.14.1. ManifestManifest

Each jar or war object has a manifest property with a separate instance of Manifest. When the archive is generated, a corresponding MANIFEST.MF file is written into the archive.

各jarやwarオブジェクトは、それぞれManifestのインスタンスであるmanifestプロパティを持ちます。 アーカイブが生成されるとき、対応するMANIFEST.MFファイルがアーカイブ内に作成されます。

例23.15 MANIFEST.MFのカスタマイズ

build.gradle

jar {
    manifest {
        attributes("Implementation-Title": "Gradle",
                   "Implementation-Version": version)
    }
}

You can create stand alone instances of a Manifest. You can use that for example, to share manifest information between jars.

独立したManifestインスタンスを生成することもできます。 これは例えば、複数のjar間でマニフェスト情報を共有する目的などに利用できます。

例23.16 manifestオブジェクトの作成

build.gradle

ext.sharedManifest = manifest {
    attributes("Implementation-Title": "Gradle",
               "Implementation-Version": version)
}
task fooJar(type: Jar) {
    manifest = project.manifest {
        from sharedManifest
    }
}

You can merge other manifests into any Manifest object. The other manifests might be either described by a file path or, like in the example above, by a reference to another Manifest object.

Manifestオブジェクトに他のマニフェストをマージすることもできます。 マージ対象のマニフェストは、ファイルパス、または上の例のように別のManifestオブジェクトの参照によって指定できます。

例23.17 特定のアーカイブ用にMANIFEST.MFを分離

build.gradle

task barJar(type: Jar) {
    manifest {
        attributes key1: 'value1'
        from sharedManifest, 'src/config/basemanifest.txt'
        from('src/config/javabasemanifest.txt',
             'src/config/libbasemanifest.txt') {
            eachEntry { details ->
                if (details.baseValue != details.mergeValue) {
                    details.value = baseValue
                }
                if (details.key == 'foo') {
                    details.exclude()
                }
            }
        }
    }
}

Manifests are merged in the order they are declared by the from statement. If the base manifest and the merged manifest both define values for the same key, the merged manifest wins by default. You can fully customize the merge behavior by adding eachEntry actions in which you have access to a ManifestMergeDetails instance for each entry of the resulting manifest. The merge is not immediately triggered by the from statement. It is done lazily, either when generating the jar, or by calling writeTo or effectiveManifest

マニフェストはfrom文で宣言された順にマージされます。 元のマニフェストとマージするマニフェストの双方に同じキーを持つ値が定義されている場合、デフォルトではマージするマニフェストのものが有効になります。 マージの振る舞いは、マージで生成されるマニフェストの各エントリに対するManifestMergeDetailsインスタンスにアクセスする、eachEntryアクションを追加することによって自在にカスタマイズ可能です。 マージはfrom文によって即座に実行されるわけではありません。 jarの生成時、またはwriteToeffectiveManifestの呼び出し時に、遅延して実行されます。

You can easily write a manifest to disk.

マニフェストをディスクに書き出すのは簡単です。

例23.18 特定のアーカイブ用にMANIFEST.MFを分離

build.gradle

jar.manifest.writeTo("$buildDir/mymanifest.mf")

23.15. アップロードUploading

How to upload your archives is described in 52章アーティファクトの公開 Publishing artifacts.

作成したアーカイブをアップロードする方法は、52章アーティファクトの公開 Publishing artifactsで説明しています。



[16] The JUnit wiki contains a detailed description on how to work with JUnit categories: https://github.com/junit-team/junit/wiki/Categories.

[17] The TestNG documentation contains more details about test groups: http://testng.org/doc/documentation-main.html#test-groups.

第24章 GroovyプラグインThe Groovy Plugin

The Groovy plugin extends the Java plugin to add support for Groovy projects. It can deal with Groovy code, mixed Groovy and Java code, and even pure Java code (although we don't necessarily recommend to use it for the latter). The plugin supports joint compilation, which allows you to freely mix and match Groovy and Java code, with dependencies in both directions. For example, a Groovy class can extend a Java class that in turn extends a Groovy class. This makes it possible to use the best language for the job, and to rewrite any class in the other language if needed.

Groovyプラグインは、Javaプラグインを拡張し、Groovyプロジェクトのサポートを追加したものです。 GroovyコードとGroovy/Javaの混合コードをサポートするほか、Javaコードのみのプロジェクトを取り扱うこともできます(Javaコードだけのプロジェクトにこのプラグインを使うことはあまり推奨しませんが)。 また、JavaとGroovyのジョイントコンパイルをサポートしており、GroovyコードとJavaコードを自由に混ぜ合わせたり、お互いに統合させることができます。 例えば、GroovyのクラスはJavaのクラスを継承できますし、更にそのJavaクラスがGroovyクラスを継承していても問題ありません。時々に応じて最適な言語を選択でき、必要なときにはいつでもクラスを別言語で書き直すことができます。

24.1. 使用方法Usage

To use the Groovy plugin, include the following in your build script:

Groovyプラグインを使うためには、ビルドスクリプトに下記を含めます:

例24.1 Groovyプラグインの使用

build.gradle

apply plugin: 'groovy'

24.2. タスクTasks

The Groovy plugin adds the following tasks to the project.

Groovyプラグインは、以下のタスクをプロジェクトに追加します。

表24.1 Groovyプラグイン - タスクGroovy plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
compileGroovy compileJava GroovyCompile 製品のGroovyソースファイルをコンパイルするCompiles production Groovy source files.
compileTestGroovy compileTestJava GroovyCompile テストのGroovyソースファイルをコンパイルするCompiles test Groovy source files.
compileSourceSetGroovy compileSourceSetJava GroovyCompile 特定のソースセットのGroovyソースファイルをコンパイルするCompiles the given source set's Groovy source files.
groovydoc - Groovydoc 製品のGroovyソースファイルのAPIドキュメントを生成するGenerates API documentation for the production Groovy source files.

The Groovy plugin adds the following dependencies to tasks added by the Java plugin.

Groovyプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表24.2 Groovyプラグイン - タスクの追加依存関係Groovy plugin - additional task dependencies

タスク名Task name依存先Depends on
classes compileGroovy
testClasses compileTestGroovy
sourceSetClasses compileSourceSetGroovy

図24.1 Groovyプラグイン - タスクGroovy plugin - tasks

Groovyプラグイン - タスクGroovy plugin - tasks

24.3. プロジェクトレイアウトProject layout

The Groovy plugin assumes the project layout shown in 表24.3「Groovyプラグイン - プロジェクトレイアウトGroovy plugin - project layout. All the Groovy source directories can contain Groovy and Java code. The Java source directories may only contain Java source code. [18] None of these directories need to exist or have anything in them; the Groovy plugin will simply compile whatever it finds.

Groovyプラグインでは、表24.3「Groovyプラグイン - プロジェクトレイアウトGroovy plugin - project layoutに示したようなプロジェクトレイアウトを想定しています。すべてのGroovyソースディレクトリは、GroovyおよびJavaコードを含むことができます。Javaソースディレクトリは、Javaソースコードだけしか含むことができません。 [19] これらのどのディレクトリも、存在しなかったり、何も含んでいなくてもかまいません。Groovyプラグインは、単純に見つけたディレクトリをコンパイルするだけです。

表24.3 Groovyプラグイン - プロジェクトレイアウトGroovy plugin - project layout

ディレクトリDirectory 意味Meaning
src/main/java 製品のJavaソースProduction Java source
src/main/resources 製品のリソースProduction resources
src/main/groovy 製品のGroovyソース。ジョイントコンパイルするJavaソースを含んでもよいProduction Groovy sources. May also contain Java sources for joint compilation.
src/test/java テストのJavaソースTest Java source
src/test/resources テストのリソースTest resources
src/test/groovy テストのGroovyソース。ジョイントコンパイルするJavaソースを含んでもよいTest Groovy sources. May also contain Java sources for joint compilation.
src/sourceSet/java 特定のソースセットのJavaソースJava source for the given source set
src/sourceSet/resources 特定のソースセットのリソースResources for the given source set
src/sourceSet/groovy 特定のソースセットのGroovyソース。ジョイントコンパイルするJavaソースを含んでもよいGroovy sources for the given source set. May also contain Java sources for joint compilation.

24.3.1. プロジェクトレイアウトの変更Changing the project layout

Just like the Java plugin, the Groovy plugin allows you to configure custom locations for Groovy production and test sources.

Javaプラグインと同じように、Groovyプラグインも製品コードやテストコードの場所を変更することができます。

例24.2 Groovyソースレイアウトのカスタマイズ

build.gradle

sourceSets {
    main {
        groovy {
            srcDirs = ['src/groovy']
        }
    }

    test {
        groovy {
            srcDirs = ['test/groovy']
        }
    }
}

24.4. 依存関係の管理 Dependency management

Because Gradle's build language is based on Groovy, and parts of Gradle are implemented in Groovy, Gradle already ships with a Groovy library (2.3.3 as of Gradle 2.0). Nevertheless, Groovy projects need to explicitly declare a Groovy dependency. This dependency will then be used on compile and runtime class paths. It will also be used to get hold of the Groovy compiler and Groovydoc tool, respectively.

Gradleのビルド言語はGroovyをベースにしており、Gradleの一部もGroovyで実装されているので、Gradleには既にGroovyライブラリ(Gradle2.0からは2.3.3)が同梱されています。ですが、Groovyプロジェクトでは明示的にGroovyへの依存関係を宣言しなければなりません。 ここで宣言したGroovyへの依存関係は、コンパイルクラスパスおよび実行時クラスパスに追加されます。さらに、GroovyコンパイラおよびGroovydocツールを取得するのにも使用されます。

If Groovy is used for production code, the Groovy dependency should be added to the compile configuration:

Groovyが製品コードで使われている場合は、Groovy依存関係はcompileコンフィギュレーションに追加してください。

例24.3 Groovyプラグインの設定

build.gradle

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.6'
}

If Groovy is only used for test code, the Groovy dependency should be added to the testCompile configuration:

Groovyがテストコードのみで使われている場合は、Groovy依存関係はtestCompileコンフィギュレーションに追加してください。

例24.4 Groovyテスト用の依存関係設定

build.gradle

dependencies {
    testCompile "org.codehaus.groovy:groovy:2.3.6"
}

To use the Groovy library that ships with Gradle, declare a localGroovy() dependency. Note that different Gradle versions ship with different Groovy versions; as such, using localGroovy() is less safe then declaring a regular Groovy dependency.

Gradleに同梱されているGroovyを使うには、localGroovy()を依存関係で宣言してください。ただ注意してほしいのは、Gradleのバージョンが異なれば同梱されているGroovyのバージョンも異なる可能性があるということです。localGroovy()は、普通の宣言方法に比べると安全とは言えません。

例24.5 同梱のGroovyを使用する依存関係設定

build.gradle

dependencies {
    compile localGroovy()
}

The Groovy library doesn't necessarily have to come from a remote repository. It could also come from a local lib directory, perhaps checked in to source control:

Groovyライブラリは、必ずしもリモートのリポジトリから取得しなければならないわけではありません。ローカルのlibディレクトリなどに格納して、ソースコード管理システムにチェックインしたりすることもできます。

例24.6 Groovyをファイル依存関係で設定する

build.gradle

repositories {
    flatDir { dirs 'lib' }
}

dependencies {
    compile module('org.codehaus.groovy:groovy:1.6.0') {
        dependency('asm:asm-all:2.2.3')
        dependency('antlr:antlr:2.7.7')
        dependency('commons-cli:commons-cli:1.2')
        module('org.apache.ant:ant:1.9.3') {
            dependencies('org.apache.ant:ant-junit:1.9.3@jar',
                         'org.apache.ant:ant-launcher:1.9.3')
        }
    }
}

The “module” reference may be new to you. See 51章依存関係の管理 Dependency Management for more information about this and other information about dependency management.

24.5. Groovyクラスパスの自動設定 Automatic configuration of groovyClasspath

GroovyCompile and Groovydoc tasks consume Groovy code in two ways: on their classpath, and on their groovyClasspath. The former is used to locate classes referenced by the source code, and will typically contain the Groovy library along with other libraries. The latter is used to load and execute the Groovy compiler and Groovydoc tool, respectively, and should only contain the Groovy library and its dependencies.

GroovyCompileタスクとGroovydocタスクは二つの用途でGroovyを使用します。タスクのclasspathgroovyClasspathです。前者はソースコードから参照されているクラスを配置するパスで、Groovyライブラリも典型的には他のライブラリと一緒に格納されます。後者はGroovyコンパイラとGroovydocツールをロードして実行するために使用されるパスで、Groovyライブラリとその依存関係のみが配置されていなければなりません。

Unless a task's groovyClasspath is configured explicitly, the Groovy (base) plugin will try to infer it from the task's classpath. This is done as follows: groovyClasspathが明示的に設定されていない場合、Groovy(base)プラグインはタスクのclasspathから以下のように設定値を推論しようとします。

  • If a groovy-all(-indy) Jar is found on classpath, that jar will be added to groovyClasspath.groovy-all(-indy)のJarがclasspathに見つかれば、そのjarをgroovyClasspathにも追加します。
  • If a groovy(-indy) jar is found on classpath, and the project has at least one repository declared, a corresponding groovy(-indy) repository dependency will be added to groovyClasspath.groovy(-indy)のJarがclasspathに見つかれば、そして少なくとも一つのリポジトリがプロジェクトに設定されていれば、リポジトリから対応するgroovy(-indy)の依存関係を取得してgroovyClasspathに追加します。
  • Otherwise, execution of the task will fail with a message saying that groovyClasspath could not be inferred. それ以外の場合は、groovyClasspathの推論に失敗した旨のメッセージを出力してタスクは失敗します。

Note that the “-indy” variation of each jar refers to the version with invokedynamic support.

24.6. 規約プロパティConvention properties

The Groovy plugin does not add any convention properties to the project.

Groovyプラグインは、プロジェクトには規約プロパティを追加しません。

24.7. ソースセットプロパティSource set properties

The Groovy plugin adds the following convention properties to each source set in the project. You can use these properties in your build script as though they were properties of the source set object (see 「規約 Conventions).

Groovyプラグインは、プロジェクトの各ソースセットに以下の規約プロパティを追加します。これらのプロパティは、あたかもソースセットオブジェクトのプロパティであるかのようにビルドスクリプト内で使うことができます(「規約 Conventions参照)。

表24.4 Groovyプラグイン - ソースセットプロパティGroovy plugin - source set properties

プロパティ名Property name Type デフォルト値Default value 説明Description
groovy SourceDirectorySet (読取り専用) SourceDirectorySet (read-only) 非null Not null このソースセットのGroovyソースファイル。Groovyソースディレクトリにある、すべての.groovy.javaファイルを含み、その他のタイプのファイルは含まない The Groovy source files of this source set. Contains all .groovy and .java files found in the Groovy source directories, and excludes all other types of files.
groovy.srcDirs Set<File>「入力ファイルセットを指定する Specifying a set of input filesで説明されたものなら何でも設定可能 Set<File>. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. [projectDir/src/name/groovy] このソースセットのGroovyソースファイルを含むソースディレクトリ。ジョイントコンパイルするJavaソースファイルも含む場合がある The source directories containing the Groovy source files of this source set. May also contain Java source files for joint compilation.
allGroovy FileTree (読取り専用) FileTree (read-only) 非null Not null このソースセットの全Groovyソースファイル。Groovyソースディレクトリにある.groovyファイルのみを含む All Groovy source files of this source set. Contains only the .groovy files found in the Groovy source directories.

These properties are provided by a convention object of type GroovySourceSet.

上記プロパティはGroovySourceSet型の規約オブジェクトにより提供されます。

The Groovy plugin also modifies some source set properties:

また、Groovyプラグインは、いくつかのソースセットプロパティを修正します:

表24.5 Groovyプラグイン - ソースセットプロパティGroovy plugin - source set properties

プロパティ名Property name 変更点Change
allJava Groovyソースディレクトリにあるすべての.javaファイルを追加Adds all .java files found in the Groovy source directories.
allSource Groovyソースディレクトリにあるすべてのソースファイルを追加Adds all source files found in the Groovy source directories.

24.8. GroovyCompile

The Groovy plugin adds a GroovyCompile task for each source set in the project. The task type extends the JavaCompile task (see 「CompileJavaCompileJava). The GroovyCompile task supports most configuration options of the official Groovy compiler.

Groovyプラグインは、プロジェクトの各ソースセットにGroovyCompileタスクを追加します。このタスクはJavaCompileタスクを拡張したものです(「CompileJavaCompileJava参照)。groovyOptions.useAntがtrueになっていなければ、GradleネイティブのGroovyコンパイラ統合が使用されます。Antベースのコンパイラを使うこともできますが、ほとんどのプロジェクトではネイティブのGroovyコンパイラを使ったほうがいいでしょう。 このGroovyCompileタスクは、公式Groovyコンパイラのオプションをほとんど全てサポートしています。

表24.6 Groovyプラグイン - GroovyCompileプロパティGroovy plugin - GroovyCompile properties

タスクプロパティTask Property Type デフォルト値Default Value
classpath FileCollection sourceSet.compileClasspath
source FileTree「入力ファイルセットを指定する Specifying a set of input filesで説明されたものなら何でも設定可能FileTree. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. sourceSet.groovy
destinationDir File. sourceSet.output.classesDir
groovyClasspath FileCollection groovy configuration if non-empty; Groovy library found on classpath otherwise


[18] We are using the same conventions as introduced by Russel Winder's Gant tool (http://gant.codehaus.org).

[19] Russel WinderのGant (http://gant.codehaus.org)が導入したのと同じ規約を使っています。

第25章 Scalaプラグイン The Scala Plugin

The Scala plugin extends the Java plugin to add support for Scala projects. It can deal with Scala code, mixed Scala and Java code, and even pure Java code (although we don't necessarily recommend to use it for the latter). The plugin supports joint compilation, which allows you to freely mix and match Scala and Java code, with dependencies in both directions. For example, a Scala class can extend a Java class that in turn extends a Scala class. This makes it possible to use the best language for the job, and to rewrite any class in the other language if needed.

Scalaプラグインは、Javaプラグインを拡張し、Scalaプロジェクトのサポートを追加したものです。 ScalaコードとScala/Javaの混合コードをサポートするほか、Javaコードのみのプロジェクトを取り扱うこともできます(Javaコードだけのプロジェクトにこのプラグインを使うことはあまり推奨しませんが)。 また、JavaとScalaのジョイントコンパイルをサポートしており、ScalaコードとJavaコードを自由に混ぜ合わせたり、お互いに統合させることができます。 例えば、ScalaのクラスはJavaのクラスを継承できますし、更にそのJavaクラスがScalaクラスを継承していても問題ありません。時々に応じて最適な言語を選択でき、必要なときにはいつでもクラスを別言語で書き直すことができます。

25.1. 使用方法 Usage

To use the Scala plugin, include the following in your build script:

Scalaプラグインを使うには、ビルドスクリプトに以下の行を追加します。

例25.1 Scalaプラグインを使う

build.gradle

apply plugin: 'scala'

25.2. タスク Tasks

The Scala plugin adds the following tasks to the project.

Scalaプラグインは、プロジェクトに以下のタスクを追加します。

表25.1 Scalaプラグイン - タスク Scala plugin - tasks

Task name タスク Depends on 依存先 Type Description 説明
compileScala compileJava ScalaCompile Compiles production Scala source files. Scalaの製品ソースファイルをコンパイルする。
compileTestScala compileTestJava ScalaCompile Compiles test Scala source files. Scalaのテストソースファイルをコンパイルする。
compileSourceSetScala compileSourceSetJava ScalaCompile Compiles the given source set's Scala source files. 指定したソースセットのScalaソースファイルをコンパイルする。
scaladoc - ScalaDoc Generates API documentation for the production Scala source files. Scala製品ソースファイルのAPIドキュメントを生成する。

The Scala plugin adds the following dependencies to tasks added by the Java plugin.

Scalaプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表25.2 Scalaプラグイン - タスクの追加依存関係 Scala plugin - additional task dependencies

Task name タスク名Depends on 依存先
classes compileScala
testClasses compileTestScala
sourceSetClasses compileSourceSetScala

図25.1 Scalaプラグイン - タスクScala plugin - tasks

Scalaプラグイン - タスクScala plugin - tasks

25.3. プロジェクトレイアウト Project layout

The Scala plugin assumes the project layout shown below. All the Scala source directories can contain Scala and Java code. The Java source directories may only contain Java source code. None of these directories need to exist or have anything in them; the Scala plugin will simply compile whatever it finds.

Scalaプラグインは次のようなプロジェクトレイアウトを想定しています。 すべてのScalaソースディレクトリにはScalaだけでなくJavaコードも含めることができますが、JavaソースディレクトリにはJavaコードしか含めることができません。 また、これらのどのディレクトリも、存在しなかったり、何も含んでいなくてもかまいません。Scalaプラグインは、単純に見つけたディレクトリをコンパイルするだけです。

表25.3 Scalaプラグイン Scala plugin - project layout

Directory ディレクトリ Meaning 意味
src/main/java 製品のJavaソースProduction Java source
src/main/resources 製品のリソースProduction resources
src/main/scala Production Scala sources. May also contain Java sources for joint compilation. 製品のScalaソース。ジョイントコンパイルするJavaソースを含んでもよい
src/test/java テストのJavaソースTest Java source
src/test/resources テストのリソースTest resources
src/test/scala Test Scala sources. May also contain Java sources for joint compilation. テストのScalaソース。ジョイントコンパイルするJavaソースを含んでもよい
src/sourceSet/java 特定のソースセットのJavaソースJava source for the given source set
src/sourceSet/resources 特定のソースセットのリソースResources for the given source set
src/sourceSet/scala Scala sources for the given source set. May also contain Java sources for joint compilation. 特定のソースセットのScalaソース。ジョイントコンパイルするJavaソースを含んでもよい

25.3.1. プロジェクトレイアウトの変更 Changing the project layout

Just like the Java plugin, the Scala plugin allows you to configure custom locations for Scala production and test sources.

Javaプラグインと同じように、Scalaプラグインも製品コードやテストコードの場所を変更することができます。

例25.2 Scalaソースレイアウトのカスタマイズ

build.gradle

sourceSets {
    main {
        scala {
            srcDirs = ['src/scala']
        }
    }
    test {
        scala {
            srcDirs = ['test/scala']
        }
    }
}

25.4. 依存関係の管理 Dependency management

Scala projects need to declare a scala-library dependency. This dependency will then be used on compile and runtime class paths. It will also be used to get hold of the Scala compiler and Scaladoc tool, respectively. Scalaプロジェクトでは、scala-libraryへの依存関係を宣言する必要があります。 この依存関係は、Scalaコードをコンパイルしたり実行したりする際のクラスパスに追加されるほか、ScalaコンパイラおよびScaladocツールを取得する際にも使用されます。 [20]

If Scala is used for production code, the scala-library dependency should be added to the compile configuration:

Scalaが製品コードで使われている場合は、scala-libraryへの依存関係はcompileコンフィグレーションに追加してください。

例25.3 製品コードに使うScalaへの依存関係の宣言

build.gradle

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.scala-lang:scala-library:2.11.1'
}

If Scala is only used for test code, the scala-library dependency should be added to the testCompile configuration:

Scalaがテストコードのみで使われている場合は、scala-libraryへの依存関係はtestCompileコンフィグレーションに追加してください。

例25.4 テストコードに使うScalaへの依存関係の宣言

build.gradle

dependencies {
    testCompile "org.scala-lang:scala-library:2.11.1"
}

25.5. scalaClasspathの自動設定 Automatic configuration of scalaClasspath

The ScalaCompile and ScalaDoc tasks consume Scala code in two ways: on their classpath, and on their scalaClasspath. The former is used to locate classes referenced by the source code, and will typically contain scala-library along with other libraries. The latter is used to load and execute the Scala compiler and Scaladoc tool, respectively, and should only contain the scala-compiler library and its dependencies.

ScalaCompileタスクとScalaDocタスクは二つの用途でScalaを使用します。タスクのclasspathscalaClasspathです。前者はソースコードから参照されているクラスを配置するパスで、scala-libraryも典型的には他のライブラリと一緒に格納されます。後者はScalaコンパイラとScaladocツールをロードして実行するために使用されるパスで、scala-compilerライブラリとその依存関係のみが配置されていなければなりません。

Unless a task's scalaClasspath is configured explicitly, the Scala (base) plugin will try to infer it from the task's classpath. This is done as follows: scalaClasspathが明示的に設定されていない場合、Scala(base)プラグインはタスクのclasspathから以下のように設定値を推論しようとします。

  • If a scala-library Jar is found on classpath, and the project has at least one repository declared, a corresponding scala-compiler repository dependency will be added to scalaClasspath.scala-libraryのJarがclasspathに見つかれば、そして少なくとも一つのリポジトリがプロジェクトに設定されていれば、リポジトリから対応するscala-compilerの依存関係を取得してscalaClasspathに追加します。
  • Otherwise, execution of the task will fail with a message saying that scalaClasspath could not be inferred. それ以外の場合は、scalaClasspathの推論に失敗した旨のメッセージを出力してタスクは失敗します。

25.6. 規約プロパティ Convention properties

The Scala plugin does not add any convention properties to the project.

Scalaプラグインは、プロジェクトに規約プロパティを追加しません。

25.7. ソースセットプロパティ Source set properties

The Scala plugin adds the following convention properties to each source set in the project. You can use these properties in your build script as though they were properties of the source set object (see 「規約 Conventions).

Scalaプロジェクトの各ソースセットに以下の規約プロパティを追加します。これらのプロパティは、あたかもソースセットオブジェクトのプロパティであるかのようにビルドスクリプト内で使うことができます(「規約 Conventions参照)

表25.4 Scalaプラグイン - ソースセットプロパティ Scala plugin - source set properties

Property name プロパティ名 Type Default value デフォルト値 Description 説明
scala SourceDirectorySet (read-only読取り専用) Not null 非null The Scala source files of this source set. Contains all .scala and .java files found in the Scala source directories, and excludes all other types of files. このソースセットのScalaソースファイル。Scalaソースディレクトリにある、すべての.scala.javaファイルを含み、その他のタイプのファイルは含まない
scala.srcDirs Set<File>. Can set using anything described in 「入力ファイルセットを指定する Specifying a set of input files. 「入力ファイルセットを指定する Specifying a set of input filesで説明されたものなら何でも設定可能 [projectDir/src/name/scala] The source directories containing the Scala source files of this source set. May also contain Java source files for joint compilation. このソースセットのScalaソースファイルを含むソースディレクトリ。ジョイントコンパイルするJavaソースファイルも含む場合がある
allScala FileTree (read-only読取り専用) Not null 非null All Scala source files of this source set. Contains only the .scala files found in the Scala source directories. このソースセットの全Scalaソースファイル。Scalaソースディレクトリにある.scalaファイルのみを含む

These convention properties are provided by a convention object of type ScalaSourceSet.

これらの規約プロパティはScalaSourceSet型の規約オブジェクトにより提供されます。

The Scala plugin also modifies some source set properties:

また、Scalaプラグインはいくつかのソースセットプロパティを修正します。

表25.5 Scalaプラグイン Scala plugin - source set properties

Property name プロパティ名 Change 変更点
allJava Adds all .java files found in the Scala source directories. Scalaソースディレクトリにあるすべての.javaファイルを追加
allSource Adds all source files found in the Scala source directories. Scalaソースディレクトリにあるすべてのファイルを追加

25.8. Fast Scala Compiler

The Scala plugin includes support for fsc, the Fast Scala Compiler. fsc runs in a separate daemon process and can speed up compilation significantly. Scalaプラグインには、fsc、Fast Scala Compilerのサポートが含まれています。

例25.5 Fast Scala Compilerを有効にする

build.gradle

compileScala {
    scalaCompileOptions.useCompileDaemon = true

    // optionally specify host and port of the daemon:
    scalaCompileOptions.daemonServer = "localhost:4243"
}


Note that fsc expects to be restarted whenever the contents of its compile class path change. (It does detect changes to the compile class path itself.) This makes it less suitable for multi-project builds. ただし、次の点に注意してください。fscは、コンパイル時のクラスパスに含まれるもの(訳注:jarなど)が変更される度に再起動させる必要があります。(コンパイル時クラスパス自体の変更は検知されますが)。 このため、マルチプロジェクトとの相性は悪くなります。

25.9. 別プロセスでコンパイルする Compiling in external process

When scalaCompileOptions.fork is set to true, compilation will take place in an external process. The Ant based compiler (scalaCompileOptions.useAnt = true) will fork a new process for every invocation of the ScalaCompile task, and does not fork by default. The Zinc based compiler (scalaCompileOptions.useAnt = false) will leverage the Gradle compiler daemon, and does so by default.

scalaCompileOptions.forkオプションがtrueにセットされていると、コンパイル処理は外部プロセスで実行されます。 フォーク処理の詳細はどのコンパイラを使用するかにより異なり、Antベースのコンパイラを使用する場合は(scalaCompileOptions.useAnt = true)、ScalaCompileタスクが実行される度に新しいプロセスがフォークされます。また、デフォルトではフォークされません。 Zincベースのコンパイラを使う場合(scalaCompileOptions.useAnt = false)、Gradleのコンパイラデーモンを使用してコンパイルされます。Antベースのコンパイラと異なり、こちらがデフォルトの処理です。

Memory settings for the external process default to defaults of the JVM. To adjust memory settings, configure the scalaCompileOptions.forkOptions property as needed: 外部プロセスのメモリ設定は、デフォルトではJVMのデフォルト値が使用されます。メモリ設定を調整するには、scalaCompileOptions.forkOptionsを必要に応じて設定してください。

例25.6 メモリ設定の調整

build.gradle

tasks.withType(ScalaCompile) {
    configure(scalaCompileOptions.forkOptions) {
        memoryMaximumSize = '1g'
        jvmArgs = ['-XX:MaxPermSize=512m']
    }
}


25.10. インクリメンタルコンパイル Incremental compilation

By compiling only classes whose source code has changed since the previous compilation, and classes affected by these changes, incremental compilation can significantly reduce Scala compilation time. It is particularly effective when frequently compiling small code increments, as is often done at development time.

前回コンパイルしたときからの変更差分、およびそれにより影響を受けるクラスのみを再コンパイルすることで、Scalaのコンパイル時間を大幅に減らすことができます。 これは、コードを小さく変更して頻繁にコンパイルするようなとき、開発中にはしばしばそういうことがありますが、そのような場面では特に有用です。

The Scala plugin now supports incremental compilation by integrating with Zinc, a standalone version of sbt's incremental Scala compiler. To switch the ScalaCompile task from the default Ant based compiler to the new Zinc based compiler, set scalaCompileOptions.useAnt to false: Scalaプラグインは、Zincという、sbtのインクリメンタルScalaコンパイラのスタンドアローン版を統合することでインクリメンタルコンパイルをサポートしています。

例25.7 Zincベースのコンパイラを有効にする

build.gradle

tasks.withType(ScalaCompile) {
    scalaCompileOptions.useAnt = false
}


Except where noted in the API documentation, the Zinc based compiler supports exactly the same configuration options as the Ant based compiler. Note, however, that the Zinc compiler requires Java 6 or higher to run. This means that Gradle itself has to be run with Java 6 or higher.

APIドキュメントに記載されている部分を除き、ZincベースのコンパイラはAntベースのコンパイラと全く同じ設定オプションをサポートします。 ただ、ZincコンパイラはJava6以上のバージョンを必要とするので注意してください。これは、Gradle自身もJava6以上で動かさなくてはならないことを意味します。

The Scala plugin adds a configuration named zinc to resolve the Zinc library and its dependencies. Gradle will have a default version of the Zinc library, but if you want to override the Zinc version that Gradle uses, add an explicit dependency like “com.typesafe.zinc:zinc:0.1.4”. Regardless of which Zinc version is used, Zinc will always use the Scala compiler found on the scalaTools configuration.

Scalaプラグインは、zincという名前のコンフィグレーションを追加し、Zincライブラリとその依存関係を解決するために使用します。 Gradleがデフォルトで使用するZincのバージョンをオーバーライドするには、Zincへの依存関係(例えば、zinc "com.typesafe.zinc:zinc:0.1.4")を明示的に指定してください。 どのバージョンのZincが使用されているかにかかわらず、Zincは常にscalaToolsコンフィグレーションに含まれるScalaコンパイラを使用します。

Just like Gradle's Ant based compiler, the Zinc based compiler supports joint compilation of Java and Scala code. By default, all Java and Scala code under src/main/scala will participate in joint compilation. With the Zinc based compiler, even Java code will be compiled incrementally.

Antベースのコンパイラ同様、ZincベースのコンパイラもJavaとScalaのジョイントコンパイルをサポートします。 デフォルトでは、src/main/scalaにある全てのJavaとScalaのコードがジョイントコンパイルに使用されます。Zincベースのコンパイラは、たとえJavaコードでもインクリメンタルにコンパイルできます。

Incremental compilation requires dependency analysis of the source code. The results of this analysis are stored in the file designated by scalaCompileOptions.incrementalOptions.analysisFile (which has a sensible default). In a multi-project build, analysis files are passed on to downstream ScalaCompile tasks to enable incremental compilation across project boundaries. For ScalaCompile tasks added by the Scala plugin, no configuration is necessary to make this work. For other ScalaCompile tasks that you might add, the property scalaCompileOptions.incrementalOptions.publishedCode needs to be configured to point to the classes folder or Jar archive by which the code is passed on to compile class paths of downstream ScalaCompile tasks. Note that if publishedCode is not set correctly, downstream tasks may not recompile code affected by upstream changes, leading to incorrect compilation results.

インクリメンタルコンパイルを行うには、ソースコードを解析する必要があります。解析結果は、scalaCompileOptions.incrementalOptions.analysisFile(適切なデフォルト値が設定されています)で指定されたファイルに保存されます。 マルチプロジェクトの場合、この解析ファイルは下流のScalaCompileタスクに渡されるので、プロジェクトをまたいでのインクリメンタルコンパイルが可能です。 Scalaプラグインにより追加されたScalaCompileタスクはデフォルトでそのように動作するので、追加の設定は必要ありません。 その他のScalaCompileタスクでこの動作を有効にするには、scalaCompileOptions.incrementalOptions.publishedCodeが適切なクラスフォルダやJarアーカイブを指すように設定し、下流のタスクのコンパイルクラスパスにコードを渡す必要があります。 publishedCodeが正しく設定されていない場合、上流のソースが変更されても下流のタスクの再コンパイルが適切に動かず、コンパイル結果も正しくなりませんので注意してください。

Due to the overhead of dependency analysis, a clean compilation or a compilation after a larger code change may take longer than with the Ant based compiler. For CI builds and release builds, we currently recommend to use the Ant based compiler.

解析処理に伴うオーバーヘッドにより、クリーンコンパイルや大規模な変更を行った後のコンパイルは、Antベースのコンパイラより長い時間を要するかもしれません。インテグレーションサーバーでのビルドやリリースビルドの際は、今のところAntベースのコンパイラを推奨します。

Note that Zinc's Nailgun based daemon mode is not supported. Instead, we plan to enhance Gradle's own compiler daemon to stay alive across Gradle invocations, reusing the same Scala compiler. This is expected to yield another significant speedup for Scala compilation.

ZincのNailgunベースのデーモンモードには対応していません。代わりに、Gradle自身のコンパイラデーモンを拡張し、Gradle実行間で同じScalaコンパイラを再利用できるようにする予定です。デーモンモードにより、Scalaコンパイルが更にスピードアップすることが期待されます。

25.11. Eclipse Integration

When the Eclipse plugin encounters a Scala project, it adds additional configuration to make the project work with Scala IDE out of the box. Specifically, the plugin adds a Scala nature and dependency container.

25.12. IntelliJ IDEA Integration

When the IDEA plugin encounters a Scala project, it adds additional configuration to make the project work with IDEA out of the box. Specifically, the plugin adds a Scala facet and a Scala compiler library that matches the Scala version on the project's class path.

第26章 War プラグインThe War Plugin

The War plugin extends the Java plugin to add support for assembling web application WAR files. It disables the default JAR archive generation of the Java plugin and adds a default WAR archive task.

War プラグインは WEB アプリケーションの WAR ファイルを生成できるように Java プラグインを拡張したものです。 Java プラグインの 標準の JAR ファイルは生成されなくなり、WAR アーカイブ タスクが追加されます。

26.1. 使用方法Usage

To use the War plugin, include the following in your build script:

War プラグインを使うためには、ビルドスクリプトに下記を含めます:

例26.1 Using the War plugin

build.gradle

apply plugin: 'war'

26.2. タスクTasks

The War plugin adds the following tasks to the project.

War プラグインは 次のタスクをプロジェクトに追加します。

表26.1 War プラグイン - タスクWar plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
war compile War WAR ファイルを生成します。Assembles the application WAR file.

The War plugin adds the following dependencies to tasks added by the Java plugin.

War プラグインは Java プラグインで追加されたタスクに対し、次の依存関係を追加します。

表26.2 War プラグイン - 追加されたタスクの依存関係War plugin - additional task dependencies

タスク名Task name依存先Depends on
assemble war

図26.1 War プラグイン - タスクWar plugin - tasks

War プラグイン - タスクWar plugin - tasks

26.3. プロジェクトレイアウトProject layout

表26.3 War プラグイン - プロジェクトレイアウトWar plugin - project layout

ディレクトリDirectory 意味Meaning
src/main/webapp WEB アプリケーションソースWeb application sources

26.4. 依存関係の管理Dependency management

The War plugin adds two dependency configurations named providedCompile and providedRuntime. Those two configurations have the same scope as the respective compile and runtime configurations, except that they are not added to the WAR archive. It is important to note that those provided configurations work transitively. Let's say you add commons-httpclient:commons-httpclient:3.0 to any of the provided configurations. This dependency has a dependency on commons-codec. Because this is a “provided” configuration, this means that neither of these dependencies will be added to your WAR, even if the commons-codec library is an explicit dependency of your compile configuration. If you don't want this transitive behavior, simply declare your provided dependencies like commons-httpclient:commons-httpclient:3.0@jar.

War プラグインは providedCompileprovidedRuntime の2つの依存構成を追加します。 これらの構成は WAR アーカイブには追加されないという点を除けば、それぞれ compileruntime と同じスコープを持ちます。 provided 構成が推移的に機能することは特筆すべき点です。 そうですね。例えば provided 構成の何れかに commons-httpclient:commons-httpclient:3.0 を追加したとします。 この依存ライブラリは commons-codec に依存します。 これは、たとえ、commons-codeccompile 構成に依存していることが明らかであったとしても WAR ファイルには httpclientcommons-codec も追加されないことを意味します。 もし、この推移的な挙動を望まないのであれば、単純に commons-httpclient:commons-httpclient:3.0@jar を dependencies の provided 構成に定義してください。

26.5. 規約プロパティConvention properties

表26.4 War プラグイン - ディレクトリプロパティWar plugin - directory properties

プロパティ名Property name Type デフォルト値Default value 説明Description
webAppDirName String src/main/webapp WEB アプリケーションソースディレクトリの名前、プロジェクトディレクトリからの相対パス The name of the web application source directory, relative to the project directory.
webAppDir File (読取専用)(read-only) projectDir/webAppDirName WEB アプリケーションソースディレクトリ The web application source directory.

>These properties are provided by a WarPluginConvention convention object.

これらのプロパティは WarPluginConvention オブジェクトによって提供されています。

26.6. War

>The default behavior of the War task is to copy the content of src/main/webapp to the root of the archive. Your webapp directory may of course contain a WEB-INF sub-directory, which may contain a web.xml file. Your compiled classes are compiled to WEB-INF/classes. All the dependencies of the runtime [21] configuration are copied to WEB-INF/lib.

The War class in the API documentation has additional useful information.

26.7. カスタマイズCustomizing

Here is an example with the most important customization options:

以下は最も重要なカスタマイズ例です。

例26.2 Customization of war plugin

build.gradle

configurations {
   moreLibs
}

repositories {
   flatDir { dirs "lib" }
   mavenCentral()
}

dependencies {
    compile module(":compile:1.0") {
        dependency ":compile-transitive-1.0@jar"
        dependency ":providedCompile-transitive:1.0@jar"
    }
    providedCompile "javax.servlet:servlet-api:2.5"
    providedCompile module(":providedCompile:1.0") {
        dependency ":providedCompile-transitive:1.0@jar"
    }
    runtime ":runtime:1.0"
    providedRuntime ":providedRuntime:1.0@jar"
    testCompile "junit:junit:4.11"
    moreLibs ":otherLib:1.0"
}

war {
    from 'src/rootContent' // adds a file-set to the root of the archive
    webInf { from 'src/additionalWebInf' } // adds a file-set to the WEB-INF dir.
    classpath fileTree('additionalLibs') // adds a file-set to the WEB-INF/lib dir.
    classpath configurations.moreLibs // adds a configuration to the WEB-INF/lib dir.
    webXml = file('src/someWeb.xml') // copies a file to WEB-INF/web.xml
}

Of course one can configure the different file-sets with a closure to define excludes and includes.

もちろん、excludes と includes を定義したクロージャを使って異なるファイルセットを設定することもできます。



[21] The runtime configuration extends the compile configuration.

第27章 EarプラグインThe Ear Plugin

The Ear plugin adds support for assembling web application EAR files. It adds a default EAR archive task. It doesn't require the Java plugin, but for projects that also use the Java plugin it disables the default JAR archive generation.

EarプラグインはWebアプリケーションのEARファイルアセンブリサポートを追加します。 Javaプラグインは必須ではありませんが、Javaプラグインを利用するプロジェクトに対してはデフォルトのJARアーカイブ生成を無効にします。

27.1. 使用方法Usage

To use the Ear plugin, include the following in your build script:

Earプラグインを使うには、ビルドスクリプトに以下を含めてください:

例27.1 Earプラグインの利用

build.gradle

apply plugin: 'ear'

27.2. タスクTasks

The Ear plugin adds the following tasks to the project.

Earプラグインはプロジェクトに以下のタスクを追加します。

表27.1 Earプラグイン - タスクEar plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
ear compile(Javaプラグインが同時に適用されている場合のみ)(only if the Java plugin is also applied) Ear アプリケーションのEARファイルをアセンブルAssembles the application EAR file.

The Ear plugin adds the following dependencies to tasks added by the base plugin.

Earプラグインはベースプラグインが追加したタスクに以下の依存関係を追加します。

表27.2 Earプラグイン - タスク依存関係の追加Ear plugin - additional task dependencies

タスク名Task name依存先Depends on
assemble ear

27.3. プロジェクトレイアウトProject layout

表27.3 Earプラグイン - プロジェクトレイアウトEar plugin - project layout

ディレクトリDirectory 意味Meaning
src/main/application META-INFディレクトリなどのEarリソースEar resources, such as a META-INF directory

27.4. 依存関係の管理Dependency management

The Ear plugin adds two dependency configurations: deploy and earlib. All dependencies in the deploy configuration are placed in the root of the EAR archive, and are not transitive. All dependencies in the earlib configuration are placed in the 'lib' directory in the EAR archive and are transitive.

Earプラグインは2つの依存関係コンフィグレーションを追加します: deployおよびearlib deployコンフィグレーションにおけるすべての依存関係はEARアーカイブのルートに配置され、それらは推移的ではありませんearlibコンフィグレーションにおけるすべての依存関係はEARアーカイブの'lib'ディレクトリに配置され、推移的です

27.5. 規約プロパティConvention properties

表27.4 Earプラグイン - ディレクトリプロパティEar plugin - directory properties

プロパティ名Property name Type デフォルト値Default value 説明Description
appDirName String src/main/application アプリケーションのソースディレクトリ名(プロジェクトディレクトリに対する相対パス)The name of the application source directory, relative to the project directory.
libDirName String lib 生成されたEARに含まれるlibディレクトリ名The name of the lib directory inside the generated EAR.
deploymentDescriptor org.gradle.plugins.ear.descriptor.DeploymentDescriptor デプロイメントディスクリプター、デフォルトは通常application.xml A deployment descriptor with sensible defaults named application.xml application.xmlなど、デプトイメントディスクリプタファイルを生成するためのメタデータ。 このファイルが既にappDirName/META-INFに存在している場合は既存のファイルの内容が利用され、ear.deploymentDescriptorでの設定内容は無視される。 Metadata to generate a deployment descriptor file, e.g. application.xml. If this file already exists in the appDirName/META-INF then the existing file contents will be used and the explicit configuration in the ear.deploymentDescriptor will be ignored.

These properties are provided by a EarPluginConvention convention object.

これらのプロパティは規約オブジェクトEarPluginConventionが提供します。

27.6. Ear

The default behavior of the Ear task is to copy the content of src/main/application to the root of the archive. If your application directory doesn't contain a META-INF/application.xml deployment descriptor then one will be generated for you.

Earタスクのデフォルトのふるまいは、src/main/applicationの内容をアーカイブのルートにコピーすることです。 applicationディレクトリがデプロイメントディスクリプタMETA-INF/application.xmlを含まない場合は、生成してくれます。

The Ear class in the API documentation has additional useful information.

Earも参照してみてください。

27.7. カスタマイズCustomizing

Here is an example with the most important customization options:

最も重要なカスタマイズオプションを使う例はこちらです:

例27.2 Earプラグインのカスタマイズ

build.gradle

apply plugin: 'ear'
apply plugin: 'java'

repositories { mavenCentral() }

dependencies {
    // The following dependencies will be the ear modules and
    // will be placed in the ear root
    deploy project(':war')

    // The following dependencies will become ear libs and will
    // be placed in a dir configured via the libDirName property
    earlib group: 'log4j', name: 'log4j', version: '1.2.15', ext: 'jar'
}

ear {
    appDirName 'src/main/app'  // use application metadata found in this folder
    // put dependent libraries into APP-INF/lib inside the generated EAR
    libDirName 'APP-INF/lib'
    deploymentDescriptor {  // custom entries for application.xml:
//      fileName = "application.xml"  // same as the default value
//      version = "6"  // same as the default value
        applicationName = "customear"
        initializeInOrder = true
        displayName = "Custom Ear"  // defaults to project.name
        // defaults to project.description if not set
        description = "My customized EAR for the Gradle documentation"
//      libraryDirectory = "APP-INF/lib"  // not needed, above libDirName setting does this
//      module("my.jar", "java")  // won't deploy as my.jar isn't deploy dependency
//      webModule("my.war", "/")  // won't deploy as my.war isn't deploy dependency
        securityRole "admin"
        securityRole "superadmin"
        withXml { provider -> // add a custom node to the XML
            provider.asNode().appendNode("data-source", "my/data/source")
        }
    }
}

You can also use customization options that the Ear task provides, such as from and metaInf.

frommetaInfといった、Earタスクが提供するカスタマイズオプションも利用できます。

27.8. カスタムのディスクリプタファイルを使うUsing custom descriptor file

You may already have appropriate settings in a application.xml file and want to use that instead of configuring the ear.deploymentDescriptor section of the build script. To accommodate that goal, place the META-INF/application.xml in the right place inside your source folders (see the appDirName property). The file contents will be used and the explicit configuration in the ear.deploymentDescriptor will be ignored.

ear.deploymentDescriptorセクションで設定するかわりに、既にapplication.xmlがあって、それを使いたいとしましょう。 そのためにはMETA-INF/application.xmlをソースフォルダ内の適切な場所に配置します(appDirNameプロパティを参照)。 既存のファイルの内容が利用され、ear.deploymentDescriptorの設定内容は無視されます。

第28章 Jetty プラグインThe Jetty Plugin

The Jetty plugin extends the War plugin to add tasks which allow you to deploy your web application to a Jetty web container embedded in the build.

JettyプラグインはWarプラグインを拡張し、あなたのWEBアプリケーションをJettyコンテナにビルドしてデプロイできるタスクを追加したものです

28.1. 使用方法Usage

To use the Jetty plugin, include the following in your build script:

Jettyプラグインを使うためには、ビルドスクリプトに下記を含めます:

例28.1 Using the Jetty plugin

build.gradle

apply plugin: 'jetty'

28.2. タスクTasks

The Jetty plugin defines the following tasks:

Jettyプラグインは、以下のタスクを定義します。

表28.1 Jettyプラグイン - タスクJetty plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
jettyRun compile JettyRun Jettyのインスタンスを開始し、webアプリケーションをデプロイしますStarts a Jetty instance and deploys the exploded web application to it.
jettyRunWar war JettyRunWar Jettyのインスタンスを開始し、WARファイルをデプロイしますStarts a Jetty instance and deploys the WAR to it.
jettyStop - JettyStop Jettyのインスタンスを停止しますStops the Jetty instance.

図28.1 Jettyプラグイン - タスクJetty plugin - tasks

Jettyプラグイン - タスクJetty plugin - tasks

28.3. プロジェクトレイアウトProject layout

The Jetty plugin uses the same layout as the War plugin.

Jettyプラグインは、Warプラグインと同じレイアウトを使用します。

28.4. 依存関係の管理Dependency management

The Jetty plugin does not define any dependency configurations.

Jettyプラグインは、依存関係を定義しません。

28.5. 規約プロパティConvention properties

The Jetty plugin defines the following convention properties:

Jettyプラグインは、規約プロパティに従って定義されます。

表28.2 Jettyプラグイン - プロパティJetty plugin - properties

プロパティ名Property name Type デフォルト値Default value 説明Description
contextPath String WAR file base name The application deployment location within the Jetty container.
httpPort Integer 8080 JettyのHTTPリクエストの待受けTCPポートThe TCP port which Jetty should listen for HTTP requests on.
stopPort Integer null Jettyの管理者リクエストの待受けTCPポートThe TCP port which Jetty should listen for admin requests on.
stopKey String null 停止要求時にJettyに渡す文字列キーThe key to pass to Jetty when requesting it to stop.

These properties are provided by a JettyPluginConvention convention object.

上記プロパティはJettyPluginConvention型の規約オブジェクトにより提供されます。

第29章 CheckstyleプラグインThe Checkstyle Plugin

The Checkstyle plugin performs quality checks on your project's Java source files using Checkstyle and generates reports from these checks.

Checkstyleプラグインは Checkstyleを使用して、あなたのプロジェクトのJavaソースファイルの品質チェックを行ないます。 そして、これらのチェック結果から結果レポートを生成します。

29.1. 使用方法Usage

To use the Checkstyle plugin, include the following in your build script:

Checkstyleプラグインを使うためには、ビルドスクリプトに下記を含めます:

例29.1 Checkstyleプラグインの使用

build.gradle

apply plugin: 'checkstyle'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。 貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

29.2. タスクTasks

The Checkstyle plugin adds the following tasks to the project:

Checkstyleプラグインは、以下のタスクをプロジェクトに追加します:

表29.1 Checkstyleプラグイン - タスクCheckstyle plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
checkstyleMain classes Checkstyle 製品のJavaソースを対象にCheckstyleを実行します。Runs Checkstyle against the production Java source files.
checkstyleTest testClasses Checkstyle テストのJavaソースを対象にCheckstyleを実行します。Runs Checkstyle against the test Java source files.
checkstyleSourceSet sourceSetClasses Checkstyle 特定のソースセットで指定されたJavaソースを対象にCheckstyleを実行します。Runs Checkstyle against the given source set's Java source files.

The Checkstyle plugin adds the following dependencies to tasks defined by the Java plugin.

Checkstyleプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表29.2 Checkstyleプラグイン - タスクの追加依存関係Checkstyle plugin - additional task dependencies

タスク名Task name依存先Depends on
check 全てのCheckstyleタスクは、checkstyleMaincheckstyleTestを含みます。All Checkstyle tasks, including checkstyleMain and checkstyleTest.

29.3. プロジェクトレイアウトProject layout

The Checkstyle plugin expects the following project layout:

Checkstyleプラグインは、以下のようなプロジェクトレイアウトを想定しています:

表29.3 Checkstyle プラグイン - プロジェクトレイアウトCheckstyle plugin - project layout

ファイル

File

意味

Meaning

config/checkstyle/checkstyle.xml Checkstyle の設定ファイル

Checkstyle configuration file

29.4. 依存関係の管理Dependency management

The Checkstyle plugin adds the following dependency configurations:

Checkstyleプラグインは、以下の依存関係設定を追加します。

表29.4 Checkstyleプラグイン - 依存関係設定

Checkstyle plugin - dependency configurations

名前

Name

意味

Meaning

checkstyle Checkstyleのライブラリを使用します。

The Checkstyle libraries to use

29.5. 設定

Configuration

See the CheckstyleExtension class in the API documentation.

CheckstyleExtensionを参照。

第30章 CodeNarcプラグインThe CodeNarc Plugin

The CodeNarc plugin performs quality checks on your project's Groovy source files using CodeNarc and generates reports from these checks.

CodeNarcプラグインは CodeNarcを使用して、あなたのプロジェクトのGroovyソースファイルの品質チェックを行ないます。 そして、これらのチェック結果から結果レポートを生成します。

30.1. 使用方法Usage

To use the CodeNarc plugin, include the following in your build script:

CodeNarcプラグインを使うためには、ビルドスクリプトに下記を含めます:

例30.1 CodeNarcプラグインの使用

build.gradle

apply plugin: 'codenarc'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。 貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

30.2. タスクTasks

The CodeNarc plugin adds the following tasks to the project:

CodeNarcプラグインを使うためには、ビルドスクリプトに下記を含めます:

表30.1 CodeNarcプラグイン - タスクCodeNarc plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
codenarcMain - CodeNarc 製品のGroovyソースを対象にCodeNarcを実行します。Runs CodeNarc against the production Groovy source files.
codenarcTest - CodeNarc Runs CodeNarc against the test Groovy source files. テストのGroovyソースを対象にCodeNarcを実行します。Runs Checkstyle against the test Groovy source files.
codenarcSourceSet - CodeNarc 特定のソースセットで指定されたGroovyソースを対象にCodeNarcを実行します。Runs CodeNarc against the given source set's Groovy source files.

The CodeNarc plugin adds the following dependencies to tasks defined by the Groovy plugin.

CodeNarcプラグインは、Groovyプラグインによって追加されたタスクに以下の依存関係を追加します。

表30.2 CodeNarcプラグイン - タスクの追加依存関係CodeNarc plugin - additional task dependencies

タスク名Task name依存先Depends on
check 全てのCodeNarcタスクは、codenarcMaincodenarcTestを含みます。All CodeNarc tasks, including codenarcMain and codenarcTest.

30.3. プロジェクトレイアウトProject layout

The CodeNarc plugin expects the following project layout:

CodeNarcプラグインは、以下のようなプロジェクトレイアウトを想定しています:

表30.3 CodeNarc プラグイン - プロジェクトレイアウトCodeNarc plugin - project layout

ファイル

File

意味

Meaning

config/codenarc/codenarc.xml CodeNarc の設定ファイル

CodeNarc configuration file

30.4. 依存関係の管理Dependency management

The CodeNarc plugin adds the following dependency configurations:

CodeNarcプラグインは、以下の依存関係設定を追加します。

表30.4 CodeNarcプラグイン - 依存関係設定

CodeNarc plugin - dependency configurations

名前

Name

意味

Meaning

codenarc CodeNarcのライブラリを使用します。

The CodeNarc libraries to use

30.5. 設定

Configuration

See the CodeNarcExtension class in the API documentation.

CodeNarcExtensionを参照。

第31章 FindBugsプラグインThe FindBugs Plugin

The FindBugs plugin performs quality checks on your project's Java source files using FindBugs and generates reports from these checks.

FindBugsプラグインは FindBugsを使用して、あなたのプロジェクトのJavaソースファイルの品質チェックを行ないます。 そして、これらのチェック結果から結果レポートを生成します。

31.1. 使用方法Usage

To use the FindBugs plugin, include in the following your build script:

FindBugsプラグインを使うためには、ビルドスクリプトに下記を含めます:

例31.1 FindBugsプラグインの使用

build.gradle

apply plugin: 'findbugs'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。 貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

31.2. タスクTasks

The FindBugs plugin adds the following tasks to the project:

FindBugsプラグインは、以下のタスクをプロジェクトに追加します:

表31.1 FindBugsプラグイン - タスクFindBugs plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
findbugsMain classes FindBugs 製品のJavaソースを対象にFindBugsを実行します。Runs FindBugs against the production Java source files.
findbugsTest testClasses FindBugs テストのJavaソースを対象にFindBugsを実行します。Runs FindBugs against the test Java source files.
findbugsSourceSet sourceSetClasses FindBugs 特定のソースセットで指定されたJavaソースを対象にFindBugsを実行します。Runs FindBugs against the given source set's Java source files.

The FindBugs plugin adds the following dependencies to tasks defined by the Java plugin.

FindBugsプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表31.2 FindBugsプラグイン - タスクの追加依存関係FindBugs plugin - additional task dependencies

タスク名Task name依存先Depends on
check 全てのFindBugsタスクは、findbugsMainfindbugsTestを含みます。All FindBugs tasks, including findbugsMain and findbugsTest.

31.3. 依存関係の管理Dependency management

The FindBugs plugin adds the following dependency configurations:

FindBugsプラグインは、以下の依存関係設定を追加します。

表31.3 FindBugsプラグイン - 依存関係設定

FindBugs plugin - dependency configurations

名前

Name

意味

Meaning

findbugs FindBugsのライブラリを使用します。

The FindBugs libraries to use

31.4. 設定

Configuration

See the FindBugsExtension class in the API documentation.

FindBugsExtensionを参照。

第32章 JDependプラグインThe JDepend Plugin

The JDepend plugin performs quality checks on your project's source files using JDepend and generates reports from these checks.

JDependプラグインは JDependを使用して、あなたのプロジェクトのJavaソースファイルの品質チェックを行ないます。 そして、これらのチェック結果から結果レポートを生成します。

32.1. 使用方法Usage

To use the JDepend plugin, include the following in your build script:

JDependプラグインを使うためには、ビルドスクリプトに下記を含めます:

例32.1 JDependプラグインの使用

build.gradle

apply plugin: 'jdepend'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。 貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

32.2. タスクTasks

The JDepend plugin adds the following tasks to the project:

JDependプラグインは、以下のタスクをプロジェクトに追加します:

表32.1 JDependプラグイン - タスクJDepend plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
jdependMain classes JDepend 製品のJavaソースを対象にJDependを実行します。Runs JDepend against the production Java source files.
jdependTest testClasses JDepend テストのJavaソースを対象にJDependを実行します。Runs JDepend against the test Java source files.
jdependSourceSet sourceSetClasses JDepend 特定のソースセットで指定されたJavaソースを対象にJDependを実行します。Runs JDepend against the given source set's Java source files.

The JDepend plugin adds the following dependencies to tasks defined by the Java plugin.

JDependプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表32.2 JDependプラグイン - タスクの追加依存関係JDepend plugin - additional task dependencies

タスク名Task name依存先Depends on
check 全てのJDependタスクは、jdependMainjdependTestを含みます。All JDepend tasks, including jdependMain and jdependTest.

32.3. 依存関係の管理Dependency management

The JDepend plugin adds the following dependency configurations:

JDependプラグインは、以下の依存関係設定を追加します。

表32.3 JDependプラグイン - 依存関係設定

JDepend plugin - dependency configurations

名前

Name

意味

Meaning

jdepend JDependのライブラリを使用します。

The JDepend libraries to use

32.4. 設定

Configuration

See the JDependExtension class in the API documentation.

JDependExtensionを参照。

第33章 PMDプラグインThe PMD Plugin

The PMD plugin performs quality checks on your project's Java source files using PMD and generates reports from these checks.

PMDプラグインは PMDを使用して、あなたのプロジェクトのJavaソースファイルの品質チェックを行ないます。 そして、これらのチェック結果から結果レポートを生成します。

33.1. 使用方法Usage

To use the PMD plugin, include the following in your build script:

PMDプラグインを使うためには、ビルドスクリプトに下記を含めます:

例33.1 PMDプラグインの使用

build.gradle

apply plugin: 'pmd'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。 貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

33.2. タスクTasks

The PMD plugin adds the following tasks to the project:

PMDプラグインは、以下のタスクをプロジェクトに追加します:

表33.1 PMDプラグイン - タスクPMD plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
pmdMain - Pmd 製品のJavaソースを対象にPMDを実行します。Runs PMD against the production Java source files.
pmdTest - Pmd テストのJavaソースを対象にPMDを実行します。Runs PMD against the test Java source files.
pmdSourceSet - Pmd 特定のソースセットで指定されたJavaソースを対象にPMDを実行します。Runs PMD against the given source set's Java source files.

The PMD plugin adds the following dependencies to tasks defined by the Java plugin.

PMDプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表33.2 PMDプラグイン - タスクの追加依存関係PMD plugin - additional task dependencies

タスク名Task name依存先Depends on
check 全てのPMDタスクは、pmdMainpmdTestを含みます。All PMD tasks, including pmdMain and pmdTest.

33.3. 依存関係の管理Dependency management

The PMD plugin adds the following dependency configurations:

PMDプラグインは、以下の依存関係設定を追加します。

表33.3 PMDプラグイン - 依存関係設定

PMD plugin - dependency configurations

名前

Name

意味

Meaning

pmd PMDのライブラリを使用します。

The PMD libraries to use

33.4. 設定

Configuration

See the PmdExtension class in the API documentation.

PmdExtensionを参照。

Chapter 34. The JaCoCo Plugin

The JaCoCo plugin is currently incubating. Please be aware that the DSL and other configuration may change in later Gradle versions.

The JaCoCo plugin provides code coverage metrics for Java code via integration with JaCoCo.

34.1. Getting Started

To get started, apply the JaCoCo plugin to the project you want to calculate code coverage for.

Example 34.1. Applying the JaCoCo plugin

build.gradle

apply plugin: "jacoco"

If the Java plugin is also applied to your project, a new task named jacocoTestReport is created that depends on the test task. The report is available at $buildDir/reports/jacoco/test. By default, a HTML report is generated.

34.2. Configuring the JaCoCo Plugin

The JaCoCo plugin adds a project extension named jacoco of type JacocoPluginExtension, which allows configuring defaults for JaCoCo usage in your build.

Example 34.2. Configuring JaCoCo plugin settings

build.gradle

jacoco {
    toolVersion = "0.7.1.201405082137"
    reportsDir = file("$buildDir/customJacocoReportDir")
}

Table 34.1. Gradle defaults for JaCoCo properties

Property Gradle default
reportsDir $buildDir/reports/jacoco”

34.3. JaCoCo Report configuration

The JacocoReport task can be used to generate code coverage reports in different formats. It implements the standard Gradle type Reporting and exposes a report container of type JacocoReportsContainer.

Example 34.3. Configuring test task

build.gradle

jacocoTestReport {
    reports {
        xml.enabled false
        csv.enabled false
        html.destination "${buildDir}/jacocoHtml"
    }
}

34.4. JaCoCo specific task configuration

The JaCoCo plugin adds a JacocoTaskExtension extension to all tasks of type Test. This extension allows the configuration of the JaCoCo specific properties of the test task.

Example 34.4. Configuring test task

build.gradle

test {
    jacoco {
        append = false
        destinationFile = file("$buildDir/jacoco/jacocoTest.exec")
        classDumpFile = file("$buildDir/jacoco/classpathdumps")
    }
}

Table 34.2. Default values of the JaCoCo Task extension

Property Gradle default
enabled true
destPath $buildDir/jacoco
append true
includes []
excludes []
excludeClassLoaders []
sessionId auto-generated
dumpOnExit true
output Output.FILE
address -
port -
classDumpPath -
jmx false

While all tasks of type Test are automatically enhanced to provide coverage information when the java plugin has been applied, any task that implements JavaForkOptions can be enhanced by the JaCoCo plugin. That is, any task that forks Java processes can be used to generate coverage information.

For example you can configure your build to generate code coverage using the application plugin.

Example 34.5. Using application plugin to generate code coverage data

build.gradle

apply plugin: "application"
apply plugin: "jacoco"

mainClassName = "org.gradle.MyMain"

jacoco {
    applyTo run
}

task applicationCodeCoverageReport(type:JacocoReport){
    executionData run
    sourceSets sourceSets.main
}

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/testing/jacoco/application


Example 34.6. Coverage reports generated by applicationCodeCoverageReport

Build layout

application/
  build/
    jacoco/
      run.exec
    reports/jacoco/applicationCodeCoverageReport/html/
      index.html

34.5. Tasks

For projects that also apply the Java Plugin, The JaCoCo plugin automatically adds the following tasks:

Table 34.3. JaCoCo plugin - tasks

Task name Depends on Type Description
jacocoTestReport - JacocoReport Generates code coverage report for the test task.

34.6. Dependency management

The JaCoCo plugin adds the following dependency configurations:

Table 34.4. JaCoCo plugin - dependency configurations

Name Meaning
jacocoAnt The JaCoCo Ant library used for running the JacocoReport and JacocoMerge tasks.
jacocoAgent The JaCoCo agent library used for instrumenting the code under test.

第35章 SonarプラグインThe Sonar Plugin

You may wish to use the new Sonar Runner Plugin instead of this plugin. In particular, only the Sonar Runner plugin supports Sonar 3.4 and higher.

このプラグインの代わりに、新しくできたSonnar Runnerを使いたくなる場面もあるかもしれません。 特に、Sonar3.4以上をサポートしているのはSonar Runnerプラグインだけです。

The Sonar plugin provides integration with Sonar, a web-based platform for monitoring code quality. The plugin adds a sonarAnalyze task that analyzes the project to which the plugin is applied, as well as its subprojects. The results are stored in the Sonar database. The plugin is based on the Sonar Runner and requires Sonar 2.11 or higher.

Sonarプラグインは、コード品質モニタリングのためのWebベースのプラットフォームであるSonarとの統合機能を提供します。 プラグインにより追加されるsonarAnalyzeタスクは、プラグインが適用されたプロジェクト、およびそのサブプロジェクトを解析することができます。結果はSonarデータベースに格納されます。 このプラグインはベースにSonar Runnerが使われていて、Sonar 2.11以上を必要とします。

The sonarAnalyze task is a standalone task that needs to be executed explicitly and doesn't depend on any other tasks. Apart from source code, the task also analyzes class files and test result files (if available). For best results, it is therefore recommended to run a full build before the analysis. In a typical setup, analysis would be performed once per day on a build server.

sonarAnalyzeタスクは明示的に実行する必要のあるスタンドアロンタスクで、 他のいかなるタスクにも依存しません。 ソースコードだけでなく、タスクはクラスファイルと(可能であれば)テスト結果ファイルも解析します。 そのため、最大限の結果を得るために、解析の前にフルビルドを実行することが推奨されます。 典型的なセットアップでは、解析はビルドサーバー上で1日1回実行されるようにします。

35.1. 使用方法 Usage

At a minimum, the Sonar plugin has to be applied to the project.

必要最小限、Sonarプラグインがプロジェクトに適用されている必要があります。

例35.1 Sonarプラグインの適用

build.gradle

apply plugin: "sonar"

Unless Sonar is run locally and with default settings, it is necessary to configure connection settings for the Sonar server and database.

Sonarがデフォルト設定でローカル実行されるのでなければ、Sonarサーバーとデータベースへの接続設定も必要になります。

例35.2 Sonar接続設定のコンフィグレーション

build.gradle

sonar {
    server {
        url = "http://my.server.com"
    }
    database {
        url = "jdbc:mysql://my.server.com/sonar"
        driverClassName = "com.mysql.jdbc.Driver"
        username = "Fred Flintstone"
        password = "very clever"
    }
}

Alternatively, some or all connection settings can be set from the command line (see 「コマンドラインでSonarの設定を行う Configuring Sonar Settings from the Command Line).

代わりに、いくつかの、または全ての接続設定をコマンドラインで設定することもできます(「コマンドラインでSonarの設定を行う Configuring Sonar Settings from the Command Line参照)。

Project settings determine how the project is going to be analyzed. The default configuration works well for analyzing standard Java projects and can be customized in many ways.

プロジェクト設定によって、プロジェクトをどのように解析するのかが決まります。 標準的なJavaプロジェクトに対してはデフォルト設定で事が足りますが、さまざまな方法でカスタマイズも可能です。

例35.3 Sonarプロジェクト設定のコンフィグレーション

build.gradle

sonar {
    project {
        coberturaReportPath = file("$buildDir/cobertura.xml")
    }
}

The sonar, server, database, and project blocks in the examples above configure objects of type SonarRootModel, SonarServer, SonarDatabase, and SonarProject, respectively. See their API documentation for further information.

サンプルのsonarserverdatabase、およびproject ブロックは、それぞれコンフィグレーションオブジェクト SonarRootModelSonarServerSonarDatabase、 およびSonarProjectに対応します。 詳細はAPIドキュメントを参照してください。

35.2. マルチプロジェクトビルドの解析 Analyzing Multi-Project Builds

The Sonar plugin is capable of analyzing a whole project hierarchy at once. This yields a hierarchical view in the Sonar web interface with aggregated metrics and the ability to drill down into subprojects. It is also faster than analyzing each project separately.

Sonarプラグインはプロジェクト階層全体を一度に解析する機能をもちます。 集約されたメトリクスとサブプロジェクトへのドリルダウン機能を含む階層ビューをSonarのWebインターフェースに生成でき、 個別のプロジェクトごとに解析を行うよりも高速でもあります。

To analyze a project hierarchy, the Sonar plugin needs to be applied to the top-most project of the hierarchy. Typically (but not necessarily) this will be the root project. The sonar block in that project configures an object of type SonarRootModel. It holds all global configuration, most importantly server and database connection settings.

プロジェクト階層を解析するには、Sonarプラグインを階層の最上位のプロジェクトに適用する必要があります。 これは、典型的には(必須ではないですが)ルートプロジェクトです。 そのプロジェクトのsonarブロックが SonarRootModel型のオブジェクトを構成します。 これはすべてのグローバルコンフィグレーションを保持しますが、 最も重要なのはサーバーとデータベース接続設定です。

例35.4 マルチプロジェクトビルドにおけるグローバルコンフィグレーション

build.gradle

apply plugin: "sonar"

sonar {
    server {
        url = "http://my.server.com"
    }
    database {
        url = "jdbc:mysql://my.server.com/sonar"
        driverClassName = "com.mysql.jdbc.Driver"
        username = "Fred Flintstone"
        password = "very clever"
    }
}

Each project in the hierarchy has its own project configuration. Common values can be set from a parent build script.

階層の各プロジェクトは独自のプロジェクトコンフィグレーションを持ちます。 共通の値は親のビルドスクリプトから設定可能です。

例35.5 マルチプロジェクトビルドにおける共通のプロジェクトコンフィグレーション

build.gradle

subprojects {
    sonar {
        project {
            sourceEncoding = "UTF-8"
        }
    }
}

The sonar block in a subproject configures an object of type SonarProjectModel.

サブプロジェクトのsonarブロックは SonarProjectModel型のオブジェクトを構成します.

Projects can also be configured individually. For example, setting the skip property to true prevents a project (and its subprojects) from being analyzed. Skipped projects will not be displayed in the Sonar web interface.

プロジェクトを個別に構成することもできます。 例えば、skipプロパティをtrueに設定することで、 プロジェクト(およびそのサブプロジェクト)を解析対象から除外することができます。 スキップされたプロジェクトはSonar Webインターフェースには表示されません。

例35.6 マルチプロジェクトビルドにおけるプロジェクト個別コンフィグレーション

build.gradle

project(":project1") {
    sonar {
        project {
            skip = true
        }
    }
}

Another typical per-project configuration is the programming language to be analyzed. Note that Sonar can only analyze one language per project.

プロジェクト単位のコンフィグレーションでもう一つ典型的なのは、解析対象のプログラム言語です。 Sonarはプロジェクトあたり一つの言語しか解析できないことに注意してください。

例35.7 解析対象の言語のコンフィグレーション

build.gradle

project(":project2") {
    sonar {
        project {
            language = "groovy"
        }
    }
}

When setting only a single property at a time, the equivalent property syntax is more succinct:

一度に単一のプロパティしか設定しないときは、等価なプロパティの文法はより簡潔になります:

例35.8 プロパティ文法の利用

build.gradle

project(":project2").sonar.project.language = "groovy"

35.3. カスタムソースセットの解析 Analyzing Custom Source Sets

By default, the Sonar plugin will analyze the production sources in the main source set and the test sources in the test source set. This works independent of the project's source directory layout. Additional source sets can be added as needed.

デフォルトでは、Sonarプラグインはmainソースセットのプロダクションソースと、 testソースセットのテストソースを解析します。 これはプロジェクトのソースディレクトリレイアウトとは独立して動作します。 ソースセットは必要に応じて追加できます。

例35.9 カスタムソースセットの解析

build.gradle

sonar.project {
    sourceDirs += sourceSets.custom.allSource.srcDirs
    testDirs += sourceSets.integTest.allSource.srcDirs
}

35.4. Java言語以外の解析 Analyzing languages other than Java

To analyze code written in a language other than Java, install the corresponding Sonar plugin, and set sonar.project.language accordingly:

Java以外の言語で書かれたコードを解析するには、対応するSonarプラグインをインストールして、次のようにsonar.project.languageを設定してください。

例35.10 Java言語以外の解析

build.gradle

sonar.project {
    language = "grvy" // set language to Groovy
}

As of Sonar 3.4, only one language per project can be analyzed. You can, however, set a different language for each project in a multi-project build.

Sonarでは、バージョン3.4現在、一プロジェクトにつき一つの言語の解析しかできません。しかし、マルチプロジェクトで、それぞれのプロジェクトに異なる言語を設定することはできます。

35.5. カスタムSonarプロパティの設定 Setting Custom Sonar Properties

Eventually, most configuration is passed to the Sonar code analyzer in the form of key-value pairs known as Sonar properties. The SonarProperty annotations in the API documentation show how properties of the plugin's object model get mapped to the corresponding Sonar properties. The Sonar plugin offers hooks to post-process Sonar properties before they get passed to the code analyzer. The same hooks can be used to add additional properties which aren't covered by the plugin's object model.

最終的には、コンフィグレーションのほとんどは、 Sonarプロパティとして知られるkey-valueペアの形でSonarコードアナライザに渡されます。 プラグインのオブジェクトモデルのプロパティが対応するSonarプロパティにどのようにしてマップされるかは、 APIドキュメントのSonarPropertyアノテーションが示してます。 Sonarプラグインは、Sonarプロパティがコードアナライザに渡される前の後処理のためのフックを提供します。 このフックは、プラグインのオブジェクトモデルがカバーしていないプロパティを追加するためにも利用できます。

For global Sonar properties, use the withGlobalProperties hook on SonarRootModel:

グローバルSonarプロパティに対しては、SonarRootModelwithGlobalPropertiesフックを利用してください:

例35.11 カスタムグローバルプロパティ設定

build.gradle

sonar.withGlobalProperties { props ->
    props["some.global.property"] = "some value"
    // non-String values are automatically converted to Strings
    props["other.global.property"] = ["foo", "bar", "baz"]
}

For per-project Sonar properties, use the withProjectProperties hook on SonarProject:

プロジェクト毎のSonarプロパティに対しては、SonarProjectwithProjectPropertiesフックを利用してください:

例35.12 カスタムプロジェクトプロパティ設定

build.gradle

sonar.project.withProjectProperties { props ->
    props["some.project.property"] = "some value"
    // non-String values are automatically converted to Strings
    props["other.project.property"] = ["foo", "bar", "baz"]
}

A list of available Sonar properties can be found in the Sonar documentation. Note that for most of these properties, the Sonar plugin's object model has an equivalent property, and it isn't necessary to use a withGlobalProperties or withProjectProperties hook. For configuring a third-party Sonar plugin, consult the plugin's documentation.

使用できるSonarプロパティはSonarのドキュメントで調べることができます。 ただし、これらのプロパティのほとんどはプラグインのオブジェクトモデルに対応するプロパティがあり、withGlobalPropertieswithProjectPropertiesフックを使って設定する必要はありません。 サードパーティのSonarプラグインに対しては、それらのドキュメントを参照してください。

35.6. コマンドラインでSonarの設定を行う Configuring Sonar Settings from the Command Line

The following properties can alternatively be set from the command line, as task parameters of the sonarAnalyze task. A task parameter will override any corresponding value set in the build script.

次に示すプロパティは、sonarAnalyzeタスクのパラメーターとしてコマンドラインからでも設定できます。 タスクパラメーターは、ビルドスクリプト内の対応する値を全て上書きします。

  • server.url
  • database.url
  • database.driverClassName
  • database.username
  • database.password
  • showSql
  • showSqlResults
  • verbose
  • forceAnalysis

Here is a complete example:

以下に使用例を示します。

gradle sonarAnalyze --server.url=http://sonar.mycompany.com --database.password=myPassword --verbose

If you need to set other properties from the command line, you can use system properties to do so:

他の値をコマンドラインから設定する必要がある場合は、システムプロパティが使用できます。

例35.13 カスタムのコマンドラインプロパティを実装する

build.gradle

sonar.project {
    language = System.getProperty("sonar.language", "java")
}

However, keep in mind that it is usually best to keep configuration in the build script and under source control.

ただ、たいていの場合は設定値をビルドスクリプトに格納し、ソースコード管理システムで管理するのが一番良い方法だということは頭に留めておいてください。

35.7. タスク Tasks

The Sonar plugin adds the following tasks to the project.

Sonarプラグインはプロジェクトに以下のタスクを追加します。

表35.1 Sonarプラグイン - タスク Sonar plugin - tasks

タスク名 Task name 依存先 Depends on タイプ Type 説明 Description
sonarAnalyze - SonarAnalyze プロジェクト階層全体を解析し、結果をSonarデータベースに格納。 Analyzes a project hierarchy and stores the results in the Sonar database.

Chapter 36. The Sonar Runner Plugin

The Sonar Runner plugin is currently incubating. Please be aware that the DSL and other configuration may change in later Gradle versions.

It is intended that this plugin will replace the older Sonar Plugin in a future Gradle version.

The Sonar Runner plugin provides integration with Sonar, a web-based platform for monitoring code quality. It is based on the Sonar Runner, a Sonar client component that analyzes source code and build outputs, and stores all collected information in the Sonar database. Compared to using the standalone Sonar Runner, the Sonar Runner plugin offers the following benefits:

Automatic provisioning of Sonar Runner

The ability to execute the Sonar Runner via a regular Gradle task makes it available anywhere Gradle is available (developer build, CI server, etc.), without the need to manually download, setup, and maintain a Sonar Runner installation.

Dynamic configuration from Gradle build scripts

All of Gradle's scripting features can be leveraged to configure Sonar Runner as needed.

Extensive configuration defaults

Gradle already has much of the information needed for Sonar Runner to successfully analyze a project. By preconfiguring the Sonar Runner based on that information, the need for manual configuration is reduced significantly.

36.1. Sonar Runner version and compatibility

The default version of the Sonar Runner used by the plugin is 2.3, which makes it compatible with Sonar 3.0 and higher. For compatibility with Sonar versions earlier than 3.0, you can configure the use of an earlier Sonar Runner version (see Section 36.4, “Specifying the Sonar Runner version”).

36.2. Getting started

To get started, apply the Sonar Runner plugin to the project to be analyzed.

Example 36.1. Applying the Sonar Runner plugin

build.gradle

apply plugin: "sonar-runner"

Assuming a local Sonar server with out-of-the-box settings is up and running, no further mandatory configuration is required. Execute gradle sonarRunner and wait until the build has completed, then open the web page indicated at the bottom of the Sonar Runner output. You should now be able to browse the analysis results.

Before executing the sonarRunner task, all tasks producing output to be analysed by Sonar need to be executed. Typically, these are compile tasks, test tasks, and code coverage tasks. To meet these needs, the plugins adds a task dependency from sonarRunner on test if the java plugin is applied. Further task dependencies can be added as needed.

36.3. Configuring the Sonar Runner

The Sonar Runner plugin adds a SonarRunnerRootExtension extension to the project and a SonarRunnerExtension extension to its subprojects, which allows you to configure the Sonar Runner via key/value pairs known as Sonar properties. A typical base line configuration includes connection settings for the Sonar server and database.

Example 36.2. Configuring Sonar connection settings

build.gradle

sonarRunner {
    sonarProperties {
        property "sonar.host.url", "http://my.server.com"
        property "sonar.jdbc.url", "jdbc:mysql://my.server.com/sonar"
        property "sonar.jdbc.driverClassName", "com.mysql.jdbc.Driver"
        property "sonar.jdbc.username", "Fred Flintstone"
        property "sonar.jdbc.password", "very clever"
    }
}

Alternatively, Sonar properties can be set from the command line. See 「コマンドラインでSonarの設定を行う Configuring Sonar Settings from the Command Line for more information.

For a complete list of standard Sonar properties, consult the Sonar documentation. If you happen to use additional Sonar plugins, consult their documentation.

In addition to set Sonar properties, the SonarRunnerRootExtension extension allows the configuration of the Sonar Runner version and the JavaForkOptions of the forked Sonar Runner process.

The Sonar Runner plugin leverages information contained in Gradle's object model to provide smart defaults for many of the standard Sonar properties. The defaults are summarized in the tables below. Notice that additional defaults are provided for projects that have the java-base or java plugin applied. For some properties (notably server and database connection settings), determining a suitable default is left to the Sonar Runner.

Table 36.1. Gradle defaults for standard Sonar properties

Property Gradle default
sonar.projectKey “$project.group:$project.name” (for root project of analysed hierarchy; left to Sonar Runner otherwise)
sonar.projectName project.name
sonar.projectDescription project.description
sonar.projectVersion project.version
sonar.projectBaseDir project.projectDir
sonar.working.directory “$project.buildDir/sonar”
sonar.dynamicAnalysis “reuseReports”

Table 36.2. Additional defaults when java-base plugin is applied

Property Gradle default
sonar.java.source project.sourceCompatibility
sonar.java.target project.targetCompatibility

Table 36.3. Additional defaults when java plugin is applied

Property Gradle default
sonar.sources sourceSets.main.allSource.srcDirs (filtered to only include existing directories)
sonar.tests sourceSets.test.allSource.srcDirs (filtered to only include existing directories)
sonar.binaries sourceSets.main.runtimeClasspath (filtered to only include directories)
sonar.libraries sourceSets.main.runtimeClasspath (filtering to only include files; rt.jar added if necessary)
sonar.surefire.reportsPath test.testResultsDir (if the directory exists)
sonar.junit.reportsPath test.testResultsDir (if the directory exists)

Table 36.4. Additional defaults when jacoco plugin is applied

Property Gradle default
sonar.jacoco.reportPath jacoco.destinationFile

36.4. Specifying the Sonar Runner version

By default, version 2.3 of the Sonar Runner is used. To specify an alternative version, set the SonarRunnerRootExtension.getToolVersion() property of the sonarRunner extension of the project the plugin was applied to to the desired version. This will result in the Sonar Runner dependency org.codehaus.sonar.runner:sonar-runner-dist:«toolVersion» being used as the Sonar Runner.

Example 36.3. Configuring Sonar runner version

build.gradle

sonarRunner {
    toolVersion = '2.3' // default
}

36.5. Analyzing Multi-Project Builds

The Sonar Runner is capable of analyzing whole project hierarchies at once. This yields a hierarchical view in the Sonar web interface, with aggregated metrics and the ability to drill down into subprojects. Analyzing a project hierarchy also takes less time than analyzing each project separately.

To analyze a project hierarchy, apply the Sonar Runner plugin to the root project of the hierarchy. Typically (but not necessarily) this will be the root project of the Gradle build. Information pertaining to the analysis as a whole, like server and database connections settings, have to be configured in the sonarRunner block of this project. Any Sonar properties set on the command line also apply to this project.

Example 36.4. Global configuration settings

build.gradle

sonarRunner {
    sonarProperties {
        property "sonar.host.url", "http://my.server.com"
        property "sonar.jdbc.url", "jdbc:mysql://my.server.com/sonar"
        property "sonar.jdbc.driverClassName", "com.mysql.jdbc.Driver"
        property "sonar.jdbc.username", "Fred Flintstone"
        property "sonar.jdbc.password", "very clever"
    }
}

Configuration shared between subprojects can be configured in a subprojects block.

Example 36.5. Shared configuration settings

build.gradle

subprojects {
    sonarRunner {
        sonarProperties {
            property "sonar.sourceEncoding", "UTF-8"
        }
    }
}

Project-specific information is configured in the sonarRunner block of the corresponding project.

Example 36.6. Individual configuration settings

build.gradle

project(":project1") {
    sonarRunner {
        sonarProperties {
            property "sonar.language", "grvy"
        }
    }
}

To skip Sonar analysis for a particular subproject, set sonarRunner.skipProject to true.

Example 36.7. Skipping analysis of a project

build.gradle

project(":project2") {
    sonarRunner {
        skipProject = true
    }
}

36.6. Analyzing Custom Source Sets

By default, the Sonar Runner plugin passes on the project's main source set as production sources, and the project's test source set as test sources. This works regardless of the project's source directory layout. Additional source sets can be added as needed.

Example 36.8. Analyzing custom source sets

build.gradle

sonarRunner {
    sonarProperties {
        properties["sonar.sources"] += sourceSets.custom.allSource.srcDirs
        properties["sonar.tests"] += sourceSets.integTest.allSource.srcDirs
    }
}

36.7. Analyzing languages other than Java

To analyze code written in a language other than Java, you'll need to set sonar.project.language accordingly. However, note that your Sonar server has to have the Sonar plugin that handles that programming language.

Example 36.9. Analyzing languages other than Java

build.gradle

sonarRunner {
    sonarProperties {
        property "sonar.language", "grvy" // set language to Groovy
    }
}

As of Sonar 3.4, only one language per project can be analyzed. It is, however, possible to analyze a different language for each project in a multi-project build.

36.8. More on configuring Sonar properties

Let's take a closer look at the sonarRunner.sonarProperties {} block. As we have already seen in the examples, the property() method allows you to set new properties or override existing ones. Furthermore, all properties that have been configured up to this point, including all properties preconfigured by Gradle, are available via the properties accessor.

Entries in the properties map can be read and written with the usual Groovy syntax. To facilitate their manipulation, values still have their “idiomatic” type (File, List, etc.). After the sonarProperties block has been evaluated, values are converted to Strings as follows: Collection values are (recursively) converted to comma-separated Strings, and all other values are converted by calling their toString() method.

Because the sonarProperties block is evaluated lazily, properties of Gradle's object model can be safely referenced from within the block, without having to fear that they have not yet been set.

36.9. Setting Sonar Properties from the Command Line

Sonar Properties can also be set from the command line, by setting a system property named exactly like the Sonar property in question. This can be useful when dealing with sensitive information (e.g. credentials), environment information, or for ad-hoc configuration.

gradle sonarRunner -Dsonar.host.url=http://sonar.mycompany.com -Dsonar.jdbc.password=myPassword -Dsonar.verbose=true

While certainly useful at times, we do recommend to keep the bulk of the configuration in a (versioned) build script, readily available to everyone.

A Sonar property value set via a system property overrides any value set in a build script (for the same property). When analyzing a project hierarchy, values set via system properties apply to the root project of the analyzed hierarchy. Each system property starting with ""sonar." will taken into account for the sonar runner setup.

36.10. Controlling the Sonar Runner process

The Sonar Runner is executed in a forked process. This allows fine grained control over memory settings, system properties etc. just for the Sonar Runner process. The forkOptions property of the sonarRunner extension of the project that applies the sonar-runner plugin (Usually the rootProject but not necessarily) allows the process configuration to be specified. This property is not available in the SonarRunnerExtension extension applied to the subprojects.

Example 36.10. setting custom Sonar Runner fork options

build.gradle

sonarRunner {
    forkOptions {
        maxHeapSize = '512m'
    }
}

For a complete reference about the available options, see JavaForkOptions.

36.11. Tasks

The Sonar Runner plugin adds the following tasks to the project.

Table 36.5. Sonar Runner plugin - tasks

Task name Depends on Type Description
sonarRunner - SonarRunner Analyzes a project hierarchy and stores the results in the Sonar database.

第37章 OSGiプラグインThe OSGi Plugin

The OSGi plugin provides a factory method to create an OsgiManifest object. OsgiManifest extends Manifest. To learn more about generic manifest handling, see 「ManifestManifest. If the Java plugins is applied, the OSGi plugin replaces the manifest object of the default jar with an OsgiManifest object. The replaced manifest is merged into the new one.

OSGiプラグインは OsgiManifest オブジェクトを生成するためのファクトリメソッドを提供します。 OsgiManifestManifest を継承しています。一般的な manifest 操作に関しての詳細については、 「ManifestManifest を参照してください。 Javaプラグインが適用されている場合、OSGiプラグインはデフォルトのjarのmanifestオブジェクトを OsgiManifest オブジェクトに置き換えます。 置き換えられたmanifestは新しいmanifestにマージされます。

The OSGi plugin makes heavy use of Peter Kriens BND tool.

OSGiプラグインは Peter Kriens の BND tool を大いに活用しています。

37.1. 使用方法Usage

To use the OSGi plugin, include the following in your build script:

OSGiプラグインを使うためには、ビルドスクリプトに以下のコードを追加します:

例37.1 OSGiプラグインの利用

build.gradle

apply plugin: 'osgi'

37.2. 暗黙的に適用されるプラグインImplicitly applied plugins

Applies the Java base plugin.

Java ベースプラグインを適用します。

37.3. タスクTasks

This plugin does not add any tasks.

このプラグインはタスクを追加しません。

37.4. 依存関係の管理Dependency management

TBD

TBD

37.5. 規約オブジェクトConvention object

The OSGi plugin adds the following convention object: OsgiPluginConvention

OSGiプラグインは以下の規約オブジェクトを追加します: OsgiPluginConvention

37.5.1. 規約プロパティConvention properties

The OSGi plugin does not add any convention properties to the project.

OSGiプラグインはプロジェクトに規約プロパティを追加しません。

37.5.2. 規約メソッドConvention methods

The OSGi plugin adds the following methods. For more details, see the API documentation of the convention object.

OSGiプラグインは以下の規約メソッドを追加します。詳細については規約オブジェクトのAPIドキュメントを参照してください。

表37.1 OSGiメソッドOSGi methods

メソッドMethod 戻り値Return Type 説明Description
osgiManifest() OsgiManifest OsgiManifestオブジェクトを返す。Returns an OsgiManifest object.
osgiManifest(Closure cl) OsgiManifest クロージャによって構成されたOsgiManifestオブジェクトを返す。Returns an OsgiManifest object configured by the closure.

The classes in the classes dir are analyzed regarding their package dependencies and the packages they expose. Based on this the Import-Package and the Export-Package values of the OSGi Manifest are calculated. If the classpath contains jars with an OSGi bundle, the bundle information is used to specify version information for the Import-Package value. Beside the explicit properties of the OsgiManifest object you can add instructions.

classesディレクトリにあるクラスのパッケージ依存関係と公開するパッケージが解析され、その情報に基づいてOSGi Manifestの Import-PackageExport-Package の値が決定されます。 クラスパスにOSGiバンドル形式のjarがある場合、Import-Packageの値を決定するためにバンドルの情報が参照されます。 OsgiManifest オブジェクトに明示的にinstructionプロパティを追加することでメタデータを追加できます。

例37.2 OSGiのMANIFEST.MFファイルの設定

build.gradle

jar {
    manifest { // the manifest of the default jar is of type OsgiManifest
        name = 'overwrittenSpecialOsgiName'
        instruction 'Private-Package',
                'org.mycomp.package1',
                'org.mycomp.package2'
        instruction 'Bundle-Vendor', 'MyCompany'
        instruction 'Bundle-Description', 'Platform2: Metrics 2 Measures Framework'
        instruction 'Bundle-DocURL', 'http://www.mycompany.com'
    }
}
task fooJar(type: Jar) {
    manifest = osgiManifest {
        instruction 'Bundle-Vendor', 'MyCompany'    
    }
}

The first argument of the instruction call is the key of the property. The other arguments form the value. They are joined by Gradle with the , separator. To learn more about the available instructions have a look at the BND tool.

instruction の第1引数にはプロパティのキー、第2引数には値を指定します。 それらはGradleによって , で結合されます。 利用可能な instruction の詳細については BND tool を参照してください。

第38章 Eclipse プラグインThe Eclipse Plugin

The Eclipse plugin generates files that are used by the Eclipse IDE, thus making it possible to import the project into Eclipse (File - Import... - Existing Projects into Workspace). Both external dependencies (including associated source and Javadoc files) and project dependencies are considered.

Eclipse プラグインは Eclipse IDE が利用するファイルを生成し、 (ファイル - インポート... - 既存プロジェクトをワークスペースへ で) Eclipse 内にプロジェクトをインポートできるようにします。 外部依存関係 (ソースと Javadoc も含む) とプロジェクト依存関係の両方が考慮されます。

Since version 1.0-milestone-4 of Gradle, the WTP-generating code was refactored into a separate plugin called eclipse-wtp. So if you are interested in WTP integration then only apply the eclipse-wtp plugin. Otherwise applying the eclipse plugin is enough. This change was requested by Eclipse users who take advantage of the war or ear plugins, but who don't use Eclipse WTP. Internally, the eclipse-wtp plugin also applies the eclipse plugin so you don't need to apply both of those plugins.

1.0-milestone-4 以降、WTP生成コードはリファクタリングされ、eclipse-wtp プラグインに分離されました。 もしWTP が必要であれば、eclipse-wtp プラグインを適用するだけです。必要でなければ、eclipse プラグインを適用するだけでよいです。 この変更は WTP を利用せずに war プラグインや ear プラグインだけを利用するという Eclipse ユーザの要望によるものです。 eclipse-wtp プラグインは 内部的に eclipse プラグインも適用するので 両方を適用する必要はありません。

What exactly the Eclipse plugin generates depends on which other plugins are used:

Eclipse プラグインが何を生成するかは どのプラグインと一緒に利用するかで決まります。

表38.1 Eclipse プラグインの振舞いEclipse plugin behavior

プラグインPlugin説明Description
なしNone最小構成の .project ファイルを生成します。 Generates minimal .project file.
JavaJava の構成を .project ファイルに追加します。 .classpath ファイルと JDT 設定ファイルを生成します。 Adds Java configuration to .project. Generates .classpath and JDT settings file.
GroovyGroovy の構成を.project ファイルに追加します。 Adds Groovy configuration to .project file.
ScalaAdds Scala support to .project and .classpath files.
WarWEBアプリケーションのサポートを.projectファイルと.classpathファイルに追加します。 eclipse-wtp プラグインを適用している場合のみ WTP 設定ファイルを生成します。 Adds web application support to .project file. Generates WTP settings files only if eclipse-wtp plugin was applied.
Ear EAR アプリケーションのサポートを .project ファイルに追加します。 eclipse-wtp プラグインを適用している場合のみ WTP 設定ファイルを生成します。 Adds ear application support to .project file. Generates WTP settings files only if eclipse-wtp plugin was applied.

The Eclipse plugin is open to customization and provides a standardized set of hooks for adding and removing content from the generated files.

Eclipseプラグインは、カスタマイズが容易なように作られています。 生成されたファイルに内容を追加したり削除したりするための、標準化されたフックが用意されています。

38.1. 使用方法Usage

To use the Eclipse plugin, include this in your build script:

Eclipseプラグインを使う為には、ビルドスクリプトに下記を含めます:

例38.1 Eclipseプラグインの使用方法

build.gradle

apply plugin: 'eclipse'

The Eclipse plugin adds a number of tasks to your projects. The main tasks that you will use are the eclipse and cleanEclipse tasks.

Eclipseプラグインは多くのタスクをプロジェクトに追加しますが、主に利用するのは eclipsecleanEclipse タスクだけです。

38.2. タスクTasks

The Eclipse plugin adds the tasks shown below to a project.

Eclipseプラグインはプロジェクトに以下のタスクを追加します。

表38.2 Eclipse プラグイン - タスクEclipse plugin - tasks

タスク名Task name 依存先Depends on Type 説明Description
eclipse eclipseProject, eclipseClasspath, eclipseJdt, eclipseWtpComponent, cleanEclipseWtpFacet Task Eclipseの全ての設定ファイルを生成します。 Generates all Eclipse configuration files
cleanEclipse cleanEclipseProject, cleanEclipseClasspath, cleanEclipseJdt, cleanEclipseWtpComponent, cleanEclipseWtpFacet Delete Eclipseの全ての設定ファイルを削除します。 Removes all Eclipse configuration files
cleanEclipseProject - Delete .projectファイルを生成します。 Generates the .project file.
cleanEclipseClasspath - Delete .classpathファイルを生成します。 Generates the .classpath file.