[EffectiveJava] item36 - 비트 필드 대신 EnumSet을 사용하라

열거한 값들이 주로 (단독이 아닌) 집합으로 사용될 경우, 예전에는 각 상수에 서로 다른 2의 거듭제곱 값을 할당한 정수 열거 패턴을 사용했다고 한다.

비트 필드

public class Text {
    public static final int STYLE_BOLD          = 1 << 0;  // 1
    public static final int STYLE_ITALIC        = 1 << 1;  // 2
    public static final int STYLE_UNDERLINE     = 1 << 1;  // 4
    public static final int STYLE_STRIKETHROUGH = 1 << 1;  // 8

    /** 매개변수 styles 는 0개 이상의 STYLE_ 상수를 비트별로 OR 한 값이다. */
    public void applyStyles(int styles) {...}
}

위와 같은 코드로 비트별 OR를 사용해 여러 상수를 하나의 집합으로 모을 수 있으며, 이렇게 만들어진 집합을 비트 필드(bit field)라 한다.

text.applyStyles(STYLE_BOLD | STYLE_ITALIC);

비트 필드를 사용하면 비트별 연산을 사용해 합집합과 교집합 같은 집합 연산을 효율적으로 수행할 수 있다.

비트 필드의 단점

하지만 비트 필드는 정수 열거 상수의 단점을 그대로 지니며, 다음과 같은 문제까지 안고 있다.

비트 필드 값이 그대로 출력되면 단순한 정수 열거 상수를 출력할때보다 이해가 어렵다. 또 비트 필드 하나에 녹아 있는 모든 원소를 순회하기도 까다롭다. 마지막으로, 최대 몇 비트가 필요한지를 API 작성시 미리 예측하여 적절한 타입(보통은 int 또는 long)을 선택해야한다.

API를 수정하지 않고는 비트 수(32비트 or 64비트)를 더 늘릴 수 없기 때문이다.

EnumSet

java.util 패키지의 EnumSet 클래스는 열거 타입 상수의 값으로 구성된 비합을 효과적으로 표현해준다.

Set 인터페이스를 완벽히 구현하며, 타입 안전하고, 다른 어떤 Set 구현체화 사용할 수 있다. 하지만 EnumSet의 내부는 비트 벡터로 구현되었다.

원소가 총 64개 이하라면, 즉 대부분의 경우에 EnumSet 전체를 long 변수 하나로 표현하여 비트 필드에 비견되는 성능을 보여준다.

앞의 예제코드를 EnumSet을 이용해 구현해보자.

public class Text {
    public enum Style { BOLD, ITALIC, UNDERLINE, STRIKETHROUGH }

    /** 어떤 Set을 넘겨도 되나, EnumSet이 가장 좋다. */
    public void applyStyles(Set<Style> styles) {...}
}

다음은 applyStyles 메서드에 EnumSet 인스턴스를 건네는 클라이언트 코드이다.

text.applyStyles(EnumSet.of(Style.BOLE, Style.ITALIC));

덤으로 applyStyles 메서드가 EnumSet

모든 클라이언트가 EnumSet을 건네리라 짐작되는 상황이라도 이왕이면 인터페이스로 받는게 일반적으로는 좋은 습관이다.

이렇게 하면 좀 특이한 클라이언트가 다른 Set 구현체를 넘기더라도 처리할 수 있다.