구조 분해 선언

때로는 객체를 여러 변수로 구조 분해(destructure) 하는 것이 편리할 때가 있습니다. 예를 들면 다음과 같습니다:

val (name, age) = person

이러한 구문을 구조 분해 선언(destructuring declaration) 이라고 부릅니다. 구조 분해 선언은 한 번에 여러 변수를 생성합니다. 여기서는 name과 age라는 두 개의 새로운 변수를 선언했으며, 이들을 독립적으로 사용할 수 있습니다:

println(name)
println(age)

구조 분해 선언은 컴파일 시 다음과 같은 코드로 변환됩니다:

val name = person.component1()
val age = person.component2()

component1()과 component2() 함수는 Kotlin에서 널리 사용되는 관례(conventions) 원칙의 또 다른 예시입니다(+와 * 같은 연산자, for 루프 등이 예시입니다). 필요한 개수만큼의 component 함수를 호출할 수만 있다면 구조 분해 선언의 우변에 어떤 것이든 올 수 있습니다. 그리고 당연히 component3(), component4() 등도 가능합니다.

componentN() 함수가 구조 분해 선언에서 사용되려면 operator 키워드가 붙어 있어야 합니다.

구조 분해 선언은 for 루프에서도 작동합니다:

for ((a, b) in collection) { ... }

변수 a와 b에는 컬렉션의 요소에 대해 호출된 component1()과 component2()가 반환한 값이 할당됩니다.

예제: 함수에서 두 개의 값 반환하기

함수에서 두 가지 결과(예: 결과 객체와 일종의 상태 값)를 반환해야 한다고 가정해 보겠습니다. Kotlin에서 이를 수행하는 간결한 방법은 데이터 클래스(data class)를 정의하고 그 인스턴스를 반환하는 것입니다:

data class Result(val result: Int, val status: Status)
fun function(...): Result {
    // 계산 수행
    
    return Result(result, status)
}

// 이제 이 함수를 사용하려면:
val (result, status) = function(...)

데이터 클래스는 자동으로 componentN() 함수를 선언하므로 구조 분해 선언을 바로 사용할 수 있습니다.

표준 클래스인 Pair를 사용하여 function()이 Pair<Int, Status>를 반환하도록 할 수도 있지만, 데이터에 적절한 이름을 부여하는 것이 더 나은 경우가 많습니다.

예제: 구조 분해 선언과 맵(Map)

맵을 순회하는 가장 좋은 방법은 아마도 다음과 같을 것입니다:

for ((key, value) in map) {
   // 키와 값을 사용하여 작업 수행
}

이것이 작동하게 하려면 다음이 필요합니다:

• iterator() 함수를 제공하여 맵을 값의 시퀀스로 나타내야 합니다.
• 각 요소를 component1() 및 component2() 함수를 제공하여 쌍(pair)으로 나타내야 합니다.

실제로 표준 라이브러리는 다음과 같은 확장 기능을 제공합니다:

operator fun <K, V> Map<K, V>.iterator(): Iterator<Map.Entry<K, V>> = entrySet().iterator()
operator fun <K, V> Map.Entry<K, V>.component1() = getKey()
operator fun <K, V> Map.Entry<K, V>.component2() = getValue()

따라서 맵(데이터 클래스 인스턴스의 컬렉션 등과 마찬가지로)을 사용할 때 for 루프에서 구조 분해 선언을 자유롭게 사용할 수 있습니다.

사용하지 않는 변수에 대한 언더스코어

구조 분해 선언에서 변수가 필요하지 않은 경우, 이름 대신 언더스코어(_)를 넣을 수 있습니다:

val (_, status) = getResult()

이렇게 건너뛴 컴포넌트에 대해서는 componentN() 연산자 함수가 호출되지 않습니다.

람다에서의 구조 분해

람다 파라미터에 구조 분해 선언 구문을 사용할 수 있습니다. 람다가 Pair 타입(또는 Map.Entry나 적절한 componentN 함수가 있는 기타 타입)의 파라미터를 가지는 경우, 파라미터를 괄호 안에 넣어 하나 대신 여러 개의 새로운 파라미터로 대체할 수 있습니다:

map.mapValues { entry -> "${entry.value}!" }
map.mapValues { (key, value) -> "$value!" }

파라미터 두 개를 선언하는 것과 파라미터 대신 구조 분해 쌍을 선언하는 것의 차이점에 유의하세요:

{ a -> ... } // 파라미터 한 개
{ a, b -> ... } // 파라미터 두 개
{ (a, b) -> ... } // 구조 분해된 쌍(pair)
{ (a, b), c -> ... } // 구조 분해된 쌍과 또 다른 파라미터

구조 분해된 파라미터의 특정 컴포넌트를 사용하지 않는 경우, 이름을 지어내는 대신 언더스코어로 대체할 수 있습니다:

map.mapValues { (_, value) -> "$value!" }

전체 구조 분해 파라미터에 대한 타입을 지정하거나 특정 컴포넌트에 대해 개별적으로 타입을 지정할 수 있습니다:

map.mapValues { (_, value): Map.Entry<Int, String> -> "$value!" }

map.mapValues { (_, value: String) -> "$value!" }

Experimental

이름 기반 구조 분해

Kotlin은 이름 기반 구조 분해 선언(name-based destructuring declarations)을 지원합니다. 이 방식에서는 위치 기반(position-based) 구조 분해에서 componentN() 함수에 의해 정의된 위치 대신, 이름에 따라 변수가 프로퍼티와 매칭됩니다.

이름 기반 구조 분해에 대한 자세한 내용은 해당 기능의 KEEP을 참조하세요.

위치 기반 구조 분해에서 변수는 componentN() 함수의 순서에 대응합니다. 예를 들면 다음과 같습니다:

data class User(val username: String, val email: String)

fun main() {
    val user = User("alice", "[email protected]")

    val (email, username) = user

    println(email)
    // alice

    println(username)
    // [email protected]
}

이 예제에서는 구조 분해가 componentN() 함수의 순서에 의존하기 때문에, email 변수에는 username 값이 할당되고 username 변수에는 email 값이 할당됩니다.

이름 기반 구조 분해를 사용하면 componentN() 함수의 위치가 아니라 프로퍼티 이름에 따라 추출할 값이 결정됩니다:

fun main() {
    val user = User("alice", "[email protected]")

    // 명시적 형태(explicit form)의 이름 기반 구조 분해 사용
    (val mail = email, val name = username) = user

    println(name)
    // alice

    println(mail)
    // [email protected]
}

이름 기반 구조 분해는 실험적(Experimental) 기능입니다. 이 기능을 활성화하면 대괄호([])를 사용하는 위치 기반 구조 분해를 위한 새로운 구문도 도입됩니다. 리스트나 다른 순서가 있는 컬렉션처럼 요소의 순서가 중요한 타입, 또는 Pair나 Triple과 같이 이름이 없는 튜플(tuple)에 대해서는 이 구문을 사용하세요:

val point = Pair(10, 20)

// 위치 기반 구조 분해 사용
val [x, y] = point

-Xname-based-destructuring 컴파일러 옵션을 사용하여 컴파일러가 구조 분해 선언을 해석하는 방식을 제어할 수 있습니다.

다음과 같은 모드가 있습니다:

• only-syntax: 기존 구조 분해 선언의 동작을 변경하지 않고 명시적 형태의 이름 기반 구조 분해만 활성화합니다.
• name-mismatch: 데이터 클래스의 위치 기반 구조 분해에서 변수 이름이 프로퍼티 이름과 일치하지 않을 때 경고를 보고합니다.
• complete: 소괄호를 사용하는 단축형(short-form) 이름 기반 구조 분해를 활성화하며, 대괄호 구문을 통한 위치 기반 구조 분해를 계속 지원합니다.

complete 모드를 활성화하기 전에 name-mismatch 모드에서 보고된 경고를 검토하고 해결하세요. 이러한 경고는 complete 모드에서 컴파일러가 다르게 해석하게 될 구조 분해 선언을 보여주며, 해당 선언을 적절하게 다시 작성하기 위한 제안을 포함합니다.

complete 모드를 사용하면 소괄호를 사용하는 단축형 구조 분해 구문은 위치에 의존하는 대신 변수를 프로퍼티 이름과 매칭합니다:

val (email, username) = user

프로젝트에서 이름 기반 구조 분해를 활성화하려면 빌드 구성 파일에 컴파일러 옵션을 추가하세요:

GradleMaven

kotlin {
    compilerOptions {
        freeCompilerArgs.add("-Xname-based-destructuring=only-syntax")
    }
}

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <configuration>
                <args>
                    <arg>-Xname-based-destructuring=only-syntax</arg>
                </args>
            </configuration>
        </plugin>
    </plugins>
</build>