Kotlin Academy · 강의

사용자를 방해하지 않고 DSL 테스트하고 발전시키기

안정적인 DSL API를 설계하고 읽기 쉬운 검증 블록으로 테스트해 보세요.

사용자를 방해하지 않고 DSL 테스트하고 발전시키기은(는) CoddyKit의 무료 Kotlin Academy 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Kotlin Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

DSL 검증이 다른 이유

DSL은 공개 API입니다. DSL을 변경하면 사용자 코드의 모든 호출부가 중단될 수 있습니다. DSL을 검증한다는 것은 DSL이 생성하는 출력과 DSL이 강제하는 구조를 모두 확인하는 것을 의미합니다. 잘못된 구문이 계속 컴파일 오류로 남는지도 포함됩니다.

DSL 출력 검증

가장 간단한 검증 방법은 DSL을 사용해 객체를 구축한 다음, 렌더링된 결과나 빌더의 내부 상태를 검증하는 것입니다.

@Test
fun `div contains a paragraph`() {
    val result = html {
        body {
            div { p("Hi") }
        }
    }
    assertTrue(result.render().contains("<p>"))
}

빌더 상태 검증

렌더링된 문자열을 검증하는 대신 빌더 객체 그래프를 직접 검증합니다. 이렇게 하면 서식이 변경되어도 더 안정적으로 동작합니다:

@Test
fun `server config has correct port`() {
    val cfg = server {
        host = "example.com"
        port = 9090
    }
    assertEquals(9090, cfg.port)
    assertEquals("example.com", cfg.host)
}

중첩 구조 검증

객체 트리를 따라가며 중첩 관계를 확인합니다:

@Test
fun `body contains one div`() {
    val page = html { body { div { } } }
    assertEquals(1, page.children
        .filterIsInstance<Body>().first()
        .children.filterIsInstance<Div>().size
    )
}

컴파일 오류 검증

컴파일 오류를 단위 검증으로 직접 검증할 수는 없지만, 실패하는 코드를 주석 처리한 상태로 // This should NOT compile 같은 주석을 추가할 수 있습니다. 일부 프로젝트에서는 Kotlin Compile Testing 라이브러리를 사용해 특정 코드가 컴파일되지 않는다는 사실을 검증합니다.

DSL을 안전하게 발전시키기: 추가 변경

기본값이 있는 새 선택적 매개변수나 새 빌더 함수를 추가하는 것은 이전 버전과 호환됩니다. 기존 호출부는 수정하지 않아도 컴파일됩니다.

// Before
fun server(block: ServerConfig.() -> Unit): ServerConfig
// After — additive: new optional feature
fun server(enableMetrics: Boolean = false, block: ServerConfig.() -> Unit): ServerConfig

호환성을 깨는 변경: 제거 또는 이름 변경

DSL 함수를 제거하거나 이름을 변경하면 호출부가 중단됩니다. 이름을 변경해야 한다면 사용 중단된 별칭을 제공하고 향후 주 버전에서 제거합니다:

@Deprecated("Use database{} instead", ReplaceWith("database(block)"))
fun db(block: DbConfig.() -> Unit) = database(block)

DSL 버전 관리

라이브러리 DSL에는 의미론적 버전 관리를 따릅니다. DSL을 깨뜨리는 변경 사항(함수 제거, 수신 타입 변경)은 주 버전 번호를 올릴 근거가 됩니다. 이러한 변경 사항은 변경 로그에 기록합니다.

실험적 DSL 기능에 @RequiresOptIn 사용하기

불안정한 DSL 확장 기능에는 @RequiresOptIn을 적용합니다. 사용자가 명시적으로 사용을 허용해야 하므로 변경될 수 있는 기능에 실수로 의존하는 일을 방지할 수 있습니다:

@RequiresOptIn(message = "This DSL feature is experimental and may change")
annotation class ExperimentalDsl

@ExperimentalDsl
fun ServerConfig.enableDebug() { /*...*/ }

DSL에서 프로퍼티 위임 사용하기

DSL에서는 프로퍼티 위임을 사용해 필수 필드를 강제하고, 필수 값이 없을 때 명확한 오류 메시지를 제공할 수 있습니다:

class Required<T> {
    private var value: T? = null
    operator fun getValue(t: Any?, p: KProperty<*>): T = value ?: error("${p.name} is required")
    operator fun setValue(t: Any?, p: KProperty<*>, v: T) { value = v }
}

버전 간 계약 검증

DSL 사용 예제 중 일부를 "기준" 검증 사례로 유지합니다. 리팩터링으로 이러한 예제가 중단되면 사용자가 발견하기 전에 검증 모음이 문제를 찾아냅니다. 이 예제는 살아 있는 문서 역할도 합니다.

빠른 확인

이전 버전과의 호환성을 가장 안전하게 유지하는 DSL 변경 유형은 무엇인가요?

요약: DSL 검증 및 발전시키기

핵심 내용:

단위 검증에서 DSL 출력과 빌더 객체 상태를 검증합니다
추가 변경(새 선택적 함수 또는 매개변수)은 안전합니다
사용자를 중단시키지 않고 이름을 변경하려면 @Deprecated(ReplaceWith=...)를 사용합니다
실험적 DSL 기능에는 @RequiresOptIn을 사용합니다
버전 간 회귀를 찾을 수 있도록 기준 사용 검증을 유지합니다

자주 묻는 질문

“사용자를 방해하지 않고 DSL 테스트하고 발전시키기” 강의는 무료인가요?

네 — “사용자를 방해하지 않고 DSL 테스트하고 발전시키기” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Kotlin Academy 강의 전체를 잠금 해제할 수 있습니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“사용자를 방해하지 않고 DSL 테스트하고 발전시키기”에서 뭘 배우나요?

안정적인 DSL API를 설계하고 읽기 쉬운 검증 블록으로 테스트해 보세요. 브라우저에서 직접 실행하는 실습 코드로 Kotlin Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Kotlin Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Kotlin Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.

“사용자를 방해하지 않고 DSL 테스트하고 발전시키기” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Kotlin Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Kotlin Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← Kotlin Academy(으)로 돌아가기