일정 개수의 상수 값을 정의한 다음, 그 외의 값은 허용하지 않는 타입(ex. 사계절, 태양계의 행성, 카드게임의 카드 종류 등)
// 열거 타입 이전의 정수 열거 패턴(int 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 ORNGE_NAVEL = 0;
public static final int ORNGE_TEMPLE = 1;
public static final int ORNGE_BLOOD = 2;
정수 열거 패턴의 단점
APPLE_PIPPIN 대신 ORNGE_TEMPLE를 사용해도 컴파일러가 잡지 못한다.
접두어를 사용해 이름 충돌 방지(별도 이름 공간 X)
컴파일 하면 해당 상수 값이 클라이언트 파일에 그대로 새겨짐 -> 상수 값이 바뀌면 반드시 다시 컴파일
문자열로 출력하면 단지 숫자로 보여 의미를 알 수 없다.
같은 정수 열거 그룹에 속한 모든 상수를 순회하는 방법도 마땅치 않으며, 그룹 내 상수 개수도 알 수 없다.
정수가 아닌 문자열 상수를 사용한다면(문자열 열거 패턴) 하드코딩이 되어 오타가 있어도 컴파일러가 확인할 길이 없다. -> 런타임 버그
🍑 본론
java의 열거타입 enum
// 가장 단순한 열거 타입
public enum Apple {FUJI, PIPPIN, GRANNY_SMITH}
public enum Orange {NAVEL, TEMPLE, BLOOD}
열거 타입
java의 열거 타입은 완전형 형태의 클래스
상수 하나당 자신의 인스턴스를 하나씩 만들어 public static final 필드로 공개한다.
열거 타입은 밖에서 접근 가능 생성자를 제공하지 않으므로 사실상 final -> 생성, 확장 불가 -> 열거 타입으로 만들어진 인스턴스들은 유일성 보장 -> 인스턴스 통제
싱글턴은 원소가 하나뿐인 열거 타입, 열거 타입은 싱글턴을 일반화한 형태로 볼 수 있다.
컴파일타임 타입 안전성 제공(Apple 열거타입이 매개변수라면 Apple의 세 가지 값 중 하나가 확실)
각자의 이름 공간이 있어 이름이 같은 상수도 공존 가능(필드가 다른)
새로운 상수를 추가하거나 순서를 바꿔도 다시 컴파일하지 않아도 된다.(필드 이름만 공개되기 때문)
열거 타입은 toString 메서드로 적합한 출력 가능
메서드, 필드 추가, 인터페이스 구현 가능
데이터와 메서드를 갖는 열거 타입
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),
URANUS(8.683e+25, 2.556e7),
NEPTUNE(1.024e+26, 2.477e7);
private final double mass; // 질량(단위: 킬로그램)
private final double radius; // 반지름(단위: 미터)
private final double surfaceGravity; // 표면중력(단위: m/ 5^2)
// 중력상수(단위: m^3/ kg 5^2)
private static final double G = 6.67300 - 11;
// 생성자
Planet(double mass, double radius) {
this.mass = mass;
this.radius = radius;
surfaceGravity = G * mass / (radius * radius);
}
public double mass() { return mass; }
public double radius() { return radius; }
public double getSurfaceGravity() { return surfaceGravity; }
public double surfaceWeight(double mass) {
return mass * surfaceGravity; // F = ma
}
}
열거 타입 상수 각각을 특정 데이터와 연결지으려면 생성자에게 데이터를 받아 인스턴스 필드에 저장하면 된다.
열거 타입은 근본적으로 불변 -> 모든 필드는 final(item17)
필드를 public으로 선언 가능하지만, privat으로 두고 별도의 public 접근자 메서드를 두는게 낫다(item 16)
// 지구의 무게를 입력받아 여덟 행성의 무게를 출력하는 코드
public static void main(String[] args) {
double earthWeight = Double.parseDouble(args[0]);
double mass = earthWeight / Planet.EARTH.surfaceGravity;
for(Planet p : Planet.values())
System.out.printf("%s에서의 무게는 %f이다. %n", p, p.surfaceWeight(mass));
}
values : 열거 타입 안에 정의된 상수들의 값을 배열에 담아 반환하는 정적 메서드
toString : 상수 이름을 문자열로 반환
/**
* MERCURY에서의 무게는 69.912739이다.
* VENUS에서의 무게는 167.434436이다.
* EARTH에서의 무게는 185.000000이다.
* MARS에서의 무게는 70.226739이다.
* JUPITER에서의 무게는 467.990696이다.
* SATURN에서의 무게는 197.120111이다.
* URANUS에서의 무게는 167.398264이다.
* NEPTUNE에서의 무게는 210.208751이다.
*/
만약 열거 타입 내 상수를 하나 제거한다면?
제거한 상수를 참조하지 않는 클라이언트에는 아무 영향이 없다.
제거한 상수를 참조하는 클라이언트는 컴파일 오류
열거 타입을 선언한 클래스 혹은 그 패키지에서만 유용한 기능은 private이나 package-private 메서드로 구현한다(item 15)
널리 쓰이는 열거 타입은 톱레벨 클래스로, 특정 톱레벨 클래스에서만 사용되면 해당 클래스의 멤버 클래스(item 24)로 만든다.
상수마다 동작이 달라져야 하는 상황에서의 열거 타입
switch문
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 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 재정의, 재정의하지 않으면 컴파일 오류
상수별 메서드 구현과 상수별 데이터 결합
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);
}
public static void main(String[] args) {
double x = Double.parseDouble(args[0]);
double y = Double.parseDouble(args[1]);
for(Operation op : Operation.values())
System.out.printf("%f %s %f = %f%n", x, op, y, op.apply(x, y));
}
열거 타입에는 상수 이름을 입력받아 이름에 해당하는 상수를 반환해주는 valueOf(String) 메서드가 자동 생성된다.
fromString : toString이 반환하는 문자열을 열거 타입 상수로 변환해주기
private static final Map<String, Operation> stringToEnum =
Stream.of(values()).collect(
toMap(Object::toString, e -> e));
// 지정한 문자열에 해당하는 Operation을 반환한다.
public static Optional<Operation> fromString(String symbol) {
return Optional.ofNullable(stringToEnum.get(symbol));
}
열거 타입 상수는 생성자에서 자신의 인스턴스를 맵에 추가할 수 없다.(컴파일 오류 혹은 NullPointerException)
열거 타입의 정적 필드 중 열거 타입의 생성자에게 접근할 수 있는 것은 상수 변수뿐이다.(item 24)
상수별 메서드 구현에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.
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;
}
}
간결하지만, 관리 관점에서는 위험한 코드이다. 휴가와 같은 경우 새로운 경우로 추가해야한다.
따라서, 전략을 구성하고 새로운 상수를 추가할 때 전략을 선택하도록 한다.
아래 코드는 switch 문보다 복잡하지만 더 안전하고 유연하다.
enum PayrollDay {
MONDAY (WEEKDAY), TUESDAY (WEEKDAY), WEDNESDAY (WEEKDAY) , THURSDAY (WEEKDAY), FRIDAY (WEEKDAY),
SATURDAY (WEEKEND), SUNDAY (WEEKEND);
private final PayType payType;
PayrollDay(PayType рауТуре) { this. 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 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);
}
}
}
- switch 문은 열거 타입의 상수별 동작을 구현하는데 적합하지 않다.
- 하지만 기존 열거 타입에 상수별 동작을 혼합해 넣는 경우 switch문이 좋은 선택이 될 수 있다.
```java
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("알 수 없는 연산 : " + op);
}
}
추가하려는 메서드가 의미상 열거 타입에 속하지 않는다면 직접 만든 열거 타입이라도 위 방식을 적용하는게 좋다. 열거 타입 안에 포함할 만큼 유용하지 않은 경우도 마찬가지.
youngkimi
commented
3 months ago
Chapter : 6. 열거 타입과 애너테이션
Item : 34. int 상수 대신 열거 타입을 사용하라
Assignee : heon118
🍑 서론
열거 타입
일정 개수의 상수 값을 정의한 다음, 그 외의 값은 허용하지 않는 타입(ex. 사계절, 태양계의 행성, 카드게임의 카드 종류 등)
정수 열거 패턴의 단점
🍑 본론
java의 열거타입 enum
열거 타입
데이터와 메서드를 갖는 열거 타입
만약 열거 타입 내 상수를 하나 제거한다면?
열거 타입을 선언한 클래스 혹은 그 패키지에서만 유용한 기능은 private이나 package-private 메서드로 구현한다(item 15)
널리 쓰이는 열거 타입은 톱레벨 클래스로, 특정 톱레벨 클래스에서만 사용되면 해당 클래스의 멤버 클래스(item 24)로 만든다.
상수마다 동작이 달라져야 하는 상황에서의 열거 타입
switch문
추상 메서드 선언 및 각 상수별 클래스 몸체 재정의
상수별 메서드 구현과 상수별 데이터 결합
toString으로 override로 인한 편리한 출력
열거 타입에는 상수 이름을 입력받아 이름에 해당하는 상수를 반환해주는 valueOf(String) 메서드가 자동 생성된다.
fromString : toString이 반환하는 문자열을 열거 타입 상수로 변환해주기
열거 타입 상수는 생성자에서 자신의 인스턴스를 맵에 추가할 수 없다.(컴파일 오류 혹은 NullPointerException)
열거 타입의 정적 필드 중 열거 타입의 생성자에게 접근할 수 있는 것은 상수 변수뿐이다.(item 24)
상수별 메서드 구현에는 열거 타입 상수끼리 코드를 공유하기 어렵다는 단점이 있다.
간결하지만, 관리 관점에서는 위험한 코드이다. 휴가와 같은 경우 새로운 경우로 추가해야한다.
따라서, 전략을 구성하고 새로운 상수를 추가할 때 전략을 선택하도록 한다.
아래 코드는 switch 문보다 복잡하지만 더 안전하고 유연하다.
🍑 결론
각 상수를 특정 데이터와 연결 짓거나 상수마다 다르게 동작할 때 필요하다.
Referenced by
-