Kotlin - Scope functions (let, with, run, apply, also)

코틀린을 사용하면서 항상 헷갈렸던 Scope functions 에 대해 정리해 보고자 합니다.

 

코틀린을 사용하다 보면 굉장히 자주 접하고 사용할 개념들이기에 이번 기회에 확실히 정리하고, 어떤 상황에 어떤 함수를 사용하는 것이 적합할지 정확히 파악하는 것이 목표입니다.

 

Scope functions

기본적으로 Scope functions는, 코드 블록을 실행하는 특정 객체에 대해 동일한 작업을 수행합니다.

일부는 람다 표현식이 제공되고, 객체의 이름을 사용하지 않고도 객체에 접근이 가능합니다. (this, it)

 

코틀린의 Scope functions에는 let, run, with, apply, also 5가지의 함수들이 존재합니다.

 

basic vs let

위 두 코드는 동일한 로직을 수행하지만, let 을 사용하면 더욱 간단하게 객체 내부에 접근이 가능합니다.

 

Function Selection

Function	Object reference	Return value	Is extension function
let	it	Lambda result	O
run	this	Lambda result	O
with	this	Lambda result	X
apply	this	Context object	O
also	it	Context object	O

위 내용은 코틀린의 공식 문서에 나와있는 내용으로 자세히 보면 크게 2가지로 나눌 수 있습니다.

• Object reference 방식이 it vs this
• Returen value 값이 Lambda result  vs Context object

위의 두 분류로 나누어보면 with만 독특하게 확장 함수로 정의되어 있지 않습니다. 대체할 수 있는 run 함수를 사용해도 무방할 것 같은데요, 아래에서 조금 더 자세히 살펴보겠습니다.

 

목적에 따라 위 함수들을 선택하는 대략적인 가이드는 다음과 같습니다.

• let: nullable이 아닌 객체에 대해 람다 실행하기
• let: 로컬 범위에서 변수로 표현식 나타내기
• apply: Object configuration
• run: Object configuration 및 결과 계산
• also: 추가적인 효과, 작업
• with: object에 대한 함수 호출 그룹화

Scope functions이 코드를 더 간결하게 만들 수 있지만, 과도하게 사용하거나 중첩해서 사용할 경우 더 복잡해질 수 있습니다.

 

 

Distinctions (차이점)

Scope functions은 성격이 비슷하기에 차이점을 이해하는 것이 중요한데요, 크게 두 가지 주요 차이점이 있습니다.

• Context object (수신 객체)
• Return value

 

Context Object(수신 객체)

Scope functions로 전달된 람다 내부에서 수신 객체는 실제 이름 대신 짧은 참조(this or it)로 사용할 수 있습니다.

 

this

run, with, apply에서는 this 키워드를 참조하기에, 람다에서 일반 클래스 함수와 마찬가지로 객체를 사용할 수 있습니다.

 

대부분의 경우 수신 객체에 접근할 때 this 키워드를 생략할 수 있어 코드가 더 짧아지는 반면 수신 객체와 외부 객체의 기능을 구분하기 어려울 수 있기 때문에 적절하게 생략하는 것이 중요합니다.

 

it

let, also는 람다 인수로 수신 객체를 참조합니다. 인수 이름이 지정되지 않은 경우, 해당 객체는 기본 이름인 it으로 접근됩니다.

it은 this 보다 짧으며, 일반적으로 읽기가 더 쉽습니다.

 

하지만, 객체의 함수나 속성을 호출할 때는 this처럼 암묵적으로 객체를 사용할 수 없습니다.

 

Return value

Scope functions는 반환되는 결과에 따라 다릅니다.

• apply와 also는 수신 객체를 반환합니다.
• let, run, with는 람다 결과를 반환합니다.

코드에서 다음에 수행할 작업에 따라 원하는 반환 값을 고려해야 최적의 Scope functions을 선택하는 데 도움이 됩니다.

 

apply와 also는 수신 객체 자체를 리턴하기 때문에, 추가 단계로 메서드 체이닝에 포함될 수 있습니다.

즉, 동일한 객체에서 함수 호출을 차례로 계속 연결이 가능합니다.

 

또한 수신 객체를 반환하는 함수의 반환문에도 사용할 수 있습니다.

 

let, run, with는 람다 결과를 반환합니다. 따라서 결과를 변수에 할당하거나, 결과에 대한 연산을 연결할 때 사용할 수 있습니다.

 

추가적으로 반환 값을 무시하고 지역 변수에 대한 임시 범위를 만들 수 있습니다.

 

 

Functions

어느 상황에서 어떠한 scope functions을 사용해야 하는지 살펴보겠습니다. 

기술적으로 scope functions은 많은 경우 교체가 가능하므로, 아래 예제에서는 사용 사례에 대한 규칙들을 설명합니다.

 

let

• let은 수신 객체(it)를 이용해 로직을 수행하고, 마지막 라인을 반환할 때 사용합니다.
• 또한 nullable 한 값을 처리해야 할 때 let을 사용해야 합니다.

메서드 참조(::)

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

 

nullable '?.let'

위 예제처럼 nullable 한 데이터를 처리하려면 null check 연산자인 '?'를 사용하고, 람다에 있는 작업과 함께 호출합니다.

'?.let'을 통해 let의 block은 수신 객체가 null이 아닐 때만 수행되도록 보장합니다.

 

nullable (not null vs null)

 

with

• with는 확장 함수가 아닌, 수신 객체를 파라미터로 받아 사용합니다.
• 반환 값을 사용할 필요가 없을 때, with를 사용하는 것을 권장합니다.
• 아래 run과 거의 동일하지만, run은 확장 함수로 사용되나 with는 수신 객체(receiver)를 파라미터로 받아 사용한다는 차이점이 있습니다.

run vs with

위 코드에서 run과 with의 결과는 동일합니다. 

 

run

• run은 수신 객체로 this를 사용하나, 수신 객체 없이도 사용할 수 있습니다. (수신 객체 명시 필수)
• 또한 run은 with와 동일하지만, run은 확장 함수로 구현되어 있습니다.
• run은 람다가 객체를 초기화하고 반환 값을 계산할 때 유용합니다.

run: 수신 객체 없이 사용

 

run: 수신 객체로 사용

 

with vs run

위의 코드나 결과를 보면 두 함수는 거의 비슷하게 사용이 되는 것 같은데요, 찾아보니 대략적으로 아래와 같은 사용 사례, 차이점 등이 존재하는 것 같습니다.

 

with는 결과가 필요하지 않는 경우에 주로 사용하는 듯하고, run은 결과 계산 등에 사용을 주로 하는 것 같습니다.

또한 run은 확장 함수로 사용되기 때문에 체이닝 방식으로 사용할 수 있습니다.

 

apply

• apply는 수신 객체 자체를 반환하므로 수신 객체 내부의 프로퍼티를 변경하기 위해 주로 사용합니다.
• 또 다른 적용 사례는 복잡한 처리를 위한 다수의 체이닝에 사용할 수 있습니다.

 

람다의 수신 객체가 apply의 수신 객체이므로 리시버(this)를 생략할 수 있습니다.

 

also

• apply와 마찬가지로 수신 객체 자신을 반환합니다.
• apply가 수신 객체의 프로퍼티를 설정하는 데 사용된다면, also는 객체의 프로퍼티 설정과 추가 작업이 필요할 때 사용할 수 있습니다.
• block은 람다의 파라미터로 수신 객체(T)를 입력받기 때문에 내부에서 수신 객체는 it을 사용해야 합니다.

 

 

 

정리

let

• let은 수신 객체(it)를 이용해 로직을 수행하고, 마지막 라인을 반환할 때 사용합니다.
• 또한 nullable 한 값을 처리해야 할 때 let을 사용해야 합니다.

with

• with는 수신 객체를 파라미터로 받아 사용합니다.
• 반환 값을 사용할 필요가 없을 때, with를 사용하는 것을 권장합니다.
• 아래 run과 거의 동일하지만, run은 확장 함수로 사용되나 with는 수신 객체(receiver)를 파라미터로 받아 사용한다는 차이점이 있습니다.

run

• run은 수신 객체로 this를 사용하나, 수신 객체 없이도 사용할 수 있습니다. (수신 객체 명시 필수)
• 또한 run은 with와 동일하지만, run은 확장 함수로 구현되어 있습니다.
• run은 람다가 객체를 초기화하고 반환 값을 계산할 때 유용합니다.

apply

• apply는 수신 객체 자체를 반환하므로 수신 객체 내부의 프로퍼티를 변경하기 위해 주로 사용합니다.
• 또 다른 적용 사례는 복잡한 처리를 위한 다수의 체이닝에 사용할 수 있습니다.

also

• apply와 마찬가지로 수신 객체 자신을 반환합니다.
• apply가 수신 객체의 프로퍼티를 설정하는 데 사용된다면, also는 객체의 프로퍼티 설정과 추가 작업이 필요할 때 사용할 수 있습니다.
• block은 람다의 파라미터로 수신 객체(T)를 입력받기 때문에 내부에서 수신 객체는 it을 사용해야 합니다.

 

이상으로 코틀린의 Scope functions인 `let, with, run, apply, also` 5가지 키워드에 대해 정리해 보았습니다.

 

대략적으로 어느 상황에서 어떠한 함수를 사용하는 것이 좋을지는 직접 사용해 보며 익혀야 할 것 같지만, 대략적인 느낌으로는 아래와 같이 사용하면 좋을 것 같네요. 😂

• let: nullable 한 값을 처리해야 할 때
• with: 결과가 필요하지 않는 경우
• run: 결과가 필요한 경우
• apply: 수신 객체의 프로퍼티를 변경해야 할 때
• also: 수신 객체의 프로퍼티 변경과, 추가적인 작업이 필요할 때

 

 

https://kotlinlang.org/docs/scope-functions.html#context-object-this-or-it