Scope Function (범위 지정 함수) with let, run, with, apply, also

📚 범위 지정 함수란?

---

Kotlin의 표준 라이브러리에는 개체의 컨텍스트 내에서 코드 블록을 실행하는 것이 목적인 여러 범위 지정 함수들이 있다. 람다 식이 있는 개체에서 이러한 함수를 호출하면 임시 범위가 형성되고 이런 범위에서는 이름 없이 객체에 액세스할 수 있다. 이러한 범위 함수의 종류로는 let, run, with, apply, also의 다섯 가지가 있다.

 

기본적으로 범위 함수들은 동일한 목적을 가지고 작업을 수행한다. 다른 점은 이 개체가 블록 내에서 사용 가능하게 되는 방식이 전체 표현식의 결과이다. 이런 이유로 하나의 범위 함수를 고르는 것은 힘든 일이다. 이제부터 범위 기능과 해당 규칙의 차이점에 대한 자세한 설명을 제공하겠다.

 

 

 

범위 함수 요약

 

위의 테이블은 범위 함수의 차이점들을 나타낸 테이블이다. 가장 눈에 띄는 것은 Object reference는 it과 this로 나뉘어져 있고 Return value는 Lambda result와 Context object가 있다는 것이다.

 

 

 

🤼‍♂️ 범위 지정 함수들을 구변하는 방법

---

범위 지정 함수의 차이를 아는 것은 각 상황에 어떤 범위 지정 함수를 사용해야 하는지 아는 가장 좋은 방법이다. 각 범위 지정 함수들간엔 위에서 보았듯이 2개의 차이가 존재한다.

 

 1. Context Object (컨텍스트 개체)를 참조하는 방식

 2. 반환 값

 

 

Context Object (컨텍스트 개체)를 참조하는 방식

범위 지정 함수 내에서 컨텍스트 개체는 실제 이름 대신 짧은 참조로 사용할 수 있다. 각 범위 지정 함수는 컨텍스트 개체를 참조하기 위해 람다 수신자(this) 또는 람다 인수 (it) 두 가지 방법 중 하나를 사용한다. 둘의 기능은 동일하다.

 

fun main() {
    val str = "Hello"
    // this
    str.run {
        println("The string's length: $length")
        // this는 생략 가능하다.
        //println("The string's length: ${this.length}") 
    }

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

 

 

this

대부분의 상황에서 'this'는 생략 가능하다. 하지만 'this'를 생략하면 수신 멤버와 외부 객체를 구분하기 어려울 수 있다. 따라서 함수를 호출하거나 속성에 값을 할당하여 수신 멤버에게 작동하는 람다의 경우 'this'를 생략하지 않는 것이 좋다. run, with, apply가 'this'를 사용해 컨텍스트 개체를 참조하고 있다.

 

it

'it'은 인수 이름이 지정되지 않는 경우 default 값을 'it'으로 설정한다. 하지만 개체의 함수나 속성을 호출할 때 'this'와 같이 암시적으로 개체를 사용할 수 없다. 따라서 객체를 함소 호출의 인수로 주로 사용할 때는 'it'을 통해 컨텍스트 객체에 접근하는 것이 좋다. 코드 블록에서 여러 변수를 사용할 때도 'it'을 사용하는 것이 좋다.  let, also가 'it'를 사용해 컨텍스트 개체를 참조하고 있다.

---

 

 

반환 값

범위 지정 함수들이 반환하는 값은 2가지로 나뉜다. 컨텍스트 개체와 람다 결과이다. 다음에 수행할 작업에 따라 원하는 반환 값을 신중하게 고려해야 하며 이는 사용할 최상위 범위 기능을 선택하는데 도움이 된다.

 

 

Context object

apply와 also의 반환 값은 컨텍스트 객체 자체이다. 따라서 이들은 동일한 객체에 대해 연이어 함수 호출을 계속할 수 있다.

 

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

println(numberList)


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

 

 

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.")

 

 

 

🎈 범위 지정 함수

---

let

'let'은 'it'으로 컨택스트 개체를 참조하며 람다 결과를 반환한다.

 

'let' 은 호출 체인의 결과에 대해 하나 이상의 함수를 호출하는 데 사용할 수 있다. 아래의 예시는 String으로 된 numbers 리스트에서 문자열의 길이가 3 초과인 number만 출력하는 코드이다. 

 

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

 

위의 코드의 단점은 바로 'resultList'라는 변수가 오직 출력을 위해 사용되고 있다는 것이다. 또한 가독성 또한 떨어진다. 이제 'let'을 사용해 보겠다.

 

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

 

우린 이제  'resultList'라는 변수를 사용하지 않고 결과를 출력할 수 있다. 'let'의 가장 큰 장점은 바로 null이 될 수 있는 객체에 사용할 수 있다는 것이다. 

 

val str: String? = "Hello"   
val length = str?.let { 
    println("let() called on $it")        
    it.length
}

 

위의 length는 str이 null이 아닐 때만 값이 할당되게 된다.

 

 

with

'with'은 'this'으로 컨택스트 개체를 참조하며 람다 결과를 반환한다.

 

'with'은 다른 범위 지정 함수들과는 다른 점이 있다. 바로 확장 함수가 아니라는 것이다. 따라서 반환된 결과를 사용할 필요가 없을 때 컨텍스트 객체의 함수를 호출하기 위해 'with'을 사용하는 것이 좋다. 

 

'with'은 "이 객체와 함께 다음 행동을 수행한다" 로 해석할 수 있다.

 

val numbers = mutableListOf("one", "two", "three")
with(numbers) {
    println("'with' is called with argument $this")
    println("It contains $size elements")
}

 

 

run

'run'은 'this'으로 컨택스트 개체를 참조하며 람다 결과를 반환한다.

 

'run'은 확장 함수로 구현된 'with'이라고 할 수 있다. 또한 'run'은 람다가 객체를 초기화하고 반환 값을 계산하는 경우에 유용하다. 따라서 'run'을 사용하면 초기화와 반환 값을 동시에 수행할 수 있다.

 

data class Person(val name: String, var age: Int)

fun main() {
    val person = Person("John", 30)

    person.run {
        println("Name: $name, Age: $age")

        age += 1
        println("Updated Age: $age")
    }
}

 

'run'은 비-확장 함수로 사용할 수 있다. 'with'의 확장 함수 버전이 'run' 이기에 'run'을 비-확장 함수로 사용하면 'with'이라고 생각할 수 있지만, run은 따로 컨택스트 객체를 가지지 않고 오직 람다 결과만을 반환한다.

 

val message = "Hello, Kotlin!"

val result = run {
    val formattedMessage = message.toUpperCase()
    val reversedMessage = formattedMessage.reversed()
    "Final message: $reversedMessage"
}

println(result)

 

 

apply

'apply'은 'this'으로 컨택스트 개체를 참조하며 컨텍스트 객체 자체를 반환한다.

 

'apply'는 컨텍스트 객체 자체를 반환하기 때문에, 반환 값을 갖지 않고 주로 수신자 객체의 멤버에 작용하는 코드 블록에 사용하는 것이 권장된다. 'apply'의 객체를 구성할 때 가장 많이 사용된다.

 

'apply'는 "다음 할당을 객체에 적용한다"로 해석할 수 있다.

 

val adam = Person("Adam").apply {
    age = 32
    city = "London"        
}
println(adam)

 

 

also

'also'은 'it'으로 컨택스트 개체를 참조하며 컨텍스트 객체 자체를 반환한다.

 

'also'는 컨텍스트 객체를 인수로 받아 일부 동작을 수행하는 데 유용하다. 'also'를 사용하여 속성이나 함수가 아닌 객체에 대한 참조가 필요한 동작이나 외부 범위에서의 'this' 참조를 가려주고 싶지 않을 때 사용할 수 있다.

 

 'also'는 "그리고 또한 객체와 함께 다음을 수행한다"로 해석할 수 있다.

 

 

 

Reference

Scope functions | Kotlin