[Kotlin] - 적절한 Scope Function 선택하기!

Kotlin 표준 라이브러리에서 객체의 컨텍스트 안에서 특정 블록의 코드를 실행하는 것이 목적인 함수가 포함되어 있다. Kotlin에서는 Scope Functions을 제공하고 목적에 맞게 선택하는 것을 권장한다.

나는 대부분 만능에 가까운 let을 사용했고, Scope Function을 선택하는 기준을 모르고 있었다. 해당 포스팅은 공식문서 기반으로 Scope Function을 선택하는 기준에 대한 내용이다.

Spec

다음은 각 Scope Function에 대해 정리한 것이다.

Function	참조 객체	반환값	확장함수 여부
let	it	Lambda result	Y
run	this	Lambda result	Y
run	-	Lambda result	N: 객체 Context 밖에서 실행된다.
with	this	Lambda result	N: 객체 Context를 인수로 사용한다.
apply	this	Context object	Y
also	it	Context object	Y

사용 용도

공식 문서에서 정의한 각 Scope Function의 용도는 아래와 같다.

• let:
  • nullable이 아닌 객체에 대한 람다 실행
  • 로컬 볌위의 변수로 표현식을 도입한다.
• apply
  • 객체를 설정한다.
•  run
  
  • 객체를 생성하고, 특정 동작을 수행한다.
  • 표현식이 필요한 동작 수행
• also
  • 부가적인 효과
• with
  • 객체의 함수 그룹핑

Scope Function을 사용하면 코드가 간결해질 수 있고, Kotlin을 잘 사용하는 듯한 느낌이 들 수 있다.

하지만 공식문서에서는 Scope Function은 코드를 읽기 어렵게 만들고, 현재 Context의 객체와 this, it의 혼동으로 인한 오류를 야기할 수 있다고 한다. Scope Function의 중첩은 피하고 연결 시 충분히 주의를 해야 한다.

코틀린의 Scope Function의 가장 큰 2개의 차이는 다음과 같다.

1. Context Object
2. Return Value

해당 2가지로 Scope Function을 선택하면 된다.

기준 1. Context Object

Scope Function에 전달된 람다 내에서 Context Object에는 Reference로 접근할 수 있는 방법을 제공한다.

이때 Scope Function에 따라 아래 두 가지 방법이 있다.

1. Lambda receiver - this
2. Lambda argument - it

아래 코드를 보자.

fun main() {
    val str = "Hello"

    str.run {
        println("The string's length: $length")
    }

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

run의 경우 Lambda receiver를 사용하고 있고, let의 경우에는 Lambda argument를 사용하고 있다.

Lambda receiver

run, with, apply에서는 Lambda receiver를 사용해서 Context Object에 접근한다.

Lambda Receiver의 경우에는 대부분 this를 생략해서 코드를 더 짧게 만들 수 있다. 그래서 외부 객체와의 구별에 주의해야 한다.

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

특정 객체의 기능을 호출하거나 필드에 값을 할당하는 동작에서는 Lambda receiver를 사용하는 것이 좋다.

Lambda argument

let, also의 경우는 Lambda argument를 사용한다. 인수의 이름은 지정할 수 있으며 기본적으로 it이 사용된다.

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

객체가 자주 사용되거나 특정 함수의 인수로 사용될 때는 Lambda argument를 사용하는 것을 권장한다.

기준 2. Return Value

Lambda receiver를 사용할 지 Lambda argument를 사용할 지 정했으면 Return 값에 맞게 선택하면 된다.

• apply, also는 Context Object를 반환한다.
• let, run, with은 Lambda Result를 반환한다.

Scope Function을 선택을 할 때는 첫 번째로 Context Object를 필요에 따라 선택하고, 이후에 Retrun Value를 선택하면 된다.

let의 경우 대부분 모든 상황에서 사용할 수 있다. 그렇지만 적절한 Scope Function을 선택하면 코드의 가독성을 증대시키고 혼동을 줄일 수 있다.

코드 예시

let

let은 Lambda argument를 사용하고 Lambda result를 반환한다.

let은 특히나 거의 대부분의 용도로 사용할 수 있기에 더 주의해야 한다. let은 아래와 같이 Lambda argument가 특정 함수의 인자로 사용할 경우 유용하게 사용할 수 있다.

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

let은 인수가 null이 아닌 경우에 사용하길 권장한다. 그래서 Safe call operator ?.와 같이 사용하는 경우가 많다.

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

with

with은 Lambda receiver를 사용하고, Lambda result를 반환한다.

with은 반환된 결과를 사용할 필요가 없을 때 사용하기를 권장한다.

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

with는 with this object, do the following의 의미를 가지고 있다. 즉, object를 사용해서 후속 작업을 하는 경우에 유용하다.

run

run은 Lambda receiver를 사용하고, Lambda result를 반환한다. with와 매우 유사하지만 run은 확장 함수라는 차이가 있다.

run은 객체를 초기화하고 연산 결과를 반환할 때 사용한다.

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

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

apply

apply는 Lambda receiver를 사용하고, 해당 객체를 반환한다.

apply는 값을 반환하지 않고, receiver를 위주로 동작하는 코드에서 사용하길 권장한다.

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

also

also는 Lambda argument를 사용하고, 해당 객체를 반환한다.

also는 인수에 대한 추가적인 동작이 있을 때 사용한다.

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

apply와 차이는 Context Object가 Receiver(this)인지 Argument(it)인지의 차이이며, 앞서 설명했듯 객체의 필드 위주로 사용되면 전자, 해당 객체를 입력으로 동작을 시키는 경우 후자를 선택하면 된다.

번외 - takeIf, takeUnless

Scope Functions 이외에도 표준 라이브러리에 takeIf와 takeUnless가 있다.

takeIf나 takeUnless를 사용하면 특정 조건에 맞는 데이터 또는 NULL을 반환합니다. 즉, 반환 타입은 XClass?가 되는 것입니다.

val number = Random.nextInt(100)

val evenOrNull = number.takeIf { it % 2 == 0 }
val oddOrNull = number.takeUnless { it % 2 == 0 }
println("even: $evenOrNull, odd: $oddOrNull")

단일 객체에 대한 filter라고 생각하면 된다. 주로 아래와 같이 ?.let과 같이 사용하는 경우가 많다.

fun displaySubstringPosition(input: String, sub: String) {
    input.indexOf(sub).takeIf { it >= 0 }?.let {
        println("The substring $sub is found in $input.")
        println("Its start position is $it.")
    }
}

참고

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