<div id="readability-page-1" class="page"><article><div><blockquote>이 글은 2024년 3월 14일에 일본어로 먼저 발행된 기사를 번역한 글입니다.</blockquote>
<p>안녕하세요. 커뮤니케이션 앱 LINE의 모바일 클라이언트를 개발하고 있는 Ishikawa입니다.</p>
<p>저희 회사는 높은 개발 생산성을 유지하기 위해 코드 품질 및 개발 문화 개선에 힘쓰고 있습니다. 이를 위해 다양한 노력을 하고 있는데요. 그중 하나가 Review Committee 활동입니다.</p>
<p>Review Committee에서는 머지된 코드를 다시 리뷰해 리뷰어와 작성자에게 피드백을 주고, 리뷰하면서 얻은 지식과 인사이트를 Weekly Report라는 이름으로 매주 공유하고 있습니다. <span>이 Weekly Report 중 일반적으로 널리 적용할 수 있는 주제를 골라 블로그에 <a href="https://techblog.lycorp.co.jp/ko/techniques-for-improving-code-quality-list" target="_blank">코드 품질 개선 기법 시리즈</a>를 연재하고 있습니다.</span></p>
<p><span>이번에 블로그로 공유할 Weekly Report의 제목은 '사상누각'입니다.</span></p>
<h2 id="사상누각">사상누각</h2>
<p>다음 <code>UserProfileViewData</code>는 '사용자 프로필'을 표시하기 위한 UI 모델입니다.</p>
<pre><code>class UserProfileViewData private constructor(
    val userName: String,
    val emailAddress: String,
    val profileImageUri: Uri?,
    val optionalStatusMessage: String?
)</code></pre>
<p>이 인스턴스를 생성하기 위해 다음과 같은 빌더를 제공한다고 가정해 봅시다.</p>
<pre><code>class UserProfileViewData private constructor(
    ...
) {
    class Builder {
        private var userName: String? = null
        private var emailAddress: String? = null
        private var profileImageUri: Uri? = null
        private var optionalStatusMessage: String? = null

        fun userName(value: String): Builder =
            also { userName = value }

        fun emailAddress(value: String): Builder =
            also { emailAddress = value }

        fun profileImageUri(value: Uri): Builder =
            also { profileImageUri = value }

        fun optionalStatusMessage(value: String): Builder =
            also { optionalStatusMessage = value }

        fun build(): UserProfileViewData {
            val nonNullUserName = checkNotNull(userName)
            val nonNullEmailAddress = checkNotNull(emailAddress)
            return UserProfileViewData(nonNullUserName, nonNullEmailAddress, profileImageUri, optionalStatusMessage)
        }
    }
}</code></pre>
<p>여기서 <code>also</code>는 인수를 호출한 후 수신자를 반환하는 함수입니다. 즉 <code>also { userName = value }</code>는 <code>value</code>를 <code>userName</code>에 대입한 후 <code>this</code>를 반환합니다. 또한 <code>checkNotNull</code>은 인수가 <code>null</code>이면 <code>IllegalStateException</code>을 발생시키고, <code>null</code>이 아니라면 인수를 그대로 반환하는 함수입니다.</p>
<p>위 코드의 문제는 무엇일까요?</p>
<h3 id="견고한-기초-위에-세우기">견고한 기초 위에 세우기</h3>
<p>특별한 이유가 없다면 빌더 패턴 대신 생성자나 팩토리 함수를 사용하는 것이 더 바람직한 경우가 많습니다. 생성자나 팩토리 함수를 사용하면 꼭 전달해야 하는 인수를 누락해 발생하는 버그를&nbsp;쉽게 방지할 수 있기 때문입니다.</p>
<p>위 예시의 경우 <code>UserProfileViewData</code>의 생성자를 그대로 사용하면 충분합니다. 앞서 빌더에서는 <code>userName</code>과 <code>emailAddress</code>가 필수였지만 이를 전달하지 않아도 컴파일 에러는 발생하지 않고 런타임 에러만 발생하는데요. 런타임 에러가 아니라 컴파일 에러로 결함을 검출할 수 있게 만들면 코드가 더 견고해집니다.</p>
<p>물론 라이브러리나 플랫폼 상황에 따라 어쩔 수 없이 빌더 패턴을 사용해야 하는 경우도 있으며(<span>Object–relational</span> mapper 등), 그 밖에도 다음과 같은 상황에서는 빌더 패턴이 필요할 수 있습니다.&nbsp;</p>
<ol><li>필수 인수가 적고, 기본값이 존재하는 인수가 많은 경우</li><li>'생성 중'인 상태를 다른 클래스나 함수에 전달해야 하는 경우</li><li>데코레이터 등에 대해 '마지막 작업'을 정의하고 싶은 경우</li></ol>
<p>1번과 2번의 경우 다른 방법으로 대체할 수 있는 경우도 있는데요. 하나씩 살펴보겠습니다.</p>
<h3 id="1:-기본값이-존재하는-인수가-많은-경우">1: 기본값이 존재하는 인수가 많은 경우</h3>
<p>만약 선택적 인수가 많다면 프로그래밍 언어에 따라 기본 인수를 사용할 수 있습니다. 또한 인수 제공 패턴이 제한적이라면 생성자를 오버로드하는 것도 한 가지 방법이 될 수 있습니다.</p>
<pre><code>class UserProfileViewData(
    val userName: String,
    val emailAddress: String,
    val profileImageUri: Uri? = null,
    val optionalStatusMessage: String? = null
)</code></pre>
<p>기본 인수를 사용할 수 없는 프로그래밍 언어에서는 빌더 패턴도 하나의 선택지입니다. 이 경우 필수 인수를 빌더 생성자로 전달하면 더욱 견고한 코드를 만들 수 있는데요. 다음 빌더에서는 필수 인수인 <code>userName</code>과 <code>emailAddress</code>를 빌더의 생성자 인수로 전달받습니다.</p>
<pre><code>class Builder(
    private val userName: String,
    private val emailAddress: String
) {
    private var profileImageUri: Uri? = null
    private var optionalStatusMessage: String? = null

    ...

    fun build(): UserProfileViewData {
        return UserProfileViewData(userName, emailAddress, profileImageUri, optionalStatusMessage)
    }
}</code></pre>
<h3 id="2:-'생성-중'-상태를-처리해야-하는-경우">2: '생성 중' 상태를 처리해야 하는 경우</h3>
<p>아래와 같이 '생성 중'인 상태를 다른 함수 등에 전달하고 싶은 경우도 있습니다.</p>
<pre><code>fun caller() {
    val builder = Builder()
        ...

    setStatusMessage(builder)

    val viewData = builder.build()
    ...
}

fun setStatusMessage(builder: Builder) {
    ...
    val statusMessage = ...

    builder.optionalStatusMessage(statusMessage)
}</code></pre>
<p>그런데 위 코드의 <code>setStatusMessage</code>의 인수 <code>builder</code>는 출력 인수(out parameter)처럼 작동합니다. 일반적으로 코드 가독성 측면에서도 출력 인수보다는 반환값을 사용하는 것이 바람직하며, 반환값을 사용하면 다음과 같이 빌더 패턴을 생성자나 팩토리 함수로 대체할 수 있습니다.</p>
<pre><code>fun caller() {
    val viewData = UserProfileViewData(
        ...,
        getStatusMessage(...)
    )
}

fun getStatusMessage(...): String {
    ...
    return statusMessage
}</code></pre>
<p>만약 인스턴스를 생성하는 로직이 파이프라인과 같은 경우, 각 구성 단계마다 다른 타입을 정의해서 유효하지 않은 상태를 제외할 수 있습니다. 다음 코드에서는 <code>profileImageUri</code> 부여 전후에 <code>UserAccountModel</code>과 <code>UserProfileViewComponent</code>로 타입을 구분합니다.</p>
<pre><code>class UserAccountModel(val userName: String, val emailAddress: String)
class UserProfileViewComponent(
    val accountModel: UserAccountModel,
    val profileImageUri: Uri?
)

fun toUserProfileViewComponent(
    accountModel: UserAccountModel
): UserProfileViewComponent { ... }</code></pre>
<h3 id="3:-'마지막-작업(terminal-operation)'을-만드는-경우">3: '마지막 작업(terminal operation)'을 만드는 경우</h3>
<p>다음 조건에 해당할 때에는 빌더 패턴과 유사한 것을 사용하면 잘 작동할 수 있습니다.</p>
<ul><li>0회 이상인 임의의 횟수와 임의의 순서로 적용되는 '작업'이 있다.</li><li>'마지막 작업' 이후에는 위 작업이 금지된다.</li></ul>
<p>일반적으로 데코레이터 패턴에 마지막 작업을 추가하는 경우가 이에 해당합니다. 다음 코드는 이미지 편집에 이 패턴을 이용한 예시입니다.</p>
<pre><code>val profileImageBitmap = loadModifiableImage(uri)
    .crop(CropType.ROUND)
    .fitIn(hightPx, widthPx)
    .colorFilter(Filter.DARK)
    .createBitmap()</code></pre>
<p>이렇게 하면 다음과 같은 순수한 데코레이터 패턴보다 가독성이 좋아집니다.</p>
<pre><code>val profileImage = ColorFilter(
    FitIn(
        Crop(
            loadModifiableImage(uri),
            CropType.ROUND
        ),
        hightPx,
        widthPx
    ),
    Filter.DARK
).getBitmap()</code></pre>
<hr>
<blockquote>
<p>한 줄 요약: 빌더 패턴 대신 생성자나 팩토리 함수를 사용하는 것을 고려한다.</p>
<p>키워드: <code>builder pattern</code>, <code>optional properties</code>, <code>immutability</code></p>
</blockquote></div></article></div>

LINE ENGINEERING

이 글은 2024년 3월 14일에 일본어로 먼저 발행된 기사를 번역한 글입니다.안녕하세요. 커뮤니케이션 앱 LINE의 모바일 클라이언트를 개발하고 있는 Ishikawa입니다.저희 ...

코드 품질 개선 기법 17편: 사상누각

댓글