Effective Javaのenum編を読んだので自分なりにまとめます。結構定数のようなものをintとかstringで管理していることがあります。

これらはint enumパターンのように呼ばれるお手軽だけど脆い実装パターンです。

enumの目覚め

例えばスポーツジムの会員種別によって支払い金額を決定するというパターンで、int enumパターンを見てみます。

public class GymConst {
	public static final int regular = 1;
	public static final int afternoon = 2;
	public static final int fulltime = 3;
}

public static void badPay(int type) {
		if(type == GymConst.regular) {
			System.out.println("7700円の会費を支払いました");
		} else if (type == GymConst.afternoon) {
			System.out.println("8800円の会費を支払いしました");
		} else if(type == GymConst.fulltime) {
			System.out.println("14300円の会費を支払いました");
		} else {
			System.out.println("エラー");
		}
	}

このようint enumパターンをロジックに組み込んでいるコードはよく見てきました。

何が悪いかというと

これはただの数字であるということ
- デバッグもただ数字が表れるだけ
- 定数の代わりに直接数値を入れても動いてしまう
- 関連のない定数同士が比較可能

enumにすることでこれらの問題を解決できます

public enum MemberType {
	REGULAR,
	AFTERNOON,
	FULLTIME
}

public static void pay(MemberType memberType) {
	if(memberType == MemberType.REGULAR) {
		System.out.println("7700円の会費を支払いしました");
	} else if(memberType == MemberType.AFTERNOON) {
		System.out.println("8800円の会費を支払いしました");
	} else if(memberType == MemberType.FULLTIME) {
		System.out.println("14300円の会費を支払いしました");
	} else {
		System.out.println("エラー");
	}
}

今までならばエラーにならなかった危ないコードを書くことはできません

if(memberType == 1) {
			System.out.println("7700円の会費を支払いしました");
}

またデフォルトでも十分なログが出力されます

if(memberType == MemberType.REGULAR) {
			System.out.println("7700円の会費を支払いしました。会員種別 = " + memberType);
}

7700円の会費を支払いしました。会員種別 = REGULAR

int enumパターンを止めるだけでも、安全なコードを書くことができます

enumのメソッド

enumを覚醒させる前にenumの持っているメソッドを少し見ていきます。

public void test2() {
	for(MemberType m : MemberType.values()) {
		System.out.println("Name = " + m.name());
		System.out.println("Ordinal = " + m.ordinal());
	}
	System.out.println("length = " + MemberType.values().length);
}

Name = REGULAR

Ordinal = 0

Name = AFTERNOON

Ordinal = 1

Name = FULLTIME

Ordinal = 2

length = 3

name
- enum列挙子の名前
ordinal
- enumの序数
- 実際に使うのは止めた方がいい。定義順によって値が変動するため
length
- 長さは0始まりでなくて1始まり

enumの覚醒

ここまでは普通のenumについて見てきましたが、ここからはこのenumを覚醒させます

ジム会員種別の情報をenumに定義してしまいます。

public enum MemberType {
	REGULAR(7700),
	AFTERNOON(8800),
	FULLTIME(14300);

	private final int price;
	
	// newはできませんが、enumにて定義することでコンストラクタにて変数を初期化できます
	private MemberType(int price) {
		this.price = price;
	}
	
	public void pay() {
		System.out.println(String.valueOf(this.price) + "円の会費を支払いました");
	}
	
}

enum自体に価格情報と支払い機能を実装させることができました。こうすると利用する時の条件分岐が消えます

public static void pay2(MemberType memberType) {
		memberType.pay();
}

なんということでしょう。これならば例えゴールド会員などの会員種別が増えたとしても、利用側はコードを修正する必要がありません。

enumが覚醒するとちょっと便利なクラスのようになります

戦略enumパターン

もしも会員種別によって割引をしたいなんて時はどうすればいいでしょうか？現状、enumにはpayメソッドがあるのですが、同様に割引するメソッドを作成してみます。

public enum MemberType {
	REGULAR(7700),
	AFTERNOON(8800),
	FULLTIME(14300);

	private final int price;
	
	private MemberType(int price) {
		this.price = price;
	}
	
	public void pay() {
		int sub = this.sale();
		System.out.println(String.valueOf(this.price - sub) + "円の会費を支払いました");
		System.out.println("割引金額 = " + String.valueOf(sub));
	}
	
	// 会員種別によって割引を行うメソッド
	private int sale() {
		int sale = 0;
		switch (this) {
		case AFTERNOON:
			sale = 200;
			break;
		case FULLTIME:
			sale = 500;
			break;
		default:
			sale = 100;
			break;
		}
		return sale;
	}
	
}

switch文に対してthisを渡してあげれば、会員種別ごとに割引金額を算出できるメソッドを作ることができます。

しかし、先ほどまでで折角if文を消せたのに、これでは会員種別が増えるごとにcaseが増えていく地獄の始まりです

そこで戦略的enumを使います。ポイントはenumの中にenumを定義してしまうという点です。そしてどういった割引(戦略)を行うのか選択させることを、enumに対して強制させます。

public enum MemberType {
	REGULAR(7700,SaleType.NORMAL),
	AFTERNOON(8800,SaleType.HIGH),
	FULLTIME(14300,SaleType.VERYHIGH);

	private final int price;
	
	private final SaleType saleType;
	
	private MemberType(int price,SaleType saleType) {
		this.price = price;
		this.saleType = saleType;
	}
	
	public void pay() {
		int sub = this.saleType.getSale();
		System.out.println(String.valueOf(this.price - sub) + "円の会費を支払いました");
		System.out.println("割引金額 = " + String.valueOf(sub));
	}
	
	private enum SaleType {
		NORMAL {
			@Override
			int getSale() {
				return 100;
			}
		},
		HIGH {
			@Override
			int getSale() {
				return 200;
			}
		},
		VERYHIGH{
			@Override
			int getSale() {
				return 500;
			}
		};
		// 各enumが実装すべきメソッドを定義できる
		abstract int getSale();
	}
}

SaleTypeというenumを定義しています。これは割引の具体的な戦略を持っています
抽象メソッドを定義することで、enumがその実装を必須とすることができます
MemberTypeのコンストラクタでSaleTypeを引数に加えれば、戦略の選択を強制できます

実際に使ってみると以下のようにログが出ます

7600円の会費を支払いました

割引金額 = 100

8600円の会費を支払いました

割引金額 = 200

13800円の会費を支払いました

割引金額 = 500

enumが覚醒しているのがよくわかりますね。

enum限界突破

最後にenumを限界突破させます。通常enumは拡張できません。しかしインターフェースを実装することができます。

今回は上記の会員種別に加えてビジターを追加したいとします。しかしビジターは会員ではないので、既存の会員種別を拡張して実装しようと思います。

まず共通のインターフェースを定義します

public interface Pay {
	void pay();
}

これを既存の会員種別に実装させます

public enum MemberType implements Pay{
	REGULAR(7700,SaleType.NORMAL),
	AFTERNOON(8800,SaleType.HIGH),
	FULLTIME(14300,SaleType.VERYHIGH);

	private final int price;
	
	private final SaleType saleType;
	
	private MemberType(int price,SaleType saleType) {
		this.price = price;
		this.saleType = saleType;
	}
	
	// これを追加
	@Override
	public void pay() {
		int sub = this.saleType.getSale();
		System.out.println(String.valueOf(this.price - sub) + "円の会費を支払いました");
		System.out.println("割引金額 = " + String.valueOf(sub));
	}
	
	private enum SaleType {
		NORMAL {
			@Override
			int getSale() {
				return 100;
			}
		},
		HIGH {
			@Override
			int getSale() {
				return 200;
			}
		},
		VERYHIGH{
			@Override
			int getSale() {
				return 500;
			}
		};
		abstract int getSale();
	}
}

Payをimplementsしたら、もともとpayメソッドを持っていたのでオーバーライドのアノテーションを付けておくだけです。

次にVisitorというenumを作成します

public enum Visitor implements Pay{
	DAY(3000),
	WEEK(5000);
	
	public final int price;
	
	private Visitor(int price) {
		this.price = price;
	}
	
	@Override
	public void pay() {
		System.out.println(String.valueOf(this.price)+ "円の支払いをしました");
	}
	
}

Visitorは当日会員と1週間会員があり、それぞれ料金が異なっています。

これらを利用してみます

public static void pay3(Pay pay) {
		pay.pay();
}

Payインターフェースを実装したenumのpayメソッドを呼び出します。

例えば以下のように実行します

public void test() {
	Payment.pay3(MemberType.AFTERNOON);
	Payment.pay3(Visitor.DAY);
}

8600円の会費を支払いました

割引金額 = 200

3000円の支払いをしました

問題なく動作します。インターフェースを実装することでenumは更に限界突破しました。

すべてのenumをテストする

enumかつPayのサブクラスであることを境界型トークンを利用して表現して、getEnumConstantsメソッドを利用してすべてのenumの要素を取得します

public static <T extends Enum<T> & Pay> void pay4(Class<T> payEnumType) {
	for(Pay pay : payEnumType.getEnumConstants()) {
		pay.pay();
	}
}

これを利用する時はenumでありPayを実装しているクラスを渡します

public void test5() {
	System.out.println("Visitor---");
	Payment.pay4(Visitor.class);
	System.out.println("Member---");
	Payment.pay4(MemberType.class);
}

Visitor---

3000円の支払いをしました

5000円の支払いをしました

Member---

7600円の会費を支払いました

割引金額 = 100

8600円の会費を支払いました

割引金額 = 200

13800円の会費を支払いました

割引金額 = 500

このようにインターフェースを利用することで、拡張可能なenumを模倣することができます。

おまけ

境界ワイルドカードを利用する

public static void pay5(Collection<? extends Pay> paySet) {
	for(Pay pay: paySet) {
		pay.pay();
	}
}

public void test6() {
	System.out.println("Visitor---");
	Payment.pay5(Arrays.asList(Visitor.values()));
	System.out.println("Member---");
	Payment.pay5(Arrays.asList(MemberType.values()));
}

Visitor---

3000円の支払いをしました

5000円の支払いをしました

Member---

7600円の会費を支払いました

割引金額 = 100

8600円の会費を支払いました

割引金額 = 200

13800円の会費を支払いました

割引金額 = 500

参考書籍

Effective Java 第3版

Java | enum超覚醒