이펙티브 코틀린 - 4장 추상화 설계

---

아이템 26. 함수 내부의 추상화 레벨을 통일하라

컴퓨터 과학에서 추상화는 복잡한 자료, 모듈, 시스템 등으로부터 핵심적인 개념 또는 기능을 간추려내는 것

간단하게 표현하면, 추상화는 복잡성을 숨기기 위해 사용되는 단순한 방식

 

코드에서는 추상화를 위한 기본적인 도구가 바로 함수이다.

추상화 레벨 통일(Single Level of Abstraction, SLA) 원칙: 함수도 높은 레벨과 낮은 레벨을 구분해서 사용

class CoffeeMachine {
    fun makeCoffee() {
        boilWater()  // 물을 끓이고,
        brewCoffee() // 커피를 내리고,
        pourCoffee() // 커피를 붓고,
        pourMilk()   // 우유를 넣는다.
    }
	
    private fun boilWater() { ... }
    private fun brewCoffe() { ... }

}

• makeCoffee 함수는 읽고 이해하기 쉽고, 누군가 낮은 레벨의 함수(물 끓이기, 커피 내리기, 우유 넣기 등)를 이해해야 한다면 해당 부분의 코드만 살펴보면 된다.
• 매우 간단한 추상화를 추출해서 가독성을 향상시킨 것

실제로 위의 정도로만 추상화를 적용하여도 가독성이 굉장히 향상되는 경우가 많았다.

---

아이템 27. 변화로부터 코드를 보호하려면 추상화를 사용하라

함수의 추상화

fun Context.toast(
    message: String,
    duration: Int = Toast.LENGTH_SHORT
) {
    Toast.makeText(this, message, duration).show()
}

context.toast(message)

toast 메시지를 출력해야 할 때 위와 같이 작성하게 되면, 토스트에서 다른 메시지로 변경해야 할 때 사용하는 클라이언트의 코드 변경도 필요하다. 따라서 적절한 추상화가 이루어지지 않은 함수이다.

 

fun Context.showMessage(
    message: String,
    duration: MessageLength = MessageLength.LONG // SHORT, LONG
) {
    val toastDuration = when(duration) {
        SHORT -> Toast.LENGTH_SHORT
        LONG -> Toast.LENGTH_LONG
    }
    
    Toast.makeText(this, message, toastDuration).show()
    
    // 변경 시 
    Snack.makeText(this, message, toastDuration).show()
}

위와 같이 showMessage 함수를 통해 단순히 메시지를 출력하도록 변경한다면?

 

함수가 "무엇"을 하는지 What에 집중하게 되고, "어떻게"에 How to는 숨겨지게 된다. 따라서 외부(클라이언트)에서는 개념을 알 필요 없이 단순히 호출함으로써 사용할 수 있다.

 

따라서 토스트에서 다른 메시지로 변경하게 된다면 위의 showMessage() 함수만 변경하면 된다.

추가적으로 위 함수에 대해 케이스가 많아지고, 복잡도가 높아질 경우 별도의 기능을 가진 클래스와 인터페이스를 추가하여 더욱 확장성있게 구현할 수 있겠다.

 

추상화에 대한 규칙?

• 많은 개발자가 참여하는 프로젝트는 이후 객체 생성과 사용 방법을 변경하기 어렵다. 따라서 추상화 방법을 사용하는 것이 좋다.
• 의존성 주입 프레임워크를 적극적으로 활용할 것
• 테스트를 하거나, 다른 애플리케이션을 기반으로 새로운 애플리케이션 생성 시 추상화 적용
• 프로젝트가 작고 실험적이라면 추상화를 적용하지 않아도 상관없음

---

아이템 28. API 안정성을 확인하라

@Experimental

 

@Deprecateed

---

 

아이템 30. 요소의 가시성을 최소화하라

class CounterSet<T>(
    private val innerSet: MutableSet<T> = setOf()
) : MutableSet<T> by innerSet {
    val elementsAdded: Int = 0
        private set

    override fun add() ...
    override fun addAll() ...
}

세터는 private으로 선언하는 코드는 많이 사용되므로 기억하라.

 

한 번 공개된 API는 숨기는 것이 어렵고, 대체제와 하위 호환을 제공해야 하므로 외부 노출은 신중하게 정하자.

---

아이템 31. 문서로 규약을 정의하라

특히나 외부(공개) API를 구현할 때 규약을 잘 정의해야 한다.

/**
 * Returns a new read-only list of given elements.  The returned list is serializable (JVM).
 * @sample samples.collections.Collections.Lists.readOnlyList
 */
public fun <T> listOf(vararg elements: T): List<T> = if (elements.size > 0) elements.asList() else emptyList()

 

...

EnableKafka 어노테이션의 주석, 주석만 200줄이 넘는다.