[클린 코드] 10장: 클래스

클래스 체계

클래스를 정의하는 표준 자바 관례에 따르면, 다음과 같은 순서로 클래스는 구성된다. 추상화 수준이 내려간다. 즉, 신문 기사처럼 읽힌다.

class A {
    public static a; // 정적 공개 변수
    private static b; // 정적 비공개 변수
    private c; // 비공개 인스턴스 변수
    
    public d() { // 공개 메서드
    	e();
        f();
    }
    
    private e() { // 공개 메서드가 호출하는 비공개 메서드
    	...
    }
    
    private f() { // 공개 메서드가 호출하는 비공개 메서드
    	...
    }
}

 

클래스는 작아야 한다!

클래스를 만들 때 가장 중요한 원칙은 '작아야 한다'는 것이다. 

그러면 얼마나 작아야 하는가?

 

클래스가 '크냐 작냐'의 기준은 '책임이 많냐 적냐'이다. 단순히 행 길이로 측정하는 것이 아니다.

 

클래스 이름은 해당 클래스 책임을 기술해야 한다. 작명은 클래스 크기를 줄이는 첫 번째 관문이다. 

간결한 클래스 이름이 떠오르지 않는다면 클래스 크기가 너무 커서 그렇다. 즉, 책임이 너무 많아서 그렇다.

 

예를 들어, Processor, Manager, Super 등과 같이 모호한 단어가 있다면 클래스에다 여러 책임을 떠안겼다는 증거다.

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

 

• 단일 책임 원칙

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

 

SRP는 적절한 클래스 크기를 제시한다. 클래스는 책임, 즉 변경할 이유가 하나여야 한다는 의미다.

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

 

하지만 문제는 우리들 대다수가 프로그램이 돌아가면 끝이라고 여기는 데 있다. 이러한 생각이 SRP를 위반하게 한다.

또한 어떤 개발자는 단일 책임 클래스가 여러 클래스로 분리되면 큰 그림을 이해하기가 어렵다고 주장한다.

 

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

 

도구 상자를 어떻게 관리할 것인가? 큰 서랍에 전부 넣어둘 것인가, 작은 서랍에 이름을 붙여 나눠서 넣을 것인가?

작은 서랍으로 분류하는 게 당연히 좋다. 클래스도 마찬가지다.

 

• 응집도

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

모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.

 

하지만 이상일 뿐, 응집도가 가장 높은 클래스는 가능하지도, 바람직하지도 않다. 

그렇지만 응집도가 높은 클래스는 그 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 뜻이므로 선호된다.

 

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

이는 클래스를 쪼개야 한다는 신호다. 응집도가 높아지도록 변수와 메서드를 적절히 분리하자.

 

변경하기 쉬운 클래스

대다수의 시스템은 지속적인 변경이 가해진다.

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

 

public class Sql {
    public Sql(String table, Column[] columns)
    public String create()
    public String insert()
    public String selectAll()
    public String findByKey(String keyColumn, String keyValue)
    private String selectWithCriteria(String criteria)
    ...
}

위 코드를 보자. 새로운 SQL문을 지원하려면(Update 등) Sql 클래스에 손을 대야 한다.

기존 SQL문 하나를 수정할 때도 반드시 Sql 클래스에 손대야 한다. 이렇듯 변경할 이유가 여러가지이므로 SRP를 위반한다.

 

단순히 구조적인 관점으로 봐도 SRP를 위반한다. selectWithCriteria 라는 비공개 메서드는 select 문을 처리할 때만 사용된다.

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

 

위 Sql 클래스를 어떻게 바꿔야 할까?

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

...

위와 같이 구성하니 각 클래스는 극도로 단순해졌고 더이상 변경에 취약하지 않다. 테스트 관점에서도 구석구석 증명하기 쉬워졌다.

이제 Update 문을 만드는 논리는 UpdateSql 클래스를 만들면 그만이다. 다른 코드가 망가질 염려가 없다.

 

위 코드는 SRP를 지원하고, 객체지향 설계에서 또 다른 핵심 원칙인 OCP(Open-Closed Principle) 역시 지원한다.

OCP란, 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙이다.

 

• 변경으로부터 격리

요구사항은 변하고 코드는 변한다.

클래스는 두 가지로 나뉜다. 1. 구체적인 클래스, 2. 추상 클래스.

구체적인 클래스는 상세한 구현(코드)을 포함하지만 추상 클래스는 개념만 포함한다.

 

상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.

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

 

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

예를 들어, Portfolio 클래스를 만든다고 가정하자. 그런데 Portfolio 클래스는 외부 'TokyoStockExchange' API 를 사용해 

포트폴리오 값을 계산한다. 따라서 해당 Portfolio 클래스는 시세 변화에 영향을 받는다. 5분마다 값이 달라지는 API로

테스트 코드를 짜기란 쉽지 않다.

 

따라서 Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하는 대신

StockExchange라는 인터페이스를 생성한 후, 메서드 하나를 선언한다.

 

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

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

 

이렇게 구성하면 이제 Test에서 Mock이 가능하다. exchange 값을 직접 지정해줄 수 있다.

 

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


@Test
public void GivenFiveMSFTTotalShoudBe500() {
    portfolio.add(5, "MSFT");
    
    assertEquals(500, portfolio.value());
}

 

이렇게 테스트가 가능할 정도로 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.

결합도가 낮다는 말의 의미는 변경으로부터 잘 격리되어 있다는 의미다.

 

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

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

 

앞선 예시에서도 Portfolio는 상세한 구현인 TokyoStockExchange에 의존하지 않고 StockExchange라는 인터페이스에 의존한다.