[클린코드] 클래스

코드의 표현력에 아무리 신경 쓸지라도 좀 더 차원 높은 단계까지 신경쓰지 않으면 깨끗한 코드를 얻기 어렵다.

클래스 체계

추상화 단계는 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.

 

캡슐화 : 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.

클래스는 작아야 한다

• 클래스는 작아야 한다.
• 함수는 물리적인 행 수로 측정했지만, 클래스는 클래스가 맡은 책임을 센다.
• 클래스 이름은 해당 클래스 책임을 기술해야 한다.
  • 간결한 이름이 떠오르지 않는다면, 필경 클래스 크기가 너무 커서 그렇다.
  • 클래스 이름에 Processor, Manager, Super 같은 모호한 단어가 포함되어있다면, 클래스 책임이 너무 낳아서다.

 

단일 책임 원칙 (Single Responsibility Principle, 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() 
}

이 클래스는 변경할 이유가 두가지이다.

1. 소프트웨어 버전이 바뀔 경우 변경이 필요하다.
   (SuperDashboard는 소프트웨어 버전 정보를 추적한다.)
2. SuperDashboard는 자바스윙 컴포넌트를 관리한다. 즉, 스윙 코드를 변경할 때마다 버전 번호가 달라진다.
   (역은 참이 아니다. 다른 코드를 바꾸고 나서도 버전 번호를 바꾼다.)

책임, 즉 변경할 이유를 파악하려 애쓰다보면 코드를 추상화하기도 쉬워진다. (좋은 추상화가 더 쉽게 떠오른다.)

 

SuperDashboard에서 버전 정보를 다루는 메소드 세개를 따로 빼내 Version이라는 독자적인 클래스를 만든다.

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

 

대다수는 ‘깨끗하고 체계적인 소프트웨어’보다 ‘돌아가는 소프트웨어’에 초점을 맞춘다. 관심사 분리하는 작업은 중요하기 때문에 올바른 태도다.

• 문제는 우리는 ‘깨끗하고 체계적인 소프트웨어’라는 다음 관심사로 전환하지 않는다.

많은 개발자들이 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다. 하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇개 뿐인 시스템이든 돌아가는 부품의 수는 비슷하다.

• 큼직한 다목적 클래스는 당장 알 필요가 없는 사실까지 이해해야 한다.
• 결국 도구 상자를 어떻게 관리하고 싶은가? 라는 질문의 답을 생각하면 쉽다.
  작은 서랍을 많이 두고 기능과 이름이 명확한 컴포넌트를 나눠 넣고 싶은가? 아니면 큰 서랍 몇 개를 두고 모두를 던져 넣고 싶은가?
• 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다. → 체계적인 정리가 필수다.
  변경을 가할 때 직접 영향이 미치는 컴포넌트만 이해해도 충분하다.
• 결국에는, 큰 클래스 몇개가 아닌 작은 클래스 여럿으로 이루어진 시스템이 더 바람직하다.
  작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

응집도

• 클래스는 인스턴스 변수 수가 작아야 한다.
• 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
  → 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
• 응집도가 높다 : 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문이다

변경하기 쉬운 클래스

대다수 시스템은 지속적인 변경이 가해진다.

• 변경 때마다 시스템이 의도대로 동작하지 않은 위험이 따른다.
• 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
• 메타 자료로 적절한 SQL 문자열을 만들어주는 sql 클래스위 클래스는 변경할 이유가 두 가지가 있기 때문에 SRP를 위반한다.

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

위 클래스는 변경할 이유가 두 가지가 있기 때문에 SRP를 위반한다.

1. 새로운 SQL 문을 지원하려면 반드시 Sql 클래스에 손대야 한다. (현재 update문이 존재하지 않음)
2. 기존 SQL 하나를 수정할 때도 반드시 Sql 클래스에 손대야 한다.

아래 코드는 공개 인터페이스를 각각 SQL 클래스에서 파생하는 클래스로 만든 결과다.

• valuesList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮긴다.
• 공통적으로 사용하는 비공개 메서드는 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, Column column, String pattern) 
	@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 String generate() {
}

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

클래스가 서로 분리되었기 때문에 클래스가 단순하고 코드는 순식간에 이해할 수 있게 변했다.

• 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사라졌다.
• 테스트하기도 쉬워졌다.
• SRP와 OCP를 지원한다.

Update 문을 추가할 때는 기존 클래스를 변경하지 않고 새로운 클래스 UpdateSql을 구현하면 된다.

 

변경으로부터 격리

• 구체적인 클래스는 상세한 구현(코드)를 포함하며, 추상 클래스는 개념만 포함한다고도 배웠다.
  상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
  → 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
• 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
• 결합도를 최소로 줄이면 자연스럽게 또 다른 클래스 설계 원칙인 DIP를 따르는 클래스가 나온다. 본질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.