CS Clean Code - 클래스

CS/Clean Code

CS Clean Code - 클래스

강태종 2022. 3. 17. 10:10

코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경 쓸지라도 좀 더 차원 높은 단계까지 신경 쓰지 않으면 깨끗한 코드를 얻기는 어렵다. 깨끗한 클래스가 필요하다.

클래스 체계

클래스를 정의하는 표준 자바 관례에 따르면, 가장 먼저 변수 목록이 나온다.

정적 공개 상수
정적 비공개 변수
비공개 인스턴스 변수
공개 변수가 필요한 경우는 거의 없다.

변수 다음에는 공개 함수가 나오고, 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다. 즉, 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.

캡슐화

변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다. 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근 을 허용한다. 하지만 그 전에 비공개 상태를 유지할 온갖 방법을 강구한다. 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.

클래스는 작아야 한다!

클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다. 두 번째 규칙도 크기다. 더 작아야 한다. 그렇다면 가장 먼저 떠오르는 의문은, 함수와 마찬가지로, "얼마나 작아야 하는가"겠다. 함수는 물리적인 행 수로 크기를 측정했다. 클래스는 다른 척도를 사용한다. 클래스가 맡은 책임을 센다.

// 버전 정보를 관리한다.
// 컴포넌트를 관리한다.
public class SuperDashboard extends JFrame implements MetaDataUser {
    public Component getLastFocusedComponent()
    public void setLastFocused(Component lastFocused)
    public int getMajorVersionNumber()
    public int getMinorVersionNumber()
    public int getBuildNumber()
}

메서드 다섯 개 정도면 괜찮다. 안 그런가? 여기서는 아니다. 메서드 수가 작음에도 불구하고 책임이 너무 많다.

작명은 클래스 크기를 줄이는 첫 번째 관문이다. 간결한 이름이 떠오르지 않는다면 클래스 크기가 너무 커서 그렇다. 예를 들어 클래스 이름에 Processor, Manager, Super 등과 같이 모호한 단어가 있다면 여러 책임을 떠안겼다는 증거다.

SuperDashboard는 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.

클래스 설명은 if, but, or, and를 사용하지 않고서 25 단어 내외로 가능해야 한다. ~하며는 SuperDashboard가 책임이 너무 많다는 증거다.

단일 책임 원칙

단일 책임 원칙(Single Responsibility Principle, SRP)는 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙이다. SRP는 책임이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.

public class Version {
    public int getMajorVersionNumber()
    public int getMinorVersionNumber()
    public int getBuildNumber()
}

SuperDashboard에서 버전 정보를 다루는 메소드를 빼내 Version이라는 독자적인 클래스를 만든다. Version이라는 클래스는 다른 곳에서 재사용하기 쉬워졌다.

소프트웨어를 돌아가게 만드는 활동과 소프트웨어를 깨끗하게 만드는 활동은 완전히 별개다. 문제는 대다수가 프로그램이 돌아가면 끝났다고 여기는 데 있다. 만능 클래스를 단일 책임 클래스 여럿으로 분리하는 대신 다음 문제로 넘어가 버린다. SRP는 객체 지향 설계에서 더욱 중요한 개념이다. 또한 이해하고 지키기 수월한 개념이기도 한다. 하지만 이상하게도 SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나다.

많은 개발자는 자잘한 단일 클래스가 많아지면 큰 그림을 이해하기 어렵다고 생각한다. 큰 그림을 이해하려면 많은 클래스를 넘나들어야 한다고 걱정한다. 하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 수가 비슷하다. 규모가 어느 수준에 이르는 시스템은 논리가 많고 복잡하다. 이런 복잡성을 다루려면 체계적인 정리가 필수다.

도구 상자를 어떻게 관리하고 싶은가? 작은 서랍을 많이 두고 기능과 이름이 명확한 컴포넌트를 나눠 넣고 싶은가? 아니면 큰 서랍 몇 개를 두고 모두 던저 녛고 싶은가?

응집도

메서드가 인스턴스 변수를 많이 사용 할수록 응집도가 더 높다. 일반적으로 이처럼 응집도가 가장 높은 클래스는 가능하지도 바람직하지도 않다. 하지만 우리는 응집도가 높은 클래스를 선호한다. 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이기 때문이다.

응집도가 매우 높은 경우이다. size를 제외한 메소드는 인스턴스 변수를 모두 사용하고 있다.

public class Stack {
    private int topOfStack = 0;
    List<Integer> elements = new LinkedList<Integer>();

    public int size() {
        return topOfStack;
    }

    public void push(int element) {
        topOfStack++;
        elements.add(element);
    }

    public int pop() throws PoppedWhenEmpty {
        if (topOfStack == 0)
            throw new PoppedWhenEmpty();
        int element = elements.get(--topOfStack);
        elements.remove(topOfStack);
        return element;
    }
}

'함수를 작게, 매개변수 목록을 짧게'라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다. 십중팔구 새로운 클래스로 쪼개야 한다는 신호다. 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스로 쪼개준다.

응집도를 유지하면 작은 클래스 여럿이 나온다

큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.

큰 함수를 작은 함수로 나눌 때 큰 함수에서 사용하는 변수의 수가 많다면 작은 함수들은 많은 변수를 매개변수로 받아야 옳을까?

매개변수는 적을 수록 재사용할 때 좋다. 클린 코드에도 나왔던 규칙

public class VeryBigFunction {
    // 변경전
    void veryBigFunction() {
        int a, b, c;
        // very
        // big
        // function
    }

    
    // 변경후
    void very(int a, int b, int c) {
        // very
    }

    void big(int a, int b, int c) {
        // big
    }

    void function(int a, int b, int c) {
        // function
    }
}

매개 변수를 인스턴스 변수로 옮긴다면??

매개변수를 줄일 수 있지만, 변수 a, b, c가 생기면서 클래스의 응집도가 낮아진다. (a, b, c)는 very, big, function에서만 쓰이는 변수이기 때문

public class VeryBigFunction {
    int a, b, c;
    
    void very() {
        // very
    }

    void big() {
        // big
    }

    void function() {
        // function
    }
}

여기서 중요한 점은 몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리할 수 있다는 점이다. 결국 큰 함수를 작은 함수로 쪼개다 보면 작은 클래스로 쪼갤 기회가 생긴다. 그러면서 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.

변경하기 쉬운 클래스

대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.

public class Sql {
    public Sql(String table, Column[] columns)
    public String create()
    public String insert(Object[] fields)
    public String selectAll()
    public String findByKey(String keyColumn, String keyValue)
    public String select(Column column, String pattern)
    public String select(Criteria criteria)
    public String preparedInsert()
    private String columnList(Column[] columns)
    private String valuesList(Object[] fields, final Column[] columns) private String selectWithCriteria(String criteria)
    private String placeholderList(Column[] columns)
}

아직 update문을 지원하지 않는다. 새로운 SQL을 지원하려면 반드시 클래스를 수정해야 한다. 또한 기존 구현된 SQL에 수정이 필요할 때 어쩔 수 없이 클래스를 수정하게 된다. 어떤 변경이든 클래스에 손대면 다른 코드를 망가뜨릴 위험이 존재한다.

경험에 의하면 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사한다. 공개 인터페이스를 Sql 클래스의 파생 클래스로 만들고, 비공개 메서드는 해당하는 파생 클래스로 옮겼다.

abstract public class Sql {
    public Sql(String table, Column[] columns)
    abstract public String generate();
}

public class SelectSql extends Sql {
    public SelectSql(String table, Column[] columns)
    @Override public String generate()
}

public class InsertSql extends Sql {
    public InsertSql(String table, Column[] columns, Object[] fields)
    @Override public String generate()
    private String valuesList(Object[] fields, final Column[] columns)
}


public class PreparedInsertSql extends Sql {
    public PreparedInsertSql(String table, Column[] columns)
    @Override public String generate() {
    private String placeholderList(Column[] columns)
}

public class ColumnList {
    public ColumnList(Column[] columns) public String generate()
}

각 클래스는 극도로 단순하다. 코드는 순식간에 이해된다. 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사라졌다. 테스트 관점에서 모든 논리를 증명하기도 쉬워졌다. 클래스가 서로 분리되었기 때문이다. update 문을 새롭게 추가할 때 기존 클래스 변경이 전혀 없고, 새롭게 Sql을 상속받고 구현하면 끝이다.

새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다. 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.

단일 책임 원칙, 개방 폐쇠 원칙이 중요한 것 같다.

변경으로부터 격리

객체 지향 프로그래밍에서 구체적인 클래스와 추상 클래스가 있다. 상세한 구현에 의존하는 클라이언트는 구현이 바뀌면 위험에 빠진다. 그래서 우리는 인터페이스와 추상 클래스로 구현이 미치는 영향을 격리한다.

상세한 구현에 의존하는 코드는 테스트가 어렵다. 예를 들어 Portfolio 클래스를 만들고 내부적으로 외부 TokyoStockExchage API를 사용해서 값을 계산한다고 가정하자. 테스트 코드는 외부 시세에 영향을 받게되고 테스트가 어려워진다.

Portfolio에서 직접 환율을 계산하는 것이 아닌 인터페이스를 통해 참조하도록 구현하자. 테스트를 진행할 때 테스트 전용 가짜 인터페이스를 전달하면 테스트가 쉬워진다. 인터페이스에 의존할 수록 결합도가 낮아지고, 내부 코드를 추상화 할 수 있다(실제 주가를 가져오는 정보).

public interface StockExchage {
    Money currentPrice(String symbol);
}

이렇게 결합도를 줄이면 유연성, 재사용성이 더욱 높아진다. 시스템 요소가 잘 격리되어 있으며 각 요소를 이해하기 쉬워진다. 또한 자연스럽게 DIP 원칙을 따르는 클래스가 나온다.

DIP(Dependency Inversion Principle) : 의존성 역전 원칙
추상화에 의존해야 하며, 구체화에 의존하면 안된다. 추상화는 세부 사항에 의존해서는 안된다. 세부 사항이 추상화에 의존해야 한다.

느낀점

클래스나 함수 모두 결국 크기를 줄여야 한다고 강조하고 있다. 크기가 줄어들면 자연스럽게 응집도가 증가하고 결합도가 낮아진다. 그러면 자연스럽게 객체 지향 프로그래밍에서 중요시 여기는 SRP, OCP 등 다양한 원칙을 지키게 된다. 크기를 줄이자