[자바 코딩의 기술] 4장 : 올바르게 명명하기

프로그래밍에서 이름을 올바르게 짓는 것은 중요하다. 하지만 패키지, 클래스, 메서드, 필드, 매개변수, 지역 변수 등 명명할 요소가 너무 많기 때문에 모든 요소에 좋은 이름을 짓는 것은 어렵다. 4장에서는 코드 요소에 걸맞는 이름을 할당하는 방법에 대해서 배운다.

 

명명할 땐 자바 규칙이 중요하며, 메서드 명명은 간결해야만 하며 의미없거나 한 글자짜리 이름은 피해야만 한다.

4.1 자바 명명 규칙 사용하기

아래 코드는 어떤 문제가 있을까..?

class Rover {
    static final double WalkingSpeed = 3;

    final String SerialNumber;
    double MilesPerHour;

    Rover(String NewSerialNumber) {
        SerialNumber = NewSerialNumber;
    }

    void Drive() {
        MilesPerHour = WalkingSpeed;
    }
    void Stop() {
        MilesPerHour = 0;
    }
}

상수, 메서드, 변수의 네이밍을 자세히 확인해보자.

 

수정해야 하는 것

- 자바 코드 규칙에 따라 첫시작은 소문자로 그다음 시작 단어는 대문자로 합니다. 

- 상수는 두드러지게 표현 -> 모든 철자를 대문자 + '_'를 통해 단어 이음

- 변수는 명사로 표현, 메서드는 동사의 형태를 취하거나 <is, has, save, get, set> 등을 이용해 동사로 시작해야한다.

 

수정 코드

class Rover {
    static final double WALKING_SPEED = 3;

    final String serialNumber;
    double milesPerHour;

    Rover(String serialNumber) {
        this.serialNumber = serialNumber;
    }

    void drive() {
        milesPerHour = WALKING_SPEED;
    }

    void stop() {
        milesPerHour = 0;
    }
}

 

4.2 프레임워크에는 Getter/Setter 규칙 적용

객체 지향 프로그래밍에서는 외부에서 클래스 필드에 직접 접근하는 것을 제한하기 위해 게터와 세터 메서드를 작성한다.

 

이러한 게터, 세터 메서드를 이용해 '하이버네이트', '잭슨' 등의 프레임워크에서는 각자의 기능을 구현하고 있다. 따라서, 게터, 세터 작성 시 마음대로 이름 지으면 안되고 '자바 빈' 명세를 따라야 한다.

class Astronaut {
    private String name;
    private boolean retired;

    public Astronaut() {
    }

    public Astronaut(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public boolean isRetired() {
        return retired;
    }

    public void setRetired(boolean retired) {
        this.retired = retired;
    }

}

- 게터, 세터를 사용할 변수명 앞에 get과 set을 붙이고 변수의 첫번째 철자는 대문자로 만든다.

- 'Boolean' 타입은 게터의 경우에만 getRetired() 대신에 isRetired() 형태로 작성한다.

4.3 한 글자로 명명하지 않기

class Inventory {
    List<Supply> sl = new ArrayList<>();

    boolean isInStock(String n) {
        Supply s = new Supply(n);
        int l = 0; // 좋지 않은 변수명.....
        int h = sl.size() - 1;

        while (l <= h) {
            int m = l + (h - l) / 2;
            int c = sl.get(m).compareTo(s);

            if (c < 0) {
                l = m + 1;
            } else if (c > 0) {
                h = m - 1;
            } else {
                return true;
            }
        }

        return false;
    }
}

위 코드 처럼 변수명을 한 글자로 표현하면 변수가 어떤 의미인지 머릿속에 항상 기억하고 있어야 한다. 이렇게 되면 메서드가 어떤 역할을 하는지도 이해하기 어려워지고 전체 코드 맥락 또한 이해하기 어려워진다.

 

변수를 머릿속에 기억하지 말고 그냥 코드에 "전체 이름"을 명확하게 작성하자.

어차피 컴퓨터가 이해하는 바이트코드에서 "한 글자"와 "전체 이름"의 차이는 없다.

4.4 축약 쓰지 않기

축약이나 한 글자 쓰기나 똑같다. 자신만 이해할 수 있는 암호이며 다른 사람은 이를 해석하는 애를 먹을 것이다.

 

따라서, 정말 흔히 쓰이는 축약 표현을 제외하고는 반드시 "전체 이름"을 사용하자.

 

- 문제 코드

class Logbook {
    static final Path DIR = Paths.get("/var/log");
    static final Path CSV = DIR.resolve("stats.csv");
    static final String GLOB = "*.log";

    void createStats() throws IOException {
        try (DirectoryStream<Path> dirStr =
                     Files.newDirectoryStream(DIR, GLOB);
             BufferedWriter bufW = Files.newBufferedWriter(CSV)) {
            for (Path lFile : dirStr) {
                String csvLn = String.format("%s,%d,%s",
                        lFile,
                        Files.size(lFile),
                        Files.getLastModifiedTime(lFile));
                bufW.write(csvLn);
                bufW.newLine();
            }
        }
    }
}

 

<개선 코드>

class Logbook {
    static final Path LOG_FOLDER = Paths.get("/var/log");
    static final Path STATISTICS_CSV = LOG_FOLDER.resolve("stats.csv");
    static final String FILE_FILTER = "*.log";

    void createStatistics() throws IOException {
        try (DirectoryStream<Path> logs =
                     Files.newDirectoryStream(LOG_FOLDER, FILE_FILTER);
             BufferedWriter writer =
                     Files.newBufferedWriter(STATISTICS_CSV)) {
            for (Path log : logs) {
                String csvLine = String.format("%s,%d,%s",
                        log,
                        Files.size(log),
                        Files.getLastModifiedTime(log));
                writer.write(csvLine);
                writer.newLine();
            }
        }
    }
}

4.5 무의미한 용어 쓰지 않기

"한 글자 쓰지 않기", "축약 사용하지 않기" 만 보면 무조건 풀어쓴 코드가 좋은 것처럼 보인다. 하지만 그건 아니다..

우리는 삭제 해도 되는 '무의미한' 단어를 찾아서 없애야 한다. 

 

문제 코드

class MainSpaceShipManager {
    AbstractRocketPropulsionEngine abstractRocketPropulsionEngine;
    INavigationController navigationController;
    boolean turboEnabledFlag;

    void navigateSpaceShipTo(PlanetInfo planetInfo) {
        RouteData data = navigationController.calculateRouteData(planetInfo);
        LogHelper.logRouteData(data);
        abstractRocketPropulsionEngine.invokeTask(data, turboEnabledFlag);
    }
}

해결 방법

1. 자주 쓰이는 무의미한 용어 찾아서 없애기 ("main", "flag", "data", "info" 등)
2. 타입이나 메서드 명에 들어있는 당연한 용어들 ("abstract", "invoke(발동)", "Call")
3. 클래스명이 이미 알려주고 있는 정보는 클래스 내 변수나 메서드에서 또 알려주지 않아도 된다.

개선 코드

class SpaceShip {
    Engine engine;
    Navigator navigator;
    boolean turboEnabled;

    void navigateTo(Planet destination) {
        Route route = navigator.calculateRouteTo(destination);
        Logger.log(route);
        engine.follow(route, turboEnabled);
    }
}

변수와 메서드의 역할을 이해할수 있으면서 훨씬 코드가 간결해졌다.

4.6 도메인 용어 사용하기

개발 중인 대부분의 코드는 특정 도메인에 속하게 되고 도메인 마다 각각의 어휘를 가진다.

 

예를 들어, 스포츠에서 '실밥이있는 공'은 야구이고 '실밥이 없으면서 튀는 볼은' 축구공일 것이다.

 

이처럼 프로그램에 해당하는 도메인 용어를 코드에 많이 넣을 수록 코드는 점점 좋아진다.

문제 코드

class Person {
    String lastName;
    String role;
    int travels;
    LocalDate employedSince;

    String serializeAsLine() {
        return String.join(",",
                Arrays.asList(lastName,
                        role,
                        String.valueOf(travels),
                        String.valueOf(employedSince))
        );
    }
}

개선 코드

class Astronaut {
    String tagName; // 우주비행사에게 특화된 네이밍
    String rank;
    int missions;
    LocalDate activeDutySince;

    String toCSV() {
        return String.join(",",
                Arrays.asList(tagName,
                        rank,
                        String.valueOf(missions),
                        String.valueOf(activeDutySince))
        );
    }
}

우주비행사 필드에 대한 의미와 이해도가 훨씬 개선된다.

4.7 4장에서 배운 내용

명명은 잘못해도 컴파일은 되지만 코드를 읽고 이해하기 어려워진다.

 

이는 코드 유지보수를 정말 어렵게 만든다.

 

꼭 명명 규칙을 지키려고 노력하면서 개발하도록 하자.