CleanCode 10장 클래스

1.  클래스 체계

표준 자바 관례에 따르면, 클래스의 구성은

<변수목록>
static public 변수 -> static private 변수 -> private 인스턴스 변수
(공개 변수가 필요한 경우는 거의 없다)
<공개 함수>
(비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.)

순으로 이루어진다.

< 객체지향 프로그래밍의 기본 원리들 >

1. SRP (Single Responsibillity Principle)

• 클래스틑 하나의 역할만 해야 한다
• 다양한 일을 할 수 있는 만능의 클래스를 만드는 것은 한가지 역할을 하는 클래스보다 좋지 않다
  - 변경을 할 가능성이 높고 좋지 않은 영향을 받을 가능성도 높음
  - 복잡한 자료구조와 메서드를 가질 가능성이 높으며 사용하기 어려울 가능성이 높음
• 명확히 정의된 하나의 구체적인 역할을 줄 수 있다면 SRP를 만족한다고 할 수 있다.

2. OCP (Open Close Principle)

• 확장에 대해서는 열려있고, 변경에 대해서는 닫혀있게 만들어야 한다.
  - 즉 새로운 기능 추가는 쉽지만 변경의 영향이 제한적이여야 한다.

3. LSP (Liskov Substitution Principle)

• 같은 형을 가지는 객체로 대체되어 사용할 수 있어야 한다.
• 동일한 클래스를 상속하는 경우, 상위 클래스를 접근하는 Client 코드들은 상속받은 클래스로 대체하더라도 변경이 없어야 한다.

4. ISP (Interface Segregation Principle)

• 필요한 인터페이스 각각에 대해서 따로 정의해서 사용하는 것이 좋다.
• 즉, 각각의 인터페이스를 공용화해서 한 인터페이스가 너무 많은 기능을 제공하도록 만드는 것은 확장성 및 변경의 영향을 제어하지 못하게 만든다.
• 만능보다는 한가지 일에 특화된 것이 좋다.

5. DIP (Dependency Inversion Principle)

• 구체적인 것에 의존하지 말라
• 다른 클래스나 자료구조의 내부에 의존적인 코드를 짜면 변경에 취약하도록 만든다.
• 추상 클래스를 사용하라.

2.   클래스는 작아야한다!

클래스를 만들 때 첫 번째 규칙은 작아야한다. 두 번째 규칙은 더 작아야한다!
(함수 단원과 같은 말)

아래 코드는 잘못된 예시를 보여준다. 무슨말인지 알아볼 수 없는 클래스이다.

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

위의 코드를 아래와 같이 고칠수도 있다.

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. 클래스 이름은 해당 클레스의 책임을 기술해야 한다.

• Processor, Manager, Super 같은 애매한 단어가 들어가는건 클래스 크기가 크다는 것
  (책임이 많다!)

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

• 위의 코드는 마지막으로 포커슬 ㄹ얻었던 컴퍼넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.
  (책임이 많다!!)

3.  단일 책임 원칙

클래스나 모듈을 변경할 이유는 단 하나뿐이어야 한다.

객체지향에서 가장 중요한 개념이란 것을 모두가 알고 있지만 잘 지켜지지 않는다.
-> '소프트웨어가 돌아가게 만드는 활동'과 '소프트웨어를 깨끗하게 만드는 활동'은 완전히 별개이기 때문

많은 개발자들이 단일 책임 클래스가 많아지면, 큰 그림을 이해하기 어려워진다고 우려한다. 하지만 작은 클래스가 많은 시스템이든, 큰 클래스로 구성된 시스템이든 부품의 수는 비슷하다
-> 도구 상자를 어떻게 정리할 것인가의 차이이다.
(작은 서랍을 많이 두고 나눠 넣고 싶은가? 큰 서랍 몇 개에 다 넣고 싶은가)

결국은 맡은 책임이 하나이며, 변경할 책임이 하나인 작은 클래스 여럿으로 이루어진 시스템이 더 바람직하다.

4.   응집도

1. 클래스 인스턴스 변수 수가 작아야한다.
2. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
3. 일반적으로 매서드는 변수를 더 많이 사용할스록 매서드와 클래스의 응집도가 높다.
4. 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.

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

• 함수를 작게, 매개변수 목록을 짧게하다보면 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.
  -> 새로운 클래스로 쪼개야 한다는 신호!

5.   변경하기 쉬운 클래스

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

아래코드처럼 sql class가 있다고 하자. 아직 미완성이라서 update 같은 기능을 지원하지 않기에 분명 수정해야 할 때가 온다.

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

변경할 때가되면 위와 같은 코드로는 변경이 쉽지않다.

아래와 같이 고친다면 변경이 쉬워질 것이다.

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를 지원한다.

6. 변경으로부터 격리

class 의 종류에는 Concrete(구체적인) class, Abstract(추상적인) class가 있다.

Concrete class는 구현이 바뀔 때 위험에 빠지기 때문에 항상 interface, Abstract class를 사용해서 구현이 미치는 영향과 격리해야 한다.

예를 들어 Protfolio 클래스를 만든다고 가정하자.

• TokyoStockExchange API를 사용해 값을 계산
• 시세에 테스트코드가 영향을 받지만, 5분마다 값이 달라지는 API로 코드짜기가 쉽지 않음

-> Portfolio 클래스에서 API를 직접 호출하지 않고, StockExchange라는 interface를 생성해서 이를 구현하는 TokyouStockExchange 클래스를 구현한다

public insterface StockExchange {
	Money currentPrice(String symbol);
}

-> Portfolio 생성자에서 StockExchange를 인수로 받도록 한다.

public Portfolio {
	private StockExchange exchange;
	public Portfolio(StockExchange exchange) {
		this.exchange = exchange;
	}
	// ...
}

-> 이제 TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있어진다.

public class PortfolioTest {
	private FixedStockExchangeStub exchange;
	private Portfolio portfolio;

	@Before
	protected void setUp() throws Exception {
		exchange = new FixedStockExchangeStub();
		exchange.fix("MSFT", 100);
		portfolio = new Portfolio(exchange);
	}

	@Test
	public void GivenFiveMSFTTotalShouldBe500() throws Exception {
		portfolio.add(5, "MSFT");
		Assert.assertEquals(500, portfolio.value());
	}
}

테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성은 더 높아진다

• 결합도를 최소로 줄이면 DIP를 따르는 클래스가 나온다.
• 각 시스템 요소가 다른 요소로부터 변경이 잘 격리되어 있다는 의미
• 시스템 요소가 잘 격리되어 있으면 요소 이해가 더 쉽다.