できない.dev

Gradle Wrapper

別名: gradlew / gradlew.bat / gradle-wrapper.properties / Gradle ラッパー

Gradle Wrapper は、プロジェクトが指定した版の Gradle を必要ならダウンロードしてから動かすスクリプトである。
gradlew と gradlew.bat、gradle/wrapper の下のファイルでできている。

公開: 更新:

定義

Gradle Wrapper は、宣言された版の Gradle を呼び出すスクリプトである。
その版が手元に無ければ、先にダウンロードしてから動かす。
公式ドキュメント(新しいタブで開く)は、どのビルドも Wrapper で実行することを勧めている。
gradle build の代わりに ./gradlew build と打つ。

詳細

Wrapper は次のファイルでできている。

gradlew                                  # macOS・Linux 用のシェルスクリプト
gradlew.bat                              # Windows 用のバッチファイル
gradle/wrapper/gradle-wrapper.jar        # Gradle の配布物をダウンロードするコード
gradle/wrapper/gradle-wrapper.properties # 使う配布物の distributionUrl などの設定

ダウンロードした Gradle は GRADLE_USER_HOME に保存され、distributionUrl が変わるまで使い回される。
版を上げるときは ./gradlew wrapper --gradle-version に新しい版を渡して、Wrapper のファイルを作り直す。

よくある誤解

Gradle Wrapper は単独では配布されていない。
最初の 1 回は、インストールした Gradle の wrapper タスクか gradle init で作る。

Wrapper のファイルは、ほかの開発者や CI が使えるようにリポジトリへコミットする。
Windows から追加した gradlew は実行ビットなしで記録されることがあり、clone した先で ./gradlew: Permission denied になる。

関連

Wrapper が実行するのは build.gradle に書いたタスクである。
実行ビットの仕組みは パーミッション を参照する。