클래스

Hant·2021년 11월 15일
CLEAN CODE
0

Clean Code

목록 보기
9/13
post-thumbnail
post-custom-banner

1. 클래스 체계

클래스를 정의하는 표준 자바 관례에 따르면, 가장 먼저 프로퍼티 목록이 나옵니다. 정적(Static) 공개(Public) 상수가 있다면 맨 처음에 나옵니다. 다음으로 정적 비공개 프로퍼티가 나오며, 이어서 비공개 인스턴스 프로퍼티가 나옵니다. 공개 프로퍼티가 필요한 경우는 거의 없습니다. 프로퍼티 목록 다음에는 공개 머세드가 나옵니다. 비공개 메서드는 자신을 호출하는 공개 함수 직후에 넣습니다. 즉, 추상화 단계가 순차적으로 내려갑니다.

1.1. 캡슐화

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

2. 클래스는 작아야 한다!

클래스를 만들 떄 첫 번째 규칙은 크기입니다. 클래스 이름은 해당 클래스 책임을 기술해야 합니다. 실제로 작명은 클래스 크기를 줄이는 첫 번째 관문입니다. 간결한 이름이 떠오르지 않는다면 필경 클래스 크기가 너무 커서 그렇습니다. 또한 클래스 설명은 만일(if), 그리고(and), 하며(or), 하지만(but)을 사용하지 않고서 25단어 내외로 가능해야 합니다.

2.1. 단일 책임 원칙

단일 책음 원칙(Single Responsibility Principle, SRP)은 클래스나 모듈을 변경할 이유가 하나뿐이어야 한다는 원칙입니다. SRP는 책임이라는 개념을 정의하며 적절한 클래스 크기를 제시합니다. 책임, 즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워지며, 다른 애플리케이션에서 재사용하기 쉬운 구조를 만들 수 있습니다.

소프트웨어를 돌아가게 만드는 활동과 소프르웨어를 깨끗하게 만드는 활동은 완전히 별개입니다. 문제는 우리들 대다수가 프로그램이 돌아가면 일이 끝났다고 여기는 데 있습니다. 깨끗하고 체계적인 소프트웨어라는 다음 관심사로 전환하지 않습니다. 프로그램으로 되돌아가 만능 클래스를 단일 책임 클래스 여럿으로 분리하는 대신 다음 문제로 넘어가버립니다.

게다가 많은 개발자는 자잘한 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려합니다. 큰 그림을 이해하려면 이 클래스 저 클래스를 수없이 넘나들어야 한다고 걱정합니다. 하지만 돌아가는 부품은 그 수가 비슷합니다. 어느 시스템이든 익힐 내용을 그 양이 비슷합니다.

규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡합니다. 이런 복잡성을 다르려면 체계적인 정리가 필수입니다. 그래야 개발자가 무엇이 어디에 있는지 쉽게 찾습니다. 그래야 직접 영향이 미치는 컴포넌트만 이해해도 충분합니다. 큼직한 다목적 클래스 몇 개로 이뤄진 시스템은 당장 알필요가 없는 사실까지 들이밀어 독자를 방해합니다.

2.2. 응집도

클래스는 인스턴스 프로퍼티의 수가 작아야 합니다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 합니다. 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 높습니다. 모든 인스턴스 프로퍼티를 메서드마다 사용하는 클래스는 응집도가 가장 높습니다.

일반적으로 이처럼 응집도가 가장 높은 크래스는 가능하지도 바람직하지도 않습니다. 그렇지만 우리는 응집도가 높은 클래스를 선호합니다. 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미기 때문입니다.

다음은 Stack을 구현한 코드입니다. 아래 클래스는 응집도가 매우 높습니다.

class Stack {
  private topOfStack: number = 0;
  private elements: number[] = [];

  public size(): number {
    return this.topOfStack;
  }

  public push(element: number): void {
    this.topOfStack += 1;
    this.elements.push(element);
  }

  public pop(): number {
    if (this.topOfStack === 0) {
      throw new Error("Popped When Empty");
    }

    const element = this.elements.pop();
    this.topOfStack -= 1;

    return element;
  }
}

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

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

큰 함수를 작은 함수 여럭으로 나누기만 해도 클래스 수가 많아집니다. 예를 들어, 변수가 아주 많은 큰 함수의 일부를 작은 함수 하나로 빼고 싶은데, 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다. 그렇다면 네 개를 새 함수에 인수로 넘겨야 할까요?

아닙니다. 만약 네 변수를 클래스 인스턴스 변수로 승격하낟면 새 함수는 인수가 필요 없습니다. 그만큼 함수를 쪼개기 쉬워집니다. 불행히도 이렇게 하면 몇몇 함수만 사용하는 인스턴스 변수가 점점 늘어나 클래스가 응집력을 잃습니다. 하지만 몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리하면 됩니다. 그래서 큰 함수를 작은 함수 여럭으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생깁니다.

다음은 커누스 교수의 PrintPrimes 프로그램을 타입스크립트로 변환한 코드입니다. 공정하게 말해 커누스 교수가 짠 프로그램이 아니라 그가 짠 WEB 도구로 출력한 결과입니다.

function printPrimes(args: string[]): void {
  const M = 1000;
  const RR = 50;
  const CC = 4;
  const WW = 10;
  const ORDMAX = 30;
  const P = Array<number>(M + 1);
  let PAGENUMBER: number;
  let PAGEOFFSET: number;
  let ROWOFFSET: number;
  let C: number;
  let J: number;
  let K: number;
  let JPRIME: boolean;
  let ORD: number;
  let SQUARE: number;
  let N: number;
  let MULT = Array<number>(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) {
      console.log("The First " + M + " Prime Numbers --- Page " + PAGENUMBER);
      console.log("");
      for (ROWOFFSET = PAGEOFFSET; ROWOFFSET < PAGEOFFSET + RR; ROWOFFSET += 1) {
        for (C = 0; C < CC; C += 1) {
          if (ROWOFFSET + C * RR <= M) {
            console.log(P[ROWOFFSET + C * RR]);
          }
        }
        console.log("");
      }
      console.log("\f");
      PAGENUMBER = PAGENUMBER + 1;
      PAGEOFFSET = PAGEOFFSET + RR * CC;
    }
  }
}

함수가 하나분인 위 프로그램은 엉망진창입니다. 들여쓰기가 심하고, 이상한 변수가 많고, 구조가 빡빡하게 결합되어 있습니다. 최소한 여러 함수로 나눠야 마땅합니다. 다음은 작은 함수와 클래스로 나눈 후 함수와 클래스와 변수에 좀 더 의미 있는 이름을 부여한 결과입니다.

function printPrimes(): void {
  const NUMBER_OF_PRIMES = 1000;
  const primes = PrimeGenrator.generate(NUMBER_OF_PRIMES);

  const ROWS_PER_PAGE = 50;
  const COLUMNS_PER_PAGE = 4;
  RowColumnPagePrinter.print(primes, {
    rowsPerPage: ROWS_PER_PAGE,
    columnsPerPage: COLUMNS_PER_PAGE,
    pageHeader: `The First ${NUMBER_OF_PRIMES} Prime Numbers`,
  });
}
interface PrintOptionParam {
  rowsPerPage: number;
  columnsPerPage: number;
  pageHeader: string;
}

class RowColumnPagePrinter {
  private static rowsperPage: number;
  private static columnsPerPage: number;
  private static numbersPerPage: number;
  private static pageHeader: string;

  public static print(data: number[], option: PrintOptionParam) {
    this.setPrintPropsFromOptionParam(option);
    let pageNumber = 1;
    for (let firstIndexOnPage = 0; firstIndexOnPage < data.length; firstIndexOnPage += this.numbersPerPage) {
      let lastIndexOnPage = Math.min(firstIndexOnPage + this.numbersPerPage - 1, data.length - 1);
      this.printPageHeader(pageNumber);
      this.printPage(firstIndexOnPage, lastIndexOnPage, data);
      console.log("\f");
      pageNumber += 1;
    }
  }

  private static setPrintPropsFromOptionParam(option: PrintOptionParam) {
    this.rowsperPage = option.rowsPerPage;
    this.columnsPerPage = option.columnsPerPage;
    this.pageHeader = option.pageHeader;
    this.numbersPerPage = this.rowsperPage * this.columnsPerPage;
  }

  private static printPageHeader(pageNumber: number): void {
    console.log(`${this.pageHeader} --- Page ${pageNumber}`);
    console.log("");
  }

  private static printPage(firstIndexOnPage: number, lastIndexOnPage: number, data: number[]): void {
    let firstIndexOfLastRowOnPage = firstIndexOnPage + this.rowsperPage - 1;
    for (let firstIndexInRow = firstIndexOnPage; firstIndexInRow <= firstIndexOfLastRowOnPage; firstIndexInRow += 1) {
      this.printRow(firstIndexInRow, lastIndexOnPage, data);
      console.log("");
    }
  }

  private static printRow(firstIndexInRow: number, lastIndexOnPage: number, data: number[]): void {
    for (let column = 0; column < this.columnsPerPage; column += 1) {
      let index = firstIndexInRow + column * this.rowsperPage;
      if (index <= lastIndexOnPage) {
        console.log(data[index]);
      }
    }
  }
}
class PrimeGenrator {
  private static primes: number[];
  private static multiplesOfPrimeFactors: number[];

  public static generate(n: number): number[] {
    this.primes = Array(n);
    this.multiplesOfPrimeFactors = [];
    this.set2AsFirstPrime();
    this.checkOddNumbersForSubsquentPrimes();
    return this.primes;
  }

  private static set2AsFirstPrime(): void {
    this.primes[0] = 2;
    this.multiplesOfPrimeFactors.push(2);
  }

  private static checkOddNumbersForSubsquentPrimes(): void {
    let primeIndex = 1;
    for (let candidate = 3; primeIndex < this.primes.length; candidate += 2) {
      if (this.isPrime(candidate)) {
        this.primes[primeIndex] = candidate;
        primeIndex += 1;
      }
    }
  }

  private static isPrime(candidate: number): boolean {
    if (this.isLeastRelevantMultipleOfNextLargerPrimeFactor(candidate)) {
      this.multiplesOfPrimeFactors.push(candidate);
      return false;
    }
    return this.isNotMultipleOfanyPreviousPrimerFactor(candidate);
  }

  private static isLeastRelevantMultipleOfNextLargerPrimeFactor(candidate: number): boolean {
    const nextLargerPrimeFactor = this.primes[this.multiplesOfPrimeFactors.length];
    const leastRelevantMultiple = nextLargerPrimeFactor * nextLargerPrimeFactor;
    return candidate === leastRelevantMultiple;
  }

  private static isNotMultipleOfanyPreviousPrimerFactor(candidate: number): boolean {
    for (let n = 1; n < this.multiplesOfPrimeFactors.length; n += 1) {
      if (this.isMultipleOfNthPrimeFactor(candidate, n)) {
        return false;
      }
    }
    return true;
  }

  private static isMultipleOfNthPrimeFactor(candidate: number, n: number): boolean {
    return candidate === this.smallestOddMultipleNotLessThanCandidate(candidate, n);
  }

  private static smallestOddMultipleNotLessThanCandidate(candidate: number, n: number): number {
    let multiple = this.multiplesOfPrimeFactors[n];
    while (multiple < candidate) {
      multiple += 2 * this.primes[n];
    }
    this.multiplesOfPrimeFactors[n] = multiple;
    return multiple;
  }
}

프로그램은 세 가지 책임으로 나눠졌고 길어졌습니다. 프로그램의 길이가 늘어난 이유는 여러가지입니다.

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

실제 리펙터링 전과 후는 알고리즘과 동작 원리가 동일합니다. 가장 먼저, 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성했습니다. 그리고, 한 번에 하나씩 수 차례에 걸쳐 조금씩 코드를 변경했습니다. 코드를 변경할 때마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인했습니다.

3. 변경하기 쉬운 클래스

대다수 시스템은 지속적인 변경이 가해집니다. 그리고 뭔가 변경할 때마다 시스템의 의도대로 동작하지 않을 위험이 따릅니다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춥니다. 다음은 주어진 메타 자료로 적절한 SQL 문자열을 만드는 Sql 클래스입니다.

class Sql {
  constructor(table: string, columns: Column[]);
  public create(): string;
  public insert(fields: object[]): string;
  public selectAll(): string;
  public findByKey(keyColumn: string, keyValue: string): string;
  public selectWithMatchSql(column: Column, pattern: string): string;
  public selectWithCriteria(cirteria: Criterial): string;
  public preparedInsert(): string;
  private columnList(columns: Column[]): string;
  private valuesList(fields: Object[], columns: Columns[]): string;
  private placeholderList(columns: Column[]);
}

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

단순히 구조적인 관저에서도 Sql은 SRP를 위반합니다. 메서드를 쭉 훑어보면 vauleList라는 비공개 메서드가 있는데, 이 메서드는 insert 문을 처리할때만 사용합니다.

클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사합니다. 하지만 실제로 개선에 뛰어드는 계기는 시스템이 변해서라야 합니다. Sql 클래스를 논리적으로 완성으로 여긴다면 책임을 분리하려 시도할 필요가 없습니다. 가까운 장래에 새로운 SQL 문이 필요하지 않다면 Sql 클래스를 내버려두는 편이 좋습니다. 하지만 클래스에 손대는 순간 설계를 개선하려는 고민과 시도가 필요합니다.

다음은 Sql 클래스에 있던 공개 인터페이스를 가각 파생된 클래스로 만들었습니다. valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮겼습니다. 모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 Where와 ColumnList라는 두 유틸리티 클래스에 넣었습니다.

abstract class Sql {
  constructor(table: string, columns: Column[]);
  public abstract geneerate(): string;
}

class CreateSql extends Sql {
  constructor(table: string, columns: Column[]);
  public geneerate(): string;
}

class SelectSql extends Sql {
  constructor(table: string, columns: Column[]);
  public geneerate(): string;
}

class InsertSql extends Sql {
  constructor(table: string, columns: Column[], fields: object[]);
  public geneerate(): string;
  private valuesList(fields: object[], columns: Column[]): string;
}

class SelectWithCriteriaSql extends Sql {
  constructor(table: string, columns: Column[], criteria: Criteria);
  public geneerate(): string;
}

class SelectWithMatchSql extends Sql {
  constructor(table: string, columns: Column[], column: Column, pattern: string);
  public geneerate(): string;
}

class SelectWithMatchSql extends Sql {
  constructor(table: string, columns: Column[], column: Column, pattern: string);
  public geneerate(): string;
}

class FindByKeySql extends Sql {
  constructor(table: string, columns: Column[], keyColumn: string, keyValue: string);
  public geneerate(): string;
}

class PreparedInsertSql extends Sql {
  constructor(table: string, columns: Column[]);
  public geneerate(): string;
  private placeholderList(columns: Column[]): string;
}

class Where {
  constructor(criteria: string);
  public generate(): string;
}

class ColumnList {
  constructor(columns: Column[]);
  public generate(): string;
}

각 클래스는 극도로 단순하고, 순식간에 이해됩니다. 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 사라졌습니다. 새로운 update 문을 추가할 때 새 클래스 UpdateSql을 상속받아 넣으면 그만입니다. 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌습니다. 클래스가 서로 분리되었기 때문입니다.

재구성한 Sql 클래스는 SRP를 지원합니다. OCP란 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙입니다. 우리가 재구성한 Sql 클래스는 파생 클래스를 생성하는 방식으로 새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 방시긍로 수정에 폐쇄적입니다.

3.1. 변경으로부터 격리

객체 지향 프로그래밍 입문에서 우리는 구체적인(Concrete) 클래스와 추상(Abstract) 클래스가 있다고 배웠습니다. 구체적인 클래스는 상세한 구현(코드)를 포함하며 추상 클래스는 개념만 포함한다고 배웠습니다. 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠집니다. 그래서 우리는 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리합니다.

상세한 구현에 의존하는 코드는 테스트가 어렵습니다. 예를 들어, Portfolio 클래스를 문든다고 가정합니다. 그런데 Portfolio 클래스는 외부 TokyoStockExchange API를 사용해 포트폴리오 값을 계산합니다. 따라서 우리 테스트 코드는 시세 변화에 영향을 받고, 값이 달라지는 API로 테스트 코드를 짜기란 쉽지 않습니다.

Portfolio 클래스에서 TokyoStockExchange API를 직접 호출하는 대신 StockExcahnge라는 인터페이스를 생성한 후 메서드 하나를 선언합니다.

interface StockExchange {
  currentPrice(symbol: string): Money;
}

다음으로 StockExcahnge 인터페이스를 구현하는 TokyoStockExcanges 클래스를 구현합니다. 또한 Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받습니다.

class Portfolio {
  private exchange: StockExchange;

  constructor(exchange: StockExchange) {
    this.exchange = exchange;
  }
}

이제 TokyoStockExchange 클래스를 흉내낸는 테스트용 클래스를 만들 수 있습니다. 테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환합니다.

describe("Portfolio test", () => {
  let FixedStockExchangeStub: exchange;
  let portfolio: Portfolio;

  beforeEach(() => {
    exchange = new FixedStockExchangeStub();
    exchange.fix("MSFT", 100);
    portfolio = new Portfolio(exchange);
  });
});

위와 같은 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아집니다. 결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미입니다. 시스템 요소가 서로 잘 격리되어 있으면 각 요소로 이해하기도 더 쉬워집니다. 이렇게 결합도를 최소로 줄이면 자연스럽게 또 다른 클래스 설계 원칙인 DIP(Dependency Inversion Principle)를 따를는 클래스가 나옵니다. 볼질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙입니다.

4. 출처

  • 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
  • 저자: 로버트 C.마틴
  • 옮긴이: 박재호, 이해영
  • 출판사: 인사이트
profile
Hant
끊임없이 도전하는 프론트 개발자가 되고자 노력합니다.
이전 포스트

단위 테스트

다음 포스트

시스템

post-custom-banner

0개의 댓글