Effective Kotlin | 2장. 가독성

💡 컴퓨터가 인식할 수 있는 코드는 바보라도 작성할 수 있지만, 인간이 이해할 수 있는 코드는 실력 있는 프로그래머만 작성할 수 있다. - Martin Flowler, <Refactoring>

아이템 11: 가독성을 목표로 설계하라

인식 부하 감소

일반적으로 자주 사용하는 패턴을 활용할 것

극단적이게 되지 않기

경험이 많은 코틀린 개발자만 쉽게 이해할 수 있는 코드가 있으면, 제너럴하게는 이해하기 어려운 코드가 된다. 그럼에도 불구하고 이러한 ‘비용’을 지불할 만한 이유가 있다면 트레이드 오프를 진행하는 옵션을 고려할 수 있다.

컨벤션

아이템 12: 연산자 오버로드를 할 때는 의미에 맞게 사용하라

factorial() 함수를 쉽게 표현하기 위해 operator fun Int.not() = factorial()을 작성하여 사용하면 혼란스럽고 오해의 소지가 있다.

분명하지 않은 경우

사람에 따라 해석이 갈릴 수 있는 경우에는 infix 또는 톱레벨 함수를 활용하여 의미를 명확하게 할 것

규칙을 무시해도 되는 경우

HTML DSL 등 DSL(Domain Specific Language)를 설계하는 경우에는 규칙을 무시해도 된다.

아이템 13: Unit?을 리턴하지 말라

fun isCorrect(key: String): Unit? = // ...
isCorrect(key) ?: return

위와 같은 식으로 코드를 사용할 수 있으나 이해하기 어렵고 오해의 소지가 있다. 대신 다음과 같이 사용하라:

fun isCorrect(key: String): Boolean = // ...
isCorrect(key) ?: return

아이템 14: 변수 타입이 명확하지 않은 경우 확실하게 지정하라

type inference(e.g. val num = 10)는 개발 시간을 줄여주고 가독성이 향상된다는 장점을 갖고 있다.

하지만 읽는 입장에서 명확하지 않은 경우 타입을 명시함으로써 가독성을 높여, 반환 타입을 알기 위해 해당 함수 정의 파일을 여는 등의 시간 낭비를 줄일 수 있다. 또한 안전성도 높아진다.

// val data = getSomeData()
val data: UserData = getSomeData()

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

여러 개의 리시버

스코프 내부에 둘 이상의 리시버가 있는 경우 명시하는 것이 좋다.

run 내부에서 this 키워드가 겹친다면 also를 사용하거나 this@Node와 같이 레이블을 지정한다.

*레이블 없이 리시버를 사용하면 가장 가까운 리시버를 의미한다.

DSL 마커

아이템 16: 프로퍼티는 동작이 아니라 상태를 나타내야 한다

getter 등을 이용해 함수처럼 작동하는 프로퍼티를 만들지 말 것

프로퍼티 대신 함수를 사용하는 것이 좋은 경우는 다음과 같다:

• 연산 비용이 높은 경우
• 비즈니스 로직을 포함하는 경우
• 결정적이지 않은 경우: 같은 동작을 연속으로 두 번 했는데 다른 값이 나오는 경우
• 변환의 경우
• getter에서 프로퍼티의 상태 변경이 일어나야 하는 경우

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

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

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

• sleep(100) → sleep(tileMillis = 100): ms인지 s인지 명확하지 않았는데 이를 개선
• default argument를 가질 경우(default argument e.g. fun add(isStable: Boolean = true))
• 같은 타입의 파라미터가 많은 경우
• 함수 타입의 파라미터가 있는 경우(마지막 경우 제외)

아이템 18: 코딩 컨벤션을 지켜라

장점은 다음과 같다:

• 어떤 프로젝트를 접해도 쉽게 이해할 수 있다.
• 외부 개발자도 쉽게 이해할 수 있다.
• 코드를 병합하거나 이동하는 것이 쉽다.

도움이 되는 도구:

• IntelliJ Formatter
• ktlink