Clean Code 9 ~ 11 장

9장 - 단위 테스트

TDD 법칙 세 가지

1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.

2. 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.

3. 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

 

깨끗한 테스트 코드 유지하기

지저분한 테스트 코드를 내놓으나 테스트를 안 하나 오십보 백보라는, 아니 오히려 더 못한다는 사실을 인지해야 한다.

문제는 실제 코드가 진화하면 테스트 코드도 변해야 한다는 데 있다.

테스트 코드는 실제 코드 못지 않게 중요하며, 실제 코드 못지 않게 깨끗하게 짜야 한다.

 

- 테스트는 유연성, 유지보수성, 재사용성을 제공한다.

테스트 케이스가 없다면 모든 변경이 잠정적인 버그다. 아키텍처가 아무리 유연하더라도, 설계를 아무리 잘 나눴더라도, 테스트 케이스가 없으면 개발자는 변경을 주저한다.

즉, 테스트는 유연성, 유지보수성, 재사용성을 제공한다. 테스트 케이스가 있으면 변경이 쉬워진다.

 

테스트 구조의 한가지 예시로 크게 3가지 부분으로 나눈다.

• 첫 부분은 테스트 자료를 만든다.
• 두 번째 부분은 테스트 자료를 조작하며
• 세 번째 부분은 조작한 결과가 올바른지 확인한다.

 

이중 표준

테스트 API 코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다. 단순하고, 간결하고, 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다.

 

테스트 당 assert 하나

함수마다 assert 문을 단 하나만 사용해야 한다고 주장하는 학파가 있다. 장점이 분명 있지만 테스트를 분리하게 되면 중복코드가 많아지기도 한다. @Before 함수를 이용하는 방법도 있지만 이럴 때는 주저 없이 함수 하나에 여러 assert 문을 넣기도 한다.

단지 assert 문 개수는 최대한 줄여야 좋다는 생각이다.

 

테스트 당 개념 하나

테스트 함수마다 한 개념만 테스트해야 한다. 이것저것 잡다한 개념을 연속으로 테스트하는 긴 함수는 피한다.

assert 문이 여럿이라는 사실이 문제가 아니라 한 테스트 함수에서 여러 개념을 테스트 한다는 것이 문제다.

 

개념 당 assert 문 수를 최소로 줄여라. 테스트 함수 하나는 개념 하나만 테스트하라

 

F.I.R.S.T

깨끗한 테스트는 다섯 가지 규칙을 따르는데 다음과 같다.

 

1. 빠르게(Fast) : 테스트는 빨라야 한다. 테스트가 느리면 자주 돌릴 엄두를 못 낸다.

 

2. 독립적으로(Independent) : 각 테스트는 서로 의존하면 안 된다. 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안 된다. 각 테스트는 독립적으로 그리고 어떤 순서로 실행해도 괜찮아야 한다.

 

3. 반복가능하게(Repeatable) : 테스트는 어떤 환경에서도 반복 가능해야 한다.

 

4. 자가검증하는(Self-Validating) : 테스트는 불린 값으로 결과를 내야 한다. 테스트가 스스로 성공과 실패를 가늠하지 않는다면 판단은 주관적이 되며 지루한 수작업 평가가 필요하게 된다.

 

5. 적시에(Timely) : 테스트는 적시에 작성해야 한다. 단위 테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다. 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다.

 

---

10장 - 클래스

깨끗한 클래스에 대해 다루는 장입니다.

 

클래스를 정의하는 표준 자바 관례를 따르면, 가장 먼저 변수 목록이 나오며, static, public 상수가 있다면 맨 처음에 나옵니다. 다음으로 private 변수가 나오며, 이어서 비공개 인스턴스 변수가 나온다. 공개 변수가 필요한 경우는 거의 없다.

 

변수 목록 다음에는 공개 함수가 나온다. 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다. 즉, 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.

 

클래스는 작아야 한다!!

클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다. 두 번째 규칙도 크기다. 더 작아야 한다.

 

그렇다면 얼마나 작게 해야 하는가?? 메서드가 다섯 개 정도면 괜찮은 것인가??

여기서는 책임을 기준으로 클래스를 작게 만든다. 클래스 이름은 해당 클래스 책임을 기술해야 한다. 실제로 작명은 클래스 크기를 줄이는 첫 번째 관문이다. 간결한 이름이 떠오르지 않는다면 필경 클래스 크기가 너무 커서 그런 것이다. 클래스 이름이 모호하다면 필경 클래스 책임이 너무 많아서이다.
예를 들어, 클래스 이름에 Processor, Manager, Super 등과 같이 모호한 단어가 있다면 클래스에다 여러 책임을 떠안겼다는 증거다.

 

단일 책임 원칙

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

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

단일 책임 원칙(SRP)은 객체 지향 설계에서 더욱 중요한 개념이다. 또한 이해하고 지키기 수월한 개념이기도 하다. 하지만 이상하게도 해당 원칙은 클래스 설계자가 가장 무시하는 규칙 중 하나다.

 

문제는 우리들 대다수가 프로그램이 돌아가면 일이 끝났다고 여기는 데 있다.

많은 개발자는 자잘한 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다. 큰 그림을 이해하려면 이 클래스 저 클래스를 수없이 넘나들어야 한다고 걱정한다.

 

하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개분인 시스템이든 돌아가는 부품은 그 수가 비슷하다. 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다. 이런 복잡성을 다루려면 체계적인 정리가 필수다. 그래야 개발자가 무엇이 어디에 있는지 쉽게 찾을 수 있다.

 

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

 

응집도

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

 

일반적으로 이처럼 응집도가 가장 높은 클래스는 가능하지도 바람직하지도 않다. 그렇지만 우리는 응집도가 높은 클래스를 선호한다. 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문이다.

 

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

 

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

몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리해도 되지 않는가?? 당연히 가능하다. 클래스가 응집력을 잃는다면 쪼개라

그래서 큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.

 

변경하기 쉬운 클래스

깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.

 

아래 코드에서 보듯 위에 있는 Sql 클래스에서 모든 쿼리를 수행하는 메서드를 모았지만 이를 추상메서드로 변경하고 각 쿼리에 맞는 클래스를 설정하여 리팩터링 할 수 있다.

 

이렇게 수정하게 되면 각 클래스는 극도로 단순해진다. 코드는 순식간에 이해된다. 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 사라졌다. 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌다. 클래스가 서로 분리되었기 때문이다.

public class Sql {
	public Sql(String table, Column[] columns)
	public String create()
	public String selectAll()
	public String insert(Object[] fields)
	public String findByKey(String KeyColumn, String keyValue)
	...
}

---

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

...

 

위에서 수정한 코드는 우선 SRP(단일 책임 원칙)을 지원한다. 여기다 객체 지향 설계에서 또 다른 핵심 원칙인(OCP, Open-Closed principle)도 지원한다. OCP란 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙이다. 우리가 재구성한 Sql 클래스는 파생 클래스를 생성하는 방식으로 새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 방식으로 수정에 폐쇄적이다. 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.

 

변경으로부터 격리

구체적인 클래스와 추상 클래스가 존재한다. 구체적인 클래스는 상세한 구현을 포함하며 추상 클래스는 개념만 포함한다고 배웠다.

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

 

예를 들어 Portfolio 클래스를 만든다고 가정할 때 해당 클래스는 외부 TokyoStockExchange API를 사용해 포트폴리오 값을 계산하는데 해당 API가 시세 변화에 영향을 받아서 5분 마다 값이 달라진다면 이를 가지고 테스트 코드를 짜기가 쉽지않다.

 

이때 Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언한다.

public interface StockExchange {
	Money currentPrice(String symbol)
}

 

다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현한다. 또한 Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받는다.

 

public class 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 클래스는 TokyoStockExchange라는 상세한 구현 클래스가 아니라 StockExchange 인터페이스에 의존한다. 추상화로 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨긴다.

 

---

 

11장 - 시스템

아쉽게도 이번 장은 제대로 이해를 하지 못했다... 나중에 기회가 된다면 다시 한번 읽어보고 다시 정리해야 할 것 같다.

 

시스템 제작과 시스템 사용을 분리하라

우선 제작과 사용은 아주 다르다는 사실을 명심해야 한다.

"소프트웨어 시스템은 (애플리케이션 객체를 제작하고 의존성을 서로 연결하는) 준비 과정과 (준비 과정 이후에 이어지는) 런타임 로직을 분리해야 한다."

 

시작 단계는 모든 애플리케이션이 풀어야 할 관심사다. 관심사 분리는 우리 분야에서 가장 오래되고 가장 중요한 설계 기법 중 하나다.

 

관심사 분리란 특정한 관심사에 따라 기능을 나누고, 각 기능을 독립적으로 개발한 뒤 이를 조합하는 방식으로 복잡한 소프트웨어를 구성해보는 것을 의미한다. 관심사를 분리하여 코드를 작성하게 되면, 독립된 특정 기능에 집중할 수 있기 때문에 코드를 파악하는데 수월하며, 특정 기능을 변경하거나 추가할 때도 그 부분만 교체하면 되기 때문에 훨씬 간단하게 문제를 해결할 수 있다.