[자바/코틀린] 열거 (enumeration)

March 20, 2023

프로그래밍에서 열거 타입(또는 열거 형)(enumeration type)이란 값의 집합을 구성하는 특별한 자료형 및 값 타입이다. 열거 타입 변수는 사전 정의된 상수 집합이며 미리 정의된 값 중 하나여야 한다. 상수인 열거 타입 변수를 열거 타입 상수(enum type constant)라고 한다. 열거 타입 변수는 상수이므로 필드명을 대문자로 표기하는 것이 코딩 컨벤션이다. 열거 타입을 정의한다는 것은 미리 정의된 상수값들의 집합을 변수로 선언하고 상수를 제외한 필드와 메서드, 생성자를 추가로 정의하는 것이다.

enum 키워드를 사용하여 열거 타입을 정의할 수 있다. 열거 타입은 클래스를 정의하는 것이므로 열거 타입 상수 외에 필드와 메서드, 생성자를 추가로 정의할 수 있다. 자바 컴파일러는 열거 타입을 생성할 때 다음과 같이 몇가지 특별한 메서드를 추가한다.

values(): 열거 타입의 상수의 모든 값을 선언된 순서대로 포함하는 배열을 반환한다.
valueOf(): 이름을 포함하는 열거 타입 상수를 반환한다.
name(): 열거 타입 선언 시 정의된 열거 타입명과 동일한 이름을 가지는 열거 타입 상수명을 반환한다.

열거 타입 상수는 필드나 메서드보다 먼저 정의되어야 하며 필드와 메서드를 정의하는 경우 상수 목록은 세미콜론으로 끝나야 한다.

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

열거 타입 상수를 정의하고 나면 특정 열거 타입 상수일 때 특정 값을 반환하는 조건문을 통해 상수에 대한 값을 표현할 수 있다.

public int getSeqInDay() {
  switch (day) {
    case SUNDAY: return 1;
    case MONDAY: return 2;
    case THUESDAY: return 3;
  }
  return 0;
}

이 방법을 사용하는 대신 열거 타입 정의 시 열거 타입 상수가 하나 이상의 값을 가지도록 할 수도 있다. 상수에 값을 포함하는 것은 상수에 대한 부가적인 메타데이터가 필요한 경우 유용하다. 이 경우 생성자와 필드(프로퍼티) 정의가 추가적으로 필요하다. 다음은 열거 타입 상수에 값을 부여하는 코드의 예이다.

public enum Day {
  SUNDAY(1),
  MONDAY(2),
  THUESDAY(3),
  WEDNESDAY(4),
  THURSDAY(5),
  FRIDAY(6),
  SATURDAY(7);
  
  public final int seq;
  
  Day(int seq) {
    this.seq = seq;
  }
}

열거 타입 생성 시 상수가 생성될 때 해당 값이 생성자에 전달된다. 즉, 선언된 열거 타입의 상수 개수 만큼 생성자가 호출된다. 생성자는 열거 타입 본문에 정의된 열거 타입 상수를 자동으로 생성한다. 열거 타입의 생성자는 해당 패키지 내에서만 접근 가능할 수 있도록 default 접근 지정자로 정의하거나 다른 클래스에서는 접근할 수 없도록 private 접근 지정자로 정의해야 한다. 생성자를 직접 호출하는 것은 불가능하며 추가적으로 호출할 필요도 없다. 상수의 값이 변경되지 않아야 한다면 필드를 final로 선언한다.

열거 타입 상수는 컴파일 타임에 코드 검사가 가능하므로 코드 내에 잘못된 값이 작성되어 프로그램 실행 도중 예기치 않은 동작이 발생하는 것을 막아준다. 또한 사전 정의된 상수를 사용함으로써 코드를 더 읽기 쉽게 만들며 IDE 상에서 자동 완성이나 선언으로 이동과 같은 기능을 사용할 수 있게 해주는 장점이 있다.

중첩 열거 클래스 정의

클래스 내에 정의한 열거 클래스인 중첩(nested) 열거 클래스는 정적인 특성을 갖는다. 자바 언어 명세에 따르면 중첩된 열거 클래스를 선언할 때 static 키워드를 명시적으로 선언하는 것이 허용된다. 따라서 중첩 열거 클래스는 정적 중첩 클래스(static nested class)이다.

class OuterClass
  enum NestedEnumClass {
    ...
  }
} 

인터페이스는 멤버 타입 선언을 포함할 수 있으며 인터페이스에 선언한 모든 멤버는 암시적으로 정적이고 공개적인 특성을 갖는다. 따라서 인터페이스는 정적 중첩 클래스를 포함할 수 있지만 비정적 중첩 클래스인 내부(inner) 클래스를 포함할 수는 없다. static 키워드를 생략하여 중첩 클래스를 선언하더라도 해당 클래스는 비정적 클래스가 아닌 정적 클래스가 된다. 인터페이스는 본질적으로 정적인 특성을 가진다. 이러한 인터페이스의 특성에 따라 인터페이스 내에 열거 클래스를 정의할 수도 있다. 클래스 내에 정의한 것과 동일하게 인터페이스 내 정의한 중첩 열거 클래스는 정적인 특성을 갖는다.

interface OuterInterface
  enum NestedEnumClass {
    ...
  }
} 

열거 타입은 인스턴스화될 수 없고 정적인 특성을 갖기 때문에 열거 타입을 중첩 열거 클래스로 정의하더라도 외부 클래스의 인스턴스 생성 없이 정적으로 열거 타입 상수에 접근할 수 있다. 이때 외부 클래스나 인터페이스는 네임스페이스만 제공할 뿐이다.

커스텀 메서드 정의

열거 타입에 메서드를 정의할 수 있으며 열거 타입 상수 별로 정의된 메서드를 재정의하여 서로 다른 구현을 제공할 수도 있다.

public enum Day {
  SUNDAY(1) {
    @Override
    public boolean isWeekend() {
      return true;
    }
  },
  MONDAY(2) {
    @Override
    public boolean isWeekend() {
      return false;
    }
  },
  THUESDAY(3),
  WEDNESDAY(4),
  THURSDAY(5),
  FRIDAY(6),
  SATURDAY(7);
  
  public final int seq;
  
  Day(int seq) {
    this.seq = seq;
  }

  public int getSeqInDay() {
    return seq;
  }
  
  public boolean isWeekend() {
    return false;
  }
}

열거 타입 상수 별로 동일한 기능을 제공하거나 상수 별로 매핑된 필드의 값에 접근하여 또다른 처리를 하기 위해 공통 메서드를 사용한다. 열거 타입 상수 별로 동일한 인터페이스에 대해 서로 다른 기능을 제공하기 위해서는 메서드를 재정의하면 된다. 이는 열거 상수 타입을 통해 다형성을 적용하는 것이다.

열거 타입의 활용

EnumMap

열거 타입을 맵 자료 구조를 구현하는 데 사용할 수 있다. 열거 타입을 사용하여 구현한 맵 구현체를 열거 맵(EnumMap)이라고 한다. 열거 맵은 열거 타입에 정의된 열거 타입 상수를 키로 하는 맵 구현체이며, 추상 맵(AbstractMap)을 상속한다. 열거 맵은 기존 해시 맵(HashMap) 보다 더 나은 성능과 기능을 제공한다.

열거 맵의 모든 키는 단일 열거 타입의 상수(요소)이어야 한다. 열거 맵은 순서가 있는(ordered) 맵 구조이다. 열거 타입의 상수가 선언되는 순서와 동일하게 키의 순서가 유지되며 컬렉션 뷰 메서드인 keySet(), entrySet() 및 values()가 반환하는 이터레이터를 통해 이를 확인할 수 있다.

열거 맵은 다음과 같이 인스턴스화하여 사용한다.

EnumMap<열거타입, 값> enumMap = new EnumMap<>(열거타입클래스명.class);
enumMap.put(열거타입.열거상수, 값);
enumMap.get(열거타입.열거상수);

해시 맵과 열거 맵

해시 맵은 인스턴스 생성 및 초기화 시 타입을 파라미터화하면 되지만 열거 맵의 경우 생성자의 인자로 키인 열거 타입 클래스를 필요로 한다는 차이점이 있다.

열거 맵은 해시 맵 보다 성능이 좋다. 열거 맵은 내부적으로 배열로 표현되며 이 표현은 매우 작고 효율적이다. 해시 맵에서는 열거 타입 뿐만 아니라 다른 객체(불변 객체)를 키로 사용할 수 있지만, 열거 맵에서는 열거 타입 이외의 다른 타입을 키로 사용할 수는 없다. 열거 맵은 일반적으로 다른 객체를 키로 사용할 때보다 열거 타입을 키로 사용하는 것에 최적화되어 있으므로 맵의 키로 열거 타입을 사용하는 경우 해시 맵 보다 더 좋은 성능을 보여준다.

열거 맵은 해시 충돌(hash collision) 가능성이 없다. 일반 객체를 키로 사용하는 해시 맵의 경우 해시 함수인 hashCode() 메서드를 호출하며 해시 함수가 서로 다른 두 개의 입력값에 대해 동일한 출력값을 내는 해시 충돌이 발생할 수 있다. 열거 맵은 값을 저장하고 조회할 때 해시 맵 보다 비교적 간단한 로직을 사용하고 해시 함수를 호출하지 않으므로 해시 충돌 가능성이 없다.

디자인 패턴 구현

열거 타입은 다음과 같이 디자인 패턴을 구현하는 데 활용할 수도 있다.

싱글톤 패턴 구현
전략 패턴 구현

싱글톤 패턴(singleton pattern)이란 애플리케이션 내에서 클래스의 인스턴스를 하나만 생성하는 디자인 패턴을 의미한다. 싱글톤 인스턴스는 싱글톤 패턴으로 생성된 인스턴스를 말한다. 싱글톤 인스턴스의 참조는 생성자나 메서드의 인자로 전달할 수 있다. 또한 싱글톤은 정적 클래스와 달리 상속 및 인터페이스 구현이 가능하므로 런타임 수준에서 객체지향 프로그래밍의 다형성을 사용할 수 있다. 싱글톤 인스턴스는 애플리케이션 내에서 전역적으로 공유되어 사용된다. 멀티 스레드로 동작하는 애플리케이션에서는 스레드 간 경쟁 조건으로 인해 여러 개의 싱글턴 인스턴스가 생성되는 문제가 발생할 수 있다. 이를 해결하기 위해 스레드 안전한 싱글톤 인스턴스 생성 코드 구현이 반드시 필요하다.

싱글톤 인스턴스를 생성하는 방법 중 하나는 열거 타입을 사용하는 것이다. 이 방법을 사용하면 스레드 안전한 싱글톤 인스턴스 생성 코드 구현이 가능하다.

public enum Singleton {
    INSTANCE; 

    private Singleton() {
    }
 
    public Singleton getInstance() {
        return INSTANCE;
    }
}

열거 타입을 사용하면 열거 타입 구현 자체에 의해 직렬화 및 스레드 안전성이 보장되어 내부적으로 단일 인스턴스만 사용할 수 있으며 스레드 안전성 문제가 해결된다.

전략 패턴(strategy pattern)이란 다형성과 인터페이스를 통해 기능을 확장하는 디자인 패턴이다. 변하는 기능을 인터페이스의 메서드로 만들고 구체적인 기능을 인터페이스 구현 클래스에서 정의한다. 인터페이스를 사용함으로써 구체적인 클래스 형을 알 필요 없이 서로 다른 기능을 가지고 있는 전략 클래스의 교체가 가능하다.

전략 패턴에서는 변하지 않는 부분으로부터 변하는 부분을 분리하고, 변하지 않는 작업의 흐름에 영향을 주지 않으면서 새로운 기능을 수행하는 전략을 추가할 수 있다. 전략 패턴은 일반적으로 인터페이스 정의 및 구현체 정의를 통해 구현 가능하며 다음과 같이 열거 클래스를 통해서도 가능하다.

enum CalculationStrategy {
    ADDITION {
        public int calculate(int a, int b) {
            return a + b;
        }
    },
    SUBTRACTION {
        public int calculate(int a, int b) {
            return a - b;
        }
    },
    MULTIPLICATION {
        public int calculate(int a, int b) {
            return a * b;
        }
    };

    public abstract int calculate(int a, int b);
}

class Calculator {
    private CalculationStrategy strategy;

    public void setStrategy(CalculationStrategy strategy) {
        this.strategy = strategy;
    }

    public int calculate(int a, int b) {
        if (strategy == null) {
            throw new IllegalStateException("전략이 설정되지 않았습니다.");
        }
        return strategy.calculate(a, b);
    }
}

...

Calculator calculator = new Calculator();

calculator.setStrategy(CalculationStrategy.ADDITION);
calculator.calculate(5, 3);

calculator.setStrategy(CalculationStrategy.SUBTRACTION);
calculator.calculate(5, 3);

calculator.setStrategy(CalculationStrategy.MULTIPLICATION);
calculator.calculate(5, 3);

이를 통해 열거 타입 별로 실행할 메서드를 별도로 정의하는 대신 다형성을 이용하여 정의한 열거 타입 별로 메서드 구현 내용을 달리하고 열거 타입에 따라 서로 다른 코드를 실행할 수 있다.

코틀린의 열거 타입

코틀린의 경우에도 자바와 유사하게 열거 타입에 대해 다음 기본 구현 메서드가 제공된다.

values() (1.9.0 버전 이전): 열거 타입의 상수의 모든 값을 선언된 순서대로 포함하는 배열을 반환한다.
valueOf(): 이름을 포함하는 열거 타입 상수를 반환한다.

열거 타입 상수는 다음 속성을 제공한다.

name: 열거 타입 선언 시 정의된 열거 타입명과 동일한 이름을 가지는 열거 타입 상수명을 반환한다.
entries (1.9.0 버전 이후): values()와 동일하다.

다음 메서드를 통해 제네릭 타입을 사용하여 열거 타입 상수를 조회할 수도 있다.

enumValues<T>(): 열거 타입 T 항목을 포함하는 배열을 반환한다.
enumValueOf<T>(): 지정된 이름을 가진 열거 타입 항목을 반환한다.

1.9.2 버전 부터 enumValues<T>() 함수를 대체할 수 있는 enumEntries<T>() 함수가 도입되었다. enumValues<T>() 함수는 계속 지원되지만 보다 나은 성능을 제공하는 enumEntries<T>() 함수를 사용하는 것이 좋다. enumValues<T>() 함수는 호출할 때마다 새로운 배열이 생성되는 반면, enumEntries<T>() 함수는 호출할 때마다 동일한 참조를 갖는 리스트 객체를 반환하므로 훨씬 효율적이다.

참고

Twitter Facebook LinkedIn

Bldev

[자바/코틀린] 열거 (enumeration)

중첩 열거 클래스 정의

커스텀 메서드 정의

열거 타입의 활용

EnumMap

해시 맵과 열거 맵

디자인 패턴 구현

코틀린의 열거 타입

참고

Comments

You May Also Enjoy

[오픈텔레메트리] 트레이싱 API와 수동 계측을 통한 트레이스 데이터 생성

[자바] MDC

[데이터베이스] 분산 락

[자바] MDC