[자바 스터디] 11주차 : Enum
gmelon
[자바 스터디] 11주차 : Enum스터디/자바2023. 2. 12. 16:39@gmelon
Table of Contents

enum 이란?

enum 타입은 특수한 데이터 타입으로, 미리 지정된 상수만 대입할 수 있다. 미리 정의한 enum 클래스 내의 상수만 enum 타입에 대입될 수 있다. 예를 들어 방위(NORTH, SOUTH, EAST, WEST)나 요일(MONDAY, …) 등의 상수를 미리 정의하는 용도로 사용 가능하다.

Enum 클래스는 가장 간단하게는 아래와 같이 정의할 수 있다.

public enum Day {
    SUNDAY, MONDAY, TUESDAY, WEDNESDAY,
    THURSDAY, FRIDAY, SATURDAY 
}

Enum에 정의된 상수들은 각각 해당 enum 클래스의 객체이다. 이렇게 미리 정의된 상수만 객체로 사용할 수 있게 하여 enum 타입에 미리 정의된 값만 대입될 수 있게 하는 것이다. (enum의 생성자는 private로 강제된다)

즉, 위의 enum을 정의하는 코드는 내부적으론 아래와 같이 동작한다.

public enum Day {
  // static fianl로 선언된 상수로만 객체 획득 가능
  public static final SUNDAY = new Day("SUNDAY");
  public static final MONDAY = new Day("MONDAY");
  ...
  public static final SATURDAY = new Day("SATURDAY");


  // 모든 Enum이 상속받는 java.lang.Enum 클래스에 정의된 `name` 필드
  private String name;

  // 생성자는 private로 강제
  private Day(String name) {
    this.name = name;
  }
}

위와 같이 enum 클래스를 생성하고 상수로 선언해두기 때문에 자바의 모든 enum은 equals() 대신 == 로 비교가 가능하다. (같은 상수는 하나의 객체이고 따라서 참조값이 같으므로)

public boolean isMonday(Day day) {
  return Day.MONDAY == day;
}

enum을 사용하는 이유?

우선 기본적으로 enum을 사용하면 상수를 선언할 수 있기 때문에 문자열 등을 직접 사용하는 것에 비해 재사용성 등 상수가 갖는 기본적인 효과를 가질 수 있다.

거기에 더해 enum은 type safety를 보장해준다. 예를 들어 아래와 같이 이름이 동일하지만 의미가 다른 상수가 있다고 해보자.

public class Demo {
  // 과일
  public static final int APPLE = 0;
  public static final int BANANA = 1;
  public static final int MELON = 2;

  // 회사
  public static final int APPLE = 0;
  public static final int GOOGLE = 1;
  public static final int MICROSOFT = 2;
}

위와 같이 선언하면 당연히 APPLE 이 중복되어 컴파일 에러가 발생하므로 아래와 같이 작성해 문제를 해결하게 될 것이다.

public class Demo {
  // 과일
  public static final int FRUIT_APPLE = 0;
  public static final int FRUIT_BANANA = 1;
  public static final int FRUIT_MELON = 2;

  // 회사
  public static final int COMPANY_APPLE = 0;
  public static final int COMPANY_GOOGLE = 1;
  public static final int COMPANY_MICROSOFT = 2;
}

위와 같이 하면 컴파일 오류는 발생하지 않는다. 다만, 서로 종류가 다른 두 상수가 서로 비교가능하다는 문제가 남게 된다. FRUIT_APPLE과 COMPANY_APPLE은 각각 과일과 회사 라는 다른 개념으로 애초에 비교가 가능해서는 안 된다. 하지만 현재 상태로는 컴파일 타임에는 아무런 문제 없이 두 상수의 비교가 가능하다. (이러한 상황을 type safe하지 않다고 말한다.)

if (FRUIT_APPLE == COMPANY_APPLE) {
  // 컴파일 오류 발생 X
}

이러한 문제를 해결하려면 두 상수를 아예 다른 타입으로 만들어버리면 된다. 즉, 아래와 같이 할 수 있다.

public class Fruit {
  public static final Fruit APPLE = new Fruit(0, "APPLE");
  public static final Fruit BANANA = new Fruit(1, "BANANA");
  public static final Fruit MELON = new Fruit(2, "MELON");

  private final int ordinal;
  private final String name;

  private Fruit(int ordinal, String name) {
    this.ordinal = ordinal;
    this.name = name;
  }
}

public class Company {
  public static final Company APPLE = new Fruit(0, "APPLE");
  public static final Company GOOGLE = new Fruit(1, "GOOGLE");
  public static final Company MICROSOFT = new Fruit(2, "MICROSOFT");

  private final int ordinal;
  private final String name;

  private Company(int ordinal, String name) {
    this.ordinal = ordinal;
    this.name = name;
  }
}

---

if (Fruit.APPLE == Company.APPLE) { } // 타입이 다르므로 컴파일 에러 발생

위와 같이 별도 클래스로 상수를 만들어버리면 각자의 네임 스페이스가 분리되어 다른 타입으로 취급되기 때문에 서로 다른 개념끼리 비교가 가능하다는 문제가 해결된다. 이렇게 컴파일 타임에 타입 체크, 문자열을 직접 사용할 때는 불가능한 오타 검증 등 컴파일 타임에 컴파일러의 지원을 받을 수 있는 것을 type safe 하다고 말한다.

위에서 작성한 Fruit, Company 클래스를 보다 간편하게 작성할 수 있도록 하고 enum에 맞는 추가 기능 (메서드) 또한 제공하는 것이 바로 자바의 Enum 이다.

// 위의 Fruit 클래스는 아래 Fruit Enum과 동일 (Enum은 추가 메서드 등 제공)
public enum Fruit {
  APPLE, BANANA, MELON
}

Enum은 작성하기 편하다는 것 외에도 switch 문의 조건으로 사용자 정의 타입은 불가하지만 enum은 가능하다는 장점도 가지고 있다.

개인적으로는 현재까지 느낄 수 있었던 enum의 장점은 아래와 같다.

  • 상수들을 미리 선언해두어 여러 클래스에서 불러다 사용할 수 있다.
    • 이떄, 미리 정의해둔 값만 허용하게 되므로 안전하다.
  • 새로운 상수나 메소드를 추가하더라도 해당 상수를 사용하는 모든 클래스를 수정하지 않고 enum 클래스만 수정하면 되므로 리팩토링이 간편하고 안전하다.

이밖에도 상태와 행위를 한 곳에서 관리 하는 등 여러 장점이 있다. 아래 블로그에 관련 내용이 잘 정리되어 있어서 도움을 많이 받았다.
https://techblog.woowahan.com/2527/

경험이 많지 않아 처음 읽을 땐 완벽히 이해되진 않았는데 여러 번 읽다보니 enum을 써야하는 상황과 장점을 어느정도 알 것 같았다. 코드에 잘 녹여낼 수 있기를..!

enum 정의하는 방법

enum은 기본적으로는 위에서 말한 방법처럼 정의할 수 있다. 추가로 자바의 enum은 다른 언어와 다르게 클래스기 때문에 메소드나 생성자, 추가 필드도 정의할 수 있다.

추가 필드 정의

public enum Status {
  N("NEW", 10),
  ST("STARTED", 20),
  CA("CANCELED", 30),
  FN("FINISHED", 40);

  // non-final도 가능하지만, 상수의 목적상 final을 주로 사용
  public final String label;
  public final int code;

  // 내부에서 (위의 상수 선언부) 사용하므로 private 지만 생성자를 통해 필드 값을 전달하는게 가능함
  // private는 생략 가능 (무조건 private만 가능하므로)
  private Status(String label, int code) {
    this.label = label;
    this.code = code;
  }
}

N("NEW", 10) 이 public static final Status N = new Status("N", "NEW", 10); 으로 동작하기 때문에 필드를 추가하기 위해서는 1. 필드를 선언하고 2. 생성자를 추가한 뒤 3. 필드 값을 채워 상수를 선언하면 된다. 이때 필드의 final 여부는 선택이지만 불변 상수를 제공하는 enum의 목적을 생각하면 final을 항상 붙여주는게 맞다고 생각된다.

추가로, 앞서 말했듯이 enum도 클래스이므로 아래와 같이 상수를 선언하여 클래스 내부에서 사용하는 등의 활용도 물론 가능하다.

public enum Status {
  // Status type의 상수 선언
  ...

  // enum 내부에서 사용할 상수 정의 가능
  private static final int NUMBER = 10;

  // 나머지 필드, 생성자 정의
  ...
}

메소드 추가

public enum Status {
    CANCELED(value -> value * 0.3),
    FINISHED(value -> value * 0.8);

    private final Function<Integer, Double> function;

    Status(Function<Integer, Double> function) {
        this.function = function;
    }

    public double calculate(int value) {
        return function.apply(value);
    }
}

위와 같이 Function을 필드로 갖는 enum 클래스를 만들고 각 상수에 대응되는 계산식을 상수가 가지고 있게 한 뒤 해당 Function을 호출하는 메서드를 enum 클래스에 만들어주었다. 이렇게 하면, 현재 상태에 따른 행위를 한 클래스에서 관리할 수 있어 안전하고 편리하다. 물론 static 메소드도 정의하여 필요에 따라 사용할 수 있다.

enum이 제공하는 메소드 (values()와 valueOf())

메서드 설명
static T[] values() 해당 enum 타입에 정의된 상수들의 배열을 반환
static T valueOf(Class enumType, String name) 입력한 enumType 열거형에서 name에 해당하는 상수 객체를 반환
String name() 상수의 '이름'을 반환
int ordinal() 상수가 정의된 순서를 반환 (처음은 0)

values()

java.lang.Enum에 정의되어 있지는 않지만 컴파일러가 자동으로 생성해주는 메소드로, 열거형 타입의 모든 상수 객체를 배열로 반환한다. 아래와 같이 Stream 등을 사용해 필터링 해 원하는 값만 추출하는 등 방식으로 활용할 수 있다.

public enum MyEnum {
  // 상수 정의

  private final int code;

  // 생성자 정의

  // values()를 사용해 주어진 code에 해당하는 MyEnum 상수를 반환
  public MyEnum getMyEnumByCode(int code) {
        return Arrays.stream(MyEnum.values())
                .filter(myEnum -> myEnum.code == code)
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException("주어진 code에 해당하는 MyEnum이 존재하지 않습니다."));
    }
}

valueOf(Class enumType, String name)

주어진 열거형 타입과 name에 맞는 상수 객체를 반환한다.

public enum MyEnum {
  N(10, "NEW");

  private final int code;
  private final String label;

  MyEnum(int code, String label) {
    this.code = code;
    this.label = label;
  }
}

---

// java.lang.Enum으로 호출할 경우 열거형 타입 명시 필요
MyEnum myEnum = Enum.valueOf(MyEnum.class, "N");

// 실제 열거형 타입으로 호출하면 첫번째 `Class` 인자 생략 가능
MyEnum myEnum = MyEnum.valueOf("N");

name()

열거형 상수가 선언된 이름을 그대로 반환한다. 예를 들어 상수가 아래와 같이 선언되어 있으면 각각 N, CA 를 반환한다.

public enum MyEnum {
  N(10, "NEW"),
  CA(20, "CANCELED");

  ...

자바 공식 문서에서는 name() 대신 toString()을 사용하라고 이야기한다. 이유로는 name()은 선언된 상수의 이름 그 자체를 반환하지만 toString()은 필드 추가 & 메서드 재정의를 통해 유저 친화적인 이름을 작성하고 반환할 수 있기 때문이다.

ordinal()

상수가 정의된 순서를 반환한다. 처음에 작성한 상수가 0부터 시작하여 1씩 증가한다. 공식문서에서는 이 메서드는 개발자가 일반적인 상황에서 사용하기 보다 내부적으로 EnumSet 이나 EnumMap에서 사용하기 위해 존재하는 메서드이기 때문에 다른 메서드를 사용해 로직을 구현하라고 가이드하고 있다.

ordinal을 로직 구현에 사용하면 안 되는 또 다른 이유는, ordinal은 enum에 상수가 선언된 순서대로 0, 1, … 과 같이 숫자를 부여하기 때문에 만약 enum 클래스에 상수가 선언된 순서가 바뀌게 되면 로직에 오류가 발생하게되기 때문이다.

public enum Fruit {
  APPLE, // ordinal = 0
  BANANA, // ordinal = 1
  MELON // ordinal = 2
}

---

// MELON과 BANANA의 선언 순서를 바꾼 것만으로 두 상수의 ordinal 값이 바뀐다
public enum Fruit {
  APPLE, // ordinal = 0
  MELON, // ordinal = 1
  BANANA // ordinal = 2
}

java.lang.Enum

개발자가 만든 모든 enum 클래스는 자동으로(명시하지 않아도) java.lang.Enum을 상속받는다. 자바는 클래스의 다중 상속을 지원하지 않으므로 모든 enum 클래스는 다른 클래스를 상속받을 수 없다.

앞서 다룬 enum 클래스가 제공하는 메서드들은 모두 java.lang.enum 클래스에 정의되어 있어서 이를 상속받는 다른 enum 클래스들이 사용할 수 있는 것이다.

package java.lang;

...

public abstract class Enum<E extends Enum<E>> implements Comparable<E>, Serializable {

    private final String name;

    public final String name() {
        return name;
    }

    private final int ordinal;

    ...

EnumSet

EnumSet은 HashSet과 같이 Set 인터페이스의 구현체 중 하나로, 값이 enum 타입으로 한정되는 Set이다. HashSet보다도 빠른 성능을 제공하므로 값이 enum 타입으로 한정되는 경우 EnumSet을 사용하는게 유리하다.

HashSet과 EnumSet의 상속 구조 차이는 아래와 같다.

EnumSet 자체는 abstract로 선언되어 new를 사용해 직접 객체를 생성할 수 없고 아래와 같이 여러 정적 팩토리 메서드를 사용하면 상황에 맞게 RegularEnumSet과 JumboEnumSet 중 적절한 하위 클래스를 생성해 반환한다.

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

  public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType) {
        Enum<?>[] universe = getUniverse(elementType);
        if (universe == null)
            throw new ClassCastException(elementType + " not an enum");

        if (universe.length <= 64)
            return new RegularEnumSet<>(elementType, universe);
        else
            return new JumboEnumSet<>(elementType, universe);
    }

  ...

}

정리하면, EnumSet은 아래와 같이 선언하고 사용할 수 있다.

public enum MyEnum {
  A, B, C, D
}

---

EnumSet<MyEnum> enumSet;

// 주어진 열거형의 모든 상수를 포함하는 EnumSet 반환
enumSet = EnumSet.allOf(MyEnum.class);
System.out.println(enumSet); // [A, B, C, D]

// 주어진 상수만을 포함하는 EnumSet 반환
enumSet = EnumSet.of(MyEnum.A);
System.out.println(enumSet); // [A]

// 주어진 열거형 타입의 EnumSet을 반환하되, 주어진 set이 포함하지 않는 상수만을 포함한다
enumSet = EnumSet.complementOf(enumSet);
System.out.println(enumSet); // [B, C, D]

// 주어진 상수들의 ordinal을 기준으로 사이에 있는 상수들을 포함하는 EnumSet을 반환 (인자 두 개 모두 inclusive)
enumSet = EnumSet.range(MyEnum.B, MyEnum.D);
System.out.println(enumSet); // [B, C, D]

// 주어진 열거형 타입의 EnumSet을 반환하되, 빈 EnumSet을 반환한다.
enumSet = EnumSet.noneOf(MyEnum.class);
System.out.println(enumSet); // []

// Set 인터페이스를 상속받기 때문에 add, addAll, clear, remove, contains, isEmpty, size 등의 메서드 또한 사용할 수 있다.
enumSet.add(MyEnum.A);
enumSet.add(MyEnum.B);
enumSet.remove(MyEnum.A);
enumSet.add(MyEnum.C);
System.out.println(enumSet); // [B, C]

EnumSet이 new로 생성되지 않고 정적 팩토리 메서드를 사용하는 이유는 아래와 같다.

  1. 정적 팩토리 메소드 내부에서 주어진 Enum 클래스에 따라 적절한 구현 객체를 선택하도록 구현되어 있기 때문에 개발자가 직접 구현 객체를 선택할 필요가 없다. 또한, 나중에 필요하면 구현 객체를 편하게 확장해서 제공하는 것도 가능하다.
  2. EnumSet을 사용하며 해당 클래스의 모든 상수를 Set에 add() 하는 일이 빈번할텐데, allOf() 등 정적 팩토리 메소드를 제공하여 이러한 일들을 편리하게 처리할 수 있다.

위에서 살펴본 것외에 EnumSet은 아래와 같은 특징을 갖는다.

  1. null 값을 추가하는 것을 허용하지 않는다
    1. 시도하면 NPE가 발생
  2. 모든 메서드가 산술 비트 연산자를 이용해 구현되어 (해시 함수를 사용하지 않아) 매우 빠른 성능을 제공한다. (시간 복잡도 O(1))
  3. 제네릭을 사용해 EnumSet<T>와 같이 선언하므로 해당 Set의 모든 값들은 같은 열거형 타입에 속한 상수여야 한다.
  4. Thread-safe 하지 않다.
    1. 멀티 쓰레드 환경에서 동시성 문제를 해결하려면 Collections.synchronizedSet로 감싸는 등 별도의 방법을 강구해야 한다.
// Collections.synchronizedSet(Set s) 메소드를 사용해 SynchronizedSet 객체를 얻을 수 있다.
public static <T> Set<T> synchronizedSet(Set<T> s) {
    return new SynchronizedSet<>(s);
}

// Collecions.SynchronizedSet 클래스는 Collections.SynchronizedCollection 클래스를 상속 받는다
static class SynchronizedSet<E> extends SynchronizedCollection<E> implements Set<E> {
          ...
}

---

// Collections.SynchronizedCollection은 모든 메서드에 synchronized 키워드를 사용해 동기화 문제를 해결한다.
// 동기화 문제는 해결되지만, 성능 저하가 발생한다.
static class SynchronizedCollection<E> implements Collection<E>, Serializable {
  ...
  public boolean add(E e) {
      synchronized (mutex) {return c.add(e);}
  }
  public boolean remove(Object o) {
      synchronized (mutex) {return c.remove(o);}
  }
  ...
}

참고자료

'스터디 > 자바' 카테고리의 다른 글

[자바 스터디] 13주차 : IO  (0) 2023.02.16
[자바 스터디] 12주차 : 애노테이션  (0) 2023.02.12
[자바 스터디] 10주차 : 멀티쓰레드 프로그래밍  (0) 2023.02.06
[자바 스터디] 9주차 : 예외 처리  (0) 2023.02.05
[자바 스터디] 8주차 : 인터페이스  (0) 2023.01.30
gmelon
@gmelon :: gmelon's greenhouse

백엔드 개발을 공부하고 있습니다.

스터디/자바 추천 글
more
image

티스토리툴바