1. 모든 테스트를 실행하라
문서로는 시스템을 완벽하게 설계했지만, 시스템이 의도한 대로 돌아가는지 검증할 간단한 방법이 없다면, 문서 작성을 위해 투자한 노력에 대한 가치는 인정받기 힘듭니다. 테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아집니다. 크기가 작고 목적 하나만 수행하는 클래스가 나옵니다.
결합도가 높으면 테스트 케이스를 작성하기 어렵습니다. 그러므로 테스트 케이스를 많이 작성할수록 개발자는 DIP와 같은 원칙을 적용하고 의존성 주입(Dependency Injection), 인터페이스, 추상화 등과 같은 도구를 사용해 결합도를 낮춥니다. 따라서 설계의 품질은 더욱 높아집니다.
놀랍게도 테스트 케이스를 만들고 계속 돌려라라는 간단한고 단순한 규칙을 따르면 시스템은 낮은 결합도와 높은 응집력이라는, 객체 지향 방법론이 지향하는 목표를 저절로 달성합니다.
2. 리펙터링
테스트 케이스를 모두 작성했다면 이제 코드와 클래스를 정리해도 괜찮습니다. 구체적으로 코드는 점진적으로 리펙터링 해나갑니다. 코드 몇 줄을 추가할 때마다 잠시 멈추고 설계를 조감합니다. 코드를 정리하면서 시스템이 깨질까 걱정할 필요가 없습니다. 테스트 케이스가 있으니까요.
리펙터링 단계에서는 소프트웨어 설계 품질을 높이는 기법이라면 무엇이든 적용해도 괜찮습니다. 결합도를 낮추고, 관심사를 분리하고, 시스템 관심사를 모듈로 나누고, 하수와 클래스 크기를 줄이고, 더 나은 이름을 선택하는 등 다양한 기법을 동원합니다.
3. 중복을 없애라
중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻합니다. 중복은 여러 가지 형태로 표출됩니다. 비슷한 코드는 더 비슷하게 고쳐주면 리펙터링이 쉬워집니다. 구현 중복도 중복의 한 형태입니다. 각 메서드를 따로 구현하는 방법도 있지만, 한 메서드에서 다른 메서드를 이용하면 코드를 중복해 구현할 필요가 없어집니다.
class {
size(): number {}
isEmpty(): boolean {
return 0 === this.size();
}
}깔끔한 시스템을 만들려면 단 몇줄이라도 중복을 제거하겠다는 의지가 필요합니다.
scaleToOneDimension(desiredDimension: number, imageDimension: number) {
if (Math.abs(desiredDimension - imageDimension) < this.errorThreshold) {
return;
}
let scalingFactor = desiredDimension / imageDimension;
scalingFactor = Math.floor(scalingFactor * 100) * 0.01;
this.replaceImage(new Image(scalingFactor, scalingFactor));
}
rotate(degree: number) {
const newImage = new Image(this.image.width, this.image.height);
newImage.style.transform = `rotate(${degree}deg)`;
this.replaceImage(newImage);
}
private replaceImage(newImage: HTMLImageElement) {
newImage.src = this.image.src;
this.image = newImage;
}아주 적은 양이지만 공통적인 코드를 새 메서드로 뽑고 보니 클래스가 SRP를 위반합니다. 그러므로 새로 만든 replaceImage 메서드를 다른 클래스로 옮겨도 좋겠습니다. 그러면 새 메서드의 가시성이 높아집니다. 따라서 다른 팀원이 새 메서드를 좀 더 추상화해 다른 맥락에서 재사용할 기회를 포착할지도 모릅니다. 이런 소규모 재사용은 시스템 복잡도를 극적으로 줄여줍니다.
TEMPLATE METHOD 패턴은 고차원 중복을 제거할 목적으로 자주 사용하는 기법입니다. 하위 클래스는 중복되지 않는 정보만 제공해 빠진 구멍을 매웁니다.
abstract class VacationPolicy {
accrueVacation() {
this.calculateBaseVacationHours();
this.alterForLegalMinimums();
this.applyToPayroll();
}
private calculateBaseVacationHours() {
// 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
// ...
}
protected abstract alterForLegalMinimums(): void;
private applyToPayroll() {
// 휴가 일수를 급여 대장에 적용하는 코드
// ...
}
}
class USVacationPolicy extends VacationPolicy {
protected alterForLegalMinimums(): void {
// 휴가 일수가 미국 최소 법정 일수를 만족하는지 확인하는 코드
// ...
}
}
class EUVacationPolicy extends VacationPolicy {
protected alterForLegalMinimums(): void {
// 휴가 일수가 유렵연합 최소 법정 일수를 만족하는지 확인하는 코드
// ...
}
}4. 표현하라
자신이 이해하는 코드를 짜기는 쉽습니다. 코드를 짜는 동안에는 문제에 푹 빠져 코드를 구석석 이해하기 때문입니다. 하지만 나중에 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박합니다. 소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어갑니다. 코드를 변경하면서 버그의 싹을 심지 않으려면 유지보수 개발자가 시스템을 제대로 이해해야 합니다. 개발자가 코드를 명백하게 짤수록 다른 사람이 그 코드를 이해하기 쉬워집니다. 표현력을 높이는 가장 중요한 방법은 노력입니다.
- 좋은 이름을 선택합니다.
- 함수와 클래스 크기를 가능한 줄입니다.
- 표준 명칭을 사용합니다.
- 단위 테스트 케이스를 꼼꼼히 작성합니다.
5. 클래스와 메서드 수를 최소로 줄여라
중복을 제거하고, 의도를 표현하고, SRP를 준수하는 기본적인 개념도 극단으로 치닫으면 득보다 실이 많아집니다. 때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 합니다. 클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준ㅇ이 좋은 예입니다. 자료 클래스와 동작 클래스는 무조건 분리해야 한다고 주장하는 개발자도 좋은 예입니다. 가능한 실용적인 방식을 택해야 합니다.
목표는 함수와 클래스 크기를 작게 유지하면서 동시에 시스템 크기도 작게 유지하는 데 있습니다. 하지만 이 규칙은 간단한 설계 규칙 네 개 중 우선순위가 가장 낮습니다. 다시 말해, 클래스와 함수 수를 줄이는 작업도 중요하지만, 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 작업이 더 중요하다는 뜻입니다.
6. 출처
- 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
- 저자: 로버트 C.마틴
- 옮긴이: 박재호, 이해영
- 출판사: 인사이트
