Posts [이펙티브자바] 아이템36-비트 필드 대신 EnumSet을 사용하라
Post
Cancel

[이펙티브자바] 아이템36-비트 필드 대신 EnumSet을 사용하라

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

1
2
3
4
5
6
7
8
9
10
11
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) {
        // ...
    }
}

이렇게 만들어진 집합을 비트 필드(bit field)라 했으며, 실제 클라이언트 코드에선 아래와 같이 호출해서 사용했다.

1
text.applyStyles(STYLE_BOLD | STYLE_ITALIC);

비트 필드의 문제점

비트 필드를 사용하면 비트별 연산을 사용해 합집합과 교집합 같은 집합 연산을 효율적으로 수행할 수 있다. 하지만 아래와 같은 문제점을 가지고 있다.

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

비트 필드를 대체하는 현대적 기법 EnumSet

1
2
3
4
5
6
7
8
public class Text {
    public enum Style {BOLD, ITALIC, UNDERLINE, STRIKETHROUGH}

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

비트 필드보다 더 나은 대안으로 EnumSet 클래스가 있다.

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

Set 인터페이스를 완벽히 구현하며, 타입 안전하고, 다른 어떤 Set 구현체와도 함께 사용할 수 있다.

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

removeAll과 retainAll 같은 대량 작업은 (비트 필드를 사용할 때 쓰는 것과 같은) 비트를 효율적으로 처리할 수 있는 산술 연산을 써서 구현했다. 난해한 작업들은 EnumSet이 다 처리해주기 때문에 비트를 직접 다룰 때 겪는 흔한 오류들로부터 해방된다.

이를 사용한 클라이언트 코드는 아래와 같다.

1
text.applyStyles(EnumSet.of(Style.BOLD, Style.ITALIC));

applyStyles 메서드가 EnumSet<Style>이 아닌 Set<Style>을 받은 것에 주목해보자.

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

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

핵심 정리: 열거할 수 있는 타입을 한데 모아 집합 형태로 사용한다고 해도 비트 필드를 사용할 이유는 없다. EnumSet 클래스가 비트 필드 수준의 명료함과 성능, 그리고 열거 타입의 장점까지 선사하기 때문이다. EnumSet의 유일한 단점은 자바 9까지는 아직 불변 EnumSet을 만들 수 없다는 것이다(자바 9까지도 수정되지 않았다). 그때까지는 (명확성과 성능이 조금 희생되긴 하지만) Collections.unmodifiableSet으로 EnumSet을 감싸 사용할 수 있다.

실습

글로벌 알림 서비스에서 알림 타입에 따라 알림을 발송하는 요구사항이 있다고 가정해보면 아래와 같이 적용할 수 있을 것 같다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public enum SendType {
    WEB_APP,
    EMAIL,
    DESKTOP
}

public class NotificationSendProcessor {

    public static void sendProcess(Set<SendType> sendTypes) {
        sendTypes.stream()
                .forEach(sendType -> System.out.println("send! ==> " +sendType));
    }
}

public class TestMain {
    public static void main(String[] args) {
        NotificationSendProcessor.sendProcess(EnumSet.of(SendType.WEB_APP, SendType.DESKTOP));
    }
}

이를 EnumSet으로 아닌 HashSet으로 아래와 같이 넘길 수도 있다.

1
2
3
4
5
6
7
8
public class TestMain {
    public static void main(String[] args) {
        Set<SendType> sendTypes = new HashSet<>();
        sendTypes.add(SendType.WEB_APP);
        sendTypes.add(SendType.DESKTOP);
        NotificationSendProcessor.sendProcess(sendTypes);
    }
}

하지만 EnumSet이 더 효율적인 이유는 여기에서 찾을 수 있다.

이를 요약해보면 EnumSet의 세부 메서드들을 비트 산술 연산으로 처리하기 때문에 더 적은 메모리를 사용하고 더 빠르다고 한다.

This post is licensed under CC BY 4.0 by the author.

[이펙티브자바] 아이템34-int 상수 대신 열거 타입을 사용하라

[이펙티브자바] 아이템38-확장할 수 있는 열거 타입이 필요하면 인터페이스를 사용하라