[10장] 클래스

코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경 쓸지라도 좀 더 차원 높은 단계까지 신경쓰지 않으면 깨끗한 코드를 얻기는 어렵다.

이 장에서는 깨끗한 클래스를 다룬다.

클래스 체계

- 클래스를 정의하는 표준 자바 관례에 따르면, 가장 먼저 변수 목록이 나온다.

- 정적(static) 공개(public) 상수가 있다면 맨 처음에 나오고, 다음으로 정적 비공개(private) 변수가 나오며, 이어서 비공개 인스턴스 변수가 나온다. 공개 변수가 필요한 경우는 거의 없다.

- 변수 목록 다음에는 공개 함수가 나온다. 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣음으로, 추상화 단계가 순차적으로 내려간다.

캡슐화

- 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다.

- 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.

클래스는 작아야 한다!

- 클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다.

- 함수는 물리적인 행 수로 크기를 측정했지만, 클래스는 각 클래스가 맡은 책임으로 크기를 잰다.

- 아래 코드는 SuperDashboard라는 클래스로, 공개 메서드 수가 대략 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)

	// ... many non-public methods follow ...
}

- 만약 SuperDashboard가 아래와 같이 메서드 몇 개만 포함한다면?

public class SuperDashboard extends JFrame implements MetaDataUser {
	public Component getLastFocusedComponent()
	public void setLastFocused(Component lastFocused)
	public int getMajorVersionNumber()
	public int getMinorVersionNumber()
	public int getBuildNumber()
}

- SuperDashboard는 메서드 수가 작음에도 불구하고 책임이 너무 많다.

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

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

- SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, ... SuperDashboard에 책임이 너무 많다.

단일 책임 원칙

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

- 위의 코드에서의 SuperDashboard는 소프트웨어 버전 정보를 추적하지만, 버전 정보는 소프트웨어를 출시할 때마다 달라지기 때문에 수정해야 한다.

- SuperDashboard는 자바 스윙 컴포넌트를 관리하기 때문에, 스윙 코드를 변경할 때마다 버전 번호가 바뀌게 된다.

- SuperDashboard에서 버전 정보를 다루는 메서드 세 개를 따로 빼내 Version이라는 독자적인 클래스를 만들게 되면, 다른 애플리케이션에서도 재사용하기 아주 쉬울 것이다!

class Version:
	def getMajorVersionNumber(self):
    	pass
    def getMinorVersionNubmer(self):
    	pass
    def getBuildNumber(self):
    	pass

- SRP는 객체 지향 설계에서 중요한 개념이고, 이해하고 지키기 수월한 개념이다.

- SW를 돌아가게 만드는 활동과 깨끗하게 만드는 활동은 완전히 별개다. 관심사를 분리하는 작업은 프로그램만이 아니라 프로그래밍 활동에서도 마찬가지로 중요하다.

- 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하기 때문에, 이런 복잡성을 다루려면 체계적인 정리가 필수다. 그래야 개발자가 무엇이 어디에 있는지 쉽게 찾을 수 있고, 직접 영향이 미치는 컴포넌트만 이해해도 충분하다.

- 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

 

응집도

- 클래스는 인스턴스 변수 수가 작아야 하고, 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.

- 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다. 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.

- 응집도가 높다 : 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다

- 아래 코드는 Stack을 구현한 코드로, 응집도가 아주 높다. size()를 제외한 다른 두 메서드는 두 변수를 모두 사용한다.

class Stack:
	def __init__(self):
    	self.__topOfStack = 0
        self.elements = []
        
    def size(self):
    	return self.__topOfStack
        
    def push(self, element):
    	self.__topOfStack += 1
        self.elements.append(element)
        
    def pop(self):
    	if self.__topOfStack == 0:
        	raise PoppedWhenEmpty()
		element = self.elements[topOfStack-=1]
        elements.pop(topOfStack)
        return element

- 함수를 작게, 매개변수 목록을 짧게 라는 전략을 따르다 보면 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아지는데, 이는 새로운 클래스로 쪼개야 한다는 신호이다.

- 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개주어야 한다.

 

응집도를 유지하면 작은 클래스 여럿이 나온다

- 큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.

- 네 개의 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요 없다. 그만큼 함수를 쪼개기가 쉬워진다.

- 하지만 인스턴스 변수로 승격을 하게 되면 클래스가 응집력을 잃게 된다. 몇몇 함수만 사용하는 인스턴스 변수가 늘어나기 때문.

- 클래스가 응집력을 잃는다면 쪼개라!

- 큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다. 그러면서 체계가 잡히고 구조가 투명해진다.

- 아래의 코드는 큰 함수를 작은 함수/클래스 여럿으로 쪼개보는 출발점으로 훌륭한 코드이다.

M = 1000
RR = 50
CC = 4
WW = 10
ORDMAX = 30
P = []

PAGENUMBER = 0
PAGEOFFSET = 0
ROWOFFSET = 0
C = 0
J = 0
K = 0
JPRIME = False
ORD = 0
SQUARE = 0
N = 0
MULT = []

J = 1
K = 1
P.append(2)
ORD = 2
SQUARE = 9

while K<M:
	while true:
    	J += 1
        if J == SQUARE:
        	ORD += 1
            SQUARE = P[ORD]**2
            MULT[ORD-1] = J
        N = 2
        JPRIME = True
        while (N<ORD and JPRIME):
        	while MULT[N] < J:
            	MULT[N] = MULT[N] + P[N] + P[N]
            if (MULT[N] == J):
            	JPRIME = False
            N += 1
            
        if JPRIME:
        	break
    K += 1
    P[K] = J
    
PAGENUMBER = 1
PAGEOFFSET = 1

while (PAGEOFFSET <= M):
	print(f"The First {M} Prime Numbers --- Page {PAGENUMBER}")
    print()
    for ROWOFFSET in range(PAGEOFFSET, PAGEOFFSET+RR):
    	for C in range(CC):
        	if(ROWOFFSET + C * RR <= M):
            	print("%10d", %(P[ROWOFFSET + C * RR]))
        print()
    print()
    PAGENUMBER += 1
    PAGEOFFSET = PAGEOFFSET + RR * CC

- 함수가 하나뿐인 위 프로그램은 엉망진창이다. 최소한 여러 함수로 나눠야 마땅하다.

- 아래 코드들은 위 코드를 작은 함수와 클래스로 나눈 후 함수와 클래스와 변수에 좀 더 의미 있는 이름을 부여한 결과이다.

# PrimePrinter.py

NUMBER_OF_PRIMES = 1000
primes = PrimeGenerator.generate(NUMBER_OF_PRIMES)

ROWS_PER_PAGE = 50
COLUMNS_PER_PAGE = 4
tablePrinter = RowColumnPagePrinter(ROWS_PER_PAGE, COLUMNS_PER_PAGE, f"The First {NUMBER_OF_PRIMES} Prime Numbers")

tablePRinter.print(primes)

# RowColumnPagePrinter

class RowColumnPagePrinter:
	def __init__(self):
    	self.rowsPerPage = 0
        self.columnsPerPage = 0
        self.numbersPerPage = 0
        self.pageHeader = ""
        self.printStream = NULL
        
    def __init__(self, rowsPerPage, columnsPerPage, pageHeader):
    	self.rowsPerPage = rowsPerPage
        self.columnsPerPage = columnsPerPage
        self.pageHeader = pageHeader
        self.numbersPerPage = rowsPerPage * columnsPerPage
        self.printStream = print
        
    def print(self, data):
    	pageNumber = 1
        for firstIndexOnPage in range(0, len(data), numbersPerPage):
        	lastIndexOnPage = min(firstIndexOnPage+numbersPerPage-1, len(data)-1)
            self.printPageHeader(pageHeader, pageNumber)
            self.printPage(firstIndexOnPage, lastIndexOnPage, data)
            self.printStream = "\f"
            pageNumber += 1
            
    def printPage(self, firstIndexOnPage, lastIndexOnPage, data):
    	firstIndexOfLastRowOnPage = firstIndexOnPage + rowsPerPage - 1
        for firstIndexInRow in range(firstIndexOnPage, firstIndexOfLastRowOnPage+1):
        	self.printRow(firstIndexInRow, lastIndexOnPage, data)
			sefl.printStream = "\n"
            
    def printRow(self, firstIndexInRow, lastIndexOnPage, data):
    	for column in range(columnsPerPage):
        	index = firstIndexInRow + column * rowsPerPage
            
            if (index <= lastIndexOnPage):
            	self.printStream.format("%10d" %(data[index])
                
    def printPageHeader(self, pageHeader, pageNumber):
    	self.printStream = f"{pageHeader} --- Page {PageNumber}"
        self.printStream += "\n"
        
    def setOutput(self, printStream):
    	self.printStream = printStream

# PrimeGenerator.py

class PrimeGenerator:
	def __init__(self):
    	self.primes = []
        self.multiplesOfPrimeFactors = []
        
    def generate(self, n):
     	self.primes = []
        self.multiplesOfPrimeFactors = []
        self.set2AsFirstPrime()
        self.checkOddNumbersForSubsequentPrimes()
        return self.primes
        
    def set2AsFirstPrime(self):
     	primes.append(2)
        self.multiplesOfPrimeFactors.append(2)
        
    def checkOddNumbersForSubsequentPrimes(self):
    	primeIndex = 1
        candidate = 3
		while True:
        	candidate += 2
        	if(primeIndex >= len(self.primes):
            	break
                
            if(self.isPrime(candidate)):
            	self.primes.append(candidate)
                
    def isPrime(self, candidate):
    	if self.isLeastRelevantMultipleOfNextLargerPrimeFactor(candidate):
        	self.multiplesOfPrimeFactors.append(candidate)
            return False
            
        return self.isNotMultipleOfAnyPreviousPrimeFactor(candidate)
        
    def isLeastRelevantMultipleOfNextLargerPrimeFactor(self, candidate):
    	nextLargerPrimeFactor = primes[len(self.multiplesOfPrimeFactors)]
        leastRelevantMultiple = nextLargerPrimeFactor**2
        return candidate == leastRelevantMultiple
        
    def isNotMultipleOfAnyPreviousPrimeFactor(self, candidate):
    	for n in range(1, len(multiplesOfPrimeFactors)):
        	if(self.isMultipleOfNthPrimeFactor(candidate, n))
            	return False
        return True
        
    def smallestOddNthMultipleNotLessThanCandidate(self, candidate, n):
    	multiple = self.multiplesOfPrimeFactors[n]
        while(multiple < candidate):
        	multiple += 2*primes[n]
        self.multiplesOfPrimeFactors.set(n, multiple)
        return multiple

 

- 리팩터링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용하고, 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용하고, 가독성을 높이고자 공백을 추가하고 형식을 맞춤으로써 프로그램이 길어지게 되었다.

 

- 프로그램을 처음부터 다시 짠 것이 아니라, 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성하고, 한 번에 하나씩 수 차례에 걸쳐 조금씩 코드를 변경하였고, 코드를 변경할 때마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인했다.

 

변경하기 쉬운 클래스

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

- 아래 코드는 주어진 메타 자료로 적절한 SQL 문자열을 만드는 Sql 클래스인데, 코드에 "손대면" 위험이 생기게 된다.

- 어떤 변경이든 클래스에 손대면 다른 코드를 망가뜨릴 잠정적인 위험이 존재한다. 그래서 테스트도 완전히 다시 해야 한다.

class Sql:
	def __init__(self, table, columns):
    	pass
    def create(self):
    	pass
    def insert(self, fields):
    	pass
    def selectAll(self):
    	pass
    def findByKey(self, keyColumn, keyValue):
    	pass
    def select(self, column, pattern):
    	pass
    def select(self, criteria):
    	pass
    def preparedInsert(self):
    	pass
    def columnList(self, columns):
    	pass
    def valuesList(self, fields, columns):
    	pass
    def selectWithCriteria(self, criteria):
    	pass
    def placeholderList(self, columns):
    	pass

- 새로운 SQL문을 지원하려면, 기존 SQL문 하나를 수정할 때도 반드시 Sql 클래스에 손대야 한다.

- 변경할 이유가 두 가지이므로, 그리고 단순히 구조적인 관점에서도 Sql 클래스는 SRP를 위반한다.

- 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사하지만, 실제로 개선에 뛰어드는 계기는 시스템이 변해서라야 한다.

- 아래 코드는 위 코드에 있던 공개 인터페이스를 각각 Sql 클래스에서 파생하는 클래스로 만든 것이다.

class Sql:
	def __init__(self, table, columns):
    	pass
    @abstractmethod
    def generate(self):
    	pass
        
class CreateSql(Sql):
	def __init__(self, table, columns):
    	pass
    def generate(self):
    	pass
        
class SelectSql(Sql):
	def __init__(self, table, columns):
    	pass
    def generate(self):
    	pass
        
class InsertSql(Sql):
	def __init__(self, table, columns, fields):
    	pass
    def generate(self):
    	pass
    def valuesList(self, fields, columns):
    	pass
        
class SelectWithMatchSql(Sql):
	def __init__(self, table, columns, column, pattern):
    	pass
	def generate(self):
    	pass
        
class FindByKeySql(Sql):
	def __init__(self, table, columns, keyColumn, keyValue):
    	pass
    def generate(self):
    	pass

class PreparedInsertSql(Sql):
	def __init__(self, table, columns):
    	pass
    def generate(self):
    	pass
    def placeholderList(self, columns):
    	pass
        
class Where:
	def __init__(self, criteria):
    	pass
    def generate(self):
    	pass
        
class ColumnList:
	def __init__(self, columns):
    	pass
    def generate(self):
    	pass

- 각 클래스가 분리되었기 때문에 단순하고, 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 사라졌다.

- 위처럼 재구성한 클래스는 SRP를 지원하고, OCP(Open-Closed Principle)도 지원한다.

- OCP : 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다.

- 재구성한 Sql 클래스는 파생 클래스를 생성하는 방식으로 새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 방식으로 수정에 폐쇄적이다.

- 새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다. 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.

 

변경으로부터 격리

- 객체 지향 프로그래밍 입문에서 우리는 구체적인 클래스와 추상 클래스가 있다고 배웠다.

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

- 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠지기 때문에, 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.

- Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하는 대신 Stock Exchange라는 인터페이스를 생성한 후 메서드 하나를 선언하고, StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현하고, Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받는다. 이 모든 것을 적용한 뒤 테스트코드를 작성해보겠다.

class StockExchange:
	def __init__(self):
    	pass
    def currentPrice(self, symbol):
    	pass
        
class Portfolio:
	def __init__(self):
    	self.exchange = StockExchange()
    def __init__(self, exchange):
    	this.exchange = exchange
        
class PortfolioTest:
	def __init__(self):
		self.exchange = NULL
        self.portfolio = NULL
        
	def setUp(self):
    	self.exchange = FixedStockExchangeStup()
        self.exchange.fix("MSFT", 100)
        self.portfolio = Portfolio(self.exchange)
        
	def GivenFiveMSFTTotalShouldBe500(self):
    	self.portfolio.add(5, "MSFT")
        assertEqual(500, self.portfolio.value())

- 위와 같은 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.

- 결합도가 낮다 : 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미. 각 요소 이해하기 쉬워짐

- 결합도를 최소로 줄이면 DIP(Dependency Inversion Principle)를 따르는 클래스가 나온다.

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

- 추상화로 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨길 수 있다.