[클린코드(CleanCode)] 10장 클래스

개요

지금까지 코드 행, 코드 블록, 함수 구현 방법과 함수 간의 관련 맺는 방식을 공부했다.
하지만 좀 더 차원 높은 단계까지 신경 쓰지 않으면 코드를 얻기는 어렵다.

이 장에서는 깨끗한 클래스를 다룬다.

---

클래스 체계

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

static public 상수 => static private 변수 => private 인스턴스 변수 이렇게 나온다.

public 변수는 필요한 경우가 거의 없다.

변수 목록 다음에는 공개 함수가 나온다. 

비공개 함수는 자신을 호출하는 공개 함수 직후에 나온다.
즉, 추상화 단계가 순차적으로 내려간다.

그래서 프로그램은 신문 기사처럼 읽힌다.

 

캡슐화

변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다.

때로는 protected로 선언에 테스트 코드에 접근을 허용하기도 한다.

우리에게 테스트는 중요하므로 같은 패키지 안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면 그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개한다.

 

하지만 비공개 상태를 유지할 온갖 방법을 강구해야 한다.

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

---

클래스는 작아야 한다!

클래스는 작아야 한다.

클래스를 설계할 때도, 함수와 마찬가지로, '작게'가 기본 규칙이다.

그럼 얼마나 작아야 할까?

 

함수는 물리적인 행 수로 크기를 측정했다.

클래스는 함수와 다르게 맡은 책임을 센다.

 

아래 코드는 대량 70개의 공개 매서드가 있다.

public class SuperDashboard extends JFrame implements MetaDataUser {
	public String getCustomizerLanguagePath()
	public void setSystemConfigPath(String systemConfigPath) 
	public String getSystemConfigDocument()
	public void setSystemConfigDocument(String systemConfigDocument) 
	public boolean getGuruState()
	public boolean getNoviceState()
	public boolean getOpenSourceState()
	public void showObject(MetaObject object) 
	public void showProgress(String s)
	public boolean isMetadataDirty()
	public void setIsMetadataDirty(boolean isMetadataDirty)
	public Component getLastFocusedComponent()
	public void setLastFocused(Component lastFocused)
	public void setMouseSelectState(boolean isMouseSelected) 
	public boolean isMouseSelected()
	public LanguageManager getLanguageManager()
	public Project getProject()
	public Project getFirstProject()
	public Project getLastProject()
	public String getNewProjectName()
	public void setComponentSizes(Dimension dim)
	public String getCurrentDir()
	public void setCurrentDir(String newDir)
	public void updateStatus(int dotPos, int markPos)
	public Class[] getDataBaseClasses()
	public MetadataFeeder getMetadataFeeder()
	public void addProject(Project project)
	public boolean setCurrentProject(Project project)
	public boolean removeProject(Project project)
	public MetaProjectHeader getProgramMetadata()
	public void resetDashboard()
	public Project loadProject(String fileName, String projectName)
	public void setCanSaveMetadata(boolean canSave)
	public MetaObject getSelectedObject()
	public void deselectObjects()
	public void setProject(Project project)
	public void editorAction(String actionName, ActionEvent event) 
	public void setMode(int mode)
	public FileManager getFileManager()
	public void setFileManager(FileManager fileManager)
	public ConfigManager getConfigManager()
	public void setConfigManager(ConfigManager configManager) 
	public ClassLoader getClassLoader()
	public void setClassLoader(ClassLoader classLoader)
	public Properties getProps()
	public String getUserHome()
	public String getBaseDir()
	public int getMajorVersionNumber()
	public int getMinorVersionNumber()
	public int getBuildNumber()
	public MetaObject pasting(MetaObject target, MetaObject pasted, MetaProject project)
	public void processMenuItems(MetaObject metaObject)
	public void processMenuSeparators(MetaObject metaObject) 
	public void processTabPages(MetaObject metaObject)
	public void processPlacement(MetaObject object)
	public void processCreateLayout(MetaObject object)
	public void updateDisplayLayer(MetaObject object, int layerIndex) 
	public void propertyEditedRepaint(MetaObject object)
	public void processDeleteObject(MetaObject object)
	public boolean getAttachedToDesigner()
	public void processProjectChangedState(boolean hasProjectChanged) 
	public void processObjectNameChanged(MetaObject object)
	public void runProject()
	public void setAçowDragging(boolean allowDragging) 
	public boolean allowDragging()
	public boolean isCustomizing()
	public void setTitle(String title)
	public IdeMenuBar getIdeMenuBar()
	public void showHelper(MetaObject metaObject, String propertyName) 
	
	// ... many non-public methods follow ...
}

 

이를 매서드를 5개 정도만 포함하면 어떨까?

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

매세드 수가 작음에도 불구하고 책임이 너무 많다.

클래스 이름은 해당 클래스 책임을 기술해야 된다.

작명은 클래스 크기를 줄이는 첫 번째 관문이다.
간결한 이름이 떠오르지 않는다면 클래스 책임이 너무 많아서이다.

 

또한 클래스 설명은 "if", "and", "or", "but"을 사용하지 않고 25 단어 내외로 가능해야 한다.

한글의 경우 "만약", "그리고", "~하며", "하지만" 이 들어가면 안 된다.

만약 들어간다면 클래스에 책임이 많다는 증거이다.

단일 책임 원칙

단일 책임 원칙(Single Responsibility Principle, SRP)은 클래스나 모듈을 변경할 이유가 하나뿐이어야 한다는 원칙이다.

SRP는 '책임'이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.

클래스는 책임, 즉 변경할 이유가 하나여야 한다는 의미다.

변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.

 

SRP는 객체 지향 설계에서 더욱 중요한 개념이고 이해하고 지키기 수월한 개념이다.

그러나 클래스 설계자들이 가장 무시하는 규칙 중 하나다.

대부분의 프로그래머들이 돌아가는 소프트웨어에 초점을 맞춘다.

전적으로 올바른 태도이기는 하지만, 돌아가는 소프트웨어가 작성되면 깨끗하고 체계적인 소프트웨어라는 다음 관심사로 전환을 해야 한다.

 

그러나 자잘한 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다.

그래도 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다.

 

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

 

 

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

응집도

클래스는 인스턴스 변수 수가 작아야 한다.

각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.

일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.

 

모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높지만, 이런 클래스는 가능하지도, 바람직하지도 않다.

하지만 가능한 응집도가 높은 클래스를 지향해야 한다.

응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문이다.

아래 코드는 Stack을 구현한 코드인데 응집도가 아주 높다.

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

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

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

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

몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어날수록 클래스는 응집력을 잃는다.

클래스가 응집력을 잃는다면 쪼개라! 큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.

그러면서 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.

---

변경하기 쉬운 클래스

대다수 시스템은 지속적인 변경이 가해지지만 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.

깨끗한 시스템은 클래스를 체계적으로 관리해 변경에 따르는 위험을 최대한 낮춘다.

 

해당 코드는 새로운 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)
}

 

아래 코드는 공개 인터페이스를 전부 SQL 클래스에서 파생하는 클래스로 만들고, 비공개 메서드는 해당 클래스로 옮기고, 공통된 인터페이스는 따로 클래스로 뺐다.
이렇게 하면 update 문 추가 시에 기존의 클래스를 건드릴 이유가 없어진다.

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 class ColumnList {
    public ColumnList(Column[] columns) public String generate()
}

 

새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다.

이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.

 

변경으로부터 격리

요구사항이 변하면 코드도 변하기 마련이다.

객체지향 프로그래밍 입문에서 concrete 클래스와 abstract 클래스가 있다고 배웠다.

concrete 클래스(상세한 구현을 포함)에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
그래서 인터페이스와 abstract 클래스를 사용해 구현이 미치는 영향을 격리시켜야 한다.

 

상세한 구현에 의존하는 코드는 테스트가 어렵다.
그래서 추상화를 통해 테스트가 가능할 정도로 시스템의 결합도를 낮춤으로써 유연성과 재사용성도 더욱 높아진다.

결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미다. 

시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다.

 

이렇게 결합도를 최소로 줄이면 자연스럽게 또 다른 클래스 설계 원칙인 DIP(Dependency Inversion Principle)를 따르는 클래스가 나온다.

본질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.

---

글쓴이의 생각

한 가지 반성되는 점이 있다면 아직도 만능 클래스를 만들고 있다는 것이다.
의도적으로 만드는 것이 아니라 이미 목적에 맞게 클래스를 만들었는데
유지 보수하면서 그 클래스가 가져야 하는 책임이 여러 개가 되어 버린다.
그러나 동작은 잘해서 복잡하지만 어쩔 수 없다고 생각해 방치해두는 클래스가 되었다.
단일 책임 원칙에 대해서는 여러 번 들어봤지만 생각보다 잘 안 지켜지고 있다는 사실을 위의 클래스를 구현하고 나서 알았다.
물론 처음부터 잘 짤 수는 없는 법이니 여러 번 수정을 통해 고쳐 나가봐야겠다.