Item34. int 상수 대신 열거 타입을 사용하라

열거 타입(Enum)

Enum은 일정 개수의 상수 값을 정의한 다음 그 외의 값은 허용하지 않는 타입이다.

특정한 변수가 가질 수 있는 값을 제한하여 타입 세이프티를 보장할 수 있고 싱글톤 패턴을 구현할 때 사용한다.

자바에서 열거 타입을 지원하기 전에는 상수를 한 묶음으로 선언해서 사용했다.

 

보통 변하지 않는 상수들은 DB에 왔다갔다 값을 가져오지 않고 공통 상수를 만들어서 전역에서 사용하도록 만들었는데

요일이나 월, 사계절, 성별 플래그 등을 예로들 수 있다.

// 정수 열거 패턴

public static final int APPLE_FUJI = 0;
public static final int APPLE_PIPPIN = 1;
public static final int APPLE_GRANNY_SMITH = 2;

public static final int ORANGE_NAVEL = 0;
public static final int ORANGE_TEMPLE = 1;
public static final int ORANGE_BLOOD = 2;

정수 열거 패턴은 단점이 많았는데 타입 안전을 보장할 방법이 없으며 표현력도 좋지 않다.

 

오렌지를 건네받아야할 메서드에 사과를 보내고 메서드 내부에서 동등 연산자로 비교하더라도 상수의 타입이 int이기 때문에 컴파일러는 아무런 경고 메세지를 출력하지 않는다.

 

사과용 상수의 이름은 APPLE_로 시작하고 오렌지 상수는 ORANGE_로 시작하여 구분을 지어야 하는 이유는 개발자가 알아보기 위함도 있지만 자바가 정수 열거 패턴을 위한 별도 이름공간(namespace)를 지원하지 않아 중복 변수명을 피하기 위해 접두어를 붙인다.

 

정수 열거 패턴을 사용한 프로그램은 평범한 상수를 나열한 것이라 컴파일 하면 그 값이 그대로 클라이언트 파일에 새겨진다. 상수의 값이 바뀌면 클라이언트도 반드시 다시 컴파일해야 한다.(주소값을 가져서 메모리에 담긴값을 가져온다면 메모리 내부에 변경된 값을 가져갈 수 있지만 아얘 고정된 값이 입력이 되어 재 컴파일이 필요하다는 걸까?)

 

그리고 정수 열거 그룹에 속한 모든 상수를 한바퀴 순회하는 방법도 마땅치 않고 심지어 그 안에 상수가 몇 개인지 알 수 없다는 단점도 있다.

 

정수 대신 문자열 상수를 사용하는 변형 패턴도 있는데 자칫 경험이 부족한 프로그래머가 문자열 상수의 이름 대신 문자열 값을 그대로 하드코딩하게 만들어 오타가 나더라도 컴파일러는 확인할 길이 없어 런타임 버그가 생길 수 있다.

public static final String MON = "Monday";

public static String whatDay(String day) {
	// 상수가 있음에도 하드코딩
    if(day.equals("Monday")) {
        return "월요일";
    }else {
        return "다른요일";
    }

	// 상수를 이용한 코딩
    if(day.equals(EnumPatternTest.MON)) {
        return "월요일";
    }else {
        return "다른요일";
    }
    
    // 오타가 있어도 컴파일타임에 잡아낼 수 없다
    if(day.equals("Mondat")) {
        return "월요일";
    }else {
        return "다른요일";
    }
}

 

 

이러한 열거 패턴의 단점을 없애고 장점이 많은 열거 타입(enum type)이 자바 5버전부터 나왔다.

public enum Apple { FUJI, PIPPIN, GRANNY_SMITH }
public enum Orange { NAVEL, TEMPLE, BLOOD }

자바의 열거 타입은 클래스이며, 상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개한다.

열거 타입은 밖에서 접근할 수 있는 생성자를 제공하지 않으므로 사실상 final이다.

따라서 클라이언트가 인스턴스를 직접 생성하거나 확장할 수 없어서 열거 타입 선언으로 만들어진 상수변수 하나하나의 인스턴스들은 딱 하나씩만 존재함이 보장된다. 

싱글턴은 원소가 하나뿐인 열거 타입이라 할 수 있고, 거꾸로 열거 타입은 싱글턴을 일반화한 형태라고 볼 수 있다.

 

열거 타입은 컴파일타임 타입 안전성을 제공한다.

Orange 역시 별도의 타입이기 때문에 orangeJuice에 Orange 가 아닌 Apple의 값이 들어오면 Type이 다르다고 컴파일 에러가 난다. 그리고 Orange 열거 타입을 매개변수로 받는다면 건네받은 참조는 NAVEL, TEMPLE, BLOOD 값 중 하나임이 확실하다.

열거 타입에는 각자의 이름공간이 있어서 이름이 같은 상수도 평화롭게 공존한다. 열거 타입에 새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일하지 않아도 되고 공개되는 것은 오직 필드의 이름뿐이라 정수 열거 패턴과 달리 상수 값이 클라이언트로 컴파일되어 각인되지 않기 때문이다.

상수 이름이 같아도 상관 없다 각각의 클래스에 정의한 것이라서 별도의 공간에 저장된다.

 

 

열거 타입은 임의의 메서드나 필드를 추가할 수 있고 인터페이스를구현하게 할 수도 있다.

책에 예시로 나온 것은 태양계의 여덟 행성은 각각 질량과 반지름이 있고, 이 두 속성을 이용해 표면중력을 계산할 수 있다.

따라서 어떤 객체의 질량이 주어지면 그 객체가 행성 표면에 있을 때의 무게도 계산할 수 있다.

 

각 열거 타입 상수 오른쪽 괄호 안 숫자는 생성자에 넘겨지는 매개변수로, 행성의 질량과 반지름을 뜻한다.

열거 타입을 만들 때 열거 타입 상수 각각을 특정 데이터와 연결지으려면 생성자에서 데이터를 받아 인스턴스 필드에 저장하면 된다. 열거 타입은 근본적으로 불변이라 모든 필드는 final 이어야 한다. 

필드를 public 으로 선언해도 되지만, private로 두고 별도의 public 접근자 메서드를 두는게 낫다.

 

어떤 객체를 지구에서 무게를 입력받아 여덟 행성에서의 무게를 출력할 때는 values를 사용하여 상수값 전체를 출력한다.

public static void main(String[] args) {
    double earthWeight = Double.parseDouble("185");
    double mass = earthWeight / Planet.EARTH.surfaceGravity();
    // 정의된 상수들의 값을 배열에 담아 반환하는 정적 메서드 values()
    for (Planet p : Planet.values()) {
        System.out.printf("%s에서의 무게는 %f이다. %n", p, p.surfaceWeight(mass));;
    }
}

오늘날 명왕성이 행성대열에서 빠지게 되었는데 열거타입에서 상수를 제거한다면 어떻게 될까?

제거한 상수를 참조하지 않는 클라이언트에는 아무 영향이 없다.

상수를 참조하는 클라이언트에서는 컴파일 시 제거된 상수를 참조하는 줄에서 오류가 발생하고 컴파일하지 않으면 런타임에 예외가 발생한다. 정수 열거 패턴에서는 기대할 수 없는 가장 바람직한 대응이다.

 

열거타입을 선언한 클래스 혹은 그 패키지에서만 유용한 기능은 private나 package-private 메서드로 구현하여 자신을 선언한 클래스 혹은 패키지에서만 사용할 수 있게 기능을 제한하는 것이 좋다.

 

널리 쓰이는 열거타입은 톱 레벨 클래스로 만들고 특정 톱레벨 클래스에서만 쓰인다면 해당 클래스의 멤버 클래스로 만든다.

 

톱레벨 enum 클래스

멤버 enum 클래스

 

상수마다 동작이 달라져야하는 상황일 때 예컨대 사칙연산 계산기의 연산 종류를 열거 타입으로 선언하고, 실제 연산까지 열거 타입 상수가 직접 수행했으면 한다고 했을 때

이러한 코드일 때 마지막의 throw문은 실제로 도달할 일은 없지만 기술적으로 도달할 수 있기 때문에 생략하면 컴파일조차 되지 않는다. 더 나쁜 점은 깨지기 쉬운 코드라는 사실인데 새로운 상수가 추가되면 해당 case문도 추가해야 한다.

만약 깜빡한다면 컴파일은 되지만 새로 추가한 연사늘 수행하려 할 때 "알 수 없는 연산" 이라는 런타임 오류를 내며 프로그램이 종료된다.

 

다행히 열거 타입은 상수별로 다르게 동작하는 코드를 구현하는 더 나은 수단을 제공한다.

열거 타입에 apply 라는 추상 메서드를 선언하고 각 상수별 클래스 몸체, 즉 각 상수에서 자신에 맞게 재정의 하는 방법이다.

이를 상수별 메서드 구현이라 한다.

상수 선언시 apply 메서드가 바로 선언되어 있어서 상수가 추가될 때 apply도 재정의해야 한다는 사실을 잊기 어렵다.

apply가 추상 메서드 이므로 재정의하지 않았다면 컴파일 오류로 알려준다.

 

상수별 메서드 구현을 상수별 데이터와 결합할 수 있다.

 

 

열거 타입에는 상수 이름을 입력받아 그 이름에 해당하는 상수를 반환해주는 valueOf(string) 메서드가 자동 생성된다.

열거 타입의 toString을 재정의 한다면 toString이 반환하는 문자열을 해당 열거 타입 상수로 변환해주는 fromString 메서드도 함께 제공하는걸 고려해보라

 

 

한편, 상수별 메서드 구현에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.

급여 명세서에서 쓸 요일을 표현하는 열거 타입을 예로 생각해보면

급여명세서에서 쓸 요일을 표현하는 열거타입을 예로 봤을때 직원의 (시간당) 기본 임금과 그날 일한 시간(분단위)이 주어지면 일당을 계산해주는 메서드를 갖고있다. 주중에 오버타임이 발생하면 잔업수당이 주어지고, 주말에는 무조건 잔업수당이 주어진다. switch 문을 이용하면 case 문을 날짜별로 두어 이 계산을 쉽게 수행할 수 있다.

하지만 관리 관점에는 위험한 코드다. 휴가와 같은 새로운 값을 열거 타입에 추가하려면 그 값을 처리하는 case 문을 잊지 말고 쌍으로 넣어줘야 하는 것이다.

자칫 깜빡하면 휴가 기간에 열심히 일해도 평일과 똑같은 임금을 받게 된다.

 

상수별 메서드 구현으로 급여를 정확히 계산하는 방법은 

첫째, 잔업수당을 계산하는 코드를 모든 상수에 중복해서 넣으면 된다.

둘째, 계산 코드를 평일용과 주말용으로 나눠 각각을 도우미 메서드로 작성한 다음 각 상수가 자신에게 필요한 메서드를 적절히 호출하면 된다.

두 방식 모두 코드가 장황해져 가독성이 크게 떨어지고 오류 발생 가능성이 높아진다.

가장 깔끔한 방법은 새로운 상수를 추가할 때 잔업수당 '전략'을 선택하도록 하는 것이다.

잔업수당 계산을 private 중첩 열거 타입으로 옮기고 PayrollDay2 열거 타입의 생성자에서 이 중 적당한 것을 선택한다. 그러면 Payrollday2 열거 타입은 잔업수당 계산을 그 전략 열거 타입에 위임하여, switch 문이나 상수별 메서드 구현이 필요 없게 된다. 이 패턴은 switch 문보다 복잡하지만 더 안전하고 유연하다.

 

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

추가하려는 메서드가 의미상 열거 타입에 속하지 않는다면 직접 만든 열거 타입이라도 이 방식을 적용하는 게 좋다.

 

 

대부분의 경우 열거타입의 성능은 정수 상수와 별반 다르지 않다.

열거 타입을 메모리에 올리는 공간과 초기화 하는 시간이 들긴 하지만 체감될 정도는 아니다.

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

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

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

 

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

 

https://stackoverflow.com/questions/31356845/life-span-of-a-java-enum-instance