[Gradle] Type-safe Project Accessors 도입 배경 및 사용법

#1 기존의 모듈 호출 방식

// in build.gradle

plugins {
    ...
}

android {
    ...
}

dependencies {

    ...
    implementation(project(":datastore"))
    implementation(project(":designsystem"))
}

이 방식이 비효율적인 이유는 무엇일까?

• 모듈 이름의 스펠링을 하나하나 기억해야 하고, 모듈 이름을 변경이라도 하면 프로젝트 내 모든 implementation() 문을 찾아다니며 수동 변경해 주어야 한다.
• 게다가 사람의 수동 변경은 일부 코드의 누락 가능성까지 있다.
• 잘못된 모듈 이름을 입력했을 때 build.gradle의 DSL(Gradle DSL)단에서 잡아내지 못하기 때문에, Gradle의 빌드가 시작되고 나서야 뒤늦게 에러를 인지하게 된다.

 

#2 Type-safe Project Accessors

Declaring Dependencies

Type-safe Project Accessors는 Gradle 7.0부터 사용할 수 있는 Gradle의 기능이다. #1의 비효율을 해결하기 위해 도입되었다. 구체적으로 어떤 기능인지는 아래에 있는 예시 코드를 보면 바로 알 수 있다.

 

예시 코드

// in build.gradle

// 기존 방식
dependencies {
    implementation(project(":utils"))
    implementation(project(":api"))
}

---
// in build.gradle

// Type-safe Project Accessors를 사용한 방식
dependencies {
    implementation(projects.utils)
    implementation(projects.api)
}

이 방식이 효율적인 이유는 무엇일까?

• 모듈 이름의 스펠링을 하나하나 기억할 필요가 없다.
• 모듈 이름 변경 시 프로젝트의 모든 프로퍼티가 일괄(자동)적으로 변경되기에, 이름 변경 작업이 일부 코드에서 누락될 가능성이 0으로 수렴한다.
• 잘못된 모듈 이름을 입력했을 때, Kotlin DSL인 경우 Kotlin 컴파일러가 즉시 "Unresolved reference 'sampleIncorrectModuleName'."과 같은 메시지와 함께 에러를 표시해 준다 (시간 절약).

 

여담으로 Groovy는 동적 프로그래밍 언어이기에, Groovy DSL을 쓸 때는 (Kotlin DSL을 쓸 때처럼) 오입력된 모듈 이름을 '즉시' 잡아주지는 못한다고 한다.

 

#2-1 활성화 방법

Type-safe Project Accessors를 활성화하려면 setting.gradle에,

enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

구문을 추가해 주어야 한다. 그러나 setting.gradle의 어느 부분에 위치시켜야하는지는 (공식 문서에) 명확히 나와 있지 않았다.

 

그래서,

// in setting.gradle (of Now in Android)

/*
 * Copyright 2021 The Android Open Source Project
 * ...
 */

pluginManagement {
    ...
}

dependencyResolutionManagement {
    ...
}
rootProject.name = "nowinandroid"

enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
include(":app")
include(":app-nia-catalog")
include(":benchmarks")
include(":core:analytics")
include(":core:common")
include(":core:data")
...

check(JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_17)) {
    ...
}

Now in Android 소스 코드의 setting.gradle를 보고 감을 잡았다. 위의 코드와 같은 위치에 두면 될 것이다.

 

#2-2 Accessor 프로퍼티 이름 규칙

기존 방식 → Type-safe Project Accessors
:commons:utils:some:lib → projects.commons.utils.some.lib
:some-lib → projects.someLib
:some_lib → projects.someLib

모듈 이름에 있는 케밥 케이스(some-lib)와 스네이크 케이스(some_lib)는 카멜 케이스(someLib)로 변환된다.

 

#3 실사용 예시

실제 내 프로젝트의 코드에 사용해 보았다.

 

Type-safe Project Accessors 미사용 코드

// in build.gradle

plugins {
    ...
}

android {
    ...
}

dependencies {

    ...
    implementation(project(":datastore"))
    implementation(project(":designsystem"))
}

#1에 있는 코드다.

 

Type-safe Project Accessors 활성화

pluginManagement {
    ...
}

dependencyResolutionManagement {
    ...
}
rootProject.name = "swemo"

enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
include(":app")
include(":database")
include(":designsystem")
...

 

Type-safe Project Accessors를 사용한 코드

// in build.gradle

plugins {
    ...
}

android {
    ...
}

dependencies {

    ...
    implementation(projects.datastore)
    implementation(projects.designsystem)
}

 

참고

• [GitHub] 적용 전 Commit
• [GitHub] 적용 후 Commit
• [GitHub] 프로젝트 Repository