2장: 의미있는 이름

의도를 분명히 밝혀라

변수나 함수 그리고 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다.

  • 변수(혹은 함수나 클래스)의 존재 이유는?

  • 수행 기능은?

  • 사용 방법은? 따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.

예시 1

int d; // elapsed time in days

이름 d는 아무 의미도 드러나지 않는다. 경과 시간이나 날짜라는 느낌이 안 든다. 측정하려는 값과 단위를 표현하는 이름이 필요하다.

int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification; 
int fileAgeInDays;

의도가 드러나는 이름을 사용하면 코드 이해와 변경이 쉬워진다.

예시 2

public List<int[]> getThem() {
  List<int[]> list1 = new ArrayList<int[]>();
  for (int[] x : theList)
    if (x[0] == 4)
      list1.add(x);
  return list1;
}

위의 코드가 하는 일을 짐작하기 어렵다. 코드가 복잡하지는 않으나, 코드의 함축성(Implicity) 이 없다. 다시 말해, 코드 맥락이 코드 자체에 명시적으로 드러나지 않는다.

위의 코드는 암암리에 독자가 다음과 같은 정보를 안다고 가정한다.

  1. theList에 무엇이 들었는가?

  2. theList에서 0번째 값이 왜 중요한가?

  3. 값 4는 무엇을 의미하는가?

  4. 함수가 반횐하는 리스트 list1을 어떻게 사용하는가?

위 코드가 지뢰찾기 게임을 만드는 거라고 가정한다면 다음과 같이 바뀔 수 있다.

public List<int[]> getFlaggedCells() {
  List<int[]> flaggedCells = new ArrayList<int[]>();
  for (int[] cell : gameBoard)
    if (cell[STATUS_VALUE] == FLAGGED)
      flaggedCells.add(x);
  return flaggedCells;
}

코드의 단순성은 변하지 않으면서 더 명확해졌다. 한 발짝 더 나아가 칸을 int 대신 간단한 클래스로 만들어도 되겠다.

isFlagged라는 좀 더 명시적인 함수를 사용해 FLAGGED라는 상수를 감춰도 좋겠다. 새롭게 개선한 결과는 다음과 같다.

public List<Cell> getFlaggedCells() {
  List<Cell> flaggedCells = new ArrayList<Cell>();
  for (Cell cell : gameBoard)
    if (cell.isFlagged())
      flaggedCells.add(x);
  return flaggedCells;
}

단순히 이름만 고쳤는데도 함수가 하는 일을 이해하기 쉬워졌다. 바로 이것이 좋은 이름이 주는 위력이다.

그릇된 정보를 피하라

프로그래머는 코드에 그릇된 단서를 남겨서는 안 된다. 그릇된 단서는 코드 의미를 흐린다.

  • 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하면 안 된다. ex) hp, aix, sco. 유닉스 플랫폼이나 유닉스 변종을 가리킴

  • 프로그래머의 List는 특수한 의미. 컨테이너의 타입을 이름에 넣지 않는 편이 좋다. Group, Bunch of, 복수명사 등으로 대신한다.

  • 서로 흡사한 이름을 사용하지 않도록 주의한다.

  • 유사한 개념은 유사한 표기법을 사용한다.

의미 있게 구분하라

컴파일러나 인터프리터만 통과하려는 생각으로 코드를 구현하는 프로그래머는 스스로 문제를 일으킨다.

동일한 범위 내에서는 다른 두 개념에 같은 이름을 사용하지 않는다.

적절하지 않은 방식 1: 연속된 숫자를 덧붙이기

public static void copyChars(char a1[], char a2[]) {
  for (int i = 0; i < a1.length; i++) {
    a2[i] = a1[i];
  }
}

위의 코드에서 a1, a2는 의도를 전혀 드러내지 못한다. source, destination 등으로 명확한 용도를 드러낸다면 코드 읽기가 훨씬 더 쉬워진다.

적절하지 않은 방식 2: 불용어(Noise word) 추가

Product라는 클래스가 존재하고, 또 다른 클래스를 ProductInfo 내지 ProductData로 명명한다면 개념을 구분하지 않은 채 이름만 달리한 경우이다. 이는 의미가 불분명한 불용어이다.

불용어는 중복이다. 변수 이름에 variable이 들어가는 것이나 표 이름에 table이 들어가는 것과 마찬가지이다.

읽는 사람이 차이를 알도록 이름을 지어라!

발음하기 쉬운 이름을 사용하라

발음하기 쉬운 이름을 사용하자. 어려운 이름은 토론하기도 어렵다.

검색하기 쉬운 이름을 사용하라

문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다는 문제점이 있다.

변수나 상수를 코드 여러 곳에서 사용한다면, 검색하기 쉬운 이름이 바람직하다.

인코딩을 피하라

문제 해결에 집중하는 개발자에게 인코딩은 불필요한 정신적 부담이다. 인코딩한 이름은 거의가 발음하기 어려우며, 오타가 생기기도 쉽다.

자신의 기억력을 자랑하지 마라

독자가 코드를 읽으면서 변수 이름을 자신이 아는 이름으로 변환해야 한다면 그 변수 이름은 바람직하지 못하다. 이는 일반적으로 문제 영역이나 해법 영역에서 사용하지 않는 이름을 선택했기 때문에 생기는 문제이다.

전문가 프로그래머라면 명료함이 최고라는 사실을 이해한다. 전문가 프로그래머는 자신의 능력을 좋은 방향으로 상ㅇ해 남들이 이해하는 코드를 내놓는다.

클래스 이름

클래스 이름과 객체 이름은 명사나 명사구가 적합하다. ex) Customer, WikiPage, Account, AddressPage 등 Manager, Processor, Data, Info 같은 단어는 피하고, 동사는 사용하지 않는 편이 좋다.

메서드 이름

메서드 이름은 동사나 동사구가 적합하다. postPayment, deletePage, save 등이 좋은 예다. 다음과 같은 경우 javabean 표준에 따라 접두사를 붙인다.

  • 접근자: get

  • 변경자: set

  • 조건자: is

생성자를 중복정의할 때는 정적 팩토리 메서드를 사용한다. 메서드는 인수를 설명하는 이름을 사용한다.

Complex fulcrumPoint = Complex.FromRealNumber(23.0);
Complex fulcrumPoint = new Complex(23.0);

기발한 이름은 피하라

재미난 이름보다 명료한 이름을 선택하라. 특정 문화에서만 사용하는 농담은 피하는 편이 좋다. 의도를 분명하고 솔직하게 표현하라.

한 개념에 한 단어를 사용하라

추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다. 예를 들어, 똑같은 메서드를 클래스마다 fetch, retrieve, get으로 제각각 부르면 혼란스럽다. 어느 클래스에서 어느 이름을 썼는지 기억하기 어렵다.

메소드 이름은 독자적이고 일관적이어야 한다 그래야 주석을 뒤져보지 않고도 프로그래머가 올바른 메서드를 선택한다.

말장난을 하지 마라

한 단어를 두 가지 목적으로 사용하지 마라. 다른 개념에 같은 단어를 사용한다면 그것은 말장난에 불과하다.

해법 영역에서 가져온 이름을 사용하라

모든 이름을 문제 영역(도메인)에서 가져오는 정책은 현명하지 못하다. 어차피 코드를 읽을 사람은 프로그래머이며, 프로그래머에게 익숙한 기술 개념에서 이름을 가져오는 것이 적합한 선택이다.

문제 영역에서 가져온 이름을 사용하라

적절한 프로그래머 용어가 없다면 문제 영역에서 이름을 가져온다. 그러면 코드를 보수하는 프로그래머가 분야 전문가에게 의미를 물어 파악할 수 있다.

의미 있는 맥락을 추가하라

클래스, 함수, 이름 공간에 맥락을 부여한다. 정 안되면 마지막 수단으로 접두어를 붙인다.

예를 들어 firstName, lastName, street, houseNumber, city, state, zipcode라는 변수가 있다. 변수를 훑어보면 주소라는 사실을 금방 알아챌 수 있다. 하지만 어느 메서드가 state라는 변수 하나만 사용한다면? 이 state가 주소의 일부라는 사실을 알 수 있을까?

addr이라는 접두사를 사용한다면 맥락이 좀 더 분명해질 것이다. addrFirstName, addrLastName, addrState 등등. 물론 Address라는 클래스를 생성하면 더 좋다. 그러면 변수가 좀 더 큰 개념에 속한다는 사실이 컴파일러에도 분명해진다.

private void printGuessStatistics(char candidate, int count) {
    String number;
    String verb;
    String pluralModifier;
    if (count == 0) {
        number = "no";
        verb = "are";
        pluralModifier = "s";
    } else if (count == 1) {
        number = "1";
        verb = "is";
        pluralModifier = "";
    } else {
        number = Integer.toString(count); verb = "are";
        pluralModifier = "s";
    }
    String guessMessage = String.format("There %s %s %s%s", verb, number, candidate, pluralModifier );
    print(guessMessage);
}

위의 코드는 함수를 끝까지 읽어보고 나서야 number, verb, pluralModifier 세 변수가 통계 추측 메세지에 사용됨을 알 수 있다.

public class GuessStatisticsMessage {
    private String number;
    private String verb;
    private String pluralModifier;
    
    public String make(char candidate, int count) {
        createPluralDependentMessageParts(count);
        return String.format("There %s %s %s%s", verb, number, candidate, pluralModifier );
    }
    
    private void createPluralDependentMessageParts(int count) {
        if (count == 0) {
            thereAreNoLetters();
        } else if (count == 1) {
            thereIsOneLetter();
        } else {
            thereAreManyLetters(count);
        }
    }
    
    private void thereAreManyLetters(int count) {
        number = Integer.toString(count);
        verb = "are";
        pluralModifier = "s";
    }
    private void thereIsOneLetter() {
        number = "1";
        verb = "is";
        pluralModifier = "";
    }
    private void thereAreNoLetters() {
        number = "no";
        verb = "are";
        pluralModifier = "s";
    }
}

클래스 형태로 맥락을 개선하면 세 변수는 맥락이 분명해진다. 즉, 세 변수는 확실하게 GuessStatisticsMessage에 속한다!

불필요한 맥락을 없애라

일반적으로는 짧은 이름이 긴 이름보다 좋다. 단, 의미가 분명한 경우에 한해서. 이름에 불필요한 맥락을 추가하지 않도록 한다.

Previous1장: 깨끗한 코드Next3장: 함수

Last updated