윤주

윤주

꾸준히 기록하자

Clean Code - 10. 클래스

Classes

클래스 체계

클래스를 정의하는 표준 자바 관례에 따르면..

  • 변수 목록
    • 정적 공개 상수
    • 정적 비공개 변수
    • 비공개 인스턴스 변수
  • 공개 함수
  • 비공개 함수 (호출하는 공개 함수 직후에 넣음)

-> 추상화 단계가 순차적으로 내려가기 때문에 프로그램은 신문 기사처럼 읽힌다.

캡슐화

변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫다.
비공개 상태를 유지할 방법을 강구해보고, 캡슐화를 풀어주는 결정은 최후의 수단이다.

클래스는 작아야 한다!

클래스는 얼마나 작아야 할까?
클래스가 맡은 책임을 세어 최대한 작게 만든다.

RDD(Responsibility Driven Design, 책임 주도 설계)
책임을 어디에 배치하는가, 책임을 수행할 적절한 객체를 찾고
책임을 수행하는 도중 다른 객체의 도움이 필요할 경우 메시지를 먼저 설계하고
그 메시지를 수신할 객체를 찾아 책임을 할당하는 설계 방식

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

  • 간결한 이름이 떠오르지 않는다. = 클래스 크기가 너무 크다.
  • 클래스 이름이 모호하다. = 클래스 책임이 너무 많다.

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

단일 책임 원칙 (SRP, Single Responsibility Principle)

클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다.
책임(=변경할 이유)을 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.

큰 클래스 몇 개로 이루어진 시스템 < 작은 클래스 여러 개로 이루어진 시스템
작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

응집도 (Cohesion)

모듈에 포함된 내부 요소들이 하나의 책임/목적을 위해 연결되어있는 연관된 정도.
모듈이 하나의 목적을 수행하는 요소들간의 연관성 척도로, 모듈 내부 구성요소 간 연관 정도를 나타냄.

클래스는 인스턴스 변수 수가 작아야 한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
일반적으로 이처럼 응집도가 가장 높은 클래스는 가능하지도 바람직하지도 않다.
그렇지만 우리는 응집도가 높은 클래스를 선호한다.
응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문이다.

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

함수를 작게, 매개변수 목록을 짧게 라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.
이는 십중팔구 새로운 클래스로 쪼개야 한다는 신호다.
응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개준다.

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

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

변수가 아주 많은 큰 함수 한 개
큰 함수 일부를 작은 함수 하나로 빼내고 싶다
빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다면 새 함수의 인수로 넘겨야 하는가?
네 변수를 클래스 변수로 승격한다면 새 함수는 인수가 필요 없어지므로 함수를 쪼개기 쉬워진다.
-> 클래스가 응집력을 잃는다.
몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문이다.
몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리해도 되지 않을까?
-> 클래스가 응집력을 잃으면 쪼개자!

// AS-IS
public class PrintPrimes {
  public static void main(String[] args) {
    final int M = 1000;
    final int RR = 50;
    // 이후 엄청 많은 변수들

    while (K < M) {
      // do something..
    }
  }
}

// TO-BE
public class PrimePrinter { // main 함수 하나만 포함하며 실행 환경을 책임진다. 
  public static void main(String[] args) {
    final int NUMBER_OF_PRIMES = 1000;
    int[] primes = ...

    RowColumnPagePrinter tablePrinter = new RowColumnPagePrinter(...);

    tablePrinter.print(primes);
  }
}

public class RowColumnPagePrinter { // 숫자 목록을 주어진 행과 열에 맞춰 페이지에 출력하는 방법을 안다.
  private int rowPerPage;
  private int columnsPerPage;
  // 이후 적절한 변수 선언

  public RowColumnPagePrinter(int rowsPerPage, int columnsPerPage, String pageHeader) {}
  public void print(int data[]) {}
  private void printPage(int firstIndexOnPage, int lastIndexOnPage, int[] data) {}
  private void printRow(int firstIndexInRow, int lastIndexOnPage, int[] data) {}
  private void printPageHeader(String pageHeader, int pageNumber) {}
  public void setOutput(PrintStream printStream) {}
}

public class PrimeGenerator { // 소수 목록을 생성하는 방법을 안다.
  private static int[] primes;
  private static ArrayList<Integer> multiplesOfPrimeFactors;

  protected static int[] generate(int n) {}
  private static void set2AsFirstPrime() {}
  private static void checkOddNumbersForSubsequentPrimes() {}
  private static boolean is Prime(int candidate) {}
  private static boolean isLeastRelevantMultipleOfNExtLargerPrimeFactor(int candidate){}
  private static boolean isNotMultipleOfAnyPreviousPrimeFactor(int candidate) {}
  private static boolean isMultipleOfNthPrimeFactor(int candidate, int n) {}
  private static int smallestOddNthMultipleNotLessThanCandidate(int candidate, int n) {}
}

하나의 큰 함수를 여러 개의 클래스로 분리했더니 프로그램이 길어진 이유

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

변경하기 쉬운 클래스

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

// AS-IS
public class Sql {
  public Sql(String table, Column[] columns);
  public String create();
  ...
  private String selectWithCriteria(String criteria);
  ...
}

// TO-BE
// AS-IS의 public 인터페이스를 각각 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 SelectWithCriteriaSql extends Sql {
  public SelectWithCriteriaSql(String table, Column[] columns, Criteria criteria)
  @Override public String generate()
}
...

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

변경으로부터 격리

  • 구체적인 클래스 : 상세한 구현(코드)을 포함
  • 추상 클래스 : 개념만 포함

상세한 구현에 의존하는 코드

  • 구현이 바뀌면 위험에 빠지므로, 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
  • 테스트가 어렵기 때문에 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.

내 생각

하나의 클래스에 하나의 책임을 주자..!

태그:

카테고리:

업데이트:

참고