Kotlin Scope Functions

Published: October 28, 2019 by JAEHO

Categories:
Kotlin 1

Scope Functions

Kotlin 표준라이브러리에는 객체 컨텍스트 내에서 코드 블록을 실행하는 것이 유일한 목적인 여러 함수가 포함되어 있습니다. 람다식이 제공된 객체에서 이러한 함수를 호출하면 임시 범위가 형성됩니다. 이 범위에서 이름없이 개체에 접근 할 수 있습니다. 이러한 기능을 범위 기능(Scope Functions)라고 합니다. 여기에는 다섯가지 함수가 있습니다. let, run, with, apply, also

기본적으로, 다섯가지 함수들은 동일한 기능을 수행합니다. 객체에서 코드 블록을 실행합니다. 다른 점은이 객체가 블록 안에서 어떻게 사용 가능해지고 전체 표현식의 결과가 달라진다는 것입니다.

스코프 함수의 일반적인 사용법

fun main() {
    Person("Alice", 20, "Amsterdam").let {
        println(it)
        it.moveTo("London")
        it.incrementAge()
        println(it)
    }
}

스코프 함수 없이 작성

val alice = Person("Alice", 20, "Amsterdam")
println(alice)
alice.moveTo("London")
alice.incrementAge()
println(alice)

스코프 함수는 새로운 기술 기능을 도입하지 않지만 코드를보다 간결하고 읽기 쉽게 만들 수 있습니다.

특징(Distinctions)

스코프 기능은 본질적으로 매우 유사하기 때문에 그 기능의 차이점을 이해하는 것이 중요합니다. 각 스코프 기능에는 두 가지 주요 차이점이 있습니다.

컨텍스트 객체를 참조하는 방법
반환값

컨텍스트 객체 참조는 this 또는 it

범위 함수의 람다 내에서 컨텍스트 오브젝트는 실제 이름 대신 짧은 참조로 사용 가능합니다. 각 범위 함수는 컨텍스트 오브젝트에 액세스하는 두 가지 방법 중 하나를 사용합니다. : 람다 receiver(this) 또는 람다 argument (it). 둘 다 동일한 기능을 제공하므로 서로 다른 경우에 대한 각각의 장단점을 설명하고 사용에 대한 권장 사항을 제공합니다.

fun main() {
    val str = "Hello"
    // this
    str.run {
        println("The receiver string length: $length")
        //println("The receiver string length: ${this.length}") // does the same
    }

    // it
    str.let {
        println("The receiver string's length is ${it.length}")
    }
}

this

run, with 및 apply는 컨텍스트 객체를 람다 receiver로 참조합니다. 따라서 람다에서 객체는 일반 클래스 함수에서와 같이 사용할 수 있습니다. 대부분의 경우 receiver 오브젝트의 멤버에 액세스 할 때 this 생략하여 코드를 더 짧게 만들 수 있습니다. 한편, this가 생략되면, receiver 부재와 외부 물체 또는 기능을 구별하기가 어려울 수있다. 따라서 컨텍스트 객체를 receiver (this)로 갖는 것은 객체 객체에서 주로 작동하는 람다에 권장됩니다. 함수를 호출하거나 속성을 할당하십시오.

val adam = Person("Adam").apply { 
    age = 20                       // same as this.age = 20 or adam.age = 20
    city = "London"
}

it

let 과 also는 컨텍스트 객체를 람다 인수로 사용합니다. 인수 이름을 지정하지 않으면 내재 된 기본 이름 it으로 오브젝트에 액세스합니다. it은 this보다 짧으며 일반적으로 it표현식이 읽기 쉽습니다. 그러나 객체 함수 또는 속성을 호출 할 때 this와 같이 암시 적으로 사용 가능한 객체가 없습니다. 따라서 객체를 함수 호출에서 인수로 사용하는 경우 컨텍스트 객체를 it'으로하는 것이 좋습니다. 코드 블록에 여러 변수를 사용하는 경우 it도 좋습니다.

fun getRandomInt(): Int {
    return Random.nextInt(100).also {
        writeToLog("getRandomInt() generated value $it")
    }
}

val i = getRandomInt()
// INFO: getRandomInt() generated value 55

또한 컨텍스트 개체를 인수로 전달할 때 범위 내에서 컨텍스트 개체의 사용자 지정 이름을 제공 할 수 있습니다.

fun getRandomInt(): Int {
    return Random.nextInt(100).also { value ->
        writeToLog("getRandomInt() generated value $value")
    }
}

val i = getRandomInt()

Return value

범위 함수는 반환 결과에 따라 다릅니다.

apply및 also컨텍스트 개체를 반환합니다.
let,run 및with는 람다 결과를 반환합니다.

이 두 가지 옵션을 사용하면 코드에서 다음에 수행 할 작업에 따라 적절한 기능을 선택할 수 있습니다.

컨텍스트 객체(Context object)

apply와also의 반환 값은 컨텍스트 객체 자체입니다. 따라서 이러한 단계는 호출 단계에 부가 단계로 포함될 수 있습니다. 함수 호출은 이후에 동일한 객체에서 함수 호출을 계속 연결할 수 있습니다. 따라서, 그것들은 부가 단계(side step)로서 콜 체인에 포함될 수 있습니다. 동일한 객체에서 함수 호출을 계속 연결 할 수 있습니다.

val numberList = mutableListOf<Double>()
numberList.also { println("Populating the list") }
    .apply {
        add(2.71)
        add(3.14)
        add(1.0)
    }
    .also { println("Sorting the list") }
    .sort()

Populating the list
Sorting the list
[1.0, 2.71, 3.14]

컨텍스트 객체를 반환하는 함수의 return 문에도 사용할 수 있습니다.

import kotlin.random.Random

fun writeToLog(message: String) {
    println("INFO: $message")
}

fun main() {
    fun getRandomInt(): Int {
        return Random.nextInt(100).also {
            writeToLog("getRandomInt() generated value $it")
        }
    }

    val i = getRandomInt()
}

INFO: getRandomInt() generated value 3

람다 결과(Lambda result)

let, run및 with는 람다 결과를 반환합니다. 따라서 결과를 변수에 할당하거나 결과에 대한 체인 작업 등을 수행 할 때 사용할 수 있습니다.

val numbers = mutableListOf("one", "two", "three")
val countEndsWithE = numbers.run { 
    add("four")
    add("five")
    count { it.endsWith("e") }
}
println("There are $countEndsWithE elements that end with e.")

There are 3 elements that end with e.

또한 반환 값을 무시하고 범위 함수를 사용하여 변수의 임시 범위를 만들 수 있습니다.

val numbers = mutableListOf("one", "two", "three")
with(numbers) {
    val firstItem = first()
    val lastItem = last()        
    println("First item: $firstItem, last item: $lastItem")
}

First item: one, last item: three

Functions

사례에 적합한 스코프 기능을 선택하는데 도움을 드리기 위해 해당 기능을 자세히 설명하고 사용 권장 사항을 제공합니다. 기술적으로 함수는 여러 경우에 상호 교환이 가능하므로 예제는 일반적인 사용 스타일을 정의하는 규칙을 보여줍니다.

let

컨텍스트 오브젝트는 인수 (it)로 사용 가능합니다. 반환 값은 람다 결과입니다.

let은 콜 체인의 결과에서 하나 이상의 함수를 호출하는 데 사용될 수 있습니다. 예를 들어 다음 코드는 컬렉션에 대한 두 작업의 결과를 인쇄합니다.

numbers = mutableListOf("one", "two", "three", "four", "five")
val resultList = numbers.map { it.length }.filter { it > 3 }
println(resultList)

[5, 4, 4]

With let, you can rewrite it:

val numbers = mutableListOf("one", "two", "three", "four", "five")
numbers.map { it.length }.filter { it > 3 }.let { 
    println(it)
    // and more function calls if needed
}

[5, 4, 4]

코드 블록에 인수로 단일 함수가 포함 된 경우 람다 대신 메소드 참조 (: :)를 사용할 수 있습니다.

val numbers = mutableListOf("one", "two", "three", "four", "five")
numbers.map { it.length }.filter { it > 3 }.let(::println)

[5, 4, 4]

let은 종종 널이 아닌 값으로 만 코드 블록을 실행하는 데 사용됩니다. 널이 아닌 오브젝트에서 조치를 수행하려면 세이프 콜 연산자?.를 사용하십시오.

val str: String? = "Hello"   
//processNonNullString(str)       // compilation error: str can be null
val length = str?.let { 
    println("let() called on $it")        
    processNonNullString(it)      // OK: 'it' is not null inside '?.let { }'
    it.length
}

let() called on Hello

let을 사용하는 또 다른 경우는 코드 가독성을 향상시키기 위해 제한된 범위의 지역 변수를 도입하는 것입니다. 컨텍스트 객체의 새 변수를 정의하려면 기본 'it'대신 사용할 수 있도록 이름을 람다 인수로 제공하십시오.

val numbers = listOf("one", "two", "three", "four")
val modifiedFirstItem = numbers.first().let { firstItem ->
    println("The first item of the list is '$firstItem'")
    if (firstItem.length >= 5) firstItem else "!" + firstItem + "!"
}.toUpperCase()
println("First item after modifications: '$modifiedFirstItem'")

The first item of the list is 'one'
First item after modifications: '!ONE!'

with

비 확장 기능: 컨텍스트 객체는 인수로 전달됩니다. 그러나 람다 안에서는 receiver로 사용할 수 있습니다 (this).