int 상수 대신 열거 타입을 사용하라 - [6장. 열거 타입과 애너테이션(아이템34)] - (1)

  자바를 이용하여 코딩을 하다 보면 정수 열거 패턴(int enum pattern)과 열거 타입(enum type)을 사용해 본 적이 있을 것이다.

  이번 글에서는 정수 열거 패턴의 단점들을 살펴보고, 왜 열거 타입을 사용해야 하는지 알아보고자 한다. 그리고 기본적인 열거 타입의 사용법도 알아볼 것이다.

 

📙 1. 정수 열거 패턴 (int enum pattern)

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;

  자바에서 열거 타입을 지원하기 전에는 위의 코드처럼 정수 상수를 한 묶음 선언해서 사용하곤 하였다. 하지만, 이 방법에는 단점이 매우 많다.

 

⛔ 1. 타입 안전을 보장할 방법이 없다.

  사과를 파라미터로 받아야 하는 메서드가 있다고 하자. 그러나 사과를 받아야 하는 메서드임에도 불구하고 오렌지를 받는다고 해서 컴파일러가 경고를 출력해주지는 않는다.

⛔ 2. 표현력이 좋지 않다.

  사과용 상수의 이름은 모두 APPLE_로 시작하고, 오렌지용 상수는 ORANGE_로 시작한다.

  자바가 정수 열거 패턴을 위한 별도 이름공간(namespace)을 지원하지 않기 때문에 어쩔 수 없이 접두어를 써서 이름 충돌을 방지한 것이다.

  예를 들어, 영어로는 둘 다 mercury인 수은(원소)과 수성(행성)의 이름을 각각 ELEMENT_MERCYR와 PLANT_MERCURY로 지어 구분하는 것이다.

⛔ 3. 정수 열거 패턴을 사용한 프로그램은 깨지기 쉽다.

  정수 열거 패턴은 평범한 상수를 나열한 것뿐이라 컴파일하면 그 값이 클라이언트 파일에 그대로 새겨진다.

  따라서 상수의 값이 바뀌면 클라이언트도 반드시 다시 컴파일해야 한다. 다시 컴파일하지 않더라도 실행이 되겠지만 엉뚱한 동작을 할 것이다.

⛔ 4. 정수 상수는 문자열로 출력하기가 다소 까다롭다.

public static void main(String[] args) {
    System.out.println(APPLE_FUJI); // 0
    System.out.println(APPLE_PIPPIN); // 1
    System.out.println(APPLE_GRANNY_SMITH); // 2
}

  정수 상수를 출력하면 그 값을 출력한다. 또한, 디버거로 살펴보면 단지 숫자로만 보여서 썩 도움이 되지 않는다.

⛔ 5. 같은 정수 열거 그룹에 속한 모든 상수를 한 바퀴 순회하는 방법도 마땅치 않다.

  같은 정수 열거 그룹에 속한 모든 상수를 얻을 수 없을뿐더러 그 안에 상수가 몇 개인지도 알 수 없다.

 

 

📙 2. 열거 타입 (enum type)

  자바에서는 열거 패턴의 단점을 말끔히 씻어주는 동시에 여러 장점을 안겨주는 대안을 제시하였다. 바로 열거 타입이다.

public enum Apple {
    FUJI, PIPPIN, GRANNY_SMITH
}

public enum Orange {
    NAVEL, TEMPLE, BLOOD
}

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

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

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

 

  앞에서 살펴본 열거 패턴의 5가지 단점을 열거 타입이 어떻게 해소하는지 살펴보자.

 

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

public static void main(String[] args) {
    appleMethod(Apple.FUJI); // 성공
    appleMethod(Orange.NAVEL); // 컴파일 오류
}

public static void appleMethod(Apple apple) {
	...
}

  Apple 열거 타입을 매개변수로 받는 appleMethod를 선언하였다. 만약 Apple이 아닌 다른 타입의 값을 넘기게 되면 컴파일 오류가 난다.

✅ 2. 열거 타입에는 각자의 이름공간이 있어서 이름이 같은 상수도 평화롭게 공존한다.

  이름이 같은 수은(MERCURY)과 수성(MERCURY)은 각자의 이름 공간에서 같은 이름(MERCURY)으로 사용할 수 있다.

public enum Element {
    MERCURY // 수은
}

public enum Planet {
    MERCURY // 수성
}

 

✅ 3. 열거 타입에 새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일하지 않아도 된다.

  공개되는 것이 오직 필드의 이름뿐이라, 정수 열거 패턴과 달리 상수 값이 클라이언트로 컴파일되어 각인되지 않기 때문이다.

✅ 4. 열거 타입의 toString 메서드는 출력하기에 적합한 문자열을 내어준다.

  열거 타입의 toString 메서드를 이용하여 출력하면 다음과 같다.

public static void main(String[] args) {
    System.out.println(Apple.FUJI); // FUJI
    System.out.println(Apple.PIPPIN); // PIPPIN
    System.out.println(Apple.GRANNY_SMITH); // GRANNY_SMITH
}

  또한, toString을 재정의하여 더 적합한 문자열을 내어줄 수도 있다.

✅ 5. 열거 타입은 자신 안에 정의된 상수들의 값을 배열에 담아 반환하는 정적 메서드인 values를 제공한다.

  열거 타입의 values 메서드를 이용하여 자신의 그룹에 속하는 상수들을 한 바퀴 순회할 수 있다.

public static void main(String[] args) {
    for(Apple apple : Apple.values()) {
        System.out.println(apple);
    }
}

 

 

📙 3. 열거 타입 기본 사용법

  열거 타입은 정수 열거 패턴의 단점을 해소해 줄 뿐만 아니라 더 다양한 기능을 제공한다.

  열거 타입은 아래와 같이 임의의 인터페이스를 구현할 수 있다.

public enum Apple implements Comparable<Apple> {
    FUJI,
    PIPPIN,
    GRANNY_SMITH
}

 

  또한, 열거 타입에는 임의의 메서드나 필드를 추가할 수 있다. 예시로 태양계의 여덟 행성을 가지는 열거 타입이 있다고 하자.

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

  각 행성에는 질량과 반지름이 있고, 이 두 속성을 이용해 표면중력을 계산할 수 있다. 따라서 어떤 객체의 질량이 주어지면 그 객체가 해성 표면에 있을 때의 무게도 계산할 수 있다.

public enum Planet {
    MERCURY(3.302e+23, 2.439e6),
    VENUS  (4.869e+24, 6.052e6),
    EARTH  (5.975e+24, 6.378e6),
    MARS   (6.419e+23, 3.393e6),
    JUPITER(1.899e+27, 7.149e7),
    SATURN (5.685e+26, 6.027e7),
    URANUS (8.683e+25, 2.556e7),
    NEPTUNE(1.024e+26, 2.477e7);

    private final double mass;           // 질량(단위: 킬로그램)
    private final double radius;         // 반지름(단위: 미터)
    private final double surfaceGravity; // 표면중력(단위: m / s^2)

    // 중력상수(단위: m^3 / kg s^2)
    private static final double G = 6.67300E-11;

    // 생성자
    Planet(double mass, double radius) {
        this.mass = mass;
        this.radius = radius;
        surfaceGravity = G * mass / (radius * radius);
    }

    public double mass()           { return mass; }
    public double radius()         { return radius; }
    public double surfaceGravity() { return surfaceGravity; }

    public double surfaceWeight(double mass) {
        return mass * surfaceGravity;  // F = ma
    }
}

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

  열거 타입 상수 각각을 특정 데이터와 연결 지으려면 생성자에서 데이터를 받아 인스턴스 필드에 저장하면 된다.

 

  surfaceWeight 메서드는 대상 객체의 질량을 입력받아, 그 객체가 행성 표면에 있을 때의 무게를 반환한다.

  어떤 객체의 지구에서의 무게를 입력받아 여덟 행성에서의 무게를 출력하는 일은 다음과 같이 작성할 수 있다.

public static void main(String[] args) {
    double earthWeight = Double.parseDouble(args[0]);
    double mass = earthWeight / Planet.EARTH.surfaceGravity();
    for (Planet p : Planet.values())
        System.out.printf("%s에서의 무게는 %f이다.\n",
                            p, p.surfaceWeight(mass));
}

 

 

  이상으로 '정수 열거 패턴 대신 왜 열거 타입을 사용해야 하는지'와 '열거 타입의 기본 사용법'에 대해서 알아보았다.

  다음 글을 통해서 열거 타입에서 제공하는 더 다양한 기능들에 대해서 알아보자.

 

해당 글은 Joshua Bloch 님의 Effective Java 3/E를 참고하였습니다.