🐘 Groovy 에서 KTS로 전환하기

🐘 목표

gradle 관리 언어 Groovy -> kts로 바꾸기

---

🐘 Gradle

안드로이드 프로젝트에선 다양한 오픈 소스 라이브러리들을 활용할 수 있다는 게 장점입니다.

프로젝트에서 사용하는 많은 라이브러리를 관리하기 위한 도구가 필요한데, Android Studio에서는 그 도구로 Gradle을 사용합니다.

 

Gradle은 JVM에서 동작하는 빌드 자동화 시스템으로,

라이브러리 관리 뿐 아니라 컴파일, 테스트, 패키징 등의 빌드 작업을 자동화하는 역할을 합니다.

기존에 존재하던 Ant, Maven에 비해 간결하게 작성할 수 있으며 속도가 빠르다는 것이 장점입니다.

 

---

🐘 Groovy vs KTS

Gradle은 자바와 비슷한 Groovy 언어로 작성하였는데, 이제는 KTS(코틀린 스크립트)로 이를 대체할 수 있습니다.

Groovy를 대체하는 KTS의 장점은 아래와 같습니다.

• Groovy 언어를 따로 배우지 않아도 된다. 
• Groovy는 파일을 실행해야 오류를 감지하는 반면, KTS는 컴파일 타임에 오류를 발견할 수 있다.
• IDE를 사용하는 경우 자동완성을 지원한다.

그러나 Groovy보다 느리다는 단점이 존재합니다.

출처 - https://github.com/gradle/gradle/issues/15886

 

비록 느려진다는 단점이 있었지만 (정말 꽤 느려집니다)

더 잘 아는 코틀린을 사용하고 싶었고, gradle 코드를 깔끔하게 관리하고자 하는 목적을 가지고 프로젝트에 KTS를 도입하게 되었습니다.

 

---

🐘 KTS Migration

KTS로 전환하기 위해선

1. .gradle 파일을 .gradle.kts로 파일 이름을 변경하고

2. 콘텐츠를 KTS 문법에 맞게 수정하는 과정이 필요합니다.

 

위 과정을 진행하기 앞서 build.gradle 코드를 좀 더 깔끔하게 관리하기 위해서

buildSrc 디렉토리를 만들고 의존성 관련 내용을 상수로 정의하여 사용해보겠습니다.

---

1. 프로젝트 루트 디렉토리에 buildSrc 디렉토리 생성

buildSrc 디렉토리에서는 KTS 빌드 스크립트 전체에서 사용할 수 있는 작업과 도구를 정의합니다.

1. 프로젝트 루트에 buildSrc 디렉토리 생성 (New → Directory)

2. buildSrc 디렉토리에 build.gradle.kts 파일 추가 후 sync

plugins {
    `kotlin-dsl`
}

repositories {
    google()
    mavenCentral()
}

 

2. gradle 관리에 필요한 설정 파일 만들기

buildSrc 우클릭 후

new → Directory : src\main\kotlin 선택 후 object 파일 생성

 

다음의 내용을 각 파일에 정의합니다.

 

Configs 

앱 기본 정보 관리 파일

Libraries 

앱에서 사용하는 라이브러리 관리 파일

Versions 

앱 라이브러리 버전 관리 파일

 

상수 형태의 값들로 이루어진 설정파일을 만들 건데, kotlin 문법을 사용하여 다음과 같은 형식으로 만들 수 있습니다.

object Obj {
    const val value1 = "value"
    const val value2 = 30
}

 

Configs 예시

// buildSrc/src/main/kotlin/Configs.kt
object Configs {
    const val applicationId = "applicationId"
    const val compileSdkVersion = 31
    const val minSdkVersion = 26
    const val targetSdkVersion = 30
    const val versionCode = 1
    const val versionName = "1.0.0"
}

 

Versions 예시

// buildSrc/src/main/kotlin/Versions.kt
object Versions {

    // classpath
    const val classPathVersion = "7.2.0"
    const val kotlinVersion = "1.6.21"
    const val hiltVersion = "2.40.1"
    const val navigationVersion = "2.5.0"

    // core
    const val coreKtxVersion = "1.7.0"
    const val coroutineVersion = "1.6.0"

    // .. 생략

    // test
    const val junit = "4.13.2"
    const val espressoVersion = "3.4.0"
    const val androidxTestVersion = "1.2.0"
    const val mockitoVersion = "2.24.5"
}

Libraries 예시

object Libraries {

    object CLASSPATH {
        const val classpathGradle = "com.android.tools.build:gradle:${Versions.classPathVersion}"
        const val classpathKotlinGradle = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.kotlinVersion}"
        const val classpathHilt = "com.google.dagger:hilt-android-gradle-plugin:${Versions.hiltVersion}"
        const val classpathNavigation = "androidx.navigation:navigation-safe-args-gradle-plugin:${Versions.navigationVersion}"
    }
    
    object Core {
        const val KOTLIN_STDLIB = "org.jetbrains.kotlin:kotlin-stdlib:${Versions.kotlinVersion}"
        const val COROUTINE = "org.jetbrains.kotlinx:kotlinx-coroutines-android:${Versions.coroutineVersion}"
    }

    object UI {
        // 생략..
    }

    object AndroidX {
        // 생략..
    }

    object DI {
        // 생략..
    }

    object ThirdParty {
        // 생략..
    }

    object Test {
        // 생략..
    }

    object AndroidTest {
        // 생략..
    }
}

 

---

 

2. settings.grade 파일 확장자 kts로 변경 후 kotlin 문법에 맞게 파일 수정하기

 

1. setting.gradle → setting.gradle.kts 로 변경합니다.

 

2. kts 문법에 맞게 코드를 변경합니다.

rootProject.name = "Mindgarden"
include(":app")

 

4. 프로젝트 수준 build.gradle 파일 확장자 kts로 변경 후 문법에 맞게 수정

build.src에 정의한 내용을 다음과 같이 사용할 수 있습니다.

classpath(Libraries.CLASSPATH.classpathHilt)

build.gradle(Project) 코드

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {

    repositories {
        google()
        mavenCentral()
    }

    dependencies {
        classpath(Libraries.CLASSPATH.classpathGradle)
        classpath(Libraries.CLASSPATH.classpathKotlinGradle)

        classpath(Libraries.CLASSPATH.classpathHilt)
        classpath(Libraries.CLASSPATH.classpathNavigation)
    }
}

allprojects {

    repositories {
        google()
        mavenCentral()
    }
}

tasks.register("clean", Delete::class) {
    delete(rootProject.buildDir)
}

 

5. 모듈 수준 build.gradle 파일 kts로 이름 변경 후 문법에 맞게 수정

plugins {
    id("com.android.application")
    id("kotlin-android")
    id("kotlin-kapt")
    id("androidx.navigation.safeargs.kotlin")
    id("dagger.hilt.android.plugin")
}

android {
    compileSdk = Configs.compileSdkVersion

    defaultConfig {
        applicationId = Configs.applicationId
        minSdk = Configs.minSdkVersion
        targetSdk = Configs.targetSdkVersion
        versionCode = Configs.versionCode
        versionName = Configs.versionName

        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        getByName("release") {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
            )
        }
    }

    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }

    kotlinOptions {
        jvmTarget = JavaVersion.VERSION_11.toString()
    }

    testOptions {
        unitTests {
            isReturnDefaultValues = true
        }
    }

    buildFeatures {
        viewBinding = true
        dataBinding = true
    }

    namespace = "com.app.myapp"
}

dependencies {
    // core
    implementation(Libraries.Core.KOTLIN_STDLIB)
    implementation(Libraries.Core.COROUTINE)

    // UI
    implementation(Libraries.UI.MATERIAL)
    implementation(Libraries.UI.CONSTRAINT_LAYOUT)
    implementation(Libraries.UI.FRAGMENT_KTX)

    // AndroidX
    implementation(Libraries.AndroidX.CORE_KTX)
    implementation(Libraries.AndroidX.APP_COMPAT)

    // di hilt
    implementation(Libraries.DI.HILT)
    kapt(Libraries.DI.HILT_COMPILER)

    // 3rd
    // glide
    implementation(Libraries.ThirdParty.GLIDE)
    kapt(Libraries.ThirdParty.GLIDE_COMPILER)

    // test
    testImplementation(Libraries.Test.JUNIT)
    androidTestImplementation(Libraries.AndroidTest.JUNIT_KOTLIN)
    androidTestImplementation(Libraries.AndroidTest.ROOM)
    androidTestImplementation(Libraries.AndroidTest.ESPRESSO_CORE)
    androidTestImplementation(Libraries.AndroidTest.COROUTINE)
    androidTestImplementation(Libraries.AndroidTest.TEST_RUNNER)
    androidTestImplementation(Libraries.AndroidTest.TEST_RULES)
    androidTestImplementation(Libraries.AndroidTest.MOCKITO)
}

// Allow references to generated code
kapt {
    correctErrorTypes = true
}

 

---

🐘 Meaning 

• Groovy의 역할
• Groovy와 KTS 비교, KTS의 장점과 단점
• Groovy에서 KTS로 전환하는 방법과 장점

빌드 속도가 생각보다 더 느려지긴 했지만 😧

IDE를 통해 자동 완성이 지원되고 코드를 더 가독성 있게 만들고 깔끔하게 관리할 수 있다는 점이 만족스러웠습니다.

---

🐘 참고

https://docs.gradle.org/nightly/userguide/migrating_from_groovy_to_kotlin_dsl.html

Migrating build logic from Groovy to Kotlin

https://developer.android.com/studio/build/migrate-to-kts?hl=ko 

Groovy에서 KTS로 빌드 구성 이전  |  Android 개발자  |  Android Developers

https://blog.kotlin-academy.com/kotlin-dsl-buildsrc-product-flavors-flavor-icon-and-more-abf30c65e8fd

Kotlin DSL, BuildSrc, Product Flavors, Flavor Icon and more

 https://github.com/gradle/gradle/issues/15886

The Kotlin and Groovy DSLs should have similar performance characteristics · Issue #15886 · gradle/gradle