클린코드 레시피: 유지보수 가능한 코드 작성하기

쉽게 배우는 튼튼한 프로그래밍 방법론

클린코드 레시피: 유지보수 가능한 코드 작성하기

일상로그92 2024. 9. 19. 19:27

클린코드(Clean Code)란 무엇일까요? 이 개념은 코드가 단순히 작동하는 것 이상의 의미를 담고 있습니다. 클린코드는 가독성과 유지보수성을 고려하여 작성된 코드를 의미합니다. 좋은 코드는 단순히 버그가 없는 것에 그치지 않고, 다른 개발자들이 쉽게 이해하고 수정할 수 있는 구조를 갖추어야 합니다. 클린코드의 핵심은 명확성과 간결함입니다. 코드가 간결하고 명확하게 작성되면, 버그를 찾고 수정하는 것이 쉬워지며, 새로운 기능을 추가하는 것도 훨씬 간편해집니다.

이 블로그 시리즈에서는 클린코드를 작성하기 위한 다양한 레시피를 소개하고, 이를 실제 코드 예제와 함께 설명해 드리겠습니다. 각 레시피는 클린코드의 핵심 원칙을 따라, 코드를 어떻게 개선할 수 있는지를 다루고 있습니다.

레시피 1: 의미 있는 이름 짓기

클린코드를 작성하는 데 있어 가장 기본적인 것은 바로 변수명과 함수명을 의미 있게 짓는 것입니다. 이름을 지을 때는 다음과 같은 규칙을 따르는 것이 좋습니다:

자세하고 구체적인 이름 사용: 변수명이나 함수명은 그 역할을 명확히 설명해야 합니다. 예를 들어, x나 temp와 같은 이름보다는 userAge나 calculateTotalAmount와 같이 구체적인 이름이 더 좋습니다.
명사와 동사 사용: 변수명은 명사로, 함수명은 동사로 시작하는 것이 일반적입니다. 예를 들어, customerList는 명사로서 리스트를 나타내고, calculateTotalPrice는 동사로서 기능을 설명합니다.
일관성 유지: 같은 종류의 변수나 함수는 일관된 명명 규칙을 사용하는 것이 좋습니다. 이를 통해 코드를 읽는 사람이 변수나 함수의 용도를 쉽게 이해할 수 있습니다.

코드 예제

# 나쁜 예
def calc(x, y):
    return x + y

total = calc(5, 10)

# 좋은 예
def calculateSum(firstNumber, secondNumber):
    return firstNumber + secondNumber

totalAmount = calculateSum(5, 10)

위 예제에서, calc라는 함수명은 그 기능이 무엇인지 명확히 알기 어렵습니다. 반면, calculateSum은 함수의 목적을 명확히 전달합니다. 이와 같이 코드의 가독성을 높이기 위해서는 의미 있는 이름을 사용하는 것이 중요합니다.

레시피 2: 함수는 하나의 일만 하게 하라

클린코드의 원칙 중 하나는 함수는 하나의 작업만 수행해야 한다는 것입니다. 함수가 여러 가지 일을 처리하게 되면, 코드가 복잡해지고 유지보수가 어려워집니다. 함수가 하나의 명확한 작업만 수행하도록 설계하면, 코드의 가독성이 향상되고, 테스트도 용이해집니다.

작은 함수로 나누기: 복잡한 함수는 여러 개의 작은 함수로 나누어 각각의 함수가 하나의 일만 하도록 합니다.
함수명으로 기능 설명: 함수명으로 그 기능을 명확히 설명하도록 합니다. 예를 들어, processData라는 함수가 saveData, loadData를 호출하는 경우, processData는 명확한 기능을 설명하지 않습니다. 이럴 때는 각 함수가 하나의 작업만 수행하도록 나누는 것이 좋습니다.

코드 예제

# 나쁜 예
def processOrder(order):
    validateOrder(order)
    applyDiscount(order)
    chargeCustomer(order)
    sendConfirmation(order)

# 좋은 예
def validateOrder(order):
    # 주문 유효성 검사 코드

def applyDiscount(order):
    # 할인 적용 코드

def chargeCustomer(order):
    # 고객에게 청구하는 코드

def sendConfirmation(order):
    # 확인 메일 전송 코드

processOrder 함수는 여러 가지 일을 처리하고 있어, 이 함수를 이해하고 수정하는 것이 어려울 수 있습니다. 반면, 각 함수가 하나의 작업만 수행하도록 나누면 코드가 더 명확해지고 유지보수가 쉬워집니다.

레시피 3: 주석은 최소화하라

코드에 주석을 다는 것은 중요하지만, 주석이 많아지면 오히려 코드가 복잡해질 수 있습니다. 주석은 코드의 의도를 설명하는 도구로 사용되며, 코드 자체가 명확할 때 주석이 필요하지 않습니다. 따라서 코드는 가능한 한 스스로 설명할 수 있어야 하며, 주석은 코드의 의도를 명확히 하는 데만 사용해야 합니다.

자명한 코드는 주석 없이 작성: 코드 자체가 명확하게 의도를 전달할 수 있도록 작성합니다. 코드가 자명하다면 주석은 필요하지 않습니다.
주석은 왜와 무엇을 설명: 주석은 코드가 왜 그렇게 작성되었는지, 무엇을 하는지 설명하는 데 사용합니다. 코드의 동작을 설명하는 주석은 코드가 바뀔 때 함께 수정되어야 합니다.

코드 예제

# 나쁜 예
def calculateDiscount(price):
    # 가격이 100 이하인 경우 10% 할인
    if price <= 100:
        return price * 0.1
    # 가격이 100 초과인 경우 5% 할인
    else:
        return price * 0.05

# 좋은 예
def calculateDiscount(price):
    if price <= 100:
        return price * 0.1
    else:
        return price * 0.05

위 예제에서 주석은 코드의 동작을 설명하고 있지만, 코드 자체가 간단하고 명확하기 때문에 주석 없이도 이해할 수 있습니다. 주석이 필요 없는 코드 작성이 최상의 방법입니다.

레시피 4: 오류 처리와 예외 관리

오류 처리와 예외 관리는 코드의 안정성을 높이는 중요한 부분입니다. 적절한 오류 처리를 통해 프로그램이 예기치 않은 상황에서도 올바르게 작동할 수 있도록 해야 합니다.

구체적인 예외 처리: 가능한 한 구체적인 예외를 처리하도록 하며, 일반적인 예외는 피하는 것이 좋습니다. 예를 들어, Exception 클래스보다 더 구체적인 예외 클래스를 사용하는 것이 좋습니다.
예외 발생 시 적절한 대처: 예외가 발생했을 때 적절한 대처를 하도록 하며, 예외에 대한 로깅이나 사용자에게 유용한 오류 메시지를 제공하는 것이 좋습니다.

코드 예제

# 나쁜 예
try:
    result = divide(a, b)
except Exception as e:
    print(f"Error: {e}")

# 좋은 예
try:
    result = divide(a, b)
except ZeroDivisionError:
    print("Error: Division by zero is not allowed.")
except ValueError:
    print("Error: Invalid value provided.")

위 예제에서 Exception을 처리하는 것은 너무 일반적입니다. ZeroDivisionError와 ValueError를 구체적으로 처리함으로써, 예외 상황에 맞는 적절한 대응이 가능합니다.

레시피 5: 코드의 일관성 유지

코드의 일관성은 전체 코드베이스의 가독성과 유지보수성을 높이는 데 중요한 역할을 합니다. 코드가 일관되게 작성되면, 다른 개발자들이 코드를 이해하고 수정하는 데 어려움을 겪지 않게 됩니다.

코딩 스타일 가이드 준수: 팀이나 프로젝트에서 사용하는 코딩 스타일 가이드를 준수하는 것이 좋습니다. 코드의 포맷팅, 들여쓰기, 네이밍 규칙 등이 일관되게 유지되어야 합니다.
패턴과 원칙 적용: 디자인 패턴이나 프로그래밍 원칙을 일관되게 적용하여 코드의 일관성을 유지합니다. 예를 들어, 객체 지향 프로그래밍에서는 SOLID 원칙을 따르는 것이 좋습니다.

코드 예제

# 나쁜 예
def getuserData():
    # 사용자 데이터를 가져오는 코드

def calculateuserAge(userBirthdate):
    # 사용자 나이를 계산하는 코드

# 좋은 예
def getUserData():
    # 사용자 데이터를 가져오는 코드

def calculateUserAge(userBirthDate):
    # 사용자 나이를 계산하는 코드

위 예제에서 함수명에서의 일관성이 부족합니다. 일관된 네이밍 규칙을 사용하는 것이 코드의 일관성을 높이고, 읽기 쉽고 유지보수하기 쉬운 코드를 만듭니다.

결론: 클린코드의 중요성

클린코드는 단순히 코드가 작동하는 것 이상의 의미를 가집니다. 클린코드는 가독성, 유지보수성, 그리고 확장성을 고려하여 작성된

코드입니다. 위에서 소개한 레시피들을 통해 코드를 더욱 명확하고 유지보수하기 쉬운 방식으로 개선할 수 있습니다. 클린코드의 원칙을 따르다 보면, 개발자는 더 안정적이고 효율적인 소프트웨어를 개발할 수 있게 될 것입니다.

FAQ

Q1: 클린코드의 가장 중요한 원칙은 무엇인가요?

클린코드의 가장 중요한 원칙은 코드의 명확성과 간결함입니다. 코드가 간결하고 명확하게 작성되어야 가독성이 높아지고 유지보수하기 쉬워집니다.

Q2: 함수가 하나의 일만 해야 하는 이유는 무엇인가요?

함수가 하나의 일만 수행하도록 설계하면, 코드의 가독성이 높아지고 유지보수가 쉬워집니다. 여러 가지 일을 처리하는 함수는 복잡해져서 이해하기 어려워질 수 있습니다.

Q3: 주석을 줄이기 위해 어떤 방법을 사용할 수 있나요?

주석을 줄이기 위해서는 코드가 스스로 명확하게 설명할 수 있도록 작성하는 것이 중요합니다. 코드의 의도가 명확하게 전달되면, 주석이 필요 없게 됩니다.

일상로그