JAVA/Effective Java

item 34. 상수 대신 열거 타입을 사용하라

Garonguri 2022. 5. 31. 15:25
728x90

 

정수 열거 패턴(int enum pattern)

- Java에서 열거 타입을 지원하기 전 사용했던 방식

 

- 타입 안전을 보장하지 않는다.

- 표현력이 좋지 않다.

- 별도 이름 공간을 지원하지 않는다.

- 평범한 상수를 나열한 것 뿐. 따라서 컴파일하면 값이 클라이언트 파일에 그대로 새겨진다.

- 상수 값이 바뀐다면 클라이언트는 재컴파일 해야 함.

- 문자열로 출력하기 까다롭다.


문자열 열거 패턴(string enum pattern)

- 정수 대신 문자열 상수를 사용하는 패턴

 

- 상수의 의미를 출력할 수 있다.

- 문자열 값을 그대로 하드코딩 해야 함

- 문자열 비교를 통해 성능지 저하됨

 


자바 열거 타입(enum type)

- 위 열거 패턴들의 단점을 해결하기 위한 대안

 

  • 열거 타입 자체는 클래스이다. 
    • 상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개한다.

 

  • 생성자를 제공하지 않으므로 사실상 final과 같다.
    • 따라서 클라이언트가 인스턴스를 생성할 수 없어 인스턴스는 유일성이 보장되며 인스턴스 통제된다.
    • 열거 타입은 싱글턴을 일반화한 형태이다.

 

public enum APPLE {
    FUJI,
    PIPPIN,
    GRANNY_SMITH
}

"위 Apple enum type을 매개변수로 받는 메서드를 선언했다고 가정해보자.
 건네받은 참조는 위 세 가지 타입 중에 하나일 것이다." // 컴파일타임 타입 안정성 제공
  • 열거 타입은 컴파일타임에서 타입 안정성을 제공한다.
  • 열터 타입은 각자의 이름 공간이 있어서 이름이 같은 상수도 공존할 수 있다.
    • 새로운 상수를 추가하거나 순서를 변경해도 재컴파일하지 않아도 된다.
  • 열거 타입은 toString method를 사용할 수 있다.
  • 임의의 메서드나 필드를 추가할 수 있다.
  • 임의의 인터페이스(Object/Comparable/Serializable 등)를 구현할 수 있다.

 

  • 열거 타입을 선언한 클래스나 패키지에서만 유용한 기능은 private 또는 package-private 메서드로 구현한다.
  • 널리 쓰이는 열거 타입은 톱레벨 클래스로, 아니라면 멤버 클래스로 만든다.

데이터와 메서드를 가지는 열거 타입 예시 1 - 태양계의 여덟 행성

 

public class item34 {
    public static void main(String[] args) {
        double earthWeight = Double.parseDouble("46");
        double mass = earthWeight / Planet.EARTH.surfaceGravity();
        for(Planet p : Planet.values()){ //자신 안에 정의된 상수들의 값을 배열에 담아 반환.
            System.out.println(p + " 에서의 무게는 " + p.surfaceWeight(mass) + "이다.");
        }
    }

    public enum Planet {
        //상수를 제거해도 클라이언트에게는 아무런 영향이 없다.
        MERCURY(3.302e+23,2.439e6), // 괄호 안 숫자는 생성자에 넘겨지는 매개변수
        VENUS(4.869e+24,6.052e6),
        EARTH(5.975e+24, 6.378e6),
        MARS(6.419e+23,3.393e6),
        JUPITER(1.899e+27,7.149e7),
        SATURN(5.685e+26,6.027e7),
        URAUS(8.683e+25,2.556e7),
        NEPTUNE(1.024e+26,2.477e7);

        private final double mass;
        private final double radius;
        private final double surfaceGravity;

        private static final double G = 6.67300E-11;

        //생성자
        Planet(double mass, double radius){
            this.mass = mass;
            this.radius = radius;
            surfaceGravity = G * mass / (radius * radius);
        }

        "열거 타입 상수 각각을 특정 데이터와 연결지으려면,
         생성자에서 데이터를 받아 인스턴스 필드에 저장한다."

        //필드를 private으로 두고 별도의 public 접근자 메서드를 사용하자.
        public double mass()            { return mass; }
        public double radius()          { return radius; }
        public double surfaceGravity()  { return surfaceGravity; }

        public double surfaceWeight(double mass) {
            return mass * surfaceGravity;
        }

    }
}

/* 출력 형태 */
MERCURY 에서의 무게는 17.383708071712714이다.
VENUS 에서의 무게는 41.632346332449146이다.
EARTH 에서의 무게는 46.0이다.
MARS 에서의 무게는 17.46178386002025이다.
JUPITER 에서의 무게는 116.36525417697419이다.
SATURN 에서의 무게는 49.013649181597316이다.
URAUS 에서의 무게는 41.6233522071132이다.
NEPTUNE 에서의 무게는 52.26812190601241이다.

 

데이터와 메서드를 가지며 상수마다 다른 동작을 하는 열거 타입 예시 2 - 사칙 연산 계산기

 

/* 안좋은 예시 ! */

1. throw 구문 없이는 컴파일되지 못한다.
2. 새로운 Operation 타입이 추가된다면, switch 구문의 case를 추가해야한다.

public enum Operation {
    PLUS, MINUS, TIMES, DIVIDE;

    public double apply(double x, double y) {
        switch (this) {
            case PLUS: return x + y;
            case MINUS: return x - y;
            case TIMES: return x * y;
            case DIVIDE: return x / y;
        }
        throw new AssertionError("알 수 없는 연산 :" + this);
    }
}

 

 

//상수 별 메서드 구현
public enum Operation1 {
    PLUS {public double apply(double x, double y) { return x + y; }},
    MINUS {public double apply(double x, double y) { return x - y; }},
    TIMES {public double apply(double x, double y) { return x * y; }},
    DIVIDE {public double apply(double x, double y) { return x / y; }};

    // 열거 타입에 추상 메서드를 구현한 것이 특징이다.
    // 각 상수에서 해당 메서드를 자신에 맞게 재정의를 한다.
    //"상수별 메서드 구현"
    public abstract double apply(double x, double y);
}

/* 출력 형태 */
4.5 PLUS 3.2 = 7.7
4.5 MINUS 3.2 = 1.2999999999999998
4.5 TIMES 3.2 = 14.4
4.5 DIVIDE 3.2 = 1.40625
//상수 별 클래스 몸체와 데이터 사용
public enum Operation2 {
    //toString을 재정의해 해당 연산을 뜻하는 기호를 반환함으로써 가독성을 늘린다.
    PLUS("+") {public double apply(double x, double y) { return x + y; }},
    MINUS("-") {public double apply(double x, double y) { return x - y; }},
    TIMES("*") {public double apply(double x, double y) { return x * y; }},
    DIVIDE("/") {public double apply(double x, double y) { return x / y; }};
    public abstract double apply(double x, double y);

    private final String symbol;

    Operation2(String symbol) { this.symbol = symbol; }

    @Override public String toString() { return symbol; }
}

/* 출력 형태 */
4.5 + 3.2 = 7.7
4.5 - 3.2 = 1.2999999999999998
4.5 * 3.2 = 14.4
4.5 / 3.2 = 1.40625
  • 상수별 메서드 구현시에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.
    • 코드를 모든 상수별로 중복해서 구현하는 방법
    • 코드를 상수별로 나누어 도우미 메서드를 작성한 뒤 필요한 메서드를 적절히 호출하게 하는 방법
    • -> 두 가지 방식 모두 코드가 장황해져 가독성이 낮아지고 오류가 발생할 가능성이 높아진다.
    • 위와 같은 경우, '전략적 열거 타입 패턴'을 활용한다.

전략적 열거 패턴 타입 - 열거 타입 상수 일부가 같은 동작을 공유할 때 사용

 

새로운 상수를 추가할 때 '전략'을 선택하도록 하는 것.

 

ex) 요일 별 기본 임금과 일한 시간이 주어지면 일당을 계산하고,

주중에 오버타임이 발생할 경우 잔업 수당이, 주말에는 무조건 잔업 수당이 주어져 이를 계산하게 하는 열거 타입이 있다고 가정하자.

 

- 잔업수당 게산을 'private 중첩 열거 타입'으로 옮긴다.

- 탑 열거 타입 생성자에서 이 중 적당한 것을 선택한다. 

- 탑 열거 타입은 잔업 수당 계산을 전략 열거 타입에 위임하기 때문에, 상수별로 메서드를 구현하거나 switch문을 사용하지 않아도 된다.

 

public enum PayrollDay {  
	 MONDAY(WEEKDAY),  
	 TUESDAY(WEEKDAY),  
	 WEDNESDAY(WEEKDAY),  
	 THURSDAY(WEEKDAY),  
	 FRIDAY(WEEKDAY),  
	 SATURDAY(WEEKEND),  
	 SUNDAY(WEEKEND);  

	 private final PayType payType;  
    
	 PayrollDay(PayType payType) {  
		 this.payType = payType;  
	 }  
    
	 int pay(int minutesWorked, int payRate) {  
		 return payType.pay(minutesWorked, payRate);  
	 }  
    
    //(private 중첩 열거 타입) 전략적 열거 타입
	 enum PayType {  
		 WEEKDAY {  
			 int overtimePay(int minutesWorked, int payRate) {  
				 return minutesWorked <= MINS_PER_SHIFT ? 0 : (minutesWorked - MINS_PER_SHIFT) * payRate / 2;  
			 }  
		 },  
    
		 WEEKEND {  
			 int overtimePay(int minutesWorked, int payRate) {  
				 return minutesWorked * payRate / 2  
			 }  
		 };  
    
		 abstract int overtimePay(int minutesWorked, int payRate);  
		 private static final int MINS_PER_SHIFT = 8 * 60;  
    
		 int pay(int minutesWorked, int payRate) {  
			 int basePay = minutesWorked & payRate;  
			 return basePay + overtimePay(minutesWorked, payRate);  
		 }  
	 }  
}
  • 보통 switch는 간단하지만, 위 전략 열거 타입이 보다 안전하고 유연하기 때문에 이를 사용해야 한다.
  • 그러나, 기존 열거 타입에 상수별 동작을 혼합해 넣거나, 원래 열거 타입에 없는 기능을 추가할 때는 switch를 사용하는 것이 유용하다.

 

핵심 정리

1. 필요한 원소를 컴파일 타임에 모두 알 수 있는 상수 집합이라면 열거 타입을 사용해라.
2. 정수 상수보다 읽기 쉽고 안전하고 불변이다.
3. 하나의 메서드가 상수별로 다르게 동작해야 할 때는 switch문 대신 상수별 메서드 구현을 사용하자.
4. 열거 타입 상수 일부가 같은 동작을 공유할 때는 전략 열거 타입 패턴을 사용하자.
728x90