Java enum - навіщо використовувати toString замість імені

Якщо ви подивитесь на enum api на метод, name()він говорить, що:

Повертає ім'я цієї константи перерахунку, точно так, як заявлено в її декларації перерахунку. Більшість програмістів повинні використовувати метод toString віддати перевагу цьому, оскільки метод toString може повернути більш зручне ім'я. Цей метод розроблений насамперед для використання в спеціалізованих ситуаціях, коли від правильності залежить отримання точного імені, яке не буде змінюватися від випуску до випуску.

Чому краще використовувати toString()? Я маю на увазі, що toString може бути відмінено, коли name () вже остаточне. Тож якщо ви використовуєте toString і хтось замінює його, щоб повернути важко кодоване значення, вся ваша програма знижена ... Крім того, якщо ви подивитесь на джерела, метод toString () повертає саме та саме ім'я. Це те саме.

Це дійсно залежить від того, що ви хочете зробити з поверненим значенням:

• Якщо вам потрібно отримати точне ім’я, яке використовується для оголошення постійної перерахунку, вам слід скористатись name()таким чином, як toStringце було відмінено
• Якщо ви хочете надрукувати константу перерахунку зручним для користувача способом, вам слід скористатись тим, toStringщо можливо було відмінено (чи ні!).

Коли я відчуваю, що це може заплутати, я пропоную більш конкретний getXXXметод, наприклад:

public enum Fields {
    LAST_NAME("Last Name"), FIRST_NAME("First Name");

    private final String fieldDescription;

    private Fields(String value) {
        fieldDescription = value;
    }

    public String getFieldDescription() {
        return fieldDescription;
    }
}

Використовуйте, name()коли ви хочете порівняти або використовувати твердокодированное значення для внутрішнього використання у вашому коді.

Використовуйте, toString()коли ви хочете представити інформацію користувачеві (включаючи розробника, що дивиться на журнал). Ніколи не покладайтесь у своєму коді на toString()надання конкретного значення. Ніколи не тестуйте його на певній строці. Якщо ваш код порушується, коли хтось правильно змінить toString()повернення, він був уже порушений.

Від javadoc (акцент міна):

Повертає рядкове подання об'єкта. Взагалі метод toString повертає рядок, який "текстуально представляє" цей об'єкт. Результатом має бути стисле, але інформативне подання, яке людині легко читати . Рекомендується, щоб цей підклас перекрив цей метод.

name()є "вбудованим" методом enum. Вона остаточна, і ви не можете змінити її реалізацію. Він повертає назву enum константа, як вона написана, наприклад, у верхньому регістрі, без пробілів тощо.

Порівняйте MOBILE_PHONE_NUMBERі Mobile phone number. Яка версія є більш читаною? Я вірю другому. У цьому різниця: name()завжди повертається MOBILE_PHONE_NUMBER, toString()може бути відмінено для повернення Mobile phone number.

Хоча більшість людей сліпо дотримуються порад javadoc, є дуже специфічні ситуації, коли ви хочете насправді уникати toString (). Наприклад, я використовую енуми у своєму Java-коді, але їх потрібно серіалізувати до бази даних та повернути знову. Якби я використовував toString (), технічно я би зазнав перекритої поведінки, як вказували інші.

Крім того, можна також десериалізувати базу даних, наприклад, це завжди має працювати на Java:

MyEnum taco = MyEnum.valueOf(MyEnum.TACO.name());

Тоді як це не гарантується:

MyEnum taco = MyEnum.valueOf(MyEnum.TACO.toString());

До речі, мені здається, що Javadoc чітко каже «більшість програмістів має». Я знаходжу дуже мало корисного випадку в toString enum, якщо люди використовують це для "доброзичливого імені", це явно поганий випадок використання, оскільки вони повинні використовувати щось більш сумісне з i18n, що, в більшості випадків, використовувати метод name ().

Практичний приклад, коли ім'я () та toString () має сенс відрізнятися - це шаблон, коли однозначне перерахування використовується для визначення сингтона. Спочатку це виглядає дивно, але має багато сенсу:

enum SingletonComponent {
    INSTANCE(/*..configuration...*/);

    /* ...behavior... */

    @Override
    String toString() {
      return "SingletonComponent"; // better than default "INSTANCE"
    }
}

У такому випадку:

SingletonComponent myComponent = SingletonComponent.INSTANCE;
assertThat(myComponent.name()).isEqualTo("INSTANCE"); // blah
assertThat(myComponent.toString()).isEqualTo("SingletonComponent"); // better

name () - це буквально текстове ім'я в коді java enum. Це означає, що він обмежений рядками, які насправді можуть відображатися у вашому коді Java, але не всі бажані рядки можуть бути виразними в коді. Наприклад, вам може знадобитися рядок, що починається з числа. name () ніколи не зможе отримати цей рядок для вас.

Ви також можете використовувати щось на зразок коду, наведеного нижче. Я використовував lombok, щоб уникнути написання деяких кодів котла для геттерів та конструкторів.

@AllArgsConstructor
@Getter
public enum RetroDeviceStatus {
    DELIVERED(0,"Delivered"),
    ACCEPTED(1, "Accepted"),
    REJECTED(2, "Rejected"),
    REPAIRED(3, "Repaired");

    private final Integer value;
    private final String stringValue;

    @Override
    public String toString() {
        return this.stringValue;
    }
}