[Kotlin] Scope functions (let, with, run, apply, also) 이해

Scope functions 이란?

  코틀린으로 개발을 하면서 여러 Scope function들을 사용하였지만, 사용하면서도 제대로 사용하고 있는지 의구심이 들 때도 많았고 상황에 따라 어떤 Scope function들을 사용하는게 좋을지 고민이 많았습니다. 공식문서를 보고 제대로 공부하기로 마음을 먹었고 공식문서를 토대로 개발 경험과 함께 글을 작성해보려고 합니다.
  먼저, Scope function은 5개로 let, with, run,apply, also 가 코틀린의 표준 라이브러리에 포함되어 있습니다. Scope function은 말 그대로 범위(Scope)가 생기는데 해당 범위는 특정 객체의 컨텍스트를 가지고 일련의 동작을 포함하는 함수입니다. Scope function은 람다식과 동일하게 작성을 하며, 인스턴스에 해당하는 변수 없이 내부 변수나 메소드들을 접근할 수 있습니다. 

 

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

  해당 코드는 Scope function을 사용하지 않고 작성한 코드로 객체를 특정 변수에 대입을 한 후 해당 변수를 통해서 메소드들을 호출하는 모습들을 확인할 수 있습니다. 

 

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

  다음은 Scope function 중 하나인 let 함수를 사용하여 동일한 결과가 나올 수 있도록 작성한 코드입니다. 자세한 비교는 아래에서 하겠지만 Scope function을 사용하지 않았을 때보다 가독성이 있으며, 새로운 변수들을 생성하고 해당 변수들로 메소드를 호출하는 게 아닌 it 이라는 것을 사용하는 것을 확인할 수 있습니다.

 

 

Scope function 비교

  각 Scope function들을 서술하기 전에 공통점이 무엇이고, 차이점을 확인하기 위해서 어떤 점을 집중적으로 확인하면 되는지 설명하겠습니다. 일단 Scope function은 특정 객체의 컨텍스트를 가지는 범위(Scope)를 생성하여  범위 내의 코드들을 실행하는 것이 공통적인 목적입니다. 하지만 함수들마다 차이가 조금씩 존재하는데 첫 번째로는 범위 내에서 객체의 컨텍스트를 접근하는 방법과 Scope function의 반환값에서 차이가 발생합니다. 2가지 차이점을 중점으로 각 함수들이 어떻게 동작을 하고 활용되는지 확인해보면 좋습니다.

 

let

/**
 * Calls the specified function [block] with `this` value as its argument and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#let).
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block(this)
}

  다음은 let 함수를 정의하는 코드입니다. let은 T 라는 Generic 객체의 확장함수로 정의되어 있으며 block 이라는 함수를 매개변수로 받아서 호출하는 코드입니다. block 함수는 T 를 매개변수로 받고 R을 리턴하는 함수입니다. 정의로만 보면 정확하게 알기 어려워서 예제와 같이 설명하도록 하겠습니다.

 

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

  Kotlin 공식 문서의 예제를 통해 알아보겠습니다. 간단하게 let 함수를 사용하기 전까지 코드를 설명하자면 numbers의 리스트를 map 함수를 통해 문자열의 길이를 담는 리스트 {3,3,5,4,4} 로 변형하게 됩니다. 이후 filter 함수로 값이 3 이상으로만 필터링하게 되어 {5,4,4} 로 변형됩니다. 

 let 함수에서 람다표현식으로 표현이 된 식이 block 함수가 되고 T 매개변수는 리스트가 해당이 되고 R은 마지막 코드인 println의 리턴값인 Unit이 됩니다. block 함수에서 리스트 컨텍스트 접근하기 위해서는 it 이라는 기본값을 사용하며 커스텀하게 변경할 수 있습니다.

 

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은 주로 non-null 변수와 함께 사용하여 null check와 동시에 원하는 메소드를 실행하도록 합니다. ?. 연산자를 사용하여 null이면 실행하지 않도록 하고 null이 아니면 let 함수를 실행하도록 하여 null check를 할 수 있습니다.  저 또한 let 함수는 대부분 null check하면서 non-null이면 특정 메소드들을 실행하도록 사용합니다. 

 

정리를 하자면, 다음과 같이 정리할 수 있습니다.

 

• Scope 내에서 해당 컨텍스트 객체를 접근하기 위해서는 it 이라는 매개변수 사용, 커스텀하게 변경 가능
• 반환 값은 block 함수의 반환 값
• null check와 함께 block 함수를 실행하기 위해 사용

 

with

/**
 * Calls the specified function [block] with the given [receiver] as its receiver and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#with).
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> with(receiver: T, block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return receiver.block()
}

  다음은 with 함수를 정의하는 코드입니다. with은 let과 다르게 확장함수로 정의되어 있지 않고 T 와 block 함수를 매개변수로 받아 호출하는 코드입니다. block 함수는 T 컨텍스트 내에 정의된 함수로 R을 리턴하는 함수입니다. 마찬가지로 예제와 함께 부가 설명을 하겠습니다.

 

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

  주로 with 함수는 반환 값을 특정 변수에 대입하지 않고 매개변수로 대입된 T 컨텍스트 내의 메소드들이 연속적으로 실행하도록 합니다. 위의 예제에서는 numbers가 T 에 해당되고, block 함수는 람다표현식으로 작성이 가능하여 블럭 내에 여러 메소드들이 정의되어 있습니다. block은 해당 객체 컨텍스트를 this로 접근이 가능하고, 그외 멤버변수 또는 메소드들은 직접 접근이 가능합니다.

 

val numbers = mutableListOf("one", "two", "three")
val firstAndLast = with(numbers) {
    "The first element is ${first()}," +
    " the last element is ${last()}"
}
println(firstAndLast)

  다른 방식으로는 해당 객체를 받아 새로운 변수를 생성하는데 사용할 수 있습니다. numbers를 매개변수로 받아 first와 last의 메소드들을 사용하여 하나의 문자열을 리턴하는 함수로 사용하였습니다.

 

정리를 하자면, 다음과 같이 정리할 수 있습니다.

 

• Scope 내에서 해당 컨텍스트 객체를 접근하기 위해서는 this 직접 사용
• 반환 값은 block 함수의 반환 값
• T 매개변수를 받아 해당 컨텍스트 내의 메소드들을 연속적으로 호출하는데 주로 사용

 

run

/**
 * Calls the specified function [block] with `this` value as its receiver and returns its result.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#run).
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.run(block: T.() -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    return block()
}

 다음은 run 함수를 정의하는 코드입니다. with과 비슷하게 block 함수가 T 컨텍스트 내에 정의된 함수로 block의 리턴값이 R로 반환이 됩니다. 하지만 run 함수는 let과 동일하게 T 의 확장함수로 정의되어 있습니다. 

 

val service = MultiportService("https://example.kotlinlang.org", 80)

val result = service.run {
    port = 8080
    query(prepareRequest() + " to port $port")
}

// the same code written with let() function:
val letResult = service.let {
    it.port = 8080
    it.query(it.prepareRequest() + " to port ${it.port}")
}

 run 함수는 주로 객체를 초기화와 동시에 원하는 결과가 리턴값으로 필요할 때 유용합니다. run 함수에서는 T 컨텍스트를 this로 직접 접근이 가능하며 멤버변수, 메소드 또한 직접 접근할 수 있습니다. 또한, run은 확장 함수가 아닌 with과 같이 객체의 컨텍스트 없이 호출할 수 있는데 이 때는 내부의 메소드들을 실행 후 반환값을 전달하는 역할만 하게 됩니다. 따로 예제로 다루진 않고 kotlin 공식 문서에서 확인할 수 있습니다.

 

정리를 하자면, 다음과 같이 정리할 수 있습니다.

 

• Scope 내에서 해당 컨텍스트 객체를 접근하기 위해서는 this 직접 사용
• 반환 값은 block 함수의 반환 값
• 객체의 초기화와 동시에 반환 값이 필요할 때 주로 사용

 

apply

/**
 * Calls the specified function [block] with `this` value as its receiver and returns `this` value.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#apply).
 */
@kotlin.internal.InlineOnly
public inline fun <T> T.apply(block: T.() -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block()
    return this
}

  다음은 apply 함수를 정의하는 코드입니다. 위에서 설명한 let, with, run과는 다르게 block 함수의 반환값은 없습니다. apply 함수는 block 함수를 매개변수로 받아 T 컨텍스트 내에서 원하는 동작을 한 후 T 객체를 다시 반환하는 함수입니다. 

 

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

  apply가 해당 객체를 다시 반환해주기 때문에 주로 객체를 초기화하는데 사용합니다. builder 패턴과 유사하게 apply 함수로 멤버변수들을 초기화한 후 반환된 객체로 특정 변수에 대입하거나 원하는 기능을 연속적으로 호출할 수 있습니다. this로 T 컨텍스트 객체를 접근할 수 있습니다. 

 

정리를 하자면, 다음과 같이 정리할 수 있습니다.

 

• Scope 내에서 해당 컨텍스트 객체를 접근하기 위해서는 this 직접 사용
• 반환 값은 컨텍스트 객체 
• 주로 객체의 초기화할때 사용

 

also

/**
 * Calls the specified function [block] with `this` value as its argument and returns `this` value.
 *
 * For detailed usage information see the documentation for [scope functions](https://kotlinlang.org/docs/reference/scope-functions.html#also).
 */
@kotlin.internal.InlineOnly
@SinceKotlin("1.1")
public inline fun <T> T.also(block: (T) -> Unit): T {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    block(this)
    return this
}

  다음은 also 함수를 정의하는 코드입니다. also는 T 의 확장함수로 정의되어 있으며 block 함수를 매개변수로 받아 호출하게 됩니다. apply와 동일하게 block 함수의 반환 값이 없으며 원하는 동작 후 해당 객체를 다시 리턴하는 함수입니다.

 

val numbers = mutableListOf("one", "two", "three")
numbers
    .also { println("The list elements before adding new one: $it") }
    .add("four")

  also는 T 에 해당하는 컨텍스트 객체를 받아 원하는 동작을 하도록 메소드를 작성합니다. 기존 객체를 초기화는 apply 를 주로 사용하고 그 외 부가적인 작업은 also 함수를 사용합니다. 위의 예제에서는 also 함수로 원하는 문자열을 출력을 한 후 해당 객체를 다시 반환하여 add 하도록 작성되어 있습니다.

 

정리를 하자면, 다음과 같이 정리할 수 있습니다.

 

• Scope 내에서 해당 컨텍스트 객체를 접근하기 위해서는 it 이라는 매개변수 사용, 커스텀하게 변경 가능
• 반환 값은 컨텍스트 객체
• 객체의 추가적인 작업을 할 때 사용

 

 

정리

https://kotlinlang.org/docs/scope-functions.html#function-selection

 5가지의 Scope function을 정리해보면 다음과 같습니다. 위에서 언급했듯이 객체에 대한 참조 방식과 반환 값이 다르고 해당 함수가 확장함수로 정의되거나 객체를 매개변수로 받은 함수로 정의되어 있다는 것이 큰 차이입니다.

 

 

 

 

참고

• https://kotlinlang.org/docs/scope-functions

Scope functions | Kotlin