TIL

아이템 35 복잡한 객체를 생성하기 위한 DSL을 정의하라

• 코틀린을 활용하면 DSL(Domain Specific Language)을 직접 만들 수 있다.
  • 복잡한 객체, 계층을 정의할 때 유용
  • 만들기는 번거롭지만 만들고 나면 보일러플레이트와 복잡성을 숨기면서 개발자 의도를 표현할 수 있다.

// HTML을 표현하는 DSL
body {
	div {
		a("https:/kotlinlang.org") {
			target = ATarget.blank
			+"Main Site"
		}
	}
}

• 아래는 Ktor로 만든 DSL로 API를 정의한 예이다.

fun Routing.api() {
	route("news") {
		get {
			val newsData = NewsUseCase.getAcceptedNews()
			call.responsd(newsData)
		}
		get("propositions") {
			requireSecret()
			val newsData = NewsUseCase.getPropositions()
			call.respond(newsData)
		}
	}
}

• 이미 존재하는 코틀린 DSL을 활용하는 것도 좋지만 사용자 정의 DSL을 만드는 방법도 알아두면 좋다.

사용자 정의 DSL 만들기

• 사용자 정의 DSL을 만드려면 리시버를 사용하는 함수 타입에 대해 이해해야 한다.
• 함수 타입은 ‘함수를 나타내는 겍체’이며 기본적으로 아래 방식으로 만든다.

fun plus(a: Int, b: Int) = a + b // 일반 함수

val plus1: (Int, Int) -> Int = { a, b -> a + b } // 람다 표현식
val plus2: (Int, Int) -> Int = fun(a, b) = a + b // 익명 함수
val plus3: (Int, Int) -> Int = ::plus // 함수 레퍼런스

• 확장 함수도 마찬가지로 함수 타입으로 만들 수 있다.
  • 아래 함수의 타입은 확장함수를 나타내는 특별한 타입이 된다.
  • 이를 리시버를 가진 함수 타입이라 부른다.
  • 파라미터 앞에 리시버 타입이 추가되어 점으로 구분되어 있다는 것이 특징이다.

val myPlus = fun Int.(other: Int) = this + other

• 리시버를 가진 함수는 아래 방법으로 호출할 수 있다.

myPlus.invoke(1, 2) // invoke 사용
myPlus(1, 2) // 확장 함수가 아닌 함수처럼 사용
1.myPlus(2) // 확장 함수로 사용

• 리시버를 가진 함수 타입의 중요한 특징은 this 참조 대상을 변경할 수 있다는 점이다.
  • 일반 함수에서 this는 자신이 정의된 클래스 인스턴스를 가리킨다.
  • 리시버를 가진 함수 타입에선 스코프 내부에서 this 키워드는 확장 리시버(위 코드에선 Int 인스턴스)를 참조한다.

fun createTable(): TableDSL = table {
	tr {
		for (i in 1..2) {
			td { +"this is column &i" }
		}
	}
}

• 위 코드는 HTML 표를 표현한 간단한 DSL이다.
  • table 함수는 톱레벨에 위치하며 별도 리시버를 갖지 않으므로 table 함수도 톱레벨에 있어야 한다.
  • table 함수 아규먼트 내부에서 tr을 사용하며 tr은 table 정의 내부에서만 허용되어야 하기에 table 함수 아규먼트는 tr 함수를 갖는 리시버를 가져야 한다.
  • 마찬가지로 tr 함수의 아규먼트는 td 함수를 갖는 리시버를 가져야 한다.

fun table(init: TableBuilder.() -> Unit): TableBuilder { /*...*/ }

class TableBuilder {
	fun tr(init: TrBuilder.() -> Unit) { /*...*/ }
}

class TrBuilder {
	fun td(init: TdBuilder.() -> Unit) { /*...*/ }
}

• 이처럼 각각 단계에서 빌더를 만들고 파라미터를 활용해 값들을 적절히 초기화하면 된다.

언제 사용해야 할까?

• DSL은 다음과 같은 것들을 표현하는 경우 유용하다.
  • 복잡한 자료 구조
  • 계층적인 구조
  • 거대한 양의 데이터