클린 코드(Clean Code) - 10장

10장. 클래스 🏠

  지금까지 코드 행과 코드 블록을 올바로 작성하는 방법에 초점을 맞췄다. 함수를 올바로 구현하는 방법과 함수가 서로 관련을 맺는 방식도 공부했다. 하지만 코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경 쓸지라도 좀 더 차원 높은 단계까지 신경 쓰지 않으면 깨끗한 코드를 얻기는 어렵다. 이 장에서는 깨끗한 클래스를 다룬다.

• 클래스는 작아야 한다!
    얼마나 작아야 하는가? 함수는 물리적인 행 수로 크기를 측정했다. 클래스는 맡은 책임으로 측정을 한다.
• 단일 책임 원칙 (Single Responsibility Priciple)
    SRP는 클래스나 모듈을 변경할 이유가 하나, 단 하나뿐이어야 한다는 원칙이다. 이는 '책임'이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.

public class SuperDashboard extends JFrame implements MetaDataUser {
    public Component getLastFocusedComponent()
    public void setLastFocused(Component lastFocused)
    public int getMajorVersionNumber()
    public int getMinorVersionNumber()
    public int getBuildNumber()
}

  위의 클래스는 겉보기에는 작아 보이지만 변경할 이유가 두 가지다. 첫 번째로는 SuperDashboard는 소프트웨어 버전 정보를 추적한다. 두 번째로는 SuperDashboard는 자바 스윙 컴포넌트를 관리한다. (SuperDashboard는 최상위 GUI 윈도의 스윙 표현인 JFrame에서 파생한 클래스다.) 즉, 스윙 코드를 변경할 때마다 버전 정보가 달라진다.

  SRP를 지키기 위해서는 SuperDashboard에서 버전 정보를 다루는 메서드 세 개를 따로 빼내 Version이라는 독자적인 클래스를 만들면 된다.

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

  이처럼 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

 

• 응집도
    응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미다. 그래서 우리는 응집도가 높은 클래스를 선호한다. 그러기 위해서는 클래스는 인스턴스 변수 수가 작아야 한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다. 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다. 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
    그래서 '함수를 작게, 매개변수 목록을 짧게'라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다. 이는 십중팔구 새로운 클래스로 쪼개야 한다는 신호다. 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개준다.
• 변경하기 쉬운 클래스
    다음은 주어진 메타 자료로 적절한 SQL 문자열을 만드는 Sql 클래스다. 추후에 update 문과 같은 일부 SQL 기능을 지원할 시점이 오면 클래스를 수정할 필요가 있다. 

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)
}

  위의 코드는 변경할 이유가 2가지다. 앞서 말한 것처럼 새로운 SQL 문을 지원하려면 Sql 클래스에 손을 대야 하고, 또한 기존 SQL 문 하나를 수정할 때도 반드시 Sql 클래스에 손대야 한다. 

  이를 해결하기 위해 Sql 클래스에서 파생하는 클래스를 만들자. valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮기고 모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 Where과 ColumnList라는 두 유틸리티 클래스에 넣자.

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

public class CreateSql extends Sql {
    public CreateSql(String table, Column[] columns)
    @Override 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 SelectWithCriteriaSql extends Sql {
    public SelectWithCriteriaSql(
            String table, Column[] columns, Criteria criteria)
    @Override public String generate()
}

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

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

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

public class Where {
    public Where(String criteria)
    public String generate()
}

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

  update 문을 추가할 때 기존 클래스를 변경할 필요가 전혀 없다. 함수 하나를 수정했다고 다른 함수가 망가질 위험도 없다. 이는 SRP를 지원하고 OCP 또한 지원한다.