DEV ℧ Developer Diary

[EffectiveJava] item35 - ordinal 메서드 대신 인스턴스 필드를 사용하라

01 May 2023

대부분의 열거 타입 상수는 자연스럽게 하나의 정숫값에 대응된다.
그리고 모든 열거 타입은 해당 상수가 그 열거 타입에서 몇 번째 위치인지를 반환하는 ordinal이라는 메서드를 제공한다.

@Test
void ordinal_Test() {
    for (Operation op : Operation.values())
        System.out.printf("%s는 %d번째 상수 입니다.%n", op, op.ordinal());
}

+는 0번째 상수 입니다.
-는 1번째 상수 입니다.
*는 2번째 상수 입니다.
/는 3번째 상수 입니다.

ordinal

이렇게 몇번째 위치의 열거 타입 상수인지 반환해주는 메서드이지만, 실제로 사용하기는 권장하지 않는다.

다음의 예시를 통해 이유를 알아보도록 하자.
해당 예시는 함주단의 종류를 연주자가 1명인 솔로(SOLO) 부터 10명인 디텍트(DECTET) 까지 정의한 타입이다.

public enum Ensemble {
    SOLE, DUET, TRIO, QUARTET, QUINTET,
    SEXTET, SEPTET, OCTET, NONET, DECTET;

    public int numberOfMusicians() { return ordinal() + 1; }
}

동작은 하지만 유지보수하기가 어려운 코드이다. 왜일까?

상수 선언 순서를 바꾸는 순간 numberOfMusicians가 오동작 하며, 이미 사용 중인 정수와 값이 같은 상수는 추가할 방법이 없다.
예컨데 8중주(OCTET) 상수가 이미 있으니 똑같이 8명이 연주하는 복4중주(DOUBLE QUARTET)는 추가 할 수 없다.

또한 값을 중간에 비워둘 수도 없다.
예를 들어, 12명이 연주하는 3중 4중주(TRIPLE QUARTET)룰 추가한다고 하면, 11명 짜리 상수도 채워야하는데, 쓰이지 않는 더미상수를 추가해야만 해당 값을 넣을 수 있을 것이다.

실제로 Enum의 API문서의 ordinal에 관련된 항목에는 다음과 같이 쓰여있다.

“대부분 프로그래머는 이 메서드를 쓸 일이 없다. 이 메서드는 EnumSet과 EnumMap 같이 열거 타입 기반의 범용 자료구조에 쓸 목적으로 설계되었다.”

/**
 * The ordinal of this enumeration constant (its position
 * in the enum declaration, where the initial constant is assigned
 * an ordinal of zero).
 *
 * Most programmers will have no use for this field.  It is designed
 * for use by sophisticated enum-based data structures, such as
 * {@link java.util.EnumSet} and {@link java.util.EnumMap}.
 */
private final int ordinal;

/**
 * Returns the ordinal of this enumeration constant (its position
 * in its enum declaration, where the initial constant is assigned
 * an ordinal of zero).
 *
 * Most programmers will have no use for this method.  It is
 * designed for use by sophisticated enum-based data structures, such
 * as {@link java.util.EnumSet} and {@link java.util.EnumMap}.
 *
 * @return the ordinal of this enumeration constant
 */
public final int ordinal() {
    return ordinal;
}

ordinal의 해결법

해결책은 간단하다. 열거 타입 상수에 연결된 값은 ordinal 메서드로 얻지 말고, 인스턴스 필드에 저장해야 한다.

public enum Ensemble {
    SOLE(1), DUET(2), TRIO(3), QUARTET(4), QUINTET(5),
    SEXTET(6), SEPTET(7), OCTET(8), DOUBLE_QUARTET(8),
    NONET(9), DECTET(10), TRIPLE_QUARTET(12);

    private final int numberOfMusicians;
    Ensemble(int size) {this.numberOfMusicians = size;}
    public int numberOfMusicians() { return numberOfMusicians; }
}

Related posts