코드 품질과 유지보수성

제품 수준(Product-Level) C++ 코딩: 코드 품질과 유지보수성

소프트웨어 제품 개발에서는 코드 품질과 유지보수성이 매우 중요하다. 개인 프로젝트에서는 단순히 동작하는 코드를 작성하는 것이 목표일 수 있지만, 제품 수준의 C++ 코딩에서는 장기적인 유지보수와 확장성을 고려해야 한다.

이번 포스트에서는 코드 품질과 유지보수성을 높이기 위한 핵심 원칙을 설명한다.

---

1. 클린 코드 작성

클린 코드(Clean Code)란 읽기 쉽고 유지보수하기 쉬운 코드를 의미한다. 코드는 개발자뿐만 아니라 팀원, 미래의 유지보수 담당자도 쉽게 이해할 수 있어야 한다.

가독성이 높은 코드 작성

아래 두 코드를 비교해 보자.

가독성이 낮은 코드 예시

int f(int a, int b) {
    return a * b - (a + b);
}

이 함수는 a와 b를 받아 연산을 수행하지만, 이 코드만 봐서는 어떤 의미인지 알기 어렵다.

가독성이 높은 코드 예시

int calculate_discount(int price, int discount_rate) {
    return price * discount_rate - (price + discount_rate);
}

이 코드에서는 함수명을 calculate_discount로 변경하여 의미를 명확히 했다. 또한 변수명을 price와 discount_rate로 수정하여 코드를 읽는 사람이 쉽게 이해할 수 있도록 만들었다.

일관된 코딩 스타일 유지

코딩 스타일이 일관되지 않으면 유지보수가 어려워진다. 팀 내에서는 다음과 같은 스타일 가이드를 정하고 따르는 것이 중요하다.

1. 네이밍 규칙 통일 (CamelCase, snake_case 등)
2. 들여쓰기 및 공백 컨벤션 준수
3. 일관된 주석 스타일 유지

C++에서는 Google C++ Style Guide, LLVM Coding Standards 등의 스타일 가이드를 참고할 수 있다.

---

2. SOLID 원칙: 유지보수성과 확장성을 높이는 설계 원칙

SOLID 원칙은 객체 지향 프로그래밍(OOP)의 핵심 원칙으로, 코드의 유지보수성과 확장성을 높이는 데 도움을 준다.

S: 단일 책임 원칙(Single Responsibility Principle, SRP)

"클래스는 단 하나의 책임만 가져야 한다."

즉, 하나의 클래스는 한 가지 역할만 수행해야 한다.

잘못된 예시 (여러 책임을 가진 클래스)

class Report {
public:
    void generateReport() { /* 보고서 생성 */ }
    void saveToFile() { /* 파일 저장 */ }
};

이 클래스는 보고서를 생성하는 기능과 파일 저장 기능을 함께 담당하고 있다.

개선된 예시 (단일 책임 원칙 적용)

class ReportGenerator {
public:
    void generateReport() { /* 보고서 생성 */ }
};

class FileSaver {
public:
    void saveToFile() { /* 파일 저장 */ }
};

이제 ReportGenerator는 보고서 생성만 담당하고, FileSaver는 파일 저장만 담당하도록 분리했다.

---

O: 개방-폐쇄 원칙(Open-Closed Principle, OCP)

"코드는 확장에는 열려 있어야 하지만 변경에는 닫혀 있어야 한다."

즉, 기존 코드를 수정하지 않고 새로운 기능을 추가할 수 있도록 설계해야 한다.

개선된 예시 (OCP 적용: 다형성 활용)

class Shape {
public:
    virtual void draw() = 0; // 순수 가상 함수
};

class Circle : public Shape {
public:
    void draw() override { /* 원을 그리는 코드 */ }
};

class Rectangle : public Shape {
public:
    void draw() override { /* 사각형을 그리는 코드 */ }
};

이제 Shape 클래스를 상속받아 새로운 도형 클래스를 추가할 수 있다. 기존 코드를 수정할 필요 없이 확장이 가능하다.

---

L: 리스코프 치환 원칙(Liskov Substitution Principle, LSP)

"자식 클래스는 부모 클래스를 대체할 수 있어야 한다."

개선된 예시 (LSP 준수: 상속 구조 수정)

class Bird {
public:
    virtual void move() = 0;
};

class FlyingBird : public Bird {
public:
    void move() override { /* 하늘을 날아감 */ }
};

class Penguin : public Bird {
public:
    void move() override { /* 헤엄침 */ }
};

---

I: 인터페이스 분리 원칙(Interface Segregation Principle, ISP)

"클라이언트는 자신이 사용하지 않는 메서드에 의존하지 않아야 한다."

잘못된 예시 (인터페이스가 너무 큼)

class Worker {
public:
    virtual void work() = 0;
    virtual void eat() = 0;
};

개선된 예시 (인터페이스 분리)

class Workable {
public:
    virtual void work() = 0;
};

class Eatable {
public:
    virtual void eat() = 0;
};

---

D: 의존성 역전 원칙(Dependency Inversion Principle, DIP)

"고수준 모듈은 저수준 모듈에 의존해서는 안 된다."

잘못된 예시 (구체적인 클래스에 의존함)

class Light {
public:
    void turnOn() {}
};

class Switch {
    Light light;
public:
    void operate() { light.turnOn(); }
};

개선된 예시 (DIP 적용)

class Switchable {
public:
    virtual void turnOn() = 0;
};

class Light : public Switchable {
public:
    void turnOn() override {}
};

class Switch {
    Switchable& device;
public:
    Switch(Switchable& d) : device(d) {}
    void operate() { device.turnOn(); }
};

---

3. 디자인 패턴 활용

디자인 패턴은 반복적으로 등장하는 소프트웨어 설계 문제를 해결하는 템플릿이다.

---

마무리

제품 수준의 C++ 코딩에서는 가독성 높은 코드 작성, SOLID 원칙 적용, 디자인 패턴 활용이 중요하다. 이러한 원칙을 따르면 유지보수하기 쉬운 코드를 만들 수 있으며, 팀 개발에서도 효율적인 협업이 가능하다.