이펙티브 자바 Item 34 - int 상수 대신 열거 타입을 사용하라
Java에서 열거 타입을 지원하기 전에는 아래와 같이 정수 상수를 한 묶음으로 선언하여 사용하였다.
하지만 이런 '정수 열거 패턴'은 많은 단점들이 존재한다.
public static final int APPLE_PIE = 0;
public static final int APPLE_JAM = 1;
public static final int GRAPE_PIE = 0;
public static final int GRAPE_JAM = 1;
1. 타입 안전을 보장할 방법이 없으며 표현력이 좋지 않다.
위 코드에서 보는 것과 같이 APPLE_GRAPE_PIE와 GRAPE_PIE는 다른 접두어를 써서 겉보기에는 다른 곳에서 사용할 것을 알 수 있지만 컴파일러 입장에서는 둘다 정수 0이기 때문에 APPLE_PIE가 사용되는 메서드에 GRAPE_PIE가 전달되어도 컴파일때 아무런 문제가 없다.
2. 정수 열거 패턴을 사용한 프로그램은 깨지기 쉽다.
평범한 상수를 나열한 것 뿐이라 컴파일하면 해당 갑이 클라이언트 파일에 그대로 새겨진다.
만약 상수의 값이 바뀌면 반드시 다시 컴파일 해야 한다.
public static final int APPLE_PIE = 0;
//결국 똑같은 코드!
System.out.println(APPLIE_PIE);
System.out.println(0);
3. 정수 상수는 문자열로 출력하기 어렵다.
public static final int APPLE_PIE = 0;
System.out.println(APPLIE_PIE); // APPLIE_PIE 가 아닌 0이 출력!
4. 같은 정수 열거 그룹에 속한 모든 상수를 한 바퀴 순회하는 방법도 마땅치 않다.
이런 정수 열거 패턴의 단점을 보완하고 여러 장점들을 안겨주는 대안이 바로 자바의 열거 타입이다.
열거타입
중요한 것은 열거타입 자체는 클래스이다. 그리고 열거 상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개한다. 또한 열거 타입은 밖에서 접근할 수 있는 생성자를 제공하지 않는다. 이런 사실들이 열거 타입의 여러 장점을 보여준다.
1. 열거 타입 선언으로 만들어진 인스턴스들은 딱 하나씩만 존재한다.
클라이언트가 인스턴스를 직접 생성하거나 확장 할 수 없기 때문이다. 싱글톤은 원소가 하나뿐인 열거 타입이라 할 수 있고, 열거 타입은 싱글톤을 일반화한 형태로 볼 수 있다.
2. 열거 타입은 컴파일 타임 타입 안정성을 제공한다.
public enum WeekDay {
MONDAY(0),
TUESDAY(1),
WEDNESDAY(2),
THURSDAY(3),
FRIDAY(4),
SATURDAY(5),
SUNDAY(6);
private final int value;
WeekDay(int value) {
this.value = value;
}
}
WeekDay 열거타입을 인자로 받으려는 메소드는 반드시 WeekDay의 인스턴스를 건네줘야 한다.
3. 열거 타입에는 각자의 이름공간이 있어서 이름이 같은 상수도 평화롭게 공존한다.
private enum Apple{
PIE,JAM;
}
private enum Grape{
PIE,JAM;
}
//같은 클래스 안에 enum
또한 열거 타입에 새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일 하지 않아도 된다. 정수 열거 패턴과 달리 상수 값이 클라이언트로 컴파일되어 각인되지 않기 때문이다.
4. 열거 타입의 toString메소드는 출력하기에 적합한 문자열을 내어준다.
아래와 같이 열거 타입의 toString메소드는 상수 이름을 문자열로 반환한다.
5. 열거 타입에는 임의의 메서드나 필드를 추가할 수 있고, 임의의 인터페이스를 구현할 수도 있다.
public enum WeekDay {
MONDAY(0),
TUESDAY(1),
WEDNESDAY(2),
THURSDAY(3),
FRIDAY(4),
SATURDAY(5),
SUNDAY(6);
//임의의 필드
private final int value;
WeekDay(int value) {
this.value = value;
}
//임의의 메소드
public void printHi() {
System.out.println("Hi! This is " + this.name());
}
}
Eumn 자체는 Object메서드들과 Comparable, Serializable을 구현해두었다.
public abstract class Enum<E extends Enum<E>> implements Comparable<E>,Serializable{
}*Enum 구현부
+ 열거 타입은 근본적으로 불변이라 모든 필드는 final이어야한다.
열거 타입은 자신 안에 정의된 상수들을 배열에 담아 반환하는 values()메서드를 제공한다. 상수들은 선언된 순서대로 저장된다.
public enum Planet {
// 중략....
//재정의한 toString, 이름을 소문자로 출력한다.
@Override
public String toString() {
return this.name().toLowerCase();
}
}
//Planet[] planets = Planet.values();
6. 열거 타입에서 선언한 상수 하나를 제거하더라도, 제거한 상수를 참조하지 않는 클라이언트에는 아무런 영향이 없다.
따라서 private나 package-private로 구현하던가, 널리 쓰이는 열거 타입은 톱레벨 클래스로 만들어서 사용하자
2. 상수별 메서드 구현
열거 타입을 구현하면서 열거 타입의 메서드가 상수에 따라 다르게 동작해야하는 경우가 발생할 수 있다.
public enum Operation {
PLUS,MINUS,TIMES,DIVDE;
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 DIVDE:
return x / y;
}
throw new AssertionError("알 수 없는 연산:" + this);
}
}
이를 switch문을 활용할 수도 있지만, 더 나은 방법을 찾아보자
2.1 열거 추상 메서드
상수별 메서드 구현은 열거 타입에 추상 메서드로 선언하고 각 상수별로 클래스 몸체를 상수가 자신에 맞게 재정의 한는 방법을 사용하면 해결할 수 있다.
public enum Operation {
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;
}
},
DIVDE("/") {
public double apply(double x, double y) {
return x / y;
}
};
private final String symbol;
Operation(String symbol) {
this.symbol = symbol;
}
@Override
public String toString() {
return symbol;
}
public abstract double apply(double x, double y);
}
열거 타입은 상수 이름을 입력받아 그 이흠에 해당하는 상수를 반환해주는 valueOf(String)메서드가 자동 생성된다.
toString을 재정의했다면, toString이 반환하는 문자열을 해당 열거 타입 상수로 변환해주는 fromString메서드도 함께 제공하는 걸 고려해보자 .
private static final Map<String, Operation> stringToEnum =
Stream.of(Operation.values())
.collect(Collectors.toMap(Operation::toString, operation -> operation));
//Optional로 반환하여 값이 존재하지않을 상황을 클라이언트에게 알린다.
public static Optional<Operation> fromString(String symbol) {
return Optional.ofNullable(stringToEnum.get(symbol));
}
// Operation.fromString("-").get().isEqualTo(Operation.MINUS)- 여기서 중요하게 봐야할 것은 Map에 Operation 상수가 추가되는 시점이다. Operation 상수들은 정적 필드가 초기화되는 시점에 추가된다.
- 열거 타입에서 정적 필드는 열거 타입 상수가 생성된 후에 초기화 된다. 그렇게 때문에 열거 타입 생성자에서 정적 필드를 참조하려하면 컴파일 에러가 발생한다.
2.2 전략 열거 타입 패턴
상수별 메서드 구현에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.
public enum PayrollDay {
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY;
private static final int MINS_PER_SHIFT = 8 * 60;
int pay(int minutesWorked, int payRate) {
//기본 급여
int basePay = minutesWorked * payRate;
//잔업수당
int overtimePay;
switch (this) {
//주말
case SATURDAY:
case SUNDAY:
overtimePay = basePay / 2;
break;
//주중
default:
overtimePay = minutesWorked <= MINS_PER_SHIFT ?
0 : (minutesWorked - MINS_PER_SHIFT) * payRate / 2;
}
return basePay + overtimePay;
}
}- 만약, 휴가와 새로운 상수가 추가된다면, 휴가에 맞는 급여를 청리하는 case문을 추가해줘야하는 단점이 있다.
- 상수별 메서드 구현으로 급여를 계산하는 방법이 몇가지 있다.
- 잔업 수당을 계산하는 코드를 모든 상수에 중복해서 넣기
- 계산 코드를 평일용과 주말용으로 나눠 각각 메서드로 작성한 다음 각 상수가 자신에게 필요한 메서드를 적절히 호출하는방법
- 평일 잔업 수당 계산 메서드를 구현해두고 주말 상수에서만 재정의해서 쓰는 방법
- 1,2번은 코드의 가독성이 떨어지며, 오류 발생 가능성이 높다. 3번의 경우 새로운 상수가 추가되는 경우 switch와 똑같이 메서드를 잊지않고 재정의 해야하는 경우가 생길 수 있다.
- 이러한 경우에 전략 열거 타입 패턴을 사용하자
- 잔업 수당 계산을 private 중첩 열거 타입으로 위임하고, PayrollDay 열거 타입 생성자에서 적절하게 선택하도록 한다.
enum PayrollDay {
MONDAY(WEEKDAY), TUESDAY(WEEKDAY), WEDNESDAY(WEEKDAY),
THURSDAY(WEEKDAY), FRIDAY(WEEKDAY),
SATURDAY(WEEKEND), SUNDAY(WEEKEND);
// (역자 노트) 원서 1~3쇄와 한국어판 1쇄에는 위의 3줄이 아래처럼 인쇄돼 있습니다.
//
// MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
// SATURDAY(PayType.WEEKEND), SUNDAY(PayType.WEEKEND);
//
// 저자가 코드를 간결하게 하기 위해 매개변수 없는 기본 생성자를 추가했기 때문인데,
// 열거 타입에 새로운 값을 추가할 때마다 적절한 전략 열거 타입을 선택하도록 프로그래머에게 강제하겠다는
// 이 패턴의 의도를 잘못 전달할 수 있어서 원서 4쇄부터 코드를 수정할 계획입니다.
private final PayType payType;
PayrollDay(PayType payType) { this.payType = payType; }
// PayrollDay() { this(PayType.WEEKDAY); } // (역자 노트) 원서 4쇄부터 삭제
int pay(int minutesWorked, int payRate) {
return payType.pay(minutesWorked, payRate);
}
// 전략 열거 타입
enum PayType {
WEEKDAY {
int overtimePay(int minsWorked, int payRate) {
return minsWorked <= MINS_PER_SHIFT ? 0 :
(minsWorked - MINS_PER_SHIFT) * payRate / 2;
}
},
WEEKEND {
int overtimePay(int minsWorked, int payRate) {
return minsWorked * payRate / 2;
}
};
abstract int overtimePay(int mins, int payRate);
private static final int MINS_PER_SHIFT = 8 * 60;
int pay(int minsWorked, int payRate) {
int basePay = minsWorked * payRate;
return basePay + overtimePay(minsWorked, payRate);
}
}
public static void main(String[] args) {
for (PayrollDay day : values())
System.out.printf("%-10s%d%n", day, day.pay(8 * 60, 1));
}
}
- 대부분의 경우 열거 타입의 성능은 정수 상수와 별반 다르지 않다. 열거 타입을 메모리에 올리는 공간과 초기화하는 시간이 들기는 하지만 체감할 정도는 아니다.
- 그래서 필요한 원소를 컴파일 타임에 다 알 수 있는 상수 집합이라면, 항상 열거타입을 사용하자
- 열거 타입에 정의된 상수 개수가 영원히 고정 불변일 필요는 없다. 열거 타입은 나중에 상수가 추가돼도 바이너리 수준에서 호화된다.
참고자료
https://javabom.tistory.com/48
[아이템 34] int 상수 대신 열거 타입을 사용하라
Java에서 열거 타입을 지원하기 전에는 아래와 같이 정수 상수를 한 묶음으로 선언하여 사용하였다. 하지만 이런 '정수 열거 패턴'은 많은 단점들이 존재한다. public static final int APPLE_PIE = 0; public s
javabom.tistory.com
[이펙티브 자바] 아이템 34. int 상수 대신 열거 타입을 사용하라
열거 타입은 일정 개수의 상수 값을 정의하고, 그 외의 값은 허용하지 않는 것이다. 자바에서 열거 타입을 지원하기 전에는 상수를 한 묶음 선언해서 사용하고 했다. 정수 열거 패턴 기법에는 단
velog.io