Chapter 10 - 클래스 잘 설계하기

01. 캡슐화(Encapsulation)

객체의 실제 구현을 외부로부터 감추는 방식

• 클래스를 개발할 때 기본적으로 구현을 감추고, 외부 객체와 상호작용하는 부분만 노출한다.
• 외부의 잘못된 사용을 방지한다.
• 경계에서 배웠던 부분! (Map을 활용했던 예제)

Stack 예제

public class Stack {
    private int topOfStack = 0;
    private List<Integer> elements = new LinkedList<Integer>();

    public List<Integer> getElements() {
        return elements;
    }

    public int size() {
        return topOfStack;
    }

    public void push(int element) {
        topOfStack++;
        elements.add(element);
    }

    public void pop() throws PopedWhenEmpty {
        if (topOfStack == 0)
            throw new PopedWhenEmpty();
        int element = elements.get(--topOfStack);
        elements.remove(topOfStack);
        return element;
    }
}

• 필드를 private으로 제한, get으로 읽기

• 수정은 push, pop 메서드를 통해서 일어나도록 제한

02. 단일 책임 원칙 (SRP - Single Responsibility Principle)

클래스는 작아야 한다

클래스가 맡은 책임이 한 개인가

• 함수와 마찬가지로 클래스도 작아야 한다.
• 함수는 라인 수로 크기를 측정했는데, 클래스는 맡은 책임의 수로 크기를 측정한다.
• 클래스 설명은 만일(if), 그리고(and), 하며(or), 하지만(but)을 사용하지 않고 25단어 내외로 가능해야 한다. -> 책임이 한 가지 여야 한다.

public class SuperDashboard extends JFrame implements MetaDataUser {
    public Component getLastFocusedComponent()
    public void setLastFocused(Component lastFocused)
    public int getMajorVersionNumber()
    public int getMinorversionNumber()
    public int getBuildNumber()
}
// focus, version 두 가지 책임이 보인다.

⬇️

public class Version {
    public int getMajorVersionNumber()
    public int getMinorversionNumber()
    public int getBuildNumber()
}
// 다른 곳에서도 재활용할 수 있다.

"도구상자를 어떻게 관리하고 싶은가? 작은 서랍을 많이 두고 기능과 이름이 명확안 컴포넌트를 나눠 넣고 싶은가? 아니면 큰 서랍 몊개를 두고 모두를 던져 넣고 싶은가?"

단일 책임 원칙 (SRP)의 중요성

• 자잘한 단일 클래스가 많아지면 큰 그림을 이해하기 어렵다고 우려한다.하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개 뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다.

• 큼직한 다목적 클래스 몇개로 이뤄진 시스템은 (변경을 가할 때) 당장 알 필요가 없는 사실까지 들이밀어 독자를 방해한다.

class PaymentService {
    public void pay();
    public void cancel();
    public void getAccount();
    public void getAccountHistory();
}

요구사항 : 환불 기능을 추가하라

• 클래스가 많은 기능을 가진 만큼 모든 기능을 이해하고 추가 기능을 구현할 수 있다. 그리고 클래스는 더 많은 기능을 가지게 된다.

⬇️

• 작은 클래스는 각자 맡은 책임이 하나며, 변경항 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

PaymentService::pay
    (accountService.getAccount)
PaymentCancelService::cancel
    (paymentService.getPay, accountService.getAccount)
AccountService::getAccount
AccountHistoryService::getAccountHistory

03. 낮은 결합도, 높은 응집도 (Low Coupling, High Cohesion)

결합도와 응집도

결합도 - 다른 모듈간의 의존도

응집도 - 모듈 내부의 기능 집중도

• 결합도는 낮을 수록 응집도는 높을 수록 유지보수성이 좋다.

• 결합도가 높은 클래스의 문제점

  • 연관된 클래스가 변경되면 수정이 필요하다.
  • 결합도가 높으면 연관된 클래스들을 모두 이해해야 한다.

• 응집도가 낮은 클래스의 문제점

  • 여러 기능이 있으므로 이해하기 어렵다.
  • 재사용하기 어렵다.

낮은 결합도

결합도는 낮아야 한다

• 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
• DIP(Dpendency Inversion Principle - 의존성 역전 원칙) - 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다.
• 추상화를 이용하면 테스트 코드 짜기에 용이하다

public class TokyoSrockExchange {
    public Money currentPrice(String symbol);
}

public Portfolio {
    private TokyoSrockExchange tokyoSrockExchange;
    public Portfolio(TokyoSrockExchange exchange) {
        this.tokyoSrockExchange = tokyoSrockExchange;
    }
}
// Portfolio 클래스의 테스트 코드를 짜야하는데,
// TokyoSrockExchange 함수의 API는 5분마다 값이 달라진다면...?

⬇️

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

public class TokyoSrockExchange implements SrockExchange {
    public Money currentPrice(String symbol) {
        // call API...
    }
}

public Portfolio {
    private StockExchange exchange;
    public Portfolio(StockExchange exchange) {
        this.exchange = exchange;
    }
}
// StockExchange 인터페이스를 통해 Portfolio와
// TokyoSrockExchange의 결합도를 끊어준다.

PortfolioTest

public 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());
    }
}
// 테스트 결과가 늘 같도록 한다.
// 그러나.. 확장될 가능성이 적다면 일단은 결합하고, 나중에 추상화해도 좋다.
// 객체를 Mockking 하면 변경되는 클래스도 테스트할 수 있다.

높은 응집도

응집도는 높아야 한다

• 클래스는 인스턴스 변수 수가 적어야 한다. 메서드는 인스턴스 변수를 하나 이상 사용해야 한다. 메서드가 인스턴스 변수를 많이 사용할수록 응집도가 높다.
• 응집도가 높다 = 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다 = 서로 관계있는 애들만 모여있다.
• 클래스가 응집도를 잃어간다면 함수를 쪼개야한다.

[Stock 예제 참고]

04. 변경하기 쉬워야 한다

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()
    public String columnList(Column[] columns)
    public String valuesList(Object[] fields, final Column[] columns)
    public String selectWithCriteria(String criteria)
    public String placeholderList(Column[] columns)
}
// Update문을 추가해야 한다면....?
// 새로운 SQL을 추가할 때도 수정이 발생하고, 기존 SQL문을 수정할 때도 수정이 발생하므로 OCP(Open Close Principle)을 위반한다.

⬇️

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)
    @Override public String generate()
    private String valuesList(Object[] fields, final Column[] columns)
}

public class Where {
    public Where(String criteria)
    public String generate()
}

public class ColumnList {
    public ColumnList(Column[] columns)
    public String generate()
}

• 공개 인터페이스를 전부 SQL 클래스에서 파생하는 클래스로 만들고, 비공개 메서드는 해당 클래스로 옮기고, 공통된 인터페이스는 따로 클래스로 뺐다.
• 기존의 클래스를 건드리지 않아도 된다.