본문 바로가기
Effective Java

[Effective Java] 아이템36 비트 필드 대신 EnumSet을 사용하라

by byeongoo 2021. 6. 6.

■ 비트 필드

열거한 값들이 집합으로 사용될 경우, 예전에는 상수에 서로 다른 2의 거듭제곱 값을 할당한 정수 열거 패턴을 사용해왔다. 아래 코드와 같이 OR 연산자를 사용하여 상수를 하나의 집합으로 모을 수 있으며 이 집합을 비트 필드라 한다.

import java.util.Objects;

class Text {

    public static final int STYLE_BOLD = 1 << 0;
    public static final int STYLE_ITALIC = 1 << 1;
    public static final int STYLE_UNDERLINE = 1 << 2;
    public static final int STYLE_STRIKETHROUGH = 1 << 3;

    public void applyStyles(int styles) {
        System.out.println(styles);
        System.out.printf("Applying styles %s to text%n", Objects.requireNonNull(styles));
    }

    // 사용 예시
    public static void main(String[] args) {
        Text text = new Text();
        text.applyStyles(STYLE_BOLD | STYLE_STRIKETHROUGH);
    }
}

비트 필드 또한 정수 열거 상수이므로 정수 열거 상수의 단점을 그대로 지닌다. 또한 추가로 다른 문제들도 있다.

 

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

 

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

 

3. 최대 몇 비트가 필요한지를 처음부터 예상하고 적절한 타입을 선택해야 한다.

 

다행히도 이젠 더 나은 방안인 java.util 패키지의 EnumSet 클래스가 있다. EnumSet은 열거 타입 상수의 값으로 구성된 집합을 효과적으로 표현해준다. 

 

■ EnumSet

1. EnumSet 클래스는 Set인터페이스를 구현하여 어떤 Set 구현체와도 함께 사용할 수 있으며 타입 안전하다.

 

2. EnumSet 내부는 비트 벡터로 구현되어있으며, 원소가 총 64개 이하라면 EnumSet 전체를 long 변수 하나로 표현하여 비트필드에 비견되는 성능을 보여준다.

 

3. removeAll과 retainAll 과 같은 대량 작업은 비트를 효율적으로 처리할 수 있는 산술 연산을 써서 구현하였다.

 

EnumSet은 집합 생성 등 다양한 기능의 정적 팩터리를 제공하는데, 다음 코드에서는 그 중 of 메서드를 사용했다.

import java.util.EnumSet;
import java.util.Objects;
import java.util.Set;

public class EnumSetText {

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

    // 어떤 Set을 넘겨도 되나, EnumSet이 가장 좋다.
    public void applyStyles(Set<Style> styles) {
        System.out.printf("Applying styles %s to text%n", Objects.requireNonNull(styles));
    }

    // 사용 예시
    public static void main(String[] args) {
        EnumSetText enumSetText = new EnumSetText();
        enumSetText.applyStyles(EnumSet.of(Style.BOLD, Style.ITALIC));
    }

}

 

applyStyles 메서드가 EnumSet<Style>이 아닌 Set<Style>로 받는 이유는 모든 클라이언트가 EnumSet을 건네리라 짐작되는 상황이라도 이왕이면 인터페이스로 받는게 좋은 습관이다.

 

EnumSet을 사용해서 비트 필드의 단점을 개선하고 열거 상수 집합을 사용할 수 있게되었다. 하지만 그런 EnumSet에도 단점이 존재하는데, 불변 EnumSet을 만들 수 없다는 점이다. 성능상에서 손해를 보게되만 Collections.unmodifiableSet() 메소드를 사용하여  EnumSet을 불변 객체로 만들 수 있다.