文字列定数ためだけのenumを使う場合について

Question

いつもお世話になります。

今日はstatic finalとenumを使う場面について皆さんの意見を聞かせて頂きたいです。

enum定番

public class Main {
    private enum Sex {
        男性, 女性;
    }

    public static void main(String[] args) {
        Sex sex = Sex.女性;

        if (isMale(sex)) {
            System.out.println("男性です");
        } else {
            System.out.println("男性ではありません。");
        }
    }

    // type safe
    private static boolean isMale(Sex sex) {
        return sex == Sex.男性;
    }
}

一般的なeunmを使うべき場面

ざっくり説明で、あるグループを何種類かに分ける場合・・ですかね。

• 季節 {春、夏、秋、冬}
• 性別 {男性、女性}
• 会員ランク {プラチナ、ゴールド、シルバー、ブロンズ}

一般的なenumのメリット

• 制限されたインスタンス数、静的クラス
• type safe
• 可読性

議論した内容

下記、内部システムのparam_1, param_2, param_3の定義について。

• 内部システム：リクエストパラメータ文字列を生成し、外部システムに渡す(http get)

public class InternallSystem {
    public String requestToExternal() {
        // 内部システムの値
        String param_1 = "value1";
        String param_2 = "value2";
        String param_3 = "value3";

        // リクエストパラメータ生成
        StringBuilder sb = new StringBuilder();

        // FIXME param_1,param_2,param_3をリファクターする
        sb.append("param_1").append(":").append(param_1).append(",");
        sb.append("param_2").append(":").append(param_2).append(",");
        sb.append("param_3").append(":").append(param_3);

        // 外部システム呼び出し
        return "外部システム/xx.action?" + sb.toString();
    }
}

• 外部システム：リクエストパラメータの文字列を分析してなんかする。

import java.util.Arrays;
import java.util.List;

public class ExternalSystem {

    private static final String PARAM_SPLIT_REGEX = ",";
    private static final String KEY_VALUE_SPLIT_REGEX = ":";

    public void actionMethod(String requestParam) {
        // パラメータをガンマで分割してListへ格納する
        List<String> params = Arrays.asList(requestParam.split(PARAM_SPLIT_REGEX));

        // keyがparam_1を検索する
        String param_1 = params.stream()
                .filter(ele -> ele.split(KEY_VALUE_SPLIT_REGEX)[0].equals("param_1"))
                .findFirst().get();

        // keyがparam_2を検索する
        String param_2 = params.stream()
                .filter(ele -> ele.split(KEY_VALUE_SPLIT_REGEX)[0].equals("param_2"))
                .findFirst().get();

        // keyがparam_3を検索する
        String param_3 = params.stream()
                .filter(ele -> ele.split(KEY_VALUE_SPLIT_REGEX)[0].equals("param_3"))
                .findFirst().get();
        // param_1, param_2, param_3の後処理は省略
    }
}

候補案

• final staticで定義する。

private static final String EXTERNAL_KEY_PARAM_1 = "param_1";
private static final String EXTERNAL_KEY_PARAM_2 = "param_2";
private static final String EXTERNAL_KEY_PARAM_3 = "param_3";

• enumで定義する

public enum Key {
    PARAM_1("param_1"),
    PARAM_2("param_2"),
    PARAM_3("param_3");

    private String key;

    Key(String key) {
        this.key = key;
    }

    public String getKey() {
        return key;
    }
}

私の考え

私はfianl staticで十分だと思っています。

1. 外部システムで定義したキー("param_1", "param_2", "param_3")とマッピングする定数があれば十分だと思う。

2. 利用するシーンは、"param_1"の代わりにKey.PARAM_1.getKey()を使うだけであり、

内部システムでKeyが引数、判定等で使う場面が一切ないのでenumを使う意味があまりないと思う。
→ 文字列定数だけが目的であるenum
3. キーって、男_女、ON_OFFとは違う気がしてenumに定義すべきではない気がする。

※static finalを選んだ理由は、3の理由が一番強い。
※int型の場合は、基本enumに寄せるが、Stringはもう一度考えるべきだと思う。

皆さんの意見を聞かせてください。

Answer 1

値をとるためにEnumを使うようなことはあんまりしないですね。
個人的にはEnumは条件分岐に名前をつけるようなものかなと思っています。
通常のやり方としては
static finalな定数にするか
DBから取得するか
コンフィグファイルとかプロパティファイルとか

Comments

[liguofeng29]

わたくしの意見の３についてどう思いますか？

[deigo]

意図がちょっとわかりづらかったんですが
外部システムから受け取ったものから何かを取り出すためのキー？としてのキーのことなら
Enumは使わないですかね。
逆に取り出した値をEnumと照合したりはするかもしれないです。

[liguofeng29]

外部システムはリクエストパラメータとして、
「?param=p1:aa,p2:bb,p3:cc」を受信して、「p1:aa,p2:bb,p3:cc」を解析する処理をやってます。

後、異なるシステムなので、enum定義を共有するこはできないです。

Answer 2

enumには対応する値を定義することが可能ではありますが、enumの用途としてはシステム内で区別できる名前を提供することだけを考え、その実際の値に意味を持たせるべきではないと考えます。
よって、ご質問の内容からは定数として値を持つ形の方がよいかと思います。

ただし、本件は外部システムとのインタフェース部分に関する内容ですので、パラメータをどのように持たせるかというのは考慮すべきところかと思います。
提示頂いている内容はREST APIのようなものをイメージさせる内容ですが、WSDLやJSON Schemaのような形でやりとりするデータの内容を事前に取り決めておくことが可能なのであれば、定義内容から定数やデータクラス等を生成することも可能なのではないかと思います。

システムが分かれていたとしてもどちらも管理下にあるということであれば、お互いのデータ仕様についてそこまで細かく定めなくてもよいのかもしれません。
また、この場合、同じenumクラスをお互いが参照可能で、取り得る値は複数種類に限られ、実際の値に意味をもたせる必要がなく、データの受け渡しにシリアライズ等を行える、といったような前提条件が当てはまっていけば、enumで値を表現するといったこともできることがあるかもしれません。

Comments

[liguofeng29]

> その実際の値に意味を持たせるべきではないと考えます。

なるほど、なんとなくわかります。
私もenumで列挙したものより、それの属性である文字列だけが意味を持つenumはよくない考えです。

内部、外部と表現しましたが、どっちも管理配下です。
なお、REST APIではなくて、下記のようなものです。
1. 内部システムでパラメータつきリダイレクトURLをクライアントに渡す(パラメータ暗号化)
2. 外部システムにリクエストして、パラメータを元に指定画面(VIEW)をクライアントへ渡す。

> 同じenumクラスをお互いが参照可能で

異なるアプリであり、現段階ではそれぞれ同じenum定義を持つのが限界かなと。

貴重な意見、ありがとうございます。

[退会済みユーザー]

同じenumクラス、のくだリは共通ライブラリとしてjarファイル等を両方のシステムに組み込む等の形をイメージしていました。
ただ、そこまでして使用したいものでもないかとも思いますので、蛇足かとは思いましたが一案として回答に含めさせていただきました。

[liguofeng29]

ご意見、ありがとうございました。