[Gradle] Gradle Wrapper(gradlew와 gradle.bat)와 settings.gradle

 

 

 

 

🧐 서론

Gradle 프로젝트를 빌드하고 실행하기 위해서는, 로컬 컴퓨터에 해당 프로젝트와 동일한 버전이 동일해야 합니다.

만약 이들이 일치하지 않는다면, 당연하게도 오류가 발생합니다.

 

따라서, 항상 사용하려는 프로그램의 Gradle 버전과 동일하게 Gradle을 설치해주어야 하는데 이는 굉장히 귀찮고 비효율적인 방법입니다.

 

Gradle Wrapper(이하 Wrapper)는 이러한 문제를 해결해줍니다.

 

 

 

 

 

 

🧐 Gradle Wrapper

지정된 버전의 Gradle을 실행하는 스크립트로, 필요한 경우 Gradle 배포판(distribution)을 배포 서버에서 다운로드합니다.

Wrapper를 사용하면 Gradle을 설치하지 않고도 지정된 Gradle 버전으로 빌드를 진행할 수 있습니다.

 

Wrapper를 사용하기 위해서는 Wrapper 파일들이 필요한데, 이를 생성하기 위해서는 Gradle이 설치되어 있어야 합니다.

(Wrapper는 한번만 생성하면 이후 계속 사용할 수 있으므로, 이미 Wrapper 파일이 생성된 경우 Gradle의 설치 없이 사용 가능합니다.)

 

Gradle은 wrapper라고 불리는 기본 task를 제공합니다.

wrapper task가 실행되면 다음과 같은 Wrapper 파일들이 생성됩니다.

.
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
└── gradlew.bat

 

 

 

📕 gradle-wrapper.jar

Gradle 배포판을 다운로드하는 코드가 포함된 JAR 파일입니다.

 

 

 

📙 gradle-wrapper.properties

현재 프로젝트와 호환되는 Gradle 배포판의 버전을 포함하여 Gradle Wrapper의 런타임 속성이 포함됩니다. 

 

 

 

📒 gradlew, gradle.bat

Wrapper를 통해 빌드를 실행하는 스크립트입니다.

gradlew는 맥과 리눅스용 스크립트이며,

gradle.bat은 윈도우용 스크립트입니다.

 

 

 

 

 

📗 Wrapper 버전 변경하기

기본적으로 wrapper 작업(task)은 설치된 Gradle 버전과 동일한 버전의 Wrapper 파일을 생성합니다.

만약 버전을 바꾸고 싶다면, 다음과 같이 옵션을 통해 설정할 수 있습니다.

gradle wrapper --gradle-version 8.1

 

 

 

 

 

 

 

 

 

 

🧐 Wrapper를 통해 Gradle 사용하기

Gradle 빌드는 항상 Wrapper를 통해 실행하는 것이 권장됩니다.

 

Wrapper는 gradlew를 통해 다음과 같이 사용할 수 있습니다.

./gradlew [태스트 이름]

위는 gradle [태스크 이름]과 동일한 역할을 하는데, 컴퓨터에 설치된 gradle이 아닌 wapper를 사용한다는 것이 차이점입니다.

 

 

gradle.bat은 다음과 같이 사용할 수 있습니다.

gradlew.bat [태스트 이름]

윈도우에서는 ./ 을 사용하지 않아도 됩니다.

 

 

 

 

 

 

 

🧐 settings.gradle

빌드에 참여하는 project들의 계층구조를 인스턴스화하고 구성하는데 필요한 설정을 작성합니다.

 

settings.gradle의 목적 중 하나는 빌드에 포함될 프로젝트들을 설정하는 것입니다.

프로젝트들은 include 메서드를 통해 추가될 수 있습니다.

 

Gradle은 빌드가 실행될 때마다 settings.gradle 파일을 찾아, 해당 파일을 참고하여 빌드를 초기화합니다.

만약 settings.gradle 파일이 없는 디렉토리에서 gradle을 실행하는 경우 다음 순서를 따릅니다.

1. 우선 상위 디렉토리에서 찾습니다.
2. 상위 디렉토리에서 존재함이 확인되었다면, 현재 프로젝트가 multi-project 빌드에 참여하는지 확인합니다. 참여한다면 Gradle은 multi-project로 빌드됩니다.
3. 만약 찾지 못한다면 Gradle은 단일 프로젝트로 빌드됩니다.

 

 

 

😊 multi-project 추가하는 예시

구조는 다음과 같다고 하면

basic-multiproject
├── app
│   ...
│   └── build.gradle
├── lib
│   ...
│   └── build.gradle
└── settings.gradle

 

 

다음과 같이 settings.gradle을 작성합니다.

rootProject.name = 'basic-multiproject'
include 'app'
include 'lib'

 

 

 

 

 

 

 

🔎 Reference

https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:using_wrapper

The Gradle Wrapper

 

https://docs.gradle.org/current/dsl/org.gradle.api.initialization.Settings.html#org.gradle.api.initialization.Settings

Settings - Gradle DSL Version 8.1

 

https://docs.gradle.org/current/userguide/build_lifecycle.html#sec:initialization

Build Lifecycle

 

https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#sec:settings_file

Organizing Gradle Projects

 

https://docs.gradle.org/current/userguide/multi_project_builds.html#sec:adding_subprojects

Structuring and Building a Software Component with Gradle