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

• 열거 타입은 일정 개수의 상수 값을 정의한 다음, 그 외의 값은 허용하지 않는 타입이다.
• 자바에서 열거 타입을 지원하기 전에는 정수 상수를 한 묶음 선언해서 사용하곤 했다.
• 이는 타입 안전을 보장할 수 없으며 표현력도 좋지 않았다.
• 오렌지를 건네야 할 메서드에 사과를 보내고 동등 연산자(==)로 비교하더라도 컴파일러는 아무런 경고 메세지를 출력하지 않는다.

 

 

 

 

• 자바는 정수 열거 패턴(int enum pattern)의 단점을 말끔히 씻어주는 동시에 여러 장점을 안겨주는 대안을 재시했다.
• 자바의 열거 타입은 완전한 형태의 클래스라서 다른 언어의 열거 타입보다 훨씬 강력하다.
• 열거 타입 자체는 클래스이며, 상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개한다. 

 

 

• 열거 타입은 밖에서 접근할 수 있는 생성자를 제공하지 않으므로 사실상 final이다.
• 따라서 클라이언트가 인스턴스를 직접 생성하거나 확장할 수 없으니 열거 타입 선언으로 만들어진 인스턴스들은 딱 하나씩만 존재함이 보장된다.
• 싱글턴은 원소가 하나뿐인 열거 타입이라 할 수 있고, 거꾸로 열거 타입은 싱글턴을 일반화한 형태라고 볼 수 있다.

 

 

• 열거 타입은 컴파일 타임 타입 안정성을 제공한다.
• 앞 코드의 Apple 열거 타입을 매개변수로 받는 메서드를 선언했다면, 건네받은 참조는 null이 아니라면 Apple의 세 가지 값 중 하나임이 확실하다.
• 다른 타입의 값은 타입이 다른 열거 타입 변수에 할당하려 하거나 다른 열거 타입의 값끼리 == 연산자로 비교하려는 꼴이기 때문에 컴파일 오류가 난다.

 

 

• 열거 타입에는 각자의 이름 공간이 있어서 이름이 같은 상수도 평화롭게 공존한다.
• 또한 열거 타입에는 임의의 메서드나 필드를 추가할 수 있고 임의의 인터페이스를 구현하게 할 수도 있다.

 

 

 

열거 타입에 메서드나 필드를 추가하는 것은 어떨 때 필요한 기능일까?

---

• 각 상수와 연관된 데이터를 해당 상수 자체에 내재시키고 싶다고 해보자.
• Apple과 Orange를 예로 과일의 색을 알려주거나 과일 이미지를 반환하는 메서드를 추가하고 싶을 수 있다.
• 열거 타입은 메서드 추가도 가능하며 가장 단순하게는 상수 모음일 뿐이지만, 고차원의 추상 개념 하나를 완벽히 표현할 수 있다.

 

 

• 태양계의 여덟 행성은 거대한 열거 타입을 설명하기에 좋은 예다.
• 각 행성에는 질량과 반지름이 있고, 이 두 속성을 이용해 표면 중력을 계산할 수 있다.
• 어떤 객체의 질량이 주어지면 그 객체가 행성 표면에 있을 때의 무게도 계산할 수 있다.

• 열거 타입 상수 각각을 특정 데이터와 연결 지으려면 생성자에서 데이터를 받아 인스턴스 필드에 저장하면 된다.
• 열거 타입은 근본적으로 불변이라 모든 필드는 final 이어야 한다.
• 필드를 public으로 선언해도 되지만, private으로 두고 별도의 public 접근자 메서드를 두는 게 낫다.

 

 

• Planet 열거 타입은 단순하지만 강력하다.
• 어떤 객체의 지구에서의 무게를 입력받아 여덟 행성에서의 무게를 출력하는 일을 다음처럼 짧은 코드로 작성할 수 있다.

• 열거 타입은 자신 안에 정의된 상수들의 값을 배열에 담아 반환하는 정적 메서드인 values를 제공한다.
• 만약 열거 타입에 상수를 하나 제거하게 된다면 컴파일 오류가 발생하게 될 것이다.
• 정수 열거 패턴에서는 기대할 수 없는 바람직한 대응이다.

 

 

• Planet 상수들은 서로 다른 데이터와 연결되는 데 그쳤지만, 한 걸음 더 나아가 상수마다 동작이 달라져야 하는 상황도 있을 것이다.
• 사칙연산 계산기의 연산 종류를 열거 타입으로 선언하고, 실제 연산까지 열거 타입 상수가 직접 수행한다고 해보자.

• 다음 코드는 새로운 상수를 추가하면 해당 case 문도 추가해야 한다.
• 혹시라도 깜빡한다면, 컴파일은 되지만 새로 추가한 연산을 수행하려 할 때 "알 수 없는 연산" 이라는 런타임 오류를 내며 프로그램이 종료된다.

 

 

• 다행히 열거 타입은 상수별로 다르게 동작하는 코드를 구현하는 더 나은 수단을 제공한다.
• 열거 타입에 apply라는 추상 메서드를 선언하고 각 상수별 클래스 몸체, 즉 각 상수에서 자신에 맞게 재정의하는 방법이다.
• 이를 상수별 메서드 구현이라 한다.

• apply 메서드가 상수 선언 바로 옆에 붙어 있으니 새로운 상수를 추가할 때 apply도 재정의해야 한다는 사실을 깜빡하기는 어려울 것이다.
• 뿐만 아니라 apply가 추상 메서드이므로 재정의하지 않았다면 컴파일 오류로 알려주게 된다.
• 상수별 메서드 구현을 상수별 데이터와 결합할 수도 있다.

 

 

• 다음은 Operation의 toString을 재정의해 해당 연산을 뜻하는 기호를 반환하도록 한 예이다.

 

 

 

 

• 열거 타입의 toString 메서드를 재정의하려거든, toString이 반환하는 문자열을 해당 열거 타입 상수로 변환해주는 fromString 메서드도 함께 제공하는 걸 고려해보자.
• 다음 코드는 모든 열거 타입에서 사용할 수 있도록 구현한 fromString이다.

• Operation 상수가 stringToEnum 맵에 추가되는 시점은 열거 타입 상수 생성 후 정적 필드가 초기화될 때다.
• 열거 타입 생성자가 실행되는 시점에는 정적 필드들이 아직 초기화되기 전이라, 자기 자신을 추가하지 못하게 하는 제약이 꼭 필요하다.
• fromString이 Optional<Operation> 을 반환하는 점도 주의하자. 
• 이는 주어진 문자열이 가리키는 연산이 존재하지 않을 수 있음을 클라이언트에 알리며, 그 상황을 클라이언트에서 대처할 수 있도록 한다.

 

 

 

• 한편 상수별 메서드 구현에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.
• 급여명세서에서 쓸 요일을 표현하는 열거 타입을 예로 생각해보자.
• 이 열거 타입은 직원의 기본 임금과 그날 일한 시간이 주어지면 일당을 계산해주는 메서드를 갖고 있다.
• 주중에 오버타임이 발생하면 잔업수당이 주어지고, 주말에는 무조건 잔업수당이 주어진다.

• 간결하지만 관리 관점에서는 위험한 코드다.
• 휴가와 같은 새로운 값을 열거 타입에 추가하려면 그 값을 처리하는 case 문을 잊지 말고 쌍으로 넣어줘야 하는 것이다.
• 가장 깔끔한 방법은 새로운 상수를 추가할 때 잔업수당 '전략'을 선택하도록 하는 것이다.

 

 

 

 

1. 잔업수당 계산을 private 중첩 열거 타입(payType)으로 옮긴다.

 

2. PayrollDay 열거 타입의 생성자에서 이 중 적당한 것을 선택한다.

 

3. PayrollDay 열거 타입은 잔업수당 계산을 그 전략 열거 타입에 위임하여, switch 문이 필요 없게 된다.

 

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 {
            int overtimePay(int minsWorked, int payRate) {
                return minsWorked <= MINS_PER_SHIFT ? 0 : (minsWorked - MINS_PER_SHIFT) * payRate / 2;
            }
        },
        WEEKEND {
            int overtimePay(int minsWorked, int payRate) {
                return minsWorked * payRate / 2;
            }
        };
        
        abstract int overtimePay(int mins, int payRate);
        private static final int MINS_PER_SHIFT = 8 * 60;
        
        int pay(int minsWorked, int payRate) {
            int basePay = minsWorked * payRate;
            return basePay + overtimePay(minsWorked, payRate);
        }
    }
}

 

 

 

• 보다시피 switch 문은 열거 타입의 상수별 동작을 구현하는 데 적합하지 않다.
• 하지만 기존 열거 타입에 상수별 동작을 혼합해 넣을 때는 switch문이 좋은 선택이 될 수 있다.
• 각 연산의 반대 연산을 반환하는 메서드가 필요할 때 이러한 효과를 내주는 정적 메서드이다.

 

 

 

 

 

그래서 열거 타입을 과연 언제 써야 할까?

---

필요한 원소를 컴파일타임에 다 알 수 있는 상수 집합이라면 항상 열거 타입을 사용하자.

• 태양계 행성, 한 주의 요일, 체스 말처럼 본질적으로 열거 타입인 타입은 당연히 포함된다.
• 또한 메뉴 아이템, 연산 코드, 명령줄 플래그 등 허용 값 모두를 컴파일 타임에 이미 알고 있을 때도 쓸 수 있다.

열거 타입에 정의된 상수 개수가 영원히 고정 불변일 필요는 없다.

 

 

 

 

핵심 정리

---

• 열거 타입은 확실히 정수 상수보다 뛰어나다.
• 더 읽기 쉽고 안전하고 강력하다.
• 대다수 열거 타입이 명시적 생성자나 메서드 없이 쓰이지만, 각 상수를 특정 데이터와 연결짓거나 상수마다 다르게 동작하게 할 때는 필요하다.
• 드물게는 하나의 메서드가 상수별로 다르게 동작해야 할 때도 있다. 이런 열거 타입에서는 switch문 대신 상수별 메서드 구현을 사용하자. 
• 열거 타입 상수 일부가 같은 동작을 공유한다면 전략 열거 타입 패턴을 사용하자.

 

 

 

참고 자료 

---

이펙티브 자바