아이템 34. int 상수 대신 열거 타입을 사용하라

[corock]

TL;DR

• 6장. 열거 타입과 애너테이션 첫 장으로, 자바에서 특수한 목적의 참조 타입 2가지(enum, annotation) 중 열거 타입을 소개하고 있습니다.
• 열거 타입은 정수 열거 패턴보다 더 읽기 쉽고, 안전하고, 강력합니다.
• 대다수는 명시적 생성자나 메서드없이 쓰지만, 각 상수를 특정 데이터와 연결 짓거나 상수마다 다르게 동작하게 할 때는 필요합니다.
• 드물게 하나의 메서드가 상수별로 다르게 동작해야 할 때가 있는데, 이때 switch 대신 상수별 메서드 구현 사용을 권장합니다.
• 열거 타입 상수 일부가 같은 동작을 공유한다면 전략 열거 타입 패턴 사용을 권장합니다.

열거 타입(Enum Type, Java 1.5^)

• 일정 개수의 상숫값을 정의한 다음, 그 외의 값은 허용하지 않는 타입
• 열거 타입 자체는 클래스이며, 상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개
• 밖에서 접근할 수 있는 생성자를 제공하지 않아 클라이언트가 인스턴스를 직접 생성하거나 확장할 수 없어 싱글턴을 일반화한 형태

정수 열거 패턴(int enum pattern)의 단점

1. NOT fluent
2. NOT type safety
3. NOT warning message (cf. ==)

• 자바에서는 정수 열거 패턴을 위한 별도의 이름공간(namespace)을 지원하지 않아 어쩔 수 없이 접두어를 통해 이름 충돌을 방지
• 정수 상수는 문자열로 출력하기가 까다롭고, 정수 열거 그룹에 속한 상수가 몇 개인지도 알 수 없음
• 이에 정수 대신 문자열 상수를 사용하는 문자열 열거 패턴은 하드코딩과 런타임 버그, 문자열 비교로 인한 성능 저하 등으로 더 안 좋음

AS-IS

public class Constants {

    public static final int MERCURY = 0;
    public static final int VENUS = 1;
    public static final int EARTH = 2;
    public static final int MARS = 3;
    public static final int JUPITER = 4;
    public static final int SATURN = 5;
    public static final int URANUS = 6;
    public static final int NEPTUNE = 7;
    
    public static final int MONDAY = 0;
    public static final int TUESDAY = 1;
    public static final int WEDNESDAY = 2;
    public static final int THURSDAY = 3;
    public static final int FRIDAY = 4;
    public static final int SATURDAY = 5;
    public static final int SUNDAY = 6;

}

TO-BE

public enum Planet {
    MERCURY, VENUS, EARTH, MARS, JUPITER, SATURN, URANUS, NEPTUNE
}

public enum PayrollDay {
    MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
}

자바 열거 타입의 장점

• 컴파일 타임 타입 안정성을 제공
• 각자의 이름공간이 있어서 이름이 같은 상수도 평화롭게 공존 가능
• 열거 타입에서 공개되는 건 필드 이름뿐이라 새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일할 필요가 없음
• 열거 타입의 toString() 메서드가 별도의 재정의할 필요 없이 적합한 문자열을 출력함
• 클라이언트가 인스턴스를 직접 생성하거나 확장할 수 없도록 통제 가능
• 임의의 필드나 메서드를 추가할 수 있고, 인터페이스를 구현할 수 있음

System.out.println(Constants.MARS);     // 3
System.out.println(Planet.MARS);        // MARS

열거 타입 작성 시 고려사항

• public 필드 선언보다는 접근자 메서드로 사용 (feat. 아이템 16. public 클래스에서는 public 필드가 아닌 접근자 메서드를 사용하라 #39)
• 열거 타입은 근본적으로 불변이라 모든 필드는 final 이어야 함 (feat. 아이템 17. 변경 가능성을 최소화하라 #37)

상수별 메서드 구현(constant-specific method implementation)

• 열거 타입은 상수별로 다르게 동작하는 코드를 구현하는 더 나은 수단 제공
• 추상 메서드를 선언하고 각 상수에서 알맞게 재정의하는 방법

상수별 메서드 구현을 활용한 열거 타입

public enum Operation {

    PLUS { @Override public double apply(double x, double y) { return x + y; } },
    MINUS { @Override public double apply(double x, double y) { return x - y; } },
    TIMES { @Override public double apply(double x, double y) { return x * y; } },
    DIVIDE { @Override public double apply(double x, double y) { return x / y; } },

    public abstract double apply(double x, double y);

}

상수별 클래스 몸체(class body)와 데이터를 사용한 열거 타입

public enum Operation {

    PLUS("+") { @Override public double apply(double x, double y) { return x + y; } },
    MINUS("-") { @Override public double apply(double x, double y) { return x - y; } },
    TIMES("*") { @Override public double apply(double x, double y) { return x * y; } },
    DIVIDE("/") { @Override public double apply(double x, double y) { return x / y; } };

    private final String symbol;

    Operation(String symbol) {
        this.symbol = symbol;
    }

    @Override
    public String toString() {
        return symbol;
    }

    public abstract double apply(double x, double y);

}

클라이언트 코드

public class OperationShell {

    public static void main(String[] args) {
        double x = Double.parseDouble(args[0]);
        double y = Double.parseDouble(args[1]);

        for (Operation op : Operation.values()) {
            System.out.printf("%f %s %f = %f%n", x, op, y, op.apply(x, y));
        }
    }

}

열거 타입용 fromString 메서드 구현하기

public enum Operation {

    // (...)

    private static final Map<String, Operation> stringToEnum = Stream.of(values())
                                                                     .collect(toMap(Object::toString, e -> e));

    // 지정한 문자열에 해당하는 Operation 을 (존재한다면) 반환한다.
    public static Optional<Operation> fromString(String symbol) {
        return Optional.ofNullable(stringToEnum.get(symbol));
    }

}

전략 열거 타입 패턴

값에 따라 분기하여 코드를 공유하는 열거 타입 - 좋은 방법인가?

AS-IS

public enum PayrollDay {

    MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY;

    private static final int MINUTES_PER_SHIFT = 8 * 60;

    int pay(int minutesWorked, int payRate) {
        int basePay = minutesWorked * payRate;

        int overtimePay;

        switch (this) {
            case SATURDAY:
            case SUNDAY:
                overtimePay = basePay / 2;
                break;
            default:
                overtimePay = minutesWorked <= MINUTES_PER_SHIFT ? 0 : (minutesWorked - MINUTES_PER_SHIFT) * payRate / 2;
        }

        return basePay + overtimePay;
    }

}

TO-BE

public enum PayrollDay {

    MONDAY(PayType.WEEKDAY), TUESDAY(PayType.WEEKDAY), WEDNESDAY(PayType.WEEKDAY), THURSDAY(PayType.WEEKDAY),
    FRIDAY(PayType.WEEKDAY), SATURDAY(PayType.WEEKEND), SUNDAY(PayType.WEEKEND);

    private final PayType payType;

    PayrollDay(PayType payType) {
        this.payType = payType;
    }

    int pay(int minutesWorked, int payRate) {
        return payType.pay(minutesWorked, payRate);
    }

    // 전략 열거 타입
    enum PayType {
        WEEKDAY {
            @Override
            int overtimePay(int minutesWorked, int payRate) {
                return minutesWorked <= MINUTES_PER_SHIFT ? 0 : (minutesWorked - MINUTES_PER_SHIFT) * payRate / 2;
            }
        },
        WEEKEND {
            @Override
            int overtimePay(int minutesWorked, int payRate) {
                return minutesWorked * payRate / 2;
            }
        };

        abstract int overtimePay(int minutesWorked, int payRate);

        private static final int MINUTES_PER_SHIFT = 8 * 60;

        int pay(int minutesWorked, int payRate) {
            int basePay = minutesWorked * payRate;
            return basePay + this.overtimePay(minutesWorked, payRate);
        }
    }

}

• 기존 열거 타입에 상수별 동작을 혼합해 넣을 때는 switch 문 고려

public enum Operation {

    // (...)

    public static Operation inverse(Operation op) {
        switch (op) {
            case PLUS:
                return Operation.MINUS;
            case MINUS:
                return Operation.PLUS;
            case TIMES:
                return Operation.DIVIDE;
            case DIVIDE:
                return Operation.TIMES;

            default:
                throw new AssertionError("알 수 없는 연산: " + op);
        }
    }

}