타입 안전 열거 패턴(typesafe enum pattern)
열거 타입은 거의 모든 상황에서 타입 안전 열거 패턴보다 우수하다.
단점으로 한 가지가 있는데, 타입 안전 열거 패턴은 열거한 값들을 그대로 가져온 다음 값을 더 추가해 다른 목적으로 확장할 수 있는 반면, 열거 타입은 그렇게 할 수 없다. 이미 열거 타입은 추상클래스인 Enum을 상속해서 사용하기 때문이다.
하지만 대부분 열거 타입을 확장하는 것은 좋지않은 생각이다.
- 확장한 타입의 원소는 기반 타입의 원소로 취급하지만, 그 반대는 성립하지 않는다.
- 기반 타입과 확장된 타입들의 원소 모두를 순회할 방법도 마땅치 않다.
- 확장성을 높이려면 고려할 요소가 늘어나 설계와 구현이 더 복잡해진다
아래는 타입 안전 열거 패턴의 예시 소스다.
public class Fruit {
public static final Fruit apple = new Fruit("apple");
public static final Fruit banana = new Fruit("banana");
public static final Fruit mango = new Fruit("mango");
private final String name;
public Fruit(String name) {
this.name = name;
}
@Override
public String toString() {
return name;
}
}
그런데, 확장할 수 있는 열거 타입이 어울리는 쓰임이 최소한 하나는 있고, 그 예시가 연산 코드(operation code)다.
Enum의 확장: Interface 구현
API가 제공하는 기본 연산 외에 사용자 확장 연산을 추가할 수 있게 열어줘야할 때가 있다. 열거타입으로 이러한 효과를 낼 수 있는 방법이 있는데, 기본 아이디어는 연산 코드용 인터페이스를 정의하고, 열거 타입이 이 인터페이스를 구현하게 하면 된다.
열거 타입이 그 인터페이스의 표준 구현체 역할을 하는 것이다.
//interface
public interface Operation {
double apply(double x, double y);
}
public enum BasicOperation implements 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;
BasicOperation(String symbol) {
this.symbol = symbol;
}
@Override public String toString() {
return symbol;
}
}
열거 타입인 BasicOperation은 확장할 수 없지만 인터페이스인 Operation은 확장할 수 있고,
이 인터페이스를 연산의 타입으로 사용하면 된다. 지수 연산과 나머지 연산을 추가한다면 아래와 같다.
public enum ExtendedOperation implements Operation {
EXP("^") {
public double apply(double x, double y) {
return Math.pow(x, y);
}
},
REMAINDER("%") {
public double apply(double x, double y) {
return x % y;
}
};
private final String symbol;
ExtendedOperation(String symbol) {
this.symbol = symbol;
}
@Override public String toString() {
return symbol;
}
}
Operation 인터페이스를 사용하도록 작성되어 있으면 새로 작성한 연산은 기존 연산을 쓰던 곳 어디든 쓸 수 있다.
apply 메소드가 인터페이스에 선언되어 있으니 열거 타입에 따로 추상 메소드로 선언하지 않아도 된다.
타입 수준에서 확장된 열거 타입 받기
개별 인스턴스뿐 아니라 타입 수준에서도 기본 열거 타입 대신 확장된 열거 타입을 넘겨 확장된 열거 타입의 원소 모두 사용하게 할 수 있다.
다음은 테스트 메소드를 만드는 예시다.
public static void main(String[] args) {
double x = Double.parseDouble(args[0]);
double y = Double.parseDouble(args[1]);
test(ExtendedOperation.class, x, y);
}
private static <T extends Enum<T> & Operation> void test(
Class<T> opEnumType, double x, double y) {
for (Operation op : opEnumType.getEnumConstants())
System.out.printf("%f %s %f = %f%n", x, op, y, op.apply(x, y));
}
main 메소드에서 test 메소드에 class 리터럴을 넘겨 확장된 연산들이 무엇인지 알려준다. class 리터럴은 한정적 타입 토큰 역할을 한다.
매개변수의 선언은 Class 객체가 열거 타입인 동시에 Operation의 하위 타입이어야 한다는 뜻이다.
다음 대안은 Class 객체 대신 한정적 와일드카드 타입인 Collection<? extends Operation>을 넘기는 방법이다.
public static void main(String[] args) {
double x = Double.parseDouble(args[0]);
double y = Double.parseDouble(args[1]);
test(Arrays.asList(ExtendedOperation.values()), x, y);
}
private static void test(Collection<? extends Operation> opSet,
double x, double y) {
for (Operation op : opSet)
System.out.printf("%f %s %f = %f%n", x, op, y, op.apply(x, y));
}
이렇게 사용한다면 여러 구현 타입의 연산을 조합해 호출할 수 있다. 하지만 특정 연산에서는 EnumSet과 EnumMap을 사용 못한다.
HashMap이나 Hashset으로는 Operation 인터페이스를 넣을 수 있지만,
EnumMap은 다른 타입끼리 묶을 수 없었고, EnumMap은 인터페이스를 키 값으로 넣을 수 없었다.
인터페이스를 이용해 확장 가능한 열거 타입을 구현하는 방식의 문제점
열거 타입끼리 구현을 상속할 수 없다. 아무 상태에도 의존하지 않는 경우에는 디폴트 구현을 이용해 인터페이스에 추가하는 방법이 있다.
반면 Operation에는 연산 기호를 저장하고 찾는 로직이 BasicOperation, ExtendedOperation 모두에 들어가야만 한다.
현재의 경우에는 중복량이 적으니 문제되지 않지만 공유하는 기능이 많다면 별도의 도우미 클래스, 정적 도우미 메소드로 분리해 코드 중복을 없앨 수 있다. 자바 라이브러리도 이번 아이템에서 말한 패턴을 사용한다.
java.nio.file.LinkOption 열거 타입은 CopyOption, OpenOption 인터페이스를 구현했다.
정리
열거 타입 자체는 확장할 수 없지만 인터페이스와 그 인터페이스를 구현하는 기본 열거 타입을 함께 사용해 같은 효과를 낼 수 있다.
클라이언트는 이 인터페이스를 구현해 자신만의 열거 타입을 만들 수 있고 API가 인터페이스 기반으로 작성됐다면 기본 열거 타입의 인스턴스가 쓰이는 모든 곳을 새로 확장한 열거 타입의 인스턴스로 대체할 수 있다.
* 위 글은 EffectiveJava 3/E 책 내용을 정리한 글로, 저작권 관련 문제가 있다면 댓글로 남겨주시면 즉각 삭제조치 하겠습니다.
'Reading > Effective Java' 카테고리의 다른 글
[Effective-Java] Item 40. @Override 애노테이션을 일관되게 사용하라 (0) | 2021.10.31 |
---|---|
[Effective-Java] Item 39. 명명 패턴보다 애너테이션을 사용하라 (0) | 2021.10.31 |
[Effective-Java] Item 37. ordinal 인덱싱 대신 EnumMap을 사용하라 (0) | 2021.10.31 |
[Effective-Java] Item 36. 비트 필드 대신 EnumSet을 사용하라 (0) | 2021.10.31 |
[Effective-Java] Item 35. ordinal 메소드 대신 인스턴스 필드를 사용하라 (0) | 2021.10.31 |