[클린 코드] Ch.10 - 클래스

클릭하시면 네이버 Book으로 연결됩니다!

해당 서적을 참고하여 개인 공부용으로 정리한 글입니다.

---

클래스 체계

표준 자바 관례에 따르면, 변수 목록이 먼저 나온다.

변수의 순서는 다음과 같다.

1. public static
2. private static
3. private
4. public (거의 없음)

이후 공개 함수가 나오고, 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.(추상화가 내려감)

캡슐화

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

하지만, 비공개 상태를 유지할 방법을 먼저 강구하고 캡슐화를 풀어주는 결정은 마지막에 한다.

---

클래스는 작게

함수와 마찬가지로 클래스도 작아야 한다.

함수는 행 수로 크기를 측정했다면, 클래스는 맡은 책임을 센다.

메서드 수가 작다고 해서 클래스가 작은 것은 아니다.

 

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

클래스 작명이 힘들다면 책임이 많아서 그런것이다.

클래스 설명은 만일(if), 그리고(and), ~하며(or), 하지만(but)을 사용하지 않고 25단어 내외로 가능해야 한다.

---

단일 책임 원칙(SRP)

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

우선 버전 정보를 추적하는데, 버전 정보는 출시할 때마다 달라진다.

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

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

이로써 재사용성이 올라갔다.

SRP는 중요하지만 가장 무시하는 규칙 중 하나이다. (작동에만 신경쓰므로)

작동도 중요하지만 만능 클래스를 체계적인 단일 책임 클래스로 분리하는 작업도 거쳐야한다.

 

큰 클래스 몇 개보다 작은 클래스 여럿으로 이루어진 시스템이 더 바람직하다.

응집도

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

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

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

함수를 짧게, 매개변수 목록을 짧게라는 전략을 따르다 보면 몇몇 메서드만이 사용하는 인스턴스 변수가 많아진다.

이때는 클래스를 쪼개야 한다.

응집도를 유지해야 작은 클래스가 나온다

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

 

인수가 많은 함수의 일부를 작은 함수 하나로 빼내고 싶은데,

큰 함수의 인수를 4개 사용한다면, 4개를 전부 다 인수로 넘겨야 할까?

 

그럴 필요없이 네 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요없다.

하지만 이렇게 되면 클래스가 응집력을 잃는다.

이 말은 독자적인 클래스로 분리해야 될때가 왔다는 신호다.

이렇게 쪼개다 보면 프로그램에 점점 체계가 잡히고 구조가 투명해진다.

 

리팩터링을 수행할 때, 가장 먼저 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성해야 한다.
그 다음 한번에 하나씩 여러번에 걸쳐 코드를 변경하고,
코드를 변경 할 때 마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인한다.

---

변경하기 쉬운 클래스

시스템에 변경점이 있을 때마다 의도대로 동작하지 않을 위험이 따른다.

깨끗한 클래스는 이러한 위험을 줄여준다.

 

클래스 일부에서만 사용되는 비공개 메서드는 코드 개선의 잠재적인 여지를 시사한다.

SRP를 유지하면서 여러 클래스로 쪼갠다면 시스템이 변경되어도 수정해야할 코드는 최소이다.

 

이상적인 시스템이라면 OCP를 지원한다. 즉, 확장에는 개방적, 수정에는 폐쇄적이다.

변경으로부터 격리

요구사항은 바뀐다.

따라서 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.

또한, 상세한 구현에 의존하는 코드는 테스트가 어렵다.

 

아래 Portfolio 클래스는 외부 TokyoStockExchange API를 사용해 값을 계산한다.

5분마다 달라지는 이 API로는 테스트가 어려울 것이다.

따라서, 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드를 하나 선언한다.

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

다음으로 이를 구현하는 TokyoStockExchange 클래스를 구현한다.

또한, Portfolio 생성자를 통해 StockExchange 참조자를 인수로 받는다.

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

TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있다.

테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환한다.

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를 따르는 클래스가 나온다.

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

 

Portfolio클래스는 StockExchange 인터페이스에 의존한다.

StockExchange는 주식 기호를 받아 현재 주식 가격을 반환한다는 추상적인 개념을 표현한다.

이처럼 추상화로 구체적인 사실을 모두 숨긴다.