clean code 제 15장 JUnit 들여다보기

Java Framework JUnit의 테스트 코드 구조 분석을 통하여

 

테스트 코드를 잘 작성하는 방법을 배워가는 장입니다.

 

 

 

1. 접두어 f를 제거하면 깔끔함

 

1. 
private int fContextLength;
private String fExpected;
private String fActual;
private int fPrefix;
private int fSuffix;

2.
private int contextLength;
private String expected;
private String actual;
private int prefix;
private int suffix;

 

 

2. 조건문을 캡슐화하면 좋음

 

1.
public String compact(String message) {
    if (expected == null || actual == null || areStringsEqual()) {
        return Assert.format(message, expected, actual);
    }
 
    findCommonPrefix();
    findCommonSuffix();
    String expected = compactString(this.expected);
    String actual = compactString(this.actual);
    return Assert.format(message, expected, actual);
}



2.
public String compact(String message) {
    if (shouldNotCompact()) {
        return Assert.format(message, expected, actual);
    }
 
    findCommonPrefix();
    findCommonSuffix();
    String expected = compactString(this.expected);
    String actual = compactString(this.actual);
    return Assert.format(message, expected, actual);
}
 
private boolean shouldNotCompact() {
    return expected == null || actual == null || areStringsEqual();
}

 

 

3. 변수명을 명확히 하기

 

1.
String expected = compactString(this.expected);
String actual = compactString(this.actual);


2.
String compactExpected = compactString(expected);
String compactActual = compactString(actual);

 

 

4. 부정문보다는 긍정문으로

 

1.
public String compact(String message) {
    if (shouldNotCompact()) {
        return Assert.format(message, expected, actual);
    }
 
    findCommonPrefix();
    findCommonSuffix();
    String expected = compactString(this.expected);
    String actual = compactString(this.actual);
    return Assert.format(message, expected, actual);
}
 
private boolean shouldNotCompact() {
    return expected == null || actual == null || areStringsEqual();
}



2. 
public String compact(String message) {
    if (canBeCompacted()) {
        findCommonPrefix();
        findCommonSuffix();
        String compactExpected = compactString(expected);
        String compactActual = compactString(actual);
        return Assert.format(message, compactExpected, compactActual);
    } else {
        return Assert.format(message, expected, actual);
    }       
}

private boolean canBeCompacted() {
    return expected != null && actual != null && !areStringsEqual();
}

 

 

5. 함수명을 알아볼 수 있게 풀어서 작성하기

 

1.
public String compact(String message) { }


2.
public String formatCompactedComparison(String message) { }

 

문자열을 압축하는 메소드 compact() 이지만, 형식에 맞추어 반환까지 하고 있음.

 

 

 

6. 함수는 한가지 일만 하도록 작성

 

1. 
public String compact(String message) {
    if (canBeCompacted()) {
        findCommonPrefix();
        findCommonSuffix();
        String compactExpected = compactString(expected);
        String compactActual = compactString(actual);
        return Assert.format(message, compactExpected, compactActual);
    } else {
        return Assert.format(message, expected, actual);
    }       
}

private boolean canBeCompacted() {
    return expected != null && actual != null && !areStringsEqual();
}


2.
private String compactExpected;
private String compactActual;
 
public String formatCompactedComparison(String message) {
    if (canBeCompacted()) {
        compactExpectedAndActual();
        return Assert.format(message, compactExpected, compactActual);
    } else {
        return Assert.format(message, expected, actual);
    }       
}
 
private void compactExpectedAndActual() {
    findCommonPrefix();
    findCommonSuffix();
    compactExpected = compactString(expected);
    compactActual = compactString(actual);
}

 

문자열을 압축하는 로직과

foramt을 맞추는 로직을 분리

 

각 함수가 하나의 기능을 하도록 하면 좋음

 

 

7. 함수 내부 추상화 수준을 동일한 레벨로 일관적이게 구현하면 좋음

 

1.
private void compactExpectedAndActual() {
    findCommonPrefix();
    findCommonSuffix();
    compactExpected = compactString(expected);
    compactActual = compactString(actual);
}


2.
private compactExpectedAndActual() {
    prefixIndex = findCommonPrefix();
    suffixIndex = findCommonSuffix();
    String compactExpected = compactString(expected);
    String compactActual = compactString(actual);
}
 
private int findCommonPrefix() {
    int prefixIndex = 0;
    int end = Math.min(expected.length(), actual.length());
    for (; prefixIndex < end; prefixIndex++) {
        if (expected.charAt(prefixIndex) != actual.charAt(prefixIndex)) {
            break;
        }
    }
    return prefixIndex;
}
 
private int findCommonSuffix() {
    int expectedSuffix = expected.length() - 1;
    int actualSuffix = actual.length() - 1;
    for (; actualSuffix >= prefixIndex && expectedSuffix >= prefix; actualSuffix--, expectedSuffix--) {
        if (expected.charAt(expectedSuffix) != actual.charAt(actualSuffix)) {
            break;
        }
    }
    return expected.length() - expectedSuffix;
}

 

 

하나의 함수에 반환값이 존재하는 함수와 반환값이 존재하지 않는 함수를 혼합하여 사용중인데,

통일하면 좋음.

 

 

 

8. 숨겨진 시각적인 결합주의

 

1.
private compactExpectedAndActual() {
    prefixIndex = findCommonPrefix();
    suffixIndex = findCommonSuffix();
    String compactExpected = compactString(expected);
    String compactActual = compactString(actual);
}
 
private int findCommonPrefix() {
    int prefixIndex = 0;
    int end = Math.min(expected.length(), actual.length());
    for (; prefixIndex < end; prefixIndex++) {
        if (expected.charAt(prefixIndex) != actual.charAt(prefixIndex)) {
            break;
        }
    }
    return prefixIndex;
}

private int findCommonSuffix() {
    int expectedSuffix = expected.length() - 1;
    int actualSuffix = actual.length() - 1;
    for (; actualSuffix >= prefixIndex && expectedSuffix >= prefix; actualSuffix--, expectedSuffix--) {
        if (expected.charAt(expectedSuffix) != actual.charAt(actualSuffix)) {
            break;
        }
    }
    return expected.length() - expectedSuffix;
}



2.
private compactExpectedAndActual() {
    prefixIndex = findCommonPrefix();
    suffixIndex = findCommonSuffix(prefixIndex);
    String compactExpected = compactString(expected);
    String compactActual = compactString(actual);
}
 
private int findCommonSuffix(int prefixIndex) {
    int expectedSuffix = expected.length() - 1;
    int actualSuffix = actual.length() - 1;
    for (; actualSuffix >= prefixIndex && expectedSuffix >= prefix; actualSuffix--, expectedSuffix--) {
        if (expected.charAt(expectedSuffix) != actual.charAt(actualSuffix)) {
            break;
        }
    }
    return expected.length() - expectedSuffix;
}

 

 

두번째 함수인 findCommonSuffix 함수에서 참조하는 전역변수 prefixIndex는 첫번째 findCommonPrefix의 리턴값을 받는다. 이렇게 첫번째 함수 리턴값에 의존하고있는데 순서가 달라지면 결과값이 달라지는 문제가 발생한다.

 

전역변수 대신 매개변수로 입력받아 사용하면 위 문제가 발생하지 않음.

 

 

 

9. Length와 Index를 구분해서 사용하기

 

변수이름에 Index를 넣을때는

0부터 시작하는 값이여야하고

 

1부터 시작할 경우 Index 대신 Length 라는 이름을 사용하면 좋음.