클린코드 10장 - 클래스
CleanCode 10장 클래스
에 대해 정리한 포스트입니다.
Overview
이 장에서는 깨끗한 클래스 를 다룹니다.
클래스 체계
표준 자바 관례에 따르면, 클래스 안에서의 순서는 아래와 같습니다.
- static public 상수
- static private 변수
- private instance 변수(public 변수가 필요한 경우는 거의 없음)
- public method
- private method는 자신을 호출하는 public method 직후에 위치
테스트를 위해 private method나 변수를 protected로 공개해야 할 경우가 있다. 이런 경우 공개하지 않을 방법을 충분히 생각한 이후에 캡슐화를 푸는 것이 좋다.
SOLID
객체지향 프로그래밍을 할 때 기본적으로 이해해야 하는 원리들입니다.
- SRP (Single Responsibillity Principle)
- 클래스틑 하나의 역할만 해야 한다
- 다양한 일을 할 수 있는 만능의 클래스를 만드는 것은 한가지 역할을 하는 클래스보다 좋지 않다
- 변경을 할 가능성이 높고 좋지 않은 영향을 받을 가능성도 높음
- 복잡한 자료구조와 메서드를 가질 가능성이 높으며 사용하기 어려울 가능성이 높음
- 명확히 정의된 하나의 구체적인 역할을 줄 수 있다면 SRP를 만족한다고 할 수 있다.
- OCP (Open Close Principle)
- 확장에 대해서는 열려있고, 변경에 대해서는 닫혀있게 만들어야 한다.
- 즉 새로운 기능 추가는 쉽지만 변경의 영향이 제한적이여야 한다.
- 확장에 대해서는 열려있고, 변경에 대해서는 닫혀있게 만들어야 한다.
- LSP (Liskov Substitution Principle)
- 같은 형을 가지는 객체로 대체되어 사용할 수 있어야 한다.
- 동일한 클래스를 상속하는 경우, 상위 클래스를 접근하는 Client 코드들은 상속받은 클래스로 대체하더라도 변경이 없어야 한다.
- ISP (Interface Segregation Principle)
- 필요한 인터페이스 각각에 대해서 따로 정의해서 사용하는 것이 좋다.
- 즉, 각각의 인터페이스를 공용화해서 한 인터페이스가 너무 많은 기능을 제공하도록 만드는 것은 확장성 및 변경의 영향을 제어하지 못하게 만든다.
- 만능보다는 한가지 일에 특화된 것이 좋다.
- DIP (Dependency Inversion Principle)
- 구체적인 것에 의존하지 말라
- 다른 클래스나 자료구조의 내부에 의존적인 코드를 짜면 변경에 취약하도록 만든다.
- 추상 클래스를 사용하라.
클래스는 작아야 한다!
클래스를 만들 때 가장 중요한 규칙은 함수와 마찬가지로 작은 크기입니다.
클래스는 맡은 책임 를 기준으로 측정합니다.
- 물리적인 행 수로 측정했던 함수와는 다르게
아래 클래스는 public method의 수가 70개 가량됩니다.(만능클래스?)
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 void showObject(MetaObject object)
public void showProgress(String s)
public boolean isMetadataDirty()
public void setIsMetadataDirty(boolean isMetadataDirty)
public Component getLastFocusedComponent()
public void setLastFocused(Component lastFocused)
public void setMouseSelectState(boolean isMouseSelected)
public boolean isMouseSelected()
public LanguageManager getLanguageManager()
public Project getProject()
public Project getFirstProject()
public Project getLastProject()
public String getNewProjectName()
public void setComponentSizes(Dimension dim)
public String getCurrentDir()
public void setCurrentDir(String newDir)
public void updateStatus(int dotPos, int markPos)
public Class[] getDataBaseClasses()
public MetadataFeeder getMetadataFeeder()
public void addProject(Project project)
public boolean setCurrentProject(Project project)
public boolean removeProject(Project project)
public MetaProjectHeader getProgramMetadata()
public void resetDashboard()
public Project loadProject(String fileName, String projectName)
public void setCanSaveMetadata(boolean canSave)
public MetaObject getSelectedObject()
public void deselectObjects()
public void setProject(Project project)
public void editorAction(String actionName, ActionEvent event)
public void setMode(int mode)
public FileManager getFileManager()
public void setFileManager(FileManager fileManager)
public ConfigManager getConfigManager()
public void setConfigManager(ConfigManager configManager)
public ClassLoader getClassLoader()
public void setClassLoader(ClassLoader classLoader)
public Properties getProps()
public String getUserHome()
public String getBaseDir()
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
public MetaObject pasting(MetaObject target, MetaObject pasted, MetaProject project)
public void processMenuItems(MetaObject metaObject)
public void processMenuSeparators(MetaObject metaObject)
public void processTabPages(MetaObject metaObject)
public void processPlacement(MetaObject object)
public void processCreateLayout(MetaObject object)
public void updateDisplayLayer(MetaObject object, int layerIndex)
public void propertyEditedRepaint(MetaObject object)
public void processDeleteObject(MetaObject object)
public boolean getAttachedToDesigner()
public void processProjectChangedState(boolean hasProjectChanged)
public void processObjectNameChanged(MetaObject object)
public void runProject()
public void setAçowDragging(boolean allowDragging)
public boolean allowDragging()
public boolean isCustomizing()
public void setTitle(String title)
public IdeMenuBar getIdeMenuBar()
public void showHelper(MetaObject metaObject, String propertyName)
}
위 함수를 보면 굉장히 크다는 것을 느낄수 있습니다.
아래처럼 method가 몇개만 포함되면?
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocusedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
이 또한 책임이 너무 많아서 좋지 않습니다.
- 클래스 이름은 해당 클래스의 책임 ^Responsibility 를 기술해야 함
- Processor, Manager, Super 와 같은 애매한 단어가 클래스 이름이 들어간다는건, 클래스의 크기가 크다는 뜻(즉 책임이 많다)
- 클래스 설명은 if, and, or, but을 사용하지 않고 25단어 이내로 설명이 가능해야 함
- 위의 클래스를 설명하자면, SuperDashboard는 마지막으로 포커스를 얻었던 컴퍼넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.
- 책임이 많다!!!!
단일 책임 원칙 ^Single ^Responsibility ^Principle, ^SRP
SRP는 클래스나 모듈을 변경할 이유가 하나, 단 하나뿐이어야 한다 는 원칙입니다.
- SRP에서는 클래스를 변경할 이유를 책임이라 정의
위 5개 method가 있는 SuperDashboard는 얼핏 클래스가 작아보이지만 변경할 이유가 두가지가 있습니다.
- 소프트웨어 버전이 바뀔 경우 변경이 필요
- SwingComponent를 상속받았기 때문에 Swing의 버전도 관리해야 함(흠 개인적으로는 그냥 UI Component를 관리하기 때문이라고 생각)
버전 정보를 다루는 메서드 3개를 따로 빼내 Version이라는 독자적인 클래스를 만들어 책임을 줄이는 것은 어떨까?
public class Version {
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
SRP는 객체 지향 설계에서 아주 중요하고 이해하고 지키기 수월한 개념입니다.
하지만 소프트웨어를 돌아가게 만드는 활동 과 소프트웨어를 깨끗하게 만드는 활동 이 완전히 별개이기 때문에 깨끗한 소프트웨어라는 것을 소홀히 여기게 됩니다.
- 돌아가는 순간 일이 끝났다고 여김
- 예를 들어 만능 클래스를 단일 책임 클래스 여럿으로 분리하는 대신 다음 문제로 넘어감
많은 개발자들이 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려합니다. 하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇개 뿐인 시스템이든 돌아가는 부품의 수는 비슷합니다.
- 큼직한 다목적 클래스는 당장 알 필요가 없는 사실까지 이해해야 함
- 결국 도구 상자를 어떻게 관리하고 싶은가? 라는 질문의 답을 생각하면 쉽습니다.
- 작은 서랍을 많이 두고 기능과 이름이 명확한 컴포넌트를 나눠 넣고 싶은가? 아니면 큰 서랍 몇 개를 두고 모두를 던져 넣고 싶은가?
결국에는, 큰 클래스 몇개가 아닌 작은 클래스 여럿으로 이루어진 시스템이 더 바람직합니다.
- 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행합니다.
응집도 ^Cohesion
- 클래스는 인스턴스 변수 수가 작아야 합니다.
- 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 합니다.
- 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높습니다.
- 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높습니다.
우리는 응집도가 높은 클래스를 선호합니다.
- 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미
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;
}
}
함수를 작게, 매개변수 목록을 짧게 라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아집니다.
- 이는 새로운 클래스로 쪼개야 한다는 신호
- 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼갬
응집도를 유지하면 작은 클래스 여럿이 나온다
큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아집니다.
- 변수가 아주 많은 큰 함수 하나가 있다.
- 큰 함수 일부를 작은 함수 하나로 빼내고 싶은데 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다.
- 변수 네개를 새 함수의 인수로 넘겨야 할까?
- 전혀 아니다!!!
- 네 변수를 인스턴스 변수로 승격하면 인수가 필요 없어진다.
- 새 함수는 인수가 필요없어져 함수로 쪼개기 쉬워진다.
- 몇몇 함수만 사용하는 인스턴스 변수가 늘어나기 때문에, 클래스가 응집력을 잃는다.
- 응집력을 잃은 클래스를 쪼갠다.
예제
아래는 PrintPrimes 프로그램을 자바로 변환한 코드이다. 이 큰 함수를 작은 함수/클래스 여럿으로 쪼개보도록 하겠다.
package literatePrimes;
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;
}
}
}
}
함수가 하나뿐인 위 프로그램은 아주 엉망진창이다.
- 들여쓰기가 심하고
- 이상한 변수가 많고
- 구조가 빡빡하게 결합
여러 작은 함수와 클래스로 나눈 후 함수와 클래스와 변수에 의미 있는 이름을 부여하면 아래와 같습니다.
package literatePrimes;
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);
}
}
package literatePrimes;
import java.io.PrintStream;
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;
}
}
package literatePrimes;
import java.util.ArrayList;
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
- 숫자 목록을 주어진 행과 열에 맞춰 페이지에 출력
- PrimeGenerator
- 소수 목록을 생성
두 프로그램의 알고리즘과 동작 원리는 동일하다. 하지만 하나의 거대한 함수보다는 책임을 하나만 가진 여러개의 클래스가 더 좋다.
변경하기 쉬운 클래스
대다수 시스템은 지속적인 변경이 가해집니다.
- 변경 때마다 시스템이 의도대로 동작하지 않은 위험이 따름
- 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춤
아래는 메타 자료로 적절한 SQL 문자열을 만들어주는 sql 클래스입니다.
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()
private String columnList(Column[] columns)
private String valuesList(Object[] fields, final Column[] columns)
private String selectWithCriteria(String criteria)
private String placeholderList(Column[] columns)
}
위 클래스는 변경할 이유가 두 가지가 있기 때문에 SRP를 위반합니다.
- update 문을 지원
- select 문에 내장된 select 문을 지원하기 위해
또한, selectWithCriteria라는 비공개 메서드는 select문을 처리할 때만 사용됩니다. 경험적에 의하면 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지가 있다는 것을 시사합니다.
아래 코드는 공개 인터페이스를 각각 SQL 클래스에서 파생하는 클래스로 만든 결과입니다.
- valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮김.
- 공통적으로 사용하는 비공개 메서드는 Where와 ColumnList라는 두 유틸리티 클래스에 넣음
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, Object[] fields)
@Override public String generate()
private String valuesList(Object[] fields, final Column[] columns)
}
public class SelectWithCriteriaSql extends Sql {
public SelectWithCriteriaSql(
String table, Column[] columns, Criteria criteria)
@Override public String generate()
}
public class SelectWithMatchSql extends Sql {
public SelectWithMatchSql(String table, Column[] columns, Column column, String pattern)
@Override public String generate()
}
public class FindByKeySql extends Sql public FindByKeySql(
String table, Column[] columns, String keyColumn, String keyValue)
@Override public String generate()
}
public class PreparedInsertSql extends Sql {
public PreparedInsertSql(String table, Column[] columns)
@Override public String generate() {
private String placeholderList(Column[] columns)
}
public class Where {
public Where(String criteria) public String generate()
public String generate() {
}
public class ColumnList {
public ColumnList(Column[] columns) public String generate()
public String generate() {
}
클래스가 서로 분리되었기 때문에 클래스가 단순하고 코드는 순식간에 이해할 수 있게 변했다.
- 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사라졌다.
- 테스트하기도 쉬워졌다.
- SRP와 OCP를 지원
Update 문을 추가할 때는 기존 클래스를 변경하지 않고 새로운 클래스 UpdateSql을 구현하면 된다.
변경으로부터 격리
객체지향 프로그래밍에는 Concrete 클래스(구현)와 Abstract 클래스(개념)가 있습니다.
상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀔때 위험에 빠지기 때문에 항상 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리해야 합니다.
Abstract 클래스를 사용하면 테스트를 좀 더 쉽게 할 수 있기도 합니다.
Porfolio라는 클래스를 만든다고 가정해봅시다.
- 이 클래스는 외부 TokyoStockExchange API를 사용해 값을 계산
- 때문에 테스트 코드는 시세 변화에 영향을 받음
- 5분마다 값이 달라지는 API로 테스트 코드를 짜기는 쉽지 않음
Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하지 않고 StockExchange라는 인터페이스를 생성하고 이 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현합니다.
public insterface StockExchange {
Money currentPrice(String symbol);
}
그리고 Portfolio의 생성자에서 StockExchange를 인수로 받도록 합니다.
public Portfolio {
private StockExchange exchange;
public Portfolio(StockExchange exchange) {
this.exchange = exchange;
}
// ...
}
이제 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());
}
}
테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아집니다.
- 각 시스템 요소가 다른 요소로부터, 그리고 변경으로부터 잘 격리되어 있다는 의미
- 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기 더 쉬움