[좋코vs나코] 제4편: "복붙의 향연" - 중복 코드 제거 (DRY: Don't Repeat Yourself) 🔄

안녕하세요, 코드 품질에 관심 많은 주니어부터 중급 개발자 여러분! 😊 오늘은 개발자라면 누구나 한 번쯤 빠져봤을 유혹, 바로 ‘복붙’에 대한 이야기를 해보려고 해요. 일명 ‘복붙의 향연’ 속에서 허우적대다 보면 어느새 코드는 엉망진창이 되기 십상이죠. 😵‍💫 하지만 걱정 마세요! 오늘 저와 함께 DRY 원칙을 배우고 실천하면, 뽀송뽀송하고 관리하기 쉬운 코드를 만들 수 있을 거예요. ☀️

반응형

🚧 ‘복붙’, 뭐가 그렇게 문제일까요?

"일단 돌아가면 되는 거 아닌가요? 복붙 좀 하면 어때서요? 🤔" 라고 생각하실 수도 있어요. 하지만 코드 중복은 생각보다 심각한 문제들을 야기한답니다.

• 유지보수의 악몽 😱: 똑같은 코드가 여러 군데 흩어져 있다면, 수정할 때마다 모든 곳을 찾아 고쳐야 해요. 하나라도 빼먹으면? 바로 버그 파티죠! 🐛 시간도 오래 걸리고, 실수할 가능성도 커져요.
• 버그의 온상 🐞: 중복된 코드 중 일부만 수정되거나, 잘못 수정되면 예상치 못한 버그가 발생하기 쉬워요. 디버깅할 때도 어디가 문제인지 찾기 어려워지죠.
• 가독성 저하 📉: 똑같은 코드가 반복되면 전체적인 코드의 흐름을 파악하기 어려워요. "이 코드는 아까 봤던 그거랑 같은 건가? 다른 건가?" 헷갈리기 시작하면 집중력도 떨어지고, 코드를 이해하는 데 더 많은 시간이 소요돼요.
• 코드 용량 증가 🐘: 물론 요즘 저장 공간이 넉넉하긴 하지만, 불필요하게 중복된 코드는 코드베이스를 무겁게 만들어요.

결국, 중복 코드는 개발 속도를 저해하고, 코드 품질을 떨어뜨리며, 우리를 야근의 늪으로 빠뜨릴 수 있답니다. 加班... 시러요... 😭

💡 DRY: Don't Repeat Yourself!

이런 문제들을 해결하기 위한 아주 중요한 원칙이 바로 DRY(Don't Repeat Yourself) 입니다. "반복하지 마세요!"라는 뜻이죠. 모든 지식은 시스템 내에서 단일하고, 모호하지 않으며, 권위 있는 표현을 가져야 한다는 원칙이에요. 간단히 말해, 똑같은 로직은 딱 한 곳에만 존재해야 한다는 거죠! ✨

👎 이런 코드는 피해주세요: 중복 코드의 나쁜 예시

자, 그럼 어떤 코드가 중복 코드인지 한번 살펴볼까요?

예시 1: 여러 곳에 복사-붙여넣기 된 코드 블록 (Python)

Python

 

def process_user_data(user_id):
    user = get_user_from_db(user_id)
    if user:
        # 사용자 정보 유효성 검사
        if not user.name:
            print("Error: 사용자 이름이 없습니다.")
            return
        if not user.email or "@" not in user.email:
            print("Error: 유효하지 않은 이메일입니다.")
            return
        # ... (더 많은 유효성 검사 로직) ...

        print(f"{user.name}님의 데이터를 처리합니다.")
        # ... (데이터 처리 로직) ...

def process_admin_data(admin_id):
    admin = get_admin_from_db(admin_id)
    if admin:
        # 관리자 정보 유효성 검사 (사용자 유효성 검사와 매우 유사)
        if not admin.name:
            print("Error: 관리자 이름이 없습니다.")
            return
        if not admin.email or "@" not in admin.email:
            print("Error: 유효하지 않은 이메일입니다.")
            return
        # ... (더 많은 유효성 검사 로직) ...

        print(f"{admin.name}님의 데이터를 처리합니다.")
        # ... (데이터 처리 로직) ...

어때요? process_user_data 함수와 process_admin_data 함수 안에 있는 유효성 검사 로직이 거의 똑같죠? 만약 유효성 검사 규칙이 변경된다면, 두 함수 모두 수정해야 하는 번거로움이 발생해요. 😱

예시 2: 미묘하게 다른 유사 코드들 (JavaScript)

JavaScript

 

function calculateTotalPrice(items) {
    let total = 0;
    for (const item of items) {
        total += item.price * item.quantity;
    }
    // 100달러 이상 구매 시 10% 할인
    if (total >= 100) {
        total *= 0.9;
    }
    return total;
}

function calculateTotalPriceForVIP(items) {
    let total = 0;
    for (const item of items) {
        total += item.price * item.quantity;
    }
    // VIP는 50달러 이상 구매 시 15% 할인
    if (total >= 50) {
        total *= 0.85;
    }
    return total;
}

이 경우, 전체적인 계산 로직은 비슷하지만 할인 조건과 할인율이 살짝 달라요. 이런 코드도 중복으로 볼 수 있을까요? 네, 그렇습니다! 핵심 로직인 '아이템 목록으로 총합 계산' 부분이 중복되고 있거든요.

✅ 이렇게 바꿔봐요: DRY 원칙 적용!

그럼 이제 마법의 DRY 원칙을 적용해서 코드를 개선해 볼까요? 🚀

해결책 1: 중복 로직을 함수로 추출 (Python 예시 개선)

def validate_entity_data(entity):
    """사용자 또는 관리자 데이터의 유효성을 검사합니다."""
    if not entity:
        return False, "데이터가 없습니다."
    if not entity.name:
        return False, "이름이 없습니다."
    if not entity.email or "@" not in entity.email:
        return False, "유효하지 않은 이메일입니다."
    # ... (더 많은 유효성 검사 로직) ...
    return True, "유효성 검사 통과"

def process_user_data(user_id):
    user = get_user_from_db(user_id)
    is_valid, message = validate_entity_data(user)
    if not is_valid:
        print(f"Error: {message}")
        return

    print(f"{user.name}님의 데이터를 처리합니다.")
    # ... (데이터 처리 로직) ...

def process_admin_data(admin_id):
    admin = get_admin_from_db(admin_id)
    is_valid, message = validate_entity_data(admin)
    if not is_valid:
        print(f"Error: {message}")
        return

    print(f"{admin.name}님의 데이터를 처리합니다.")
    # ... (데이터 처리 로직) ...

짜잔! ✨ validate_entity_data라는 함수로 공통된 유효성 검사 로직을 쏙 뽑아냈어요. 이제 유효성 검사 규칙이 바뀌면 이 함수 하나만 수정하면 되겠죠? 훨씬 깔끔하고 관리하기 쉬워졌어요!

 

해결책 2: 유틸리티 함수 및 매개변수 활용 (JavaScript 예시 개선)

function calculateBaseTotal(items) {
    let total = 0;
    for (const item of items) {
        total += item.price * item.quantity;
    }
    return total;
}

function applyDiscount(total, discountThreshold, discountRate) {
    if (total >= discountThreshold) {
        return total * (1 - discountRate);
    }
    return total;
}

function calculateTotalPrice(items) {
    const baseTotal = calculateBaseTotal(items);
    return applyDiscount(baseTotal, 100, 0.10); // 일반 고객 할인: 100달러 이상, 10%
}

function calculateTotalPriceForVIP(items) {
    const baseTotal = calculateBaseTotal(items);
    return applyDiscount(baseTotal, 50, 0.15); // VIP 고객 할인: 50달러 이상, 15%
}

어떤가요? calculateBaseTotal 함수로 아이템 총합을 계산하는 로직을 분리하고, applyDiscount 함수로 할인 로직을 일반화했어요. 이제 각 고객 유형에 따라 다른 할인 조건과 할인율을 매개변수로 전달하기만 하면 되니, 코드의 재사용성이 확 높아졌죠! 👍

그 외의 방법들:

• 클래스와 상속/컴포지션 활용: 객체 지향 프로그래밍에서는 공통된 속성이나 메서드를 부모 클래스에 정의하고, 자식 클래스에서 상속받아 사용할 수 있어요. 또는, 여러 객체를 조합(컴포지션)하여 새로운 기능을 만들 때도 중복을 줄일 수 있답니다.
• 설정 파일 또는 상수 활용: 코드 중간중간에 하드코딩된 값들이 반복된다면, 이 값들을 설정 파일이나 상수 파일로 빼내어 관리하는 것도 좋은 방법이에요.

🎯 DRY 원칙을 지키면 뭐가 좋을까요?

DRY 원칙을 통해 중복 코드를 제거하면 다음과 같은 이점들을 얻을 수 있어요.

• 유지보수 용이성 향상 ✅: 수정할 코드가 한 곳에만 있으니, 빠르고 안전하게 변경할 수 있어요.
• 버그 감소 ✅: 코드 변경 시 발생할 수 있는 실수를 줄여 버그 발생 가능성을 낮춰요.
• 가독성 향상 ✅: 코드가 간결해지고 논리 흐름이 명확해져 이해하기 쉬워져요.
• 재사용성 극대화 ✅: 잘 분리된 함수나 모듈은 다른 곳에서도 쉽게 가져다 쓸 수 있어요.
• 테스트 용이성 향상 ✅: 각 로직이 명확하게 분리되어 있어 단위 테스트를 작성하기 수월해져요.

결국 DRY 원칙은 개발자들의 행복 지수를 높여주는 고마운 원칙이랍니다! 😊

☀️ CTRL+C, CTRL+V는 이제 그만! DRY하게 삽시다! 뽀송뽀송~

자, 오늘은 코드 중복의 문제점과 이를 해결하기 위한 DRY 원칙에 대해 알아봤어요. 처음에는 코드를 분리하고 추상화하는 과정이 조금 어색하고 귀찮게 느껴질 수도 있어요. 하지만 장기적으로 보면 훨씬 효율적이고 안정적인 코드를 만들 수 있는 지름길이랍니다!

이제부터 코드를 작성할 때 "혹시 이 로직, 다른 곳에도 비슷한 게 있지 않나?" 하고 한 번 더 생각하는 습관을 들여보세요. 🤔 여러분의 코드가 점점 더 뽀송뽀송하고 건강해지는 것을 느낄 수 있을 거예요! 💪

오늘 이야기가 여러분의 코드 품질 향상 여정에 작은 도움이 되었기를 바랍니다. 다음 편에서 더 유익한 내용으로 만나요! 👋