TIL

1. scope function이란 무엇인가

• scope function: 일시적인 영역을 형성하는 함수
• 예를 들어 scope function을 사용하면 아래 null을 체크하는 로직을 리팩터링할 수 있다.

fun printPerson(person: Person?) {
  if (person != null) {
    println(person.name)
    println(person.age)
  }
}

// scope function 사용 코드
fun printPerson(person: Person?) {
  persln?.let {
    println(it.name)
    println(it.age)
  }  
}

• let : 확장함수. 람다를 받아, 람다 결과를 반환한다.
  • 람다 안에서 it을 통해 대상 객체(Person)에 접근할 수 있다.
  • 람다에 여러 줄이 있는 경우 가장 마지막 줄이 리턴 값이 된다.

inline fun <T, R> T.let(block: (T) -> R): R {
  return block(this)
}

• 즉 scope function이란
  • 람다를 이용해 일시적인 영역을 만들고
  • 코드를 더 간결하게 만들거나
  • method chaning에 활용하는 함수

2. scope function의 분류

• 종류
  • let, run, also apply, with
  • let, run은 람다의 결과를 반환
  • also, apply는 객체 그 자체를 반환
  • let, also는 람다에서 수신 객체 호출 시 it을 사용
  • run, apply는 람다에서 수신 객체 호출 시 this를 사용

	it 사용	this 사용
람다의 결과 반환	let	run
객체 자체 반환	also	apply

val value1 = person.let { it.age } // age 반환
val value2 = person.run { this.age } // age 반환

val value3 = person.also { it.age } // Person 반환
val value4 = person.apply { this.age } // Person 반환

• it, this 차이점
  • it: 생략이 불가능한 대신 다른 이름을 붙일 수 있다.
  • this: 생략 가능한 대신 다른 이름을 붙일 수 없다

val value1 = person.let { p -> p.age }
val value2 = person.run { age }

• let, also는 일반 함수를 받고 run, apply는 확장 함수를 받는다.
  • 확장 함수에선 본인을 this로 호출하고 생략할 수 있다.
• 다른 scope function과 달리 with는 확장함수가 아니고 아래처럼 사용할 수 있다.
  • with(파미라터, 람다): this로 접근하고 this는 생략 가능

val person = Person("does", 27)
with(person) {
  println(name)
  println(this.name)
}

3. 언제 어떤 scope fucntion을 사용해야 할까

let

• 하나 이상의 함수를 call chain 결과로 호출할 때

val strings = listOf("apple", "car")
strings.map { it.length }
  .filter { it > 3 }
  .let(::println) // { lengths -> println(lengths) }

• non-null 값에 대해서만 code block을 실행시킬 때

val length = str?.let {
  println(it.uppercase())
  it.length
}

run

• 객체 초기화와 반환 값의 계산을 동시에 해야 할 때
  • ex) 객체를 만들어 DB에 바로 저장하고 그 인스턴스를 활용할 때

val person = Person("does", 27).run(personRepository::save)

apply

• apply 특징: 객체 그 자체가 반환된다.
• 객체 설정 시 객체를 수정하는 로직이 call chain 중간에 필요할 때
  • ex) test fixture 만들 때

// 모종의 이유로 Person 생성자에 hobby는 초기에 받지 않고
// 나중에 추가적으로 입력하는 경우가 있을 수 있다.
// 테스트 픽스처 설정 시 한 번에 넣어주고 싶을 때 사용 가능

fun createPerson(
  name: String,
  age: Int,
  hobby: String
): Person {
  return Person(
    name = name,
    age = age,
  ).apply {
    this.hobby = hobby
  }
}

also

• also 특징 : 객체 그 자체가 반환된다.
• 객체를 수정하는 로직이 call chain 중간에 필요할 때

mutableListOf("one", "two", "three")
  .also { println("four 추가 이전 지금 값 : $it") }
  .add("four")

with

• 특정 객체를 다른 객체로 변환해야 하는데, 모듈 간 의존성에 의해 정적 팩토리 혹은 toClass 함수를 만들기 어려울 때

return with(person) { 
  PersonDto( // this를 생략할 수 있어 필드가 많아도 코드가 간결해진다.
    name = name,
    age = age
  )
}

4. scope function과 가독성

// 1번 코드
if (person != null && person.isAdult) {
  view.showPerson(person)
} else {
  view.showError()
}

// 2번 코드
person?.takeIf { it.isAdult }
  ?.let(view::showPerson)
  ?: view.showError()

• 어느 코드가 더 가독성이 좋은지는 사람에 따라 다를거다.
• 단 사용 빈도가 적은 관용구는 코드를 더 복잡하게 만들고 이런 관용구들을 한 문장 내에서 조합해 사용한다면 복잡성이 더 증가할 수도 있다.
• scope function을 적절한 convention을 지키며 적용하면 유용하게 활용할 수 있다.