[Clean Code] 10장 클래스

ASk·2021년 12월 30일
CLEAN CODE
0

Clean Code

목록 보기
10/17
post-thumbnail

Intro

  • 지금까지 코드 행과 코드 블록, 함수 구현 방법과 함수간의 관련 맺는 방식을 공부 했다.
  • 하지만 좀 더 차원 높은 단계까지 신경 쓰지 않으면 깨끗한 코드를 얻기는 어렵다.
  • 이 장에서는 깨끗한 클래스를 다룬다.

클래스 체계

  • 클래스를 정의하는 표준 자바 관례 순서
  1. 변수 목록
    1. public static 변수
    2. private static 변수
    3. private 인스턴스 변수
    • public 인스턴스 변수 (필요한 경우는 거의 없음)
  2. 함수 목록
    1. public 함수
    2. private 함수 (자신을 호출하는 public 함수 직후에 넣는다. 따라서 추상화 단계가 순차적으로 내려간다.)

캡슐화

  • 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 하다는 법칙은 없다.
  • 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트코드에 접근을 허용하기도 한다.
  • 하지만 그 전에 비공개 상태를 유지할 온갖 방법을 강구한다.
  • 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.

클래스는 작아야 한다!

  • 클래스를 만들때 첫번째 규칙은 크기다. 클래스는 작아야 한다.
  • 두번째 규칙도 크기다. 더 작아야 한다.
  • 단, 함수와는 다르게(함수는 물리적인 행 수로 측정), 클래스는 맡은 책임을 측정한다.
// 목록 10-1, 너무많은 책임
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 setAllowDragging(boolean allowDragging) 
  public boolean allowDragging()
  public boolean isCustomizing()
  public void setTitle(String title)
  public IdeMenuBar getIdeMenuBar()
  public void showHelper(MetaObject metaObject, String propertyName)
  // ... 많은 비공개 메서드가 이어진다 ...
}
// 목록 10-2, 메소드를 5개로 줄인다고 하더라도 여전히 책임이 많다.
public class SuperDashboard extends JFrame implements MetaDataUser {
  public Component getLastFocusedComponent()
  public void setLastFocused(Component lastFocused)
  public int getMajorVersionNumber()
  public int getMinorVersionNumber()
  public int getBuildNumber() 
}
  • 클래스 이름은 해당 클래스 책임을 기술해야된다. 작명은 클래스 크기를 줄이는 첫번째 관문이다.
  • 간결한 이름이 떠오르지 않는다면 클래스 책임이 너무 많아서이다.
  • 예를들어 클래스 이름에 Manager, Processor, Super 등 모호한 이름을 포함할 경우 여러 책임이 있는 것이다.
  • 클래스 설명은 "if", "and", "or", "but"을 사용하지 않고 25 단어 내외로 가능해야된다.
  • 한글의 경우 만약, 그리고, ~하며, 하지만 이 들어가면 안된다. 들어갈 경우 책임이 많은것!

단일 책임 원칙

  • 단일 책임의 원칙 (Single Responsibility Principle)은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙이다.
  • "책임" 이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
  • 책임, 즉 변경할 이유를 파악하려고 애쓰다 보면 코드를 추상화 하기도 쉬워진다.
  • 목록 10-2 의 경우 변경할 이유가 두가지이다.
    • 첫째 소프트웨어 버전 정보를 추적한다.
    • 둘째 자바 스윙 컴포넌트를 관리한다.
// 목록 10-3, 단일 책임 클래스
// 버전 정보를 다루는 메서드 3개를 따로 빼서 Version 이라는 독자적인 클래스를 만들어 다른 곳에서 재사용하기 쉬워졌다.
public class Version {
  public int getMajorVersionNumber() 
  public int getMinorVersionNumber() 
  public int getBuildNumber()
}
  • SRP는 객체지향설계에서 더욱 중요한 개념이다, 이해하고 지키기 수월하지만 개발자가 가장 무시하는 규칙 중 하나이다.
  • 대부분의 프로그래머들이 돌아가는 소프트웨어에 초점을 맞춘다. 전적으로 올바른 태도이다.
  • 하지만, 돌아가는 소프트웨어가 작성되면 깨끗하고 체계적인 소프트웨어라는 다음 관심사로 전환을 해야한다.
  • 단일 책임 클래스가 많아지면 큰그림을 이해하기 어려워진다고 우려한다.
    • 이 클래스 저클래스 수없이 넘나들어야 한다고 걱정한다.
  • 작은 클래스가 많은 시스템이든, 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다.

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

  • 규모가 크면 시스템의 논리가 복잡하기 때문에, 체계적인 정리가 필수다.
  • 다목적 클래스 몇개로 이뤄진 시스템은 변경시에 당장 알 필요가 없는 사실까지 들이밀어 독자를 방해한다.

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

응집도 Cohesion

  • 클래스는 인스턴스 변수 수가 작아야 한다.
  • 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
  • 일반적으로 메서드가 변수를 더 많이 사용할 수록 메서드와 클래스는 응집도가 더 높다.
  • 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이다.
// 목록 10-4, 응집도가 높은 클래스.
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;
  }
}
  • 함수를 작게, 매개변수 목록을 짧게라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.
  • 이는 십중 팔구 새로운 클래스를 쪼개야 한다는 신호다.
  • 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스로 쪼개주면된다.

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

  • 큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.
  • 예를 들어, 변수가 아주 많은 큰 함수가 하나 있다.
    • 큰 함수 일부를 작은 함수로 빼내고 싶다.
    • 빼내려는 코드가 큰 함수에 정의 된 변수를 많이 사용한다.
    • 그렇다면 변수들을 새 함수에 인수로 넘겨야 하나? 전혀 아니다!
    • 변수들을 클래스 인스턴스 변수로 승격 시키면 인수가 필요없다.
      • 그러나 이렇게하면 클래스가 응집력을 잃는다.
      • 몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문이다.
    • 몇몇 함수가 몇몇 인스턴스 변수만 사용한다면 독자적인 클래스로 분리해도 되지 않는가? 당연하다!
    • 클래스가 응집력을 잃는다면 쪼개야한다!

      큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.

// 목록 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;
      }
    }
  }
}
  • 위 코드의 문제점은
    1. 들여쓰기가 심하다.
    2. 이상한 변수가 많다.
    3. 구조가 빡빡하게 결합되어있다.
// 목록 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;
  }
}
  1. 좀 더 길고 서술적인 변수 이름을 사용했다.
  2. 함수 선언과 클래스 선언으로 코드를 설명했다.
  3. 가독성을 위해 공백을 추가하고 형식을 맞췄다.
  • 가장 먼저 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성하라.
  • 그 다음 한번에 하나씩 여러번에 걸쳐 코드를 변경하고,
  • 코드를 변경 할 때 마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인하라.

변경하기 쉬운 클래스

  • 대다수 시스템은 지속적인 변경이 가해진다. 그리고 변경이 있을 때 마다 의도대로 동작하지 않을 위험이 따른다.
  • 깨끗한 시스템은 클래스를 체계적으로 관리해 변경에 따르는 위험을 최대한 낮춘다.
// 목록 10-9, 변경이 필요해 '손대야' 하는 클래스
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)
}
  • 목록 10-9는 새로운 SQL문을 지원할 때 손대야 하고, 기존 SQL문을 수정할 때도 손대야 한다.
  • 또한 기존 SQL 수정시에도 손대야 하므로 SRP를 위반한다.
// 목록 10-10 닫힌 클래스 집합
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 class ColumnList {
  public ColumnList(Column[] columns)
  public String generate()
}
  • 리팩토링
    • 공개 인터페이스를 각각 SQL 클래스에서 파생하는 클래스로 만들었다.
    • valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮겼다.
    • 모든 파생 클래스가 공통으로 사용하는 메서드는 Where와 ColumnList 라는 두 유틸리티 클래스에 넣었다.
  • 이렇게 하면 update 문을 추가 할때 기존 클래스를 변경할 필요가 전혀 없다.
  • 또한 테스트 관점에서도 모든 논리를 검증하고 증명하기 쉬워졌다.
  • 목록 10-10 은 SRP를 지원하며, OCP도 지원한다.
    • OCP(Open Closed Principle) : 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다.

변경으로부터 격리

  • 객체지향 프로그래밍에는 Concrete 클래스(구현)와 Abstract 클래스(개념)가 있다.
  • 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
  • 따라서 인터페이스와 abstract 클래스를 사용해 구현이 미치는 영향을 격리시켜야 한다.
  • 추상화를 통해 테스트가 가능할 정도로 시스템의 결합도를 낮춤으로써 유연성과 재사용성도 더욱 높아진다.
  • Porfolio라는 클래스를 만든다고 가정하자.
    • 이 클래스는 외부 TokyoStockExchange API를 사용해 값을 계산
    • 때문에 테스트 코드는 시세 변화에 영향을 받음
    • 5분마다 값이 달라지는 API로 테스트 코드를 짜기는 쉽지 않음
public interface StockExchange { 
  Money currentPrice(String symbol);
}
  • Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하지 않고 StockExchange라는 인터페이스를 생성하고
  • 이 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현합니다.
public Portfolio {
  private StockExchange exchange;
  public Portfolio(StockExchange exchange) {
    this.exchange = exchange; 
  }
  // ... 
}
  • 그리고 Portfolio의 생성자에서 StockExchange를 인수로 받도록 한다.
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) : 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
  • 위에서 개선한 Portfolio 클래스는 상세 구현 클래스가 아닌 StockExchange라는 인터페이스에 의존하므로,
  • 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨길 수 있다.
profile
ASk
Backend Developer
이전 포스트

[Clean Code] 9장 단위 테스트

다음 포스트

[Clean Code] 11장 시스템

0개의 댓글