Gradle, 버전 카탈로그

#1 이전 글

Maven, Artifact, GAV

위의 게시글에서 이어진다.

 

#2 Gradle

#2-1 What

• 공식 홈페이지
• 공식 사용 설명서
• GitHub

Maven에서 파생한 도구다. Gradle의 단점 중 하나인 장황함 등을 개선했다. Maven의 Artifact 개념도 그대로 계승해 사용한다. 따라서 Maven Repository를 Gradle도 Maven과 같이 쓸 수 있다.

 

#2-2 vs Maven DSL

Maven DSL → Gradle DSL
groupId → group
artifactId → name
version → version (동일)
groupId + ":" + artifactId → module

Gradle은 Maven을 계승했지만, DSL에서는 위와 같이 약간의 차이가 있다. 눈여겨볼 것은 'module'이다. 가령, Maven에서 groupId가 "androidx.hilt"고 artifactId가 "hilt-navigation-compose"인 Artifact를, Gradle에선 값이 "androidx.hilt:hilt-navigation-compose"인 module을 가지는 Artifact라고 표현할 수 있다.

 

module에 아주 특별한 의미가 깃든 것은 아니다. 그냥 표현 방식의 차이일 뿐이다. 따라서, 아래에 있는 (1)과 (2)는 Gradle에서 완전히 동일한 Artifact로 취급된다.

 

(1) group = "androidx.hilt", name = "hilt-navigation-compose", version = "1.2.0"
(2) module = "androidx.hilt:hilt-navigation-compose", version = "1.2.0"

 

#2-3 vs Android Module

[Android] Module 구조

Artifact의 '또 다른 정의'를 보면, Android에서 정의한 'Module'과 의미론적(추상적)으론 같다는 걸 알 수 있다. 그런 점에서 Gradle이 group(groupId) 및 name(artifactId)을 합쳐 module이라 부르는 건 (기억하기 쉽다는 측면에서) 좋은 일이다. Gradle의 module은 version 정보만 없을 뿐인 Artifact 그 자체라 해도 되니까.

 

#3 버전 카탈로그

#3-1 What

Version Catalogs

버전 카탈로그(Version Catalog)는 프로젝트가 사용하는 라이브러리(Artifact)들의 GAV 값을 모아놓은 파일이다. Gradle 7.4 버전에서부터 도입되었다. Android Project도 Gradle을 사용하므로 자연스럽게 따라 도입되었다.

 

#3-2 도입 배경

1. 하나의 프로젝트만 보자면, 버전 정보를 gradle/libs.versions.toml 단 하나만 몰아넣어 유지보수성 증대
2. 여러 개의 프로젝트끼리 비교하자면, 의존성(라이브러리) 정보 기입을 위한 장소를 gradle/libs.versions.toml로 약속(표준화)하는 효과

 

#3-3 TOML 파일 형식

• 공식 홈페이지
• 위키백과

JSON처럼 키-값 쌍을 저장하는, 설정 파일 양식이다. TOML 양식이 버전 카탈로그 파일의 양식으로 채택된 것은, 아마 다른 양식들에 비해 가독성이 훌륭하기 때문일 것이다.

 

#3-4 구조

[versions] # 버전 값 기입
ktx = "1.9.0"
androidGradlePlugin = "7.4.1"
...

[libraries] # Artifact의 GAV 값 기입
androidx-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "ktx" }
...

[plugins] # Gradle Plugin의 id 및 버전 값 기입
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
...

구조가 어떤지 보여주기 위한, 버전 카탈로그 파일(libs.versions.toml)의 예시다.

 

Gradle Plugin은 겉으로는 GAV가 없는 것처럼 보이지만, 실제론(= 내부적으론) Artifact다(= GAV가 있다). 우리(프로그래머)가 플러그인 id 및 버전 값으로 호출하면, Gradle이 알아서 매핑된 GAV로 Artifact를 다운로드해서 가져온다.

 

GAV 값에서 "version"이 아니라 "version.ref"(= version reference)라는 키가 쓰인 것은, [versions]에 있는 값을 참조(reference)하기 때문이다. 그래서 그냥 아래처럼 써도 된다. 다만, 유지보수성을 생각해 지양하자.

 

androidx-ktx = { group = "androidx.core", name = "core-ktx", version = "1.9.0" }

 

#4 기존 방식 → 버전 카탈로그

버전 카탈로그로 빌드 이전  |  Android Studio  |  Android Developers

안드로이드 프로젝트의 경우다. 공식 문서에 잘 정리되어 있다. 

 

#5 버전 카탈로그 → 기존 방식

#4의 역순이다.