💡 목표 : 자바의 열거형에 대해 학습해보자.

⚡️ 목차

• enum 정의하는 방법
• enum이 제공하는 메서드
• java.lang.Enum
• EnumSet

사전에 알면 좋은 것들

1. 열거 타입이란 ?
   일정 개수의 상수 값을 정의한 다음, 그 외의 값은 허용하지 않는 타입이다.
2. 열거 타입이 등장한 배경 → 과거 방식의 단점을 보완
   JDK 5 이전에 등장한 열거 방법 → "정수 열거 타입"
   : public static final을 통해 대표하는 문자를 정수 타입의 상수로 정의하는 방법

사용예시

public class Card {
	public static final int CLOVER = 0;
    public static final int HEART = 1;
    public static final int DIAMOND = 2;
    public static final int SPADE = 3;
    
    public static final int TWO = 0;
    public static final int THREE = 1;
    public static final int FOUR = 2;
    
    public static void main(String[]args) {
    	System.out.println("Card.CLOVER == Card.TWO); //true
	}
}

✔️ 정수형 열거 타입의 단점들

• 타입에 안전하지 않다.
  • 상수 값이 변경되면 재 컴파일 해야한다. 만약 컴파일 하지 않으면 해당 클래스를 사용하는 클래스는 잘못된 값을 가지고 동작할 수 있다.
• 의미있는 문자열을 출력하기 어렵다.
  • 정수 열거 타입에서 정의한 상수를 출력하게 되면 숫자로 출력된다. 실제 상수의 의미를 알기 어렵다. 예를들어 위의 코드를 보면 CLOVER와 TWO라는 상수의 값은 같다고 나오는데 실제 의미를 생각해 봤을 때는 모호해지게 된다. (의미상으로는 다른게 맞다.)
• 별도의 네임 스페이스가 없다.
  • 이름 충돌을 막기 위해 접두어와 같은 것들을 사용하여 상수의 이름을 지어야 한다.

✔️ 정수 대신 "문자열을 이용한 변형 패턴"

• 상수의 의미를 출력할 수 있지만 잘못된 문자열 코드로 잘못된 동작을 일으킬 수 있다. (런타임 시에 잘못된 동작임을 알 수 있다.)
• 문자열 비교의 성능 저하는 자연스럽게 따라오게 된다.

3. [정수 열거 타입, 문자열 변형 타입]의 단점을 보완한 열거 타입 등장

• JDK 5부터 지원

사용예시

public enum Kind { CLOVER, HEART, DIAMOND, SPADE }
public enum Value { TWO, THREE, FOUR }

위 코드를 자바 enum으로 변경했을 때 Card.CLOVER == Card.TWO 이렇게 의미는 다르지만 실제 값이 같은 경우로 인한 동등성 문제를 해결할 수 있을까?

Enum에서는 컴파일 에러가 발생한다. 왜일까? 자바에서의 Enum은 값 뿐만 아니라 타입도 체크하기 때문이다. 타입이 다르기 때문에 아예 비교 자체가 불가능하다.

Enum

열거형(Enumerated Type)이라고 부르며 서로 연관된 상수들의 집합이다. 기존에 상수를 사용하면서 발생했던 문제(TypeSafe)를 개선하고자 jdk 1.5 부터 추가된 기능이다.

Enum 이전의 상수 표현

✔️ 변수를 상수로
상수는 변하지 않는 수를 의미한다. 따라서 변수에 고정된 값을 집어넣으면 그 변수는 상수가 될 수 있다.

int bicmac = 1;

위와 같은 방법으로 숫자별로 어떤 햄버거 인지 구분할 수 있는 코드를 작성할 수 있다.

public class BeforeEnum {
	public static void main(String[]args) {
	/*
    1번은 빅맥
    2번은 불고기
    3번은 치즈버거
    */
    int type = 2;
    
    switch(type) {
    	case 1 :
        System.out.println("빅맥");
        break;
        
        case 2 :
        System.out.println("불고기");
        break;
        
        case 3 :
        System.out.println("치즈");
        break;
	}
  }
}

Output
불고기

하지만 이런 코드는 문제가 있다. 시간이 흘러 코드를 조작하다가 주석에 적힌 정보가 없어졌다고 가정해보자. 만약 다른 개발자가 이를 발견하면 type이 어떤 의미를 담고있는지 모를 것이다.
✔️ final을 이용한 상수
주석이 없어졌다는 이유로 코드를 분석하기 어려우면 매우 힘들 것이다. 이럴 때 숫자별로 변수를 만든 후, 불변하기 위해 final, 어차피 바뀌지 않을 값이라면 클래스 변수로 지정하는 것이다.

public class BeforeEnum {
	private final static int BIGMAC = 1;
    private final static int BULGOGI = 2;
    private final static int CHEESE = 3;
    
    public static void main(String[]args) {
    	int type = BIGMAG;
        
        switch(type) {
        	case BIGMAG : 
            System.out.println("빅맥");
            break;
            
            case BULGOGI : 
            System.out.println("불고기");
            break;
            
            case CHEESE : 
            System.out.println("치즈");
            break;
		}
	}
}

이렇게 된 경우 맨처음과 같은 경우가 발생하더라도 변수명으로 코드를 분석할 수 있기 때문에 훨씬 유지보수가 쉬워졌다.
✔️상수의 중복
프로그램을 좀 더 구체적으로 만들다보니 햄버거에 대한 상수말고, 맥올데이 행사 버거에 대한 상수가 필요해졌다.

public class BeforeEnum {
	// 일반 햄버거
	private final static int BIGMAC = 1;
    private final static int BULGOGI = 2;
    private final static int CHEESE = 3;
    
    // 맥올데이
	private final static int BIGMAC = 1; // 컴파일 에러 발생
    private final static int SHANGHI = 2;
    private final static int SHRIMP = 3;

하지만 일반 햄버거의 BIGMAC 상수와, 맥올데이 BICMAC 상수가 겹치기 때문에 컴파일 에러가 발생한다. 이를 방지하기 위해 우리는 변수명 앞에 접두사를 붙여 다시 변수명을 구분짓기로 했다.
✔️ 네임 스페이스 기법
이름이 중복되는 확률을 낮추기 위한 기법으로 위에서 상수의 이름이 겹치기 때문에 접두사를 붙여 상수명을 새로 지었다. 하지만 여기서도 만약 상수를 추가해야할 일이 있으면 선언부는 매우 지저분한 상태가 될것이다.

public class BeforeEnum {
		
	// 일반 햄버거
    private final static int BIGMAC = 1;
    private final static int BULGOGI = 2;
    private final static int CHEESE = 3;

    // 맥올데이
    private final static int BIGMAC = 1; // 컴파일 에러 발생하지
    private final static int SHANGHI = 2;
    private final static int SHRIMP = 3;

	......
}

✔️ 기존 상수를 사용하면서 발생한 문제들
위에서 했던 코드들을 보면 아직까진 별 문제가 없다. 하지만 만약 일반 햄버거의 빅맥과, 맥올데이 빅맥을 비교한다면 어떻게 될까? 실제론 둘다 구성품은 동일하지만 실질적으로 가격 차이가 있기 때문에 같다고 볼 순 없다. 이를 비교하는 코드 상에선 개발자의 목적상 false가 나와야하지만 실제론 true가 발생한다. (타입은 다르지만 값이 같기 때문에 조건식의 결과는 true) 즉, TypeSafe하지 못하다는 것이다.

public class BeforeEnum {

    // 일반 햄버거
    private final static int NORMAL_BIGMAC = 1;
    private final static int NORMAL_BULGOGI = 2;
    private final static int NORMAL_CHEESE = 3;

    // 맥올데이
    private final static int MACALL_BIGMAC = 1;
    private final static int MACALL_SHANGHI = 2;
    private final static int MACALL_SHRIMP = 3;
		
	public static void main(String[]args) {
		int type = NORMAL_BIGMAC;

		if (NOMAL_BIGMAC == MACALL_BIGMAC) {
	// 일반 빅맥과 맥올데이 빅맥은 구성품은 똑같지만, 가격에 있어 차이가 있기 때문에 같으면 안된다.
		}
	}
}

✔️ enum을 사용한 상수 사용
일반 햄버거, 맥올데이 별로 enum을 만들었다. NORMAL_BIGMAC, MACALL_BIGMAC을 비교해보면 컴파일 에러가 나기 때문에 비교 조차도 할 수 없다.

public class AfterEnum {
	
    enum NORMAL {
    	BIGMAC, BULGOGI, CHEESE
	}
    
    enum MACALL {
    	BIGMAC, SHANGHI, SHIRIMP
	}
    
    public static void main(String[]args) {
    	if (NORMAL.BIGMAC == MACALL.BIGMAC) {
        	// 컴파일 에러 발생.. 타입 불일치
		}
	}
}

Enum 정의

• enum 키워드를 이용하여 정의한다.
• 열거형 필드의 이름은 상수이기 때문에 대문자로 표기한다.
• 기본적으로 0부터 시작하는 정수값이 연속적으로 부여된다.

Enum의 사용

• Days라는 enum을 정의한 후 Calendar클래스에서 사용해보자.

public enum Week {
	MONDAY,
    THUSDAY,
    WEDNESDAY,
    THURSDAY,
    FRIDAY,
    SATURDAY,
    SUNDAY
}
class WeekExample {
	public static void main(String[]args) {
    	Week today1 = Week.SUNDAY;
        Week today2 = Week.SUNDAY;
        System.out.println(today1 == today2); // 동일 참조 값
	}
}

Output
true

Week enum 클래스

Week 타입에 today 참조변수

주의사항

• 열거형 상수의 비교에는 == 와 compareTo() 사용가능 (등가비교연산자 가능)
• =, >, >=, <, <=, <> 같은 비교연산자는 사용할 수 없음 (컴파일 에러)

왜 비교연산자를 쓸 수 없을까?
바이트코드를 분석해보면 알겠지만 enum은 클래스이다. 클래스에서 비교연산자를 쓸 수 있었나? 다시 생각해보면 객체와 객체는 서로 비교연산자를 쓸 수 없기 때문에 enum에서 지원하지 않는다.

java.lang.Enum

• Enum은 추상 클래스이다.
• 다중 상속이 되지 않아 다른 클래스를 확장할 수 없다.
• java.lang.Enum 클래스를 확장한 클래스는 java.lang.Enum 클래스 메서드를 상속받는다.
  
  그 밖에 clone(), equals(), toString()..등 여러가지 메서드가 있지만 이는 Object 클래스로부터 상속받은 메서드이기 때문에 따로 언급하지 않겠다.

values(), valueOf()

위에서 본 java.lang.Enum 즉 열거형의 조상 클래스에선 values(), valueOf() 메서드에 대한 내용을 자세히 찾아볼 수 없다. 그 이유는 컴파일러가 자동으로 추가해주는 메서드이기 때문이다.

메서드	설명
static E values()	해당 열거체의 모든 상수를 저장한 배열을 생성하여 반환
static E valuesOf(String name)	전달된 문자열과 일치하는 해당 열거체의 상수를 반환

enum Hamburger {
	BIGMAC, SHANGHI, MACCHIKEN;
}

public class EnumTest {
	public static void main(String[]args) {
    	Hamburger hamburger = Hamburger.valueOf("MACCHIKEN");
        System.out.println(hamburger + " 버거 입니다.");
	}
}

Output
MACCHIKEN 버거 입니다.

enum Hamburger {
	BIGMAC, SHANGHI, MACCHICKEN;
}
public class EnumTest {
	public static void main(String[] args) {
		Hamburger hamburger[] = Hamburger.values();
		System.out.println("현재 저희 매장에 있는 버거는");
		for (Hamburger burgers : hamburger) {
			System.out.println(burgers + " 버거가 있습니다.");
		}
	}
}

Output
현재 저희 매장에 있는 버거는
BIGMAC 버거가 있습니다.
SHANGHI 버거가 있습니다.
MACCHICKEN 버거가 있습니다.

열거형에 멤버 추가하기

• 위에서 연속적인 값을 자동으로 대입한다고 했었다. 만약 개발자가 불연속적인 열거형 상수의 경우, 원하는 값을 괄호()안에 대입하면 된다.
• 이때 단순히 괄호()안에 대입하는 것이 아니라 추가적으로 해야하는 작업이 있다.

/**
- () 안에 원하는 값을 적으면 된다.
- 하지만 이렇게 작성하기 위해선 추가적인 작업이 소모된다.
- 내부적으로 불연속적인 값을 주기 위하여 생성자를 만들어 값을 받아온 후, 인스턴스 변수에 저장하는 방식이다. */
enum Day {
	SUNDAY(1), MONDAY(5), TUESDAY(0), WEDNESDAY(2), THURSDAY(6), FRIDAY(3), SATURDAY(4);
    
    private final int value;
    
    // 항상 접근 제어자는 private이다.
    DAY (int value) {
    	this.value = value;
	}
    
    public int getValue() {
    	return value;
	}
}

주의사항

• 열거형의 생성자는 묵시적으로 private이므로, 외부에서 객체 생성이 불가하다.

Day day = new Day(1); // 열거형의 생성자는 외부에서 호출이 불가능하다.

EnumSet

✔️ Set
Set은 객체(데이터)를 중복해서 저장할 수 없다. 또한 저장된 객체(데이터)를 인덱스로 관리하지 않기 때문에 저장 순서가 보장되지 않는다. Set 컬렉션을 구현하는 대표적인 클래스들은 HashSet, TreeSet, LinkedHashSet등이 있다. 주로 공통적으로 사용하는 메서드들은 add, iterator, size, remove, clear들이 있다.
✔️ EnumSet
특징

• null을 추가할 수 없다.
• 스레드로부터 안전하지 않다.
• 열거형에 선언된 순서대로 저장한다.

Set 인터페이스를 기반으로 하면서 Enumeration Type을 사용하는 방식이다.

메서드	설명
allOf(Class elementType)	인자로 들어온 enum을 그대로 enum set 생성
range(E fro,, E to)	처음과 끝을 입력하면 그 사이에 있는 값들로 enum set 생성
complementOf(EnumSet s)	인자로 들어온 enum set에서 없는 요소들로 만 다시 enum set 생성
of(E e1, E e2, E e3, E e4, E e5)	들어갈 요소를 직접 입력하여 EnumSet을 생성할 수 있다.
EnumSet.copyOf(EnumSet.of(E e1, E e2…))	다른 EnumSet을 복사하여 새로운 EnumSet을 만들 수 있다.

enum Color {
	RED, YELLOW, GREEN, BLUE, BLACK, WHITE
}

public class EnumSetExample {
	public static void main(String[]args) {
    	System.out.println(EnumSet.allOf(Color.class));
        System.out.println(EnumSet.range(Color.YELLOW, Color.BLUE));
        System.out.println(EnumSet.complement(EnumSet.of(Color.BLACK, Color.WHITE));
        System.out.println(EnumSet.of(Color.BLACK, Color.WHITE));
	}
}

Output
[RED, YELLOW, GREEN, BLUE, BLACK, WHITE]

[YELLOW, GREEN, BLUE]

[RED, YELLOW, GREEN, BLUE]

[BLACK, WHITE]

끝 !

팀프로젝트 때문에 늦긴 했지만 모 어쩌라구 ~!~ 내맴대루 할꺼다 ~~ 그리고 힘들면 쉬었다가 할꺼다 ~~또 행보칼꺼다 ! ~ ~ ~ 다음주도 힘내서 할꺼다 ~~ ~ 열심히 할꺼다 ~!~ ✨

[참고]
https://velog.io/@ljs0429777/11주차-과제-Enum#enum
https://www.notion.so/11-Enum-ccbba2bf2b7746ed8a12d2dee09aa833#b46f3984088f43519e26eeb61d6b16f6