TIL

아이템 15 리시버를 명시적으로 참조하라

• 명확함을 위해 명시적으로 긴 코드를 사용할 때가 있다.
  • ex) 함수와 프로퍼티를 다른 리시버로부터 가져온다는 것을 나타내기 위해
  • ex) this를 명시적으로 사용

class User: Person() {
	private var beersDrunk: Int = 0
	
	fun drinkBeers(num: Int)) {
		// ...
		this.berrsDrunk += num
		// ...
	}
}

여러 개의 리시버

• 스코프 내부에 둘 이상의 리시버가 있는 경우 명시적으로 나타내면 좋다.
  • apply, with, run 함수 등을 사용할 때

class Node(val name: String) {
	fun makeChild(childName: String) = 
		create("$name.$childName")
			.apply { print("Created ${name}") }
			
	fun create(name: String): Node? = Node(name)
}

fun main() {
	val node = Node("parent")
	node.makeChild("child")
}

• 위 코드는 ‘Created parent.child’가 출력된다고 예상하지만 실제론 ‘Created parent’가 출력된다.
• 리시버를 명시적으로 사용하면 아래와 같다.
  • 하지만 this의 타입이 Node?이기에 이를 직접 사용할 수 없고 safe call을 사용해야 한다.

class Node(val name: String) {
	fun makeChild(childName: String) = 
		create("$name.$childName")
			.apply { print("Created ${this?.name}") }
}

• 사실 이는 apply의 잘못된 사용 예인데 also를 사용했다면 명시적 리시버를 지정하게 된다.
  • nullable 값을 처리할 땐 일반적으로 also 또는 let이 훨씬 좋은 선택지이다.

class Node(val name: String) {
	fun makeChild(childName: String) = 
		create("$name.$childName")
			.also { print("Created ${it?.name}") }
}

• 레이블 없이 리시버를 사용하면 가장 가까운 리시버를 의미하기에 외부 리시버를 사용하려면 레이블을 사용해야 한다.
  • 리시버를 명확히 사용하면 코드를 안전하게 사용할 수 있고 가독성도 향상된다.

class Node(val name: String) {
	fun makeChild(childName: String) = 
		create("$name.$childName")
			.apply { print("Created ${this?.name} in ${this@Node.name}") }
}

DSL 마커

• 코틀린 DSL을 사용할 땐 여러 리시버가 중접최더라도 리시버를 명시적으로 붙이지 않는다.
  • DSL은 원래 그렇게 사용하도록 설계되었기 때문이지만 위험한 경우도 있다.

table {
	tr {
		td { +"Column 1" }
		td { +"Column 2" }
	}
	tr {
		td { +"Value 1" }
		td { +"Value 2" }
	}
}

• 기본적으로 모든 스코프에서 외부 스코프에 있는 리시버를 사용할 수 있지만 코드에 문제가 생긴다.

table {
	tr {
		td { +"Column 1" }
		td { +"Column 2" }
		tr {
			td { +"Value 1" }
			td { +"Value 2" }
		}
	}
}

• 이런 잘못된 사용을 막으려면 DslMarker라는 메타 어노테이션을 사용할 수 있다.
  • 그럼 암묵적으로 외부 리시버를 사용하는 것이 금지되어 컴파일 오류가 발생한다.

@DslMarker
annotation class HtmlDsl

fun table(f: TableDsl.() -> Unit) { /*...*/ }

@HtmlDsl
class TableDsl { /*...*/ }

table {
	tr {
		td { +"Column 1" }
		td { +"Column 2" }
		tr { // 컴파일 오류
			td { +"Value 1" }
			td { +"Value 2" }
		}
	}
}

• 외부 리시버를 사용하려면 명시적으로 해야 한다.

table {
	tr {
		td { +"Column 1" }
		td { +"Column 2" }
		this@table.tr {
			td { +"Value 1" }
			td { +"Value 2" }
		}
	}
}

정리

• 짧은 코드를 이유로 리시버를 제거하지 않아야 한다.
• 여러 리시버가 있다면 명시적으로 지정해야 가독성을 향상시킬 수 있다.
• DSL에서 외부 스코프의 리시버를 명시적으로 강제하고 싶다면 DslMarker 어노테이션을 사용해야 한다.