TIL

아이템 17 이름 있는 아규먼트를 사용하라

• 코드에서 아규먼트 의미가 명확하지 않은 경우가 있다.
  • 아래 코드의 경우 joinToString의 아규먼트가 separator인 것을 모르는 사람은 명확하지 않을 수도 있다.

val text = (1..10).joinToString("|")

• 아래 코드처럼 이름 있는 아규먼트(named argument)를 사용하면 된다.
  • 이를 통해 개발자의 의도를 쉽게 알 수 있다.
  • 아규먼트에 전달할 변수를 잘못 만들거나 잘못 배치할 위험을 줄여준다.

val text = (1..10).joinToString(separator = "|")

이름 있는 아규먼트는 언제 사용해야 할까?

• 이름 있는 아규먼트의 장점
  • 이름 기반으로 값이 무엇을 나타내는지 알 수 있다.
  • 파라미터 입력 순서와 상관 없이 안전하다.

sleep(100) // 단위가 명확하지 않다

sleep(timeMillis = 100) // ms임이 명확하다

sleep(Millis(100)) // 타입을 명확히 하는 방법도 있긴 하다.

sleep(100.ms) // 확장 프로퍼티로 DSL 같은 문법을 만들 수도 있긴 하다.

• 특히 다음의 경우 강력히 추천한다.
  • 디폴트 아규먼트의 경우
  • 같은 타입 파라미터가 많은 경우
  • 함수 타입의 파라미터가 있는 경우(마지막 경우 제외)

디폴트 아규먼트의 경우

• 일반적으로 함수 이름은 필수 파라미터와 관련 있다.
• 때문에 디폴트 값을 갖는 옵션 파라미터의 설명이 명확하지 않다.
• 즉 이러한 것들은 이름을 붙이는 게 좋다.

같은 타입의 파라미터가 많은 경우

• 파라미터가 모두 같은 타입이면 순서가 바뀌면 버그가 발생할 수 있다.
• 이름 있는 아규먼트를 통해 실수를 피할 수 있다.

sendEmail(
	to = "contact@kt.academy",
	message = "hello",
)

함수 타입 파라미터

• 일반적으로 함수 타입 파라미터는 마지막 위치에 배치하는 것이 좋다.
  • 함수 이름이 함수 타입 아규먼트를 설명해 주기도 하기 때문이다.

thread { // 이후 블록이 스레드 본문이라는 것을 쉽게 알 수 있다.
	// ...
}

• 그 밖의 모든 함수 타입 아규먼트는 이름 있는 아규먼트를 사용하는 것이 좋다.

val view = linearLayout {
	text("Click velow")
	button({/* 1 */}, {/* 2 */}) // 어떤 부분이 무엇인지 명확하지 않다.
}