필요한 원소를 컴파일타임에 다시 알 수 있는 상수 집합이라면 항상 열거 타입을 사용하라.
열거 타입에 정의된 상수 개수가 영원히 고정 불변일 필요는 없다.
📌 정수 열거 패턴 (int enum pattern)과 문자열 열거 패턴 (string enum pattern)
정수 열거 패턴 기법에는 단점이 많다.
public static final int APPLE_FUJI = 0;
public static final int APPLE_PIPPIN = 1;
public static final int APPLE_GRANNY_SMITH = 2;
public static final int ORANGE_NAVEL = 0;
public static final int ORANGE_TEMPLE = 1;
public static final int ORANGE_BLOOD = 2;
- 타입 안전을 보장할 방법이 없으며, 표현력이 좋지 않다.
- 잘못된 상수를 메서드에 전달하고 동등 연산자(==)로 비교하더라도 컴파일러가 아무런 경고 메시지를 출력하지 않는다.
- 컴파일하면 그 값이 클라이언트 파일에 그대로 새겨지기 때문에, 상수의 값이 바뀌면 클라이언트도 반드시 다시 컴파일해야 한다.
- 정수 상수는 문자열로 출력하기가 어렵다. 그 값을 출력하거나 디버거로 살펴볼 때도, 의미가 아닌 숫자로 보이며, 같은 정수 열거 그룹에 속한 상수가 몇 개인지도 알 수 없다.
문자열 열거 패턴 기법은 (이 책에서 말하길) 더 나쁘다고 한다.
public static final String APPLE_FUJI = "apple fuji";
public static final String APPLE_PIPPIN = "apple pippin";
public static final String APPLE_GRANNY_SMITH = "apple granny smith";
상수의 의미를 출력할 수 있다는 점은 좋지만, 더 나쁜 변형이다.
하드코딩한 문자열에 오타가 있어도 컴파일러는 확인할 길이 없으며, 문자열 비교에 따른 성능 저하도 생긴다.
📌 열거 타입 (Enumration Type)
자바는 열거 패턴의 단점을 없애고, 클래스의 장점을 가져오는 열거 타입(enum type)을 제시했다.
열거 타입은 일정 개수의 상수값을 정의하고, 그 이외의 값은 허용하지 않는다! (싱글턴)
// public enum 열거타입이름 {...}
public enum Week {MONDAY, TUESDAY, WEDNESDAY, THURSDAY, ...};
- enum type 자체는 클래스다.
- 상수 하나당, 자신의 인스턴스를 만들어 public static final 필드로 공개한다.
- enum type은 밖에서 접근할 수 있는 생성자를 제공하지 않으므로, 사실상 final이다.
- 클라이언트가 인스턴스를 직접 생성하거나 확장할 수 없으므로, enum type으로 만들어진 인스턴스들은 딱 한 개씩만 존재한다.
- 싱글턴은 원소가 하나뿐인 enum type이고, enum type은 싱글턴을 일반화한 형태라 볼 수 있다.
- enum type은 컴파일타임에서 타입 안정성을 제공한다.
- 위 코드에서 Week enum type을 매개변수로 선언했다면, 건네받은 참조는 (null이 아니라면) Week의 값 중 하나임이 확실하다.
- 다른 타입의 값을 넘기려고 하면 컴파일 에러가 발생한다.
- 각자의 이름 공간이 있으며, enum type에 새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일하지 않아도 된다.
- 공개되는 것이 오직 필드 이름뿐이라, 상수 값이 클라이언트로 컴파일되어 각인되지 않기 때문이다.
- enum type에는 임의의 메서드나 필드를 추가할 수 있고, 임의의 인터페이스를 구현하게 할 수도 있다.
- enum type은 toString 메서드는 출력하기에 적합한 문자열을 내어준다.
- Object 메서드들과 Comparable, Serialiable을 구현했으며, 직렬화 형태도 웬만큼 변형을 가해도 문제없이 동작하도록 구현해두었다.
📌 Enum type에 method와 field를 추가하는 경우
Enum type 상수 각각을 특정 데이터와 연결지으려면, 생성자에서 데이터를 받아 인스턴스 필드에 저장하면 된다.
단순하게는 그저 상수 모음일 뿐이지만, 실제로는 클래스이므로 고차원의 추상 개념 하나를 완벽히 표현 가능하다.
public enum Planet {
MERCURY(3.302e+23, 2.439e6),
VENUS(4.869e+24, 6.052e6),
EARTH(5.975e+24, 6.378e6);
private final double mass; // 질량
private final double raduis; // 반지름
private final double surfaceGravity; // 표면중력
private static final double G = 6.67300E-11; // 중력 상수
Planet(double mass, double raduis) {
this.mass = mass;
this.raduis = raduis;
this.surfaceGravity = G * mass / (raduis * raduis);
}
public double mass() { return mass; }
public double radius() { return raduis; }
public double surfaceGravity() { return surfaceGravity; }
public double surfaceWeight(double mass) {
return mass * surfaceGravity; // F = ma
}
}
이 때, Enum type은 근본적이라 불변이라 모든 필드는 final이어야 한다. (Item 17)
그리고 필드를 public으로 선언해도 되지만, private로 두고 별도의 public 접근자 메서드를 두는 게 낫다. (Item 16)
public class WeightTable {
public static void main(String[] args) {
double earthWeight = Double.parseDouble("185");
double mass = earthWeight / Planet.EARTH.surfaceGravity();
for (Planet p : Planet.values()) {
System.out.printf("%s에서의 무게는 %f이다.%n", p, p.surfaceWeight(mass) );
}
}
}
MERCURY에서의 무게는 69.912739이다.
VENUS에서의 무게는 167.434436이다.
EARTH에서의 무게는 185.000000이다.
Process finished with exit code 0
Enum type은 내부에 정의된 상수들의 값을 배열에 담아 반환하는 정적 메서드 values를 제공한다.
그리고 각 Enum type의 값의 toString 메서드는 상수 이름을 문자열로 반환해준다.
enum type에서 제거된 상수를 참조하지 않는 클라이언트는 아무 영향이 없다.
만약, 제거된 상수를 참조하는 클라이언트는 유용한 메시지를 담은 컴파일 오류가 발생할 것이고,
클라이언트를 다시 컴파일하지 않으면 런타임에 유용한 예외가 발생할 것이다.
정수 열거 패턴에서는 기대할 수 없는 가장 바람직한 대응이라 볼 수 있다.
열거타입에 선언한 클래스 혹은 그 패키지에서만 유용한 기능은 private나 package-private 메서드로 구현하면 된다.
✒️ Enum type 선언
널리 쓰이는 enum type은 톱레벨 클래스로 만들고, 특정 톱레벨 클래스에서만 쓰인다면 해당 클래스의 멤버 클래스(item 24)로 만들어라.
예를 들어, 반올림 모드를 뜻하는 java.math.RoundingMode는 BigDecimal이 사용한다.
그런데 반올림 모드는 여러 곳에서 유용한 개념이라 자바 라이브러리 설계자는 RoundingMode를 톱레벨로 올렸다.
📌 상수별 메서드 구현 (constant-specific method implementation)
하나의 메서드가 상수별로 다르게 동작해야 할 때는 switch문 대신 상수별 메서드 구현을 사용하라.
1️⃣ As-is
// 이게 최선인가?
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);
}
}
위 스니펫은 잘 동작하지만, 새로운 상수를 추가하면 해당 case문을 추가해야한다.
그리고 혹시라도 깜빡하면 컴파일은 되지만 AssertionError가 발생한다.
마지막 throw는 실제로는 도달할 일이 없지만 기술적으로는 가능하기에 생략하면 컴파일조차 안 된다.
2️⃣ To-be
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;}},
DIVIDE {public double apply(double x, double y){return x / y;}};
public abstract double apply(double x, double y);
}
apply가 추상 메서드이므로 재정의하지 않으면 컴파일 오류로 알려준다.
그리고 새로운 상수를 추가해도, apply를 재정의해야 한다는 사실을 깜빡하기는 어려울 것이다.
3️⃣ 상수별 메서드 구현과 상수별 데이터 결합
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;}},
DIVIDE("/") {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);
}
Operation의 toString을 재정의하여 해당 연산을 뜻하는 기호를 반환하도록 한 예다.
public class Main {
public static void main(String[] args) {
double x = 1.0;
double y = 2.0;
for (Operation op : Operation.values())
System.out.printf("%f %s %f = %f%n", x, op, y, op.apply(x, y));
}
}
1.000000 + 2.000000 = 3.000000
1.000000 - 2.000000 = -1.000000
1.000000 * 2.000000 = 2.000000
1.000000 / 2.000000 = 0.500000
enum type은 상수 이름을 입력받아 그 이름에 해당하는 상수를 반환해주는 valueOf(String) 메서드가 자동 생성된다.
Operation i = Operation.valueOf("PLUS");
System.out.println(i); // PLUS
열거 타입의 toString 메서드를 재정의했다면, toString이 반환하는 문자열을 해당 enum type 상수로 변환해주는 fromString 메서드도 함께 제공하는 것을 고려해라.
private static final Map<String, Operation> stringToEnum =
Stream.of(values())
.collect(toMap(Object::toString, e -> e));
public static Optional<Operation> fromString(String symbol) {
return Optional.ofNullable(stringToEnum.get(symbol));
}
여기서 주의할 점이 있다. enum type 상수는 생성자에서 자신의 인스턴스를 맵에 추가할 수 없다.
enum type의 정적 필드 중 생성자에서 접근할 수 있는 것은 상수 변수 뿐이다. (Item 24)
enum type 생성자가 실행되는 시점에는 정적 필드들이 초기화 되기 전이라 자기 자신을 추가하지 못하도록 제약이 꼭 필요하다.
이 제약의 특수한 예로, enum type 생성자에서 같은 enum type의 다른 상수에도 접근할 수 없다.
📌 전략 열거 타입 패턴
열거 타입 상수 일부가 같은 동작을 공유한다면 전략 열거 타입 패턴을 사용하라.
1️⃣ As-is
다음 코드는 시간당 기본 임금과 그날 일한 시간이 주어지면 일단을 계산해주는 메서드를 가진 enum type이다.
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;
}
}
- 간결해보이지만 관리하는데 있어 위험하다.
- 새로운 값을 enum type에 추가하고, 그 값을 처리하는 case문에도 반드시 넣어줘야 한다.
- 만약 까먹고 case문에 추가를 하지 않은 경우, 휴일 수당을 받지 못하고 평일 수당을 받게 된다.
상수별 메서드 구현으로 급여를 정확히 계산하는 방법은 두 가지다.
- 잔업 수당을 계산하는 코드를 모든 상수에 중복해서 넣으면 된다.
- 계산 코드를 평일용과 주말용으로 나누어 각각을 도우미 메서드로 작성하고 각 상수가 자신에게 필요한 메서드를 선택하도록 한다.
그러나 두 방법 모두 코드가 장황해져 가독성이 크게 떨어지고 오류 발생 가능성이 높아진다.
2️⃣ To-be
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);
}
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 minsWorked, int payRate);
private static final int MINS_PER_SHIFT = 8 * 60;
public int pay(int minsWorked, int payRate){
int basePay = minsWorked * payRate;
return basePay + overtimePay(minsWorked, payRate);
}
}
}
잔업수당 계산을 private 중첩 enum type인 PayType 위임하고,
PayrollDay enum type의 생성자에서 적절한 잔업수당 전략을 선택하도록 하면 된다.
이 방법은 switch문보다 복잡하지만 더 안전하고 유연하다.
📌 switch 문이 적합한 경우
기존 열거 타입에 상수별 동작을 혼합해 넣을 때는 switch문이 좋은 선택이 될 수 있다.
switch문은 enum type의 상수별 동작을 구현하는데 대부분 적합하지 않다.
그래도 서드 파티에서 가져온 Opeartion enum type이 있는데, 각 연산의 반대 연산을 반환하는 메서드가 필요하다고 가정해보자.
public static Operation inverse(Operation op) {
switch (op) {
case PLUS: return Operation.MINUS;
case MINUS: return Operation.PLUS;
case TIMES: return Operation.DIVIDE;
case DIVIDE: return Operation.TIMES;
default: throw new AssertionError("알 수 없는 연산: " + this);
}
}
추가하려는 메서드가 의미상 enum type에 속하지 않는다면, 직접 만든 enum type이 아니라도 이 방식이 낫다.
종종 쓰이지만 enum type 안에 포함할 만큼 유용하지 않은 경우도 마찬가지다.