클린코드(CleanCode)를 읽고 간략하게 정리한 글입니다.
10장. 클래스
1. 클래스 체계
- 자바 표준 관례에 따른 순서
- 변수 목록
- 정적 공개 상수(public static)
- 정적 비공개(private static)
- 비공개 인스턴스 변수(private)
- 공개 변수(public, 공개 변수가 필요한 경우는 거의 없다.)
- 공개 함수
- 공개 함수(public)
- 비공개 함수(private, 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.(추상화 단계가 순차적으로 내려간다.))
1-1. 캡슐화
- 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙은 없다.
- 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다.
- 같은 패키지 안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면 그 함수는 변수를 protected로 선언하거나 패키지 전체로 공개한다.
- 하지만 그전에 비공개 상태를 유지할 온갖 방법을 강구한다.
- 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다!
2. 클래스는 작아야 한다!
- 클래스를 만들 때 첫 번째 규칙은 크기이다. -> 클래스는 작아야 한다.
- 두번째 규칙도 크기다. -> 더 작아야 한다.
- 단, 함수와는 다르게(함수는 물리적인 행 수로 측정), 클래스는 맡은 책임을 측정한다.
public class SuperDashboard extends JFrame implements MetaDataUser {
public String getCustomizerLanguagePath()
public void setSystemConfigPath(String systemConfigPath)
public String getSystemConfigDocument()
public void setSystemConfigDocument(String systemConfigDocument)
public boolean getGuruState()
public boolean getNoviceState()
public boolean getOpenSourceState()
...
public boolean isCustomizing()
public void setTitle(String title)
public IdeMenuBar getIdeMenuBar()
public void showHelper(MetaObject metaObject, String propertyName)
}- 위 코드는 공개 메서드(함수)가 약 70개 정도가 되는 엄청 큰 만능 클래스이다.
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocusedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}- 위 코드와 같이 만약 기존 클래스에서 5개 정도의 메서드만 가지고 있다면 어떨지 생각해 보라, 그렇지만 메서드 수가 작음에도 불구하고 책임이 너무 많다면 좋지 않다.
- 클래스 이름은 해당 클래스 책임을 기술해야된다. -> 작명은 클래스 크기를 줄이는 첫 번째 관문이다.
- 간결한 이름이 떠오르지 않는다면 클래스 책임이 너무 많아서이다.
2-1. 단일 책임 원칙
- 단일 책임의 원칙(Single Responsibility Principle)은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙이다.
- "책임" 이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
- 변경할 이유를 파악하려고 애쓰다 보면 코드를 추상화하기도 쉬워진다.
public class Version {
public int getMajorVersionNumber();
public int getMinorVersionNumber();
public int getBuildNumber();
}- 위 코드를 보면 버전 정보를 다루는 메서드 3 개를 따로 빼내 Version이라는 독자적인 클래스를 만들면서 다른 어플리케이션에서 재사용하기 쉬워진다.
- SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나이다.
- 소프트웨어를 돌아가게 만드는 활동과 꺠긋하게 만드는 활동은 별개이다.
- 우리들 대다수는 두뇌 용량에 한계가 있어 "꺠끗하고 체계적인 소프트웨어" 보다 "돌아가는 소프트웨어"에 초점을 맞춘다.
- 관심사를 분리하는 작업은 프로그램만이 아니라 프로그래밍 활동에서도 마찬가지로 중요하다.
- 문제는 우리들 대다수가 프로그램이 돌아가면 일이 끝났다고 여기는 데 있다.
- "깨끗하고 체계적인 소프트웨어"라는 다음 관심사로 전환하지 않는다.
- 대부분 개발자들은 자잘한 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다.
- 큰 그림을 이해하려면 이 클래스 저 클래스 수없이 넘나들어야 한다고 걱정한다.
- 하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품의 수는 비슷하다.
- 어느 시스템이든 익힐 내용은 그 양이 비슷하다.
- 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다. 이런 복잡성을 다루려면 체계적인 정리가 필수다.
- 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다.
- 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.
2-2. 응집도
- 클래스는 인스턴스 변수 수가 작아야 한다.
- 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
- 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
- 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
- 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이다.
public class Stack {
private int topOfStack = 0;
List<Integer> elements = new LinkedList<Integer>();
public int size() {
return topOfStack;
}
public void push(int element) {
topOfStack++;
elements.add(element);
}
public int pop() throws PoppedWhenEmpty {
if (topOfStack == 0)
throw new PoppedWhenEmpty();
int element = elements.get(--topOfStack);
elements.remove(topOfStack);
return element;
}
}- 함수를 작게, 매개변수 목록을 짧게 라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.
- 이는 새로운 클래스로 쪼개야 한다는 신호이다.
- 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 2~3개로 쪼갠다.
2-3. 응집도를 유지하면 작은 클래스 여럿이 나온다
- 큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.
- 예를 들어, 변수가 아주 많은 큰 함수가 하나 있다고 가정한다.
- 큰 함수 일부를 작은 함수로 빼내고 싶다.
- 빼내려는 코드가 큰 함수에 정의 된 변수를 많이 사용한다.
- 그렇다면 변수들을 새 함수에 인수로 넘겨야 하는가? 그렇지 않다.
- 변수들을 클래스 인스턴스 변수로 승격 시키면 인수가 필요 없다.
- 그렇지만, 이렇게 한다면 클래스가 응집력을 잃는다.
- 몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문이다.
- 몇몇 함수가 사용하는 인스턴스 변수만 사용한다면 독자적인 클래스로 분리해도 된다.
- 클래스가 응집력을 잃는다면 쪼개야 한다.
큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.
- 아래 샘플 코드를 통해 확인해 보자.
// 목록 10-5, 리팩토링 전
public class PrintPrimes {
public static void main(String[] args) {
final int M = 1000;
final int RR = 50;
final int CC = 4;
final int WW = 10;
final int ORDMAX = 30;
int P[] = new int[M + 1];
int PAGENUMBER;
int PAGEOFFSET;
int ROWOFFSET;
int C;
int J;
int K;
boolean JPRIME;
int ORD;
int SQUARE;
int N;
int MULT[] = new int[ORDMAX + 1];
J = 1;
K = 1;
P[1] = 2;
ORD = 2;
SQUARE = 9;
while (K < M) {
do {
J = J + 2;
if (J == SQUARE) {
ORD = ORD + 1;
SQUARE = P[ORD] * P[ORD];
MULT[ORD - 1] = J;
}
N = 2;
JPRIME = true;
while (N < ORD && JPRIME) {
while (MULT[N] < J)
MULT[N] = MULT[N] + P[N] + P[N];
if (MULT[N] == J)
JPRIME = false;
N = N + 1;
}
} while (!JPRIME);
K = K + 1;
P[K] = J;
}
{
PAGENUMBER = 1;
PAGEOFFSET = 1;
while (PAGEOFFSET <= M) {
System.out.println("The First " + M + " Prime Numbers --- Page " + PAGENUMBER);
System.out.println("");
for (ROWOFFSET = PAGEOFFSET; ROWOFFSET < PAGEOFFSET + RR; ROWOFFSET++) {
for (C = 0; C < CC; C++)
if (ROWOFFSET + C * RR <= M)
System.out.format("%10d", P[ROWOFFSET + C * RR]);
System.out.println("");
}
System.out.println("\f");
PAGENUMBER = PAGENUMBER + 1;
PAGEOFFSET = PAGEOFFSET + RR * CC;
}
}
}
}- 위 코드의 문제점은 아래와 같다.
- 들여 쓰기가 심하다.
- 이상한 변수가 많다.
- 구조가 빡빡하게 결합되어 있다.
- 위 코드를 리팩터링 해보자.
// 목록 10-6, 리팩터링한 버전
public class PrimePrinter {
public static void main(String[] args) {
final int NUMBER_OF_PRIMES = 1000;
int[] primes = PrimeGenerator.generate(NUMBER_OF_PRIMES);
final int ROWS_PER_PAGE = 50;
final int COLUMNS_PER_PAGE = 4;
RowColumnPagePrinter tablePrinter =
new RowColumnPagePrinter(ROWS_PER_PAGE,
COLUMNS_PER_PAGE,
"The First " + NUMBER_OF_PRIMES + " Prime Numbers");
tablePrinter.print(primes);
}
}// 목록 10-7, RowColumnPagePrinter
public class RowColumnPagePrinter {
private int rowsPerPage;
private int columnsPerPage;
private int numbersPerPage;
private String pageHeader;
private PrintStream printStream;
public RowColumnPagePrinter(int rowsPerPage, int columnsPerPage, String pageHeader) {
this.rowsPerPage = rowsPerPage;
this.columnsPerPage = columnsPerPage;
this.pageHeader = pageHeader;
numbersPerPage = rowsPerPage * columnsPerPage;
printStream = System.out;
}
public void print(int data[]) {
int pageNumber = 1;
for (int firstIndexOnPage = 0;
firstIndexOnPage < data.length;
firstIndexOnPage += numbersPerPage) {
int lastIndexOnPage = Math.min(firstIndexOnPage + numbersPerPage - 1, data.length - 1);
printPageHeader(pageHeader, pageNumber);
printPage(firstIndexOnPage, lastIndexOnPage, data);
printStream.println("\f");
pageNumber++;
}
}
private void printPage(int firstIndexOnPage, int lastIndexOnPage, int[] data) {
int firstIndexOfLastRowOnPage =
firstIndexOnPage + rowsPerPage - 1;
for (int firstIndexInRow = firstIndexOnPage;
firstIndexInRow <= firstIndexOfLastRowOnPage;
firstIndexInRow++) {
printRow(firstIndexInRow, lastIndexOnPage, data);
printStream.println("");
}
}
private void printRow(int firstIndexInRow, int lastIndexOnPage, int[] data) {
for (int column = 0; column < columnsPerPage; column++) {
int index = firstIndexInRow + column * rowsPerPage;
if (index <= lastIndexOnPage)
printStream.format("%10d", data[index]);
}
}
private void printPageHeader(String pageHeader, int pageNumber) {
printStream.println(pageHeader + " --- Page " + pageNumber);
printStream.println("");
}
public void setOutput(PrintStream printStream) {
this.printStream = printStream;
}
}// 목록 10-8, PrimeGenerator
public class PrimeGenerator {
private static int[] primes;
private static ArrayList<Integer> multiplesOfPrimeFactors;
protected static int[] generate(int n) {
primes = new int[n];
multiplesOfPrimeFactors = new ArrayList<Integer>();
set2AsFirstPrime();
checkOddNumbersForSubsequentPrimes();
return primes;
}
private static void set2AsFirstPrime() {
primes[0] = 2;
multiplesOfPrimeFactors.add(2);
}
private static void checkOddNumbersForSubsequentPrimes() {
int primeIndex = 1;
for (int candidate = 3; primeIndex < primes.length; candidate += 2) {
if (isPrime(candidate))
primes[primeIndex++] = candidate;
}
}
private static boolean isPrime(int candidate) {
if (isLeastRelevantMultipleOfNextLargerPrimeFactor(candidate)) {
multiplesOfPrimeFactors.add(candidate);
return false;
}
return isNotMultipleOfAnyPreviousPrimeFactor(candidate);
}
private static boolean isLeastRelevantMultipleOfNextLargerPrimeFactor(int candidate) {
int nextLargerPrimeFactor = primes[multiplesOfPrimeFactors.size()];
int leastRelevantMultiple = nextLargerPrimeFactor * nextLargerPrimeFactor;
return candidate == leastRelevantMultiple;
}
private static boolean isNotMultipleOfAnyPreviousPrimeFactor(int candidate) {
for (int n = 1; n < multiplesOfPrimeFactors.size(); n++) {
if (isMultipleOfNthPrimeFactor(candidate, n))
return false;
}
return true;
}
private static boolean isMultipleOfNthPrimeFactor(int candidate, int n) {
return candidate == smallestOddNthMultipleNotLessThanCandidate(candidate, n);
}
private static int smallestOddNthMultipleNotLessThanCandidate(int candidate, int n) {
int multiple = multiplesOfPrimeFactors.get(n);
while (multiple < candidate)
multiple += 2 * primes[n];
multiplesOfPrimeFactors.set(n, multiple);
return multiple;
}
}- 리팩터링 한 내용은 아래와 같다.
- 좀 더 길고 서술적인 변수 이름을 사용했다.
- 함수 선언과 클래스 선언으로 코드를 설명했다.
- 가독성을 위해 공백을 추가하고 형식을 맞췄다.
- 각 클래스의 책임은 아래와 같다.
- PrimePrinter : Main 함수 하나를 포함하며 실행 환경을 책임짐
- RowColumnPagePrinter : 숫자 목록을 주어진 행과 열에 맞춰 페이지에 출력
- PirmeGenerator : 소수 목록을 생성
- 두 프로그램의 아골리즘과 동작 원리는 동일하다. 그러나 하나의 거대한 함수보다는 책임을 하나만 가진 여러 개의 클래스가 더 좋다.
- 가장 먼저 원래 프로그램의 정확한 동작을 검증하는 테스트 코드를 작성해야 한다.
- 그다음 한 번에 하나씩 여러 번에 걸쳐 코드를 변경하고, 코드를 변경할 때마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인해야 한다.
3. 변경하기 쉬운 클래스
- 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
- 대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경이 있을 때마다 의도대로 동작하지 않을 위험이 따른다.
- 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사한다.
3-1. 변경으로부터 격리
- 객체지향 프로그래밍에는 Concrete(구현) 클래스와 Abstract(개념) 클래스가 있다.
- 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠지기 때문에 항상 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리해야 한다.
- 추상화를 통해 테스트가 가능할 정도로 시스템의 결합도를 낮춤으로써 유연성과 재사용성이 더욱 높아진다.
- 아래 예제인 Portfolio라는 클래스를 만든다고 가정해 보자.
- 이 클래스는 외부 TokyoStockExchange API를 사용해 값을 계산
- 때문에 테스트 코드는 시세 변화에 영향을 받음
- 5분마다 값이 달라지는 API로 테스트 코드를 짜기는 쉽지 않음
public insterface StockExchange {
Money currentPrice(String symbol);
}- Portfolio 클래스에서 TokyoStockExchange API 를 직접 호출하지 않고 StockExchange라는 인터페이스를 생성한다.
- 이 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현한다.
public Portfolio {
private StockExchange exchange;
public Portfolio(StockExchange exchange) {
this.exchange = exchange;
}
// ...
}- 그리고 Portfolio의 생성자에서 StockExchange를 인수로 받도록 한다.
- 이제 TokyoStockExchange 클래스를 테스트할 수 있는 테스트 클래스를 만들 수 있다.
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(Dependency Inversion Principle) : 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
'Study > CleanCode' 카테고리의 다른 글
| [클린코드] 11장. 시스템 (0) | 2023.11.15 |
|---|---|
| [클린코드] 9장. 단위 테스트 (2) | 2023.11.05 |
| [클린코드] 8장. 경계 (1) | 2023.11.04 |
| [클린코드] 6장. 객체와 자료 구조 (0) | 2023.10.25 |
| [클린코드] 5장. 형식 맞추기 (0) | 2023.10.22 |
