📕 목차

1. 클래스 체계
2. 클래스는 작아야 한다!
3. 변경하기 쉬운 클래스

1. 클래스 체계

 

표준 자바 관례에 따른 클래스 정의 순서

  1. 정적(static) 공개(public) 상수
  2. 정적 비공개(private) 변수
  3. 비공개 인스턴스 변수
  4. 공개 함수
  5. 비공개 함수

즉, 추상화 단계가 순차적으로 내려간다.

 

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

 

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

 

함수를 만들 때와 똑같이 '작게'가 기본 규칙이다. 그렇다면 '얼마나 작아야' 하는가?

  • 함수는 물리적인 행 수로 크기를 측정한다.
  • 클래스는 '맡은 책임'을 척도로 크기를 센다.
  • 클래스 이름은 해당 클래스 책임을 기술해야 한다.
    • 간결한 이름이 떠오르지 않는다면 필경 클래스 크기가 너무 크기 때문이다.
    • 클래스 이름이 모호하다면 필경 클래스 책임이 너무 많기 때문이다.
    • Processor, Manager, Super 등과 같이 모호한 단어를 쓴 것이 여러 책임을 떠안겼다는 증거다.
  • 클래스 설명은 if, and, or, but을 사용하지 않고 25단어 내외로 가능해야 한다.
더보기

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

 누군가는 만능 클래스라고 부를 수도 있겠지만, 딱 보기에도 메서드가 너무 많다.

2️⃣ 이 정도는 괜찮을까?

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

 이제는 메서드가 5개 밖에 없으니 괜찮아 보이나? 그렇지 않다.

중요한 건 SuperDashboard의 책임 자체가 너무 많다는 것이다.

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

 

📌 단일 책임 원칙(SRP; Single Responsibility Principle)
💡 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다.

개인적으로 이 부분을 읽고 너무 공감을 많이 했다.

 

대다수의 개발자들이 '깨끗하고 체계적인 소프트웨어'보다는 '돌아가는 소프트웨어'에 초점을 맞춘다.

전적으로 올바른 태도다. 관심사 분리는 프로그래밍 활동에서도 마찬가지로 중요하다.

문제는 돌아가는 일이 끝나고 '깨끗하고 체계적인 소프트웨어'라는 다음 관심사로 전환하지 않는 데 있다.

 

그리고 많은 개발자가 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다.

하지만 작은 클래스가 많은 시스템이든, 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다.

어느 시스템이든 익힐 내용의 양이 비슷하다면, "도구 상자를 어떻게 관리하고 싶은가?"에 답해보라.

 

규모가 커질 수록 복잡성의 증가는 필연적이고, 이를 다루려면 체계적인 정리가 필수적이다.

큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이루어진 시스템이 더 바람직하다.

작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

 

📌 응집도(Cohesion)
  • 클래스는 인스턴스 변수 수가 작아야 한다. (응집도가 높아야 한다.)
    • 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶이는 것을 의미한다.
  • 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
    • 일반적으로 메서드가 변수를 더 많이 사용할 수록 메서드와 클래스는 응집도가 더 높다.
    • 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
  • 몇몇 메서드만이 사용하는 인스턴스 변수가 많아진다면, 새로운 클래스로 쪼개야 한다는 신호다.

 

아래 Stack은 응집도가 아주 높은 경우다.

public class Stack {
    private int topOfStack = 0;
    List<Integer> elements = new ArrayList<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;
    }
}

 

📌 응집도를 유지하면 작은 클래스 여럿이 나온다
  • 때로는 큰 함수를 여럿으로 나누는 과정에서조차 클래스 수가 많아진다.
    1. 큰 함수 일부를 작은 함수로 분리한다.
    2. 작은 함수에 필요한 변수를 매개변수로 넘기지 않고, 클래스 인스턴스 변수로 승격시킨다.
    3. 클래스의 응집도가 떨어진다. (승격시킨 클래스 인스턴스 변수는 방금 분리한 함수에서만 쓰이므로)
    4. 몇몇 함수가 몇몇 변수만 사용하므로 독자적은 클래스로 분리한다.

 

더보기

✒️ Literate Programming에 나온 유서 깊은 예제

 

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

 너무 엉망진창이므로 적어도 여러 함수로 나눠야 마땅하다.

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);
    }
}
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 printPageHeader(String pageHeader, int pageNumber) {
        printStream.println(pageHeader + " --- Page " + pageNumber);
        printStream.println("");
    }
    
    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 setOutpu(PrintStream printStream) {
        this.printStream = printStream;
    }
}
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. 가독성을 높이고자 공백을 추가하고 형식을 맞췄다.
  • 원래 프로그램은 세 가지 책임으로 나누어 졌다.
    1. PrimePrinter
      • main 함수 하나만 포함하여 실행 환경을 책임진다.
      • 호출 방식이 달라지면 해당 클래스를 바꾸면 된다.
    2. RowColumnPagePrinter
      • 숫자 목록을 주어진 행과 열에 맞춰 페이지에 출력하는 방법을 안다.
      • 출력 포맷을 바꾸려면 해당 클래스를 바꾸면 된다.
    3. PrimeGenerator 클래스
      • 소수 목록을 생성하는 방법을 안다.
      • 인스턴스화 목적이 아닌, 변수를 선언하고 감추려고 사용하는 공간이다.
      • 소구 계산 알고리즘이 바뀐다면 해당 클래스면 된다.
  • 리팩토링은 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트에서, 한 번에 하나씩 수 차례의 단위 테스트를 거쳐 조금씩 코드를 변경해서 얻을 수 있다.

 

3. 변경하기 쉬운 클래스

 

📌 파생 클래스
💡 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.

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

그리고 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.

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

 

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 클래스는 SRP를 위반한다.
    • 새로운 SQL 문을 지원하려면 "반드시" SQL 클래스에 손을 대야 한다.
    • 기존 SQL문 하나를 수정할 때도 반드시 SQL 클래스에 손대야 한다.
  • 구조적 관점에서도 Sql은 SRP를 위반한다.
    • selectWithCriteria라는 비공개 메서드는 select문을 처리할 때만 사용한다.
    • 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적 여지를 시사한다.

 

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 문을 추가할 때도 기존 클래스를 변경할 필요 없이 Sql 클래스를 상속받은 새 클래스를 만들면 된다.
  • SRP 뿐만 아니라 OCP(Open-Close Principle, 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙)도 지원한다.

 

📌 변경으로부터 격리
  • 상세한 구현이 정의된 구체적인(concrete) 클래스에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
  • 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리해야 한다.

 

상세한 구현에 의존하는 코드는 테스트도 어렵다.

외부 TokyoStockExchange API를 사용해 값을 계산하는 Portfolio의 테스트 코드는 시세 변화에 영향을 받는다.

5분마다 값이 달라지는 API로 테스트 코드를 작성하긴 어렵다.

 

그래서 TokyoStockExchange API를 Portfolio 클래스에서 직접 호출하지 않고, Composition을 이용하는 방법이 있다.

public interface StockExchange { 
    Money currentPrice(String symbol);
}
  • StockExchange를 구현하는 TokyoStockExchange 클래스를 구현한다.

 

public Portfolio {
    private StockExchange exchange;
    public Portfolio(StockExchange exchange) {
    	this.exchange = exchange; 
    }
    ...
}

이 방식의 장점은 기존의 API를 이용할 수 있음과 동시에, 테스트 환경에서는 더미 객체를 주입하면 되기 때문이다.

더미 객체는 StockExchange를 구현하되, API를 이용하지 않고 언제가 고정된 값을 반환하게 한다.

 

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(Dependency Inversion Principle)를 자연스럽게 따르는 클래스가 나온다.

 

저작자표시 비영리

티스토리툴바