[자바 코딩의 기술] 2장 : 코드 스타일 레벨업

2.1 매직 넘버를 상수로 대체

void setPreset(int speedPreset) {
    if (speedPreset == 2) {
        setTargetSpeedKmh(16944);
    } else if (speedPreset == 1) {
        setTargetSpeedKmh(7667);
    } else if (speedPreset == 0) {
        setTargetSpeedKmh(0);
    }
}

void setTargetSpeedKmh(double speed) {
    targetSpeedKmh = speed;
}

위 코드 조각처럼 아무런 의미없는 숫자가 프로그램을 동작을 제어한다면 "매직 넘버"라고 부른다.

 

이러한 매직넘버의 사용은 정확한 뜻이 정해져있지 않기 때문에 오류가 발생하기 쉬우며 사용자가 메서드 내부에 대한 지식을 알고 있어야만 한다.

 

따라서, 이러한 "매직 넘버"를 없애보자.

우리는 static과 final을 이용해서 변수를 딱 한번만 존재하며 변경할 수 없게 상수로 만들 수 있다.

    static final double CRUISE_SPEED_KMH = 16944;
    static final int CRUISE_SPEED_PRESET = 2;
    
    void setPreset(int speedPreset) {
        if (speedPreset == CRUISE_SPEED_PRESET) {
            setTargetSpeedKmh(CRUISE_SPEED_KMH);
        }

CRUISE_SPEED_PRESET처럼 변수명을 비교에 넣으면 사전 속도 설정과 타깃 속도가 훨씬 명확해진다.

2.2 정수 상수 대신 열거형

2.1 처럼 사용하면 사용자가 함수에 유효하지 않은 값을 넣을 수 있다.

 

enum 타입을 사용하면 이 현상을 컴파일러 단에서 막을 수 있다.

enum SpeedPreset {
    STOP(0), PLANETARY_SPEED(7667), CRUISE_SPEED(16944);

    final double speedKmh;

    SpeedPreset(double speedKmh) {
        this.speedKmh = speedKmh;
    }
}

열거형을 선언해서 사용하면 열거형에 존재하지 않는 값은 컴파일 자체가 안되게 막을 수 있다.

 

2.3 For 루프 대신 For-Each

전통적인 순회 방식 보다는 For-Each를 사용하여 인덱스 번호를 프로그래머가 모르게 하자. (프로그래머가 저지를 수 있는 오류 방지)

        for (String check : checks) {
            System.out.println(check);
        }

컬렉션의 각 원소만 처리하는 방식으로 오류를 방지할 수 있다.

2.4 순회하며 컬렉션 수정하지 않기

컬렉션을 순회하면서 컬렉션을 수정하게 되면 "ConcurrentModificationException"이 발생한다. 컴파일 타임에는 이 오류를 잡아내지 못한다.

 

우리가 할 수 있는 방법은 수정을 원하는 원소를 기억해두고 순회가 끝난 후 수정하는 방법 하나가 있고

Iterator를 활용해서 순회 중에 수정을 올바르게 수행할 수 있다.

        Iterator<Supply> iterator = supplies.iterator();
        while (iterator.hasNext()) {
            if (iterator.next().isContaminated()) {
                iterator.remove();
            }
        }

2.5 순회하며 계산 집약적 연산하지 않기

계산이 많이 필요한 동작을 순회하면서 매번 실행하지 않기.

 

매번 실행하기 보단 순회 전에 필요한 동작을 먼저 수행해두고 사용하자.

 

2.6 새 줄로 그룹핑

여백을 사용해서 서로 의미가 비슷한 것끼리 붙여서 사용하고 의미가 다르다면 한 줄을 띄어서 사용하자.

2.7 이어붙이기 대신 서식화

        String entry = author.toUpperCase() + ": [" + formattedMonth + "-" +
                today.getDayOfMonth() + "-" + today.getYear() + "](Day " +
                (ChronoUnit.DAYS.between(start, today) + 1) + ")> " +
                message + System.lineSeparator();
        logbook.write(entry);

위 코드 처럼 문자열을 나열식으로 표현하면 실제로 어떻게 출력될 지 굉장히 혼란스럽다.

 

코드를 간소화 시켜보자 (레이아웃과 데이터의 분리)

        String entry = String.format("%S: [%tm-%<te-%<tY](Day %d)> %s%n",
                author, today,
                ChronoUnit.DAYS.between(start, today) + 1, message);
        logbook.write(entry);

위 코드처럼 "서식 문자열"을 사용하면 레이아웃과 데이터를 분리해서 사용할 수 있다.

 

2.8 직접 만들지 말고 자바 API 활용하기

이전에는 모두 자료구조와 알고리즘을 직접 구현했지만 이는 시간이 많이 걸리고 오류도 발생하기 쉬워진다.

 

잘 만들어진 자바 API(String, List 등)을 재사용하면 빠르고 최적화된 코드를 쉽게 사용할 수 있다.

    int getQuantity(Supply supply) {
        Objects.requireNonNull(supply, "supply must not be null");

        return Collections.frequency(supplies, supply);
    }

Collections의 frequency메서드를 사용하면 supplies안에 supply의 빈도를 코딩없이 쉽게 구할 수 있다.

 

2.9 2장에서 배운 내용

• 매직 넘버 처리
• enum(열거형) 사용하기
• For-Each, 서식화
• **자바 API 적극 활용하기**