자바 Enum 사용방법(예제)

1. 개요

이 사용방법(예제)에서는 Java Enum이 무엇인지, 어떤 문제를 해결하는지, 일부 디자인 패턴을 실제로 어떻게 사용할 수 있는지 알아봅니다.

Java 5는 enum 키워드를 처음 도입했습니다 . 항상 java.lang.Enum 클래스 를 확장하는 특별한 유형의 클래스를 나타냅니다 . 사용법에 대한 공식 문서를 보려면 문서로 이동 하십시오 .

이러한 방식으로 정의된 상수는 코드를 더 읽기 쉽게 만들고, 컴파일 시간 검사를 허용하고, 허용된 값 List을 미리 문서화하고, 잘못된 값이 전달되어 예기치 않은 동작을 방지합니다.

다음은 피자 주문 상태를 정의하는 Enum의 빠르고 간단한 예입니다. 주문 상태는 ORDERED , READY 또는 DELIVERED 일 수 있습니다 .

public enum PizzaStatus {
    ORDERED,
    READY, 
    DELIVERED; 
}

또한 Enum에는 기존의 공개 정적 최종 상수를 사용하는 경우 작성해야 하는 유용한 메서드가 많이 있습니다.

2. 사용자 지정 열거 방법

Enum이 무엇이고 어떻게 사용할 수 있는지에 대한 기본적인 이해를 마쳤으므로 이제 Enum에 몇 가지 추가 API 메서드를 정의하여 이전 예제를 다음 단계로 가져갈 것입니다.

public class Pizza {
    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED,
        READY,
        DELIVERED;
    }

    public boolean isDeliverable() {
        if (getStatus() == PizzaStatus.READY) {
            return true;
        }
        return false;
    }
    
    // Methods that set and get the status variable.
}

3. "==" 연산자를 사용한 Enum 유형 비교

enum 유형은 상수의 인스턴스가 JVM에 하나만 존재하도록 보장하므로 "==" 연산자를 사용하여 위의 예에서와 같이 두 변수를 안전하게 비교할 수 있습니다. 또한 "==" 연산자는 컴파일 타임 및 런타임 안전성을 제공합니다.

먼저 다음 스니펫에서 "==" 연산자를 사용하여 상태를 비교하는 런타임 안전성 을 살펴보겠습니다. 두 값 모두 null 일 수 있으며 NullPointerException이 발생 하지 않습니다 . 반대로 equals 메서드를 사용하면 NullPointerException 이 발생합니다 .

if(testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED)); 
if(testPz.getStatus() == Pizza.PizzaStatus.DELIVERED);

컴파일 타임 안전성 에 관해서 는 equals 메서드 를 사용하여 비교하여 다른 유형의 Enum이 동일한지 확인하는 예를 살펴보겠습니다 . Enum과 getStatus 메서드의 값이 우연히 동일하기 때문입니다. 그러나 논리적으로 비교는 거짓이어야 합니다. "==" 연산자를 사용하여 이 문제를 방지합니다.

컴파일러는 비교를 비호환성 오류로 표시합니다.

if(testPz.getStatus().equals(TestColor.GREEN));
if(testPz.getStatus() == TestColor.GREEN);

4. Switch 문에서 Enum 유형 사용

switch 문에서도 enum 유형을 사용할 수 있습니다 .

public int getDeliveryTimeInDays() {
    switch (status) {
        case ORDERED: return 5;
        case READY: return 2;
        case DELIVERED: return 0;
    }
    return 0;
}

5. Enum의 필드, 메서드 및 생성자

enum 유형 내부에 생성자, 메서드 및 필드를 정의할 수 있으므로 매우 강력합니다.

다음으로 피자 주문의 한 단계에서 다른 단계로의 전환을 구현하여 위의 예를 확장해 보겠습니다. 이전에 사용된 if 및 switch 문 을 제거하는 방법을 살펴보겠습니다 .

public class Pizza {

    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED (5){
            @Override
            public boolean isOrdered() {
                return true;
            }
        },
        READY (2){
            @Override
            public boolean isReady() {
                return true;
            }
        },
        DELIVERED (0){
            @Override
            public boolean isDelivered() {
                return true;
            }
        };

        private int timeToDelivery;

        public boolean isOrdered() {return false;}

        public boolean isReady() {return false;}

        public boolean isDelivered(){return false;}

        public int getTimeToDelivery() {
            return timeToDelivery;
        }

        PizzaStatus (int timeToDelivery) {
            this.timeToDelivery = timeToDelivery;
        }
    }

    public boolean isDeliverable() {
        return this.status.isReady();
    }

    public void printTimeToDeliver() {
        System.out.println("Time to delivery is " + 
          this.getStatus().getTimeToDelivery());
    }
    
    // Methods that set and get the status variable.
}

아래 테스트 스니펫은 이것이 어떻게 작동하는지 보여줍니다.

@Test
public void givenPizaOrder_whenReady_thenDeliverable() {
    Pizza testPz = new Pizza();
    testPz.setStatus(Pizza.PizzaStatus.READY);
    assertTrue(testPz.isDeliverable());
}

6. EnumSet 및 EnumMap

6.1. Enum 집합

EnumSet 은 Enum 유형 과 함께 사용하기 위한 특수한 Set 구현입니다.

HashSet과 비교할 때 사용되는 내부 비트 벡터 표현 으로 인해 특정 Enum 상수 집합 의 매우 효율적이고 간결한 표현입니다 . 또한 기존의 int 기반 "비트 플래그"에 대한 유형 안전 대안을 제공하여 보다 읽기 쉽고 유지 관리하기 쉬운 간결한 코드를 작성할 수 있습니다.

EnumSet 은 RegularEnumSet 및 JumboEnumSet 의 두 가지 구현이 있는 추상 클래스이며 , 그 중 하나는 인스턴스화 시 Enum의 상수 수에 따라 선택됩니다.

따라서 대부분의 시나리오(서브셋팅, 추가, 제거, containsAll 및 removeAll 같은 대량 작업 등)에서 Enum 상수 모음으로 작업하고 싶을 때마다 이 세트를 사용하고 다음과 같은 경우 Enum.values() 를 사용하는 것이 좋습니다. 가능한 모든 상수를 반복하고 싶습니다.

아래 코드 조각에서 EnumSet 을 사용하여 상수의 하위 집합을 만드는 방법을 볼 수 있습니다.

public class Pizza {

    private static EnumSet<PizzaStatus> undeliveredPizzaStatuses =
      EnumSet.of(PizzaStatus.ORDERED, PizzaStatus.READY);

    private PizzaStatus status;

    public enum PizzaStatus {
        ...
    }

    public boolean isDeliverable() {
        return this.status.isReady();
    }

    public void printTimeToDeliver() {
        System.out.println("Time to delivery is " + 
          this.getStatus().getTimeToDelivery() + " days");
    }

    public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {
        return input.stream().filter(
          (s) -> undeliveredPizzaStatuses.contains(s.getStatus()))
            .collect(Collectors.toList());
    }

    public void deliver() { 
        if (isDeliverable()) { 
            PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
              .deliver(this); 
            this.setStatus(PizzaStatus.DELIVERED); 
        } 
    }
    
    // Methods that set and get the status variable.
}

다음 테스트를 실행 하면 Set 인터페이스 의 EnumSet 구현 기능을 확인할 수 있습니다.

@Test
public void givenPizaOrders_whenRetrievingUnDeliveredPzs_thenCorrectlyRetrieved() {
    List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);

    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);

    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);

    List<Pizza> undeliveredPzs = Pizza.getAllUndeliveredPizzas(pzList); 
    assertTrue(undeliveredPzs.size() == 3); 
}

6.2. EnumMap

EnumMap 은 enum 상수를 키로 사용하기 위한 특수 Map 구현입니다. 대응 HashMap 과 비교할 때 내부적으로 배열로 표현되는 효율적이고 간결한 구현입니다.

EnumMap<Pizza.PizzaStatus, Pizza> map;

실제로 어떻게 사용할 수 있는지에 대한 예를 살펴보겠습니다.

public static EnumMap<PizzaStatus, List<Pizza>> 
  groupPizzaByStatus(List<Pizza> pizzaList) {
    EnumMap<PizzaStatus, List<Pizza>> pzByStatus = 
      new EnumMap<PizzaStatus, List<Pizza>>(PizzaStatus.class);
    
    for (Pizza pz : pizzaList) {
        PizzaStatus status = pz.getStatus();
        if (pzByStatus.containsKey(status)) {
            pzByStatus.get(status).add(pz);
        } else {
            List<Pizza> newPzList = new ArrayList<Pizza>();
            newPzList.add(pz);
            pzByStatus.put(status, newPzList);
        }
    }
    return pzByStatus;
}

다음 테스트를 실행 하면 Map 인터페이스 의 EnumMap 구현 기능을 확인할 수 있습니다.

@Test
public void givenPizaOrders_whenGroupByStatusCalled_thenCorrectlyGrouped() {
    List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);

    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);

    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);

    EnumMap<Pizza.PizzaStatus,List<Pizza>> map = Pizza.groupPizzaByStatus(pzList);
    assertTrue(map.get(Pizza.PizzaStatus.DELIVERED).size() == 1);
    assertTrue(map.get(Pizza.PizzaStatus.ORDERED).size() == 2);
    assertTrue(map.get(Pizza.PizzaStatus.READY).size() == 1);
}

7. Enum을 사용하여 디자인 패턴 구현

7.1. 싱글턴 패턴

일반적으로 Singleton 패턴을 사용하여 클래스를 구현하는 것은 쉽지 않습니다. Enum은 싱글톤을 구현하는 빠르고 쉬운 방법을 제공합니다.

또한 enum 클래스 는 후드 아래에서 Serializable 인터페이스를 구현하므로 클래스는 JVM에 의해 싱글톤이 되도록 보장됩니다. 이는 역직렬화 중에 새 인스턴스가 생성되지 않도록 해야 하는 기존 구현과 다릅니다.

아래 코드 스니펫에서 싱글톤 패턴을 구현하는 방법을 볼 수 있습니다.

public enum PizzaDeliverySystemConfiguration {
    INSTANCE;
    PizzaDeliverySystemConfiguration() {
        // Initialization configuration which involves
        // overriding defaults like delivery strategy
    }

    private PizzaDeliveryStrategy deliveryStrategy = PizzaDeliveryStrategy.NORMAL;

    public static PizzaDeliverySystemConfiguration getInstance() {
        return INSTANCE;
    }

    public PizzaDeliveryStrategy getDeliveryStrategy() {
        return deliveryStrategy;
    }
}

7.2. 전략 패턴

일반적으로 Strategy 패턴은 서로 다른 클래스에 의해 구현되는 인터페이스를 사용하여 작성됩니다.

새 전략을 추가한다는 것은 새 구현 클래스를 추가한다는 의미입니다. Enum을 사용하면 적은 노력으로 이를 달성할 수 있으며 새 구현을 추가한다는 것은 일부 구현으로 다른 인스턴스를 간단히 정의하는 것을 의미합니다.

아래 코드 스니펫은 전략 패턴을 구현하는 방법을 보여줍니다.

public enum PizzaDeliveryStrategy {
    EXPRESS {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in express mode");
        }
    },
    NORMAL {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in normal mode");
        }
    };

    public abstract void deliver(Pizza pz);
}

그런 다음 Pizza 클래스 에 다음 메서드를 추가합니다 .

public void deliver() {
    if (isDeliverable()) {
        PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
          .deliver(this);
        this.setStatus(PizzaStatus.DELIVERED);
    }
}

@Test
public void givenPizaOrder_whenDelivered_thenPizzaGetsDeliveredAndStatusChanges() {
    Pizza pz = new Pizza();
    pz.setStatus(Pizza.PizzaStatus.READY);
    pz.deliver();
    assertTrue(pz.getStatus() == Pizza.PizzaStatus.DELIVERED);
}

8. 자바 8과 Enum

Java 8에서 Pizza 클래스를 다시 작성할 수 있으며 getAllUndeliveredPizzas() 및 groupPizzaByStatus( ) 메서드 가 람다 및 Stream API를 사용하여 어떻게 간결해졌는지 확인할 수 있습니다.

public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {
    return input.stream().filter(
      (s) -> !deliveredPizzaStatuses.contains(s.getStatus()))
        .collect(Collectors.toList());
}

public static EnumMap<PizzaStatus, List<Pizza>> 
  groupPizzaByStatus(List<Pizza> pzList) {
    EnumMap<PizzaStatus, List<Pizza>> map = pzList.stream().collect(
      Collectors.groupingBy(Pizza::getStatus,
      () -> new EnumMap<>(PizzaStatus.class), Collectors.toList()));
    return map;
}

9. Enum의 JSON 표현

Jackson 라이브러리를 사용하면 마치 POJO인 것처럼 enum 유형의 JSON 표현을 가질 수 있습니다. 아래 코드 스니펫에서 Jackson 어노테이션을 동일한 용도로 사용하는 방법을 볼 수 있습니다.

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum PizzaStatus {
    ORDERED (5){
        @Override
        public boolean isOrdered() {
            return true;
        }
    },
    READY (2){
        @Override
        public boolean isReady() {
            return true;
        }
    },
    DELIVERED (0){
        @Override
        public boolean isDelivered() {
            return true;
        }
    };

    private int timeToDelivery;

    public boolean isOrdered() {return false;}

    public boolean isReady() {return false;}

    public boolean isDelivered(){return false;}

    @JsonProperty("timeToDelivery")
    public int getTimeToDelivery() {
        return timeToDelivery;
    }

    private PizzaStatus (int timeToDelivery) {
        this.timeToDelivery = timeToDelivery;
    }
}

다음과 같이 Pizza 및 PizzaStatus 를 사용할 수 있습니다 .

Pizza pz = new Pizza();
pz.setStatus(Pizza.PizzaStatus.READY);
System.out.println(Pizza.getJsonString(pz));

이렇게 하면 피자 상태 에 대한 다음 JSON 표현이 생성됩니다 .

{
  "status" : {
    "timeToDelivery" : 2,
    "ready" : true,
    "ordered" : false,
    "delivered" : false
  },
  "deliverable" : true
}

enum 유형의 JSON 직렬화/역직렬화(사용자 지정 포함)에 대한 자세한 내용은 Jackson – Serialize Enums as JSON Objects 를 참조하십시오 .

10. 결론

이 기사에서는 언어 기본 사항부터 보다 발전되고 흥미로운 실제 사용 사례에 이르기까지 Java enum을 살펴보았습니다.

이 기사의 코드 스니펫은 Github 리포지토리에서 찾을 수 있습니다.

Spring REST API의 이진 데이터 형식 (1)	2023.01.10
구아바용 AssertJ (0)	2023.01.10
XStream 사용자 안내서: XML을 객체로 변환 (0)	2023.01.10
XStream 사용자 사용방법(예제): 개체를 XML로 변환 (0)	2023.01.10
RESTEasy 사용방법(예제) (0)	2023.01.09

기록만이살길