Skip to content

Latest commit

 

History

History
776 lines (661 loc) · 32.1 KB

10 클래스.md

File metadata and controls

776 lines (661 loc) · 32.1 KB
Raw

들어가면서

높은 차원의 단계도 깨끗하게 만들어야 한다.

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

클래스 체계

클래스를 정의하는 관례를 따르자

  1. 변수 목록
    1. 정적 공개 상수 public static
    2. 정적 비공개 상수 private static
    3. 비공개 인스턴스 변수 private
  2. 함수 목록
    1. 생성자
    2. 호출하는 함수
    3. 호출되는 함수

관례를 따르면 추상화 단계가 순차적으로 내려가 신문처럼 읽을 수 있게 된다.

캡슐화

캡슐화는 객체지향의 본질적인 특징이지만 때로는 풀어줘도 된다.

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

  • 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하자.
  • 같은 패키지안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면
    그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개해도 된다.
  • 물론, 이전에 먼저 비공개 상태를 유지할 방법을 강구해야한다.

클래스는 작아야 한다.

클래스를 만들 때 가장 중요한 규칙은 작게 만드는 것이다.

클래스를 설계할 때도, 함수와 마찬가지로 작게 가 기본 규칙이다.
클래스는 클래스가 맡은 책임의 수를 기준으로 작게 만들어야 한다.

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) 
}
  • 대다수의 개발자들은 위 클래스가 엄청나게 크다는 사실에 동의한다.
  • public method의 수가 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() 
}

그렇다면 메서드의 양을 줄여 위와 같이 나타내면 우리가 원하는 클래스일까?
정답 : 메서드 수가 적음에도 책임이 너무 많기 때문에 아니다.

  • 마지막 포커스를 얻었던 컴포넌트에 접근 (get/set)
  • 버전과 빌드 번호를 추적하는 메커니즘 제공
  • 컴포넌트 관리, 버전 관리, 빌드 관리등 책임이 너무 많다.

클래스 이름은 해당 클래스 책임을 기술해야한다.

  • 작명은 클래스 크기를 줄이는 첫 번째 관문이다.
  • 간결한 이름이 떠오르지 않는다면 클래스가 너무 커서 그렇다.
  • 클래스 이름이 모호하다면 클래스 책임이 너무 많아서이다.
  • 클래스 이름에 Processor Mananger Super등과 같이
    모호한 단어가 있다면 클래스에 여러 책임을 떠안겼다는 증거다.
  • 클래스 설명은 if, and, or, but을 사용하지 않고 25단어 내외로 가능해야 한다.

단일 책임 원칙 - SRP

SRP : 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다.

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

책임 == 변경할 이유

책임이 많은 클래스

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

위 클래스를 변경할 이유는 2가지이다.

  • 소프트웨어 버전 정보를 추적한다.
  • 자바 스윙 컴포넌트를 관리한다.
  • 버전 정보는 출시 때마다 달라진다.
  • 즉, 스윙 코드를 변경할 때마다 버전 번호가 달라진다.
  • 버전 번호 관리/스윙 컴포넌트 관리 2가지 변경할 이유(책임)가 따른다.

책임이 1개인 클래스

public class Version {
	public int getMajorVersionNumber()
	public int getMinorVersionNumber()
	public int getBuildNumber()
}
  • 책임, 즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.
  • 버전 정보를 다루는 메서드 3개를 따로 빼낸 Version 클래스를 만들었다.
  • Version클래스는 다른 모듈에서도 재사용하기 쉬워졌다.

SRP는 객체 지향 설계에서 중요한 개념이며 이해하고 지키기 수월한 개념이다.
하지만 SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나이다.

소프트웨어를 돌아가게 만드는 활동과 깨끗하게 만드는 활동은 완전히 별개다.
하지만, 하나의 관심사에만 초점을 맞춰 코드를 작성하는 경우가 대부분이다.

  • 대다수는 깨끗한 체계적인 소프트웨어보다 돌아가는 소프트웨어에 초점을 맞춘다.
  • 문제는 프로그램이 돌아가면 깨끗한 체계적인 소프트웨어 관심사로 전환하지 않는다.
  • 대부분 만능 클래스를 단일 책임 클래스 여럿으로 분리하는 대신 다른 작업으로 넘어간다.

누군가는 단일 책임 클래스가 많아지면
클래스를 수 없이 넘나 들어야하기 때문에 큰 그림을 이해하기 어려워진다 말한다.

  • 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다.
  • 이런 복잡성을 다루려면 체계적인 정리가 필수다.
  • 그래야 변경을 가할 때 직접 영향이 미치는 컴포넌트만 이해해도 충분하다.
  • 하지만 큼직한 다목적 클래스 몇 개로 이뤄진 시스템은
  • 변경을 가할 때 알 필요가 없는 사실까지 들이밀어 독자를 방해한다.

결론은

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

응집도

클래스는 인스턴스 변수가 작아야한다.

응집도가 높다는 말은
클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이다.

응집도가 높은 클래스란

  • 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
  • 메서드가 변수를 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
  • 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
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;
    }
}
  • 위 클래스는 응집도가 매우 높다.
  • size()를 제외한 다른 두 메서드는 두 변수를 모두 사용한다.

함수를 작게, 매개변수 목록을 짧게라는 전략을 따르다 보면

  • 특정 메서드에서만 사용하는 인스턴스 변수가 많아진다.
  • 이는 새로운 클래스로 쪼개야 한다는 신호이다.
  • 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 2,3 개로 쪼개주자

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

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

public class Sample {
    ... // 이외의 인스턴스 변수 
    
    pubilc void method_one(int a, int b, int c, int d){
        ...
        ...
        ...
        ...
    }
    
    ... // 이외의 메서드 
}
  • 매개 변수가 많은 큰 함수가 있다.
  • 큰 함수를 여러개의 작은 함수로 빼고 싶다.
public class Sample {
    ... // 이외의 인스턴스 변수 
    
    pubilc void method_one(int a, int b, int c, int d){
        method_two(a, b, c, d);
	...
        ...
    }
    
    pubilc void method_two(int a, int b, int c, int d){
        ...
        ...
    }
    
    ... // 이외의 메서드 
}
  • 작은 함수로 빼낸 함수에서는 변수를 4개 이상 필요로 한다.
  • 이 같은 방법이 최선일까? 아니다!
public class Sample {
    ... // 이외의 인스턴스 변수   
    private int a;
    private int b;
    private int c;
    private int d;
    
    pubilc void method_one(){
        method_two();
        ...
        ...
    }
    
    pubilc void method_two(){
        ...
        ...
    }
    
    ... // 이외의 메서드 
}
  • 변수를 인스턴스 변수로 승격한다면 새 함수는 인수가 필요없다.
  • 그만큼 함수를 쪼개기 쉬워진다.
  • 하지만 특정 메서드만이 특정 인스턴스 변수를 사용하기 때문에 응집력을 잃는다.

잠깐! 여기서 우리가 생각해야할 점은?

  • 몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리해도 된다는 신호다.
  • 클래스가 응집력을 잃는다면 독자적인 클래스로 쪼개자!

결국, 큰 함수를 작은 함수 여럿으로 쪼개다 보면 작은 클래스 여럿으로 쪼갤 기회가 생긴다.
그러면서 클래스의 응집도는 높아지고 프로그램은 점점 더 체계가 잡히고 구조가 투명해진다.

예제

아래 코드는 커누스 교수의 PrintPrimes 프로그램을 자바로 변환한 코드이다.
큰 함수를 작은 함수/클래스 여럿으로 쪼개보도록 연습해보도록 하자.

PrimePrinter

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;
            }
        }
    }
}
  • 함수가 하나뿐이며 엉망진창이다.
  • 메서드의 길이가 매우 길다.
  • 들여쓰기가 심하다.
  • 이상한 변수가 많다.
  • 구조가 빡빡하게 결합되었다.

이 같은 코드는 여러 함수로 나눠야 마땅하다.

PrimePrinter

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

RowColumnPagePrinter

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;
    } 
}

PrimeGenerator

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;
    } 
}

여러 함수뿐만 아니라 여러 클래스로도 나뉘어졌다.
가장 먼저 눈에 띄는 변화로 기존 프로그램보다 코드가 길어졌다.

코드가 길어진 이유는?

  • 좀 더 길고 서술적인 변수 이름을 사용한다.
  • 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용한다.
  • 가독성을 높이고자 공백을 추가하고 형식을 맞추었다.

원래 프로그램을 3가지 책임으로 나눴다.

  1. PrimePrinter
  • main 함수 하나만 포함하며 실행 환경을 책임진다.
  • 호출 방식이 달라지면 클래스도 바뀐다.
  • 프로그램을 SOAP 서비스로 바꾸려면 PrimePrinter 클래스를 고쳐준다.
  1. RowColumnPagePrinter 클래스
  • 숫자 목록을 주어진 행과 열에 맞춰 페이지에 출력한다.
  • 출력하는 모양새를 바꾸려면 RowColumnPagePrinter 클래스를 고쳐준다.
  1. PrimeGenerator 클래스
  • 소수 목록을 생성하는 방법을 안다.
  • 객체로 인스턴스화하는 클래스가 아니다.
  • 단순히 변수를 선언하고 감추려고 사용하는 유용한 공간이다.
  • 소수를 계산하는 알고리즘이 바뀐다면 PrimeGenerator 클래스를 고쳐준다.

우리는 프로그램을 재구현 한 것도 아니도 다시 짜지도 않았다.
리펙토링 전/후 프로그램을 살펴보면 알고리즘과 동작 원리가 동일하다.

리팩토링 과정

  1. 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트 작성
  2. 한 번에 하나씩 수 차례에 걸쳐 조금씩 코드를 변경
  3. 코드를 변경할 때마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인
  4. 조금씩 원래 프로그램을 정리한 결과 최종 프로그램이 얻어짐

우리는 이와 같은 과정을 통해 코드를 리팩토링하며 깨끗한 클래스를 작성할 수 있다.

변경하기 쉬운 클래스

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

  • 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.
  • 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
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)
}

위 코드는 주어진 메타 자료로 적절한 SQL 문자열을 만드느 Sql 클래스이다.

  • 아직 미완성이라 update문과 같은 일부 SQL을 지원하지 않는다.
  • 언제가 update문을 지원할 시점이 오면 클래스를 고쳐야한다.
  • 문제는 클래스를 고치면 다른 코드를 망가뜨릴 잠정적인 위험이 생긴다.
  • 그래서 테스트도 완전히 다시 해야 한다.

Sql 클래스는 SRP를 위반한 클래스다.

  1. 새로운 SQL문을 지원하려면 반드시 Sql 클래스를 손대야 한다.
  2. 또한 기존 SQL문을 수정할 때도 반드시 Sql 클래스를 손대야 한다.
  • 이렇듯 변경할 이유가 2가지 이므로 Sql 클래스는 SRP를 위반한다.

Sql 클래스 코드를 살펴보면

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

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 (
	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() {
}
  • Sql 클래스에서 파생하는 클래스로 만들었다.
  • valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮겼다.
  • 모든 파생 클래스가 공통으로 사용하는 비공개 메서드는
    Where와 ColumnList라는 두 유틸리티 클래스에 넣었다.

클래스가 서로 분리되었기 때문에 클래스가 단순하고 코드는 순식간에 이해할 수 있게 변했다.

  • 함수 하나를 수정해도 다른 함수가 망가질 위험이 사실상 사라졌다.
  • 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌다.
  • update 문을 추가할 때도 기존 클래스를 변경할 필요가 없다.
  • UpdateSql 클래스를 만들고 Sql클래스를 상속받으면 된다.
  • update 문을 지원해도 다른 코드가 망가질 염려가 전혀 없어졌다.
  • 결과적으로 SRP와 OCP를 지원하는 세상의 모든 장점을 가진 클래스가 되었다.

변경으로부터 격리

요구사항은 변하고 코드도 같이 변하기 마련이다.
객체 지향 프로그래밍에서는 구체적인 클래스와 추상적인 클래스가 있다.

  • 구체적인 클래스 : 상세한 구현을 포함한다.
  • 추상적인 클래스 : 추상적인 개념을 포함한다.

상세한 구현에 의존하는 코드의 문제점*

  • 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
    • 해결 방법 : 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
  • 상세한 구현에 의존하는 코드는 테스트가 어렵다.
    • 실시간으로 데이터가 변화하는 외부 API를 사용하면 테스트를 진행하기 어렵다.
    • 해결 방법은 : 추상 클래스나 인터페이스를 이용하면 테스트를 쉽게 할 수 있다.

추상화 테스트 코드 예시

전제 상황
Protfolio 클래스에서 TokyoStockExchange API를 직접 호출하여 사용한다.
하지만 실시간으로 값이 변동되는 API를 이용하면 테스트를 진행하기 어렵다.
이를 인터페이스로 만들고 테스트용 클래스를 만들어 테스트를 진행해보자.

테스트 가능하도록 리팩토링하는 과정

// 인터페이스 
public insterface StockExchange {
	Money currentPrice(String symbol);
}
  • TokyoStockExchange API를 직접 호출하는 대신 StockExchange 인터페이스를 생성 한 후 메서드 하나를 선언한다.
// Portfolio 클래스의 생성자 
public Portfolio { 
	private StockExchange exchange;
	public Portfolio(StockExchange exchange) {
		this.exchange = exchange;
	}
	// ...
}
  • Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받는다.
  • 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());
	}
}
  • TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있다.
  • 테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주기를 반환한다.
  • 마이크로소프트 주식 5주를 구입하면 테스트용 클래스는 고정적으로 100불을 반환한다.
  • 목업 테스트 클래스를 만들어 사용하는 것이라 생각하면 된다.
  • 전체 포트폴리오 총계가 500불인지 확인하는 테스트 코드를 작성할 수 있게 되었다.

테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 높아진다.
결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터
그리고 변경으로부터 잘 격리되어 있다는 의미다.
시스템 요소가 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다.

이렇게 결합도를 최소로 줄이면 자연스럽게도 DIP를 따르는 클래스가 나온다.
DIP는 본질적으로 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.
우리가 구현한 코드도 주식값을 반환한다는 추상적인 개념을 표현한다.
이와 같은 추상화로 주가를 얻어오는 출처, 방식과 같은 구체적인 사실은 숨긴다.

참고

http://amazingguni.github.io/blog/2016/06/Clean-code-11-%EC%8B%9C%EC%8A%A4%ED%85%9C