아이템 36. 비트 필드 대신 EnumSet을 사용하라. - ksw6169/effective-java GitHub Wiki

정수 열거 패턴(int enum pattern)

열거한 값들이 주로 집합으로 사용될 경우, 예전에는 각 상수에 서로 다른 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 << 2;   // 4
    public static final int STYLE_STRIKETHROUGH = 1 << 3;   // 8

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

정수 열거 패턴의 단점(item 34)

타입 안전을 보장할 방법이 없으며 표현력도 좋지 않다. 예컨대 오렌지를 건네야 할 메소드에 사과를 보내고 동등 연산자로 비교하더라도 컴파일러는 경고조차 출력하지 않는다.


비트 필드(bit field)

비트별 OR를 사용해 여러 상수를 하나의 집합으로 모은 것을 비트 필드라 한다. 이를 사용하면 비트별 연산을 사용해 합집합과 교집합 같은 집합 연산을 효율적으로 수행할 수 있다.

// 1 Bit-OR 2 = 3을 전달
text.applyStyles(STYLE_BOLD | STYLE_ITALIC);

비트 필드의 단점

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

  • 비트 필드 값이 그대로 출력되면 단순한 정수 열거 상수를 출력할 때보다 해석하기가 훨씬 어렵다.

  • 비트 필드 하나에 녹아 있는 모든 원소를 순회하기도 까다롭다.

  • 최대 몇 비트가 필요한지를 API 작성 시 미리 예측하여 적절한 타입(보통 int나 long)을 선택해야 한다.

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


EnumSet

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

public abstract class EnumSet<E extends Enum<E>> extends AbstractSet<E>
    implements Cloneable, java.io.Serializable {

    ...
}

EnumSet의 장점

  • Set 인터페이스를 구현하여 타입 안전하여 다른 어떤 Set 구현체와도 함께 사용할 수 있다.

  • 원소가 총 64개 이하라면 EnumSet 전체를 long 변수 하나로 표현하여 비트 필드에 비견되는 성능을 보여준다. (RegularEnumSet)

  • 난해한 작업을 Enumset이 전부 처리해주기 때문에 비트를 직접 다룰 때 흔히 겪는 오류들에서 해방된다.

// 앞의 정수 열거 타입을 사용한 코드를 EnumSet을 사용해 수정한 것
public class Text {
    public enum Style {
        BOLD, ITALIC, UNDERLINE, STRIKETHROUGH
    }

    // 어떤 Set을 넘겨도 되나 EnumSet이 가장 좋다.
    public void applyStyles(Set<Style> styles) { ... }
}
  • 또한 EnumSet은 집합 생성 등 다양한 기능의 정적 팩토리를 제공한다.
text.applyStyles(EnumSet.of(Style.BOLD, Style.ITALIC));

정리

  • 열거할 수 있는 타입을 한데 모아 집합 형태로 사용한다고 해도 비트 필드를 사용할 이유는 없다.

  • EnumSet 클래스가 비트 필드 수준의 명료함과 성능을 제공하기 때문이다.

  • EnumSet의 유일한 단점이라면 EnumSet을 불변으로 만들 수 없다는 것이다. JDK에서 이 기능을 제공하지 않기 때문이다.

    (기능 지원이 이뤄지기 전까지는 Collections.unmodifableSet으로 EnumSet을 감싸 불변으로 사용할 수 있기는 하다.)


참고 자료

  • Effective Java 3/E
⚠️ **GitHub.com Fallback** ⚠️