Enum w Javie: stały zbiór nazwanych stałych

Stały zbiór nazwanych wartości

Niektóre wartości mają sens tylko jako element małej, znanej listy: dni tygodnia, kolory w talii kart, stany zamówienia. Można je modelować kodami int (0 dla oczekującego, 1 dla wysłanego) albo napisami ("PENDING", "SHIPPED"), ale nic nie powstrzyma wywołującego przed przekazaniem 7 albo "PNEDING". enum zamyka tę lukę: sam typ dopuszcza tylko zadeklarowane wartości.

enum Day {
    MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
}

public class Main {
    public static void main(String[] args) {
        Day today = Day.WEDNESDAY;
        System.out.println(today);          // WEDNESDAY
        System.out.println(today == Day.WEDNESDAY);
    }
}

Day to zupełnie nowy typ. Zmienna typu Day może przechowywać dokładnie jedną z tych siedmiu stałych albo null i nic więcej. Kompilator odrzuca Day d = "WEDNESDAY"; i Day d = 2;. Ta gwarancja to cały sens enuma.

Każda stała (Day.MONDAY i kolejne) to pojedyncza, współdzielona instancja tworzona raz. Ponieważ zawsze istnieje tylko jeden MONDAY, enumy porównuje się przez ==, a nie equals: to ten sam obiekt.

switch na enumie

Enumy naturalnie łączą się ze switch. W środku switcha nie trzeba nawet poprzedzać stałych nazwą typu:

enum Day {
    MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
}

public class Main {
    static String kind(Day d) {
        switch (d) {
            case SATURDAY:
            case SUNDAY:
                return "weekend";
            default:
                return "weekday";
        }
    }

    public static void main(String[] args) {
        System.out.println(kind(Day.SATURDAY));
        System.out.println(kind(Day.MONDAY));
    }
}

W switch pisz case SATURDAY, a nie case Day.SATURDAY: Java sama wywnioskuje typ. Wielka przewaga nad switchem na napisie lub int polega na tym, że gdy później dodasz nową stałą, IDE i sprawdzanie kompletności mogą wskazać każdy switch, który jej nie obsługuje.

Pętla po wszystkich stałych

Każdy enum automatycznie dostaje statyczną metodę values(), która zwraca wszystkie stałe w kolejności deklaracji, oraz ordinal(), która podaje pozycję stałej liczoną od zera:

enum Suit { HEARTS, DIAMONDS, CLUBS, SPADES }

public class Main {
    public static void main(String[] args) {
        for (Suit s : Suit.values()) {
            System.out.println(s.ordinal() + " -> " + s.name());
        }
    }
}

name() zwraca identyfikator stałej jako String, a values() świetnie nadaje się do budowania menu albo przechodzenia po opcjach. Jedno ostrzeżenie: nie zapisuj ordinal() nigdzie na stałe. Jeśli ktoś później zmieni kolejność stałych, numery się przesuną, a zapisane dane się zepsują. Traktuj ordinal() jako szczegół implementacji, a nie stabilny identyfikator.

Enumy to prawdziwe klasy: pola i metody

Tu enumy w Javie wykraczają poza enumy z nazwanymi liczbami znane z innych języków. Każda stała może nieść dane przekazywane przez konstruktor, a enum może mieć metody. Najpierw wypisujesz stałe, każdej podajesz argumenty konstruktora, a potem po średniku deklarujesz pola, konstruktor i metody.

enum Planet {
    MERCURY(3.303e23, 2.4397e6),
    EARTH(5.976e24, 6.37814e6);

    private final double mass;     // kilogramy
    private final double radius;   // metry

    Planet(double mass, double radius) {
        this.mass = mass;
        this.radius = radius;
    }

    double surfaceGravity() {
        final double G = 6.67300e-11;
        return G * mass / (radius * radius);
    }
}

public class Main {
    public static void main(String[] args) {
        for (Planet p : Planet.values()) {
            System.out.printf("%s gravity: %.2f%n", p, p.surfaceGravity());
        }
    }
}

Zwróć uwagę na strukturę: najpierw stałe zakończone średnikiem, potem reszta klasy. Konstruktor jest niejawnie private: nigdy nie napiszesz new Planet(...), bo jedyne dozwolone instancje to te zadeklarowane na górze. Pola final czynią każdą stałą niezmienną, a właśnie tego chcesz od współdzielonych singletonów.

Z napisu i z powrotem

Aby zamienić napis na pasującą stałą, użyj automatycznie generowanej metody valueOf:

enum Status { PENDING, SHIPPED, DELIVERED }

public class Main {
    public static void main(String[] args) {
        Status s = Status.valueOf("SHIPPED");
        System.out.println(s == Status.SHIPPED);   // true

        try {
            Status bad = Status.valueOf("shipped"); // rozróżnia wielkość liter!
            System.out.println(bad);
        } catch (IllegalArgumentException e) {
            System.out.println("no constant named 'shipped'");
        }
    }
}

valueOf dopasowuje nazwę stałej dokładnie, łącznie z wielkością liter, i rzuca IllegalArgumentException, gdy nic nie pasuje. To częsta pułapka: "shipped" nie pasuje do SHIPPED. Przy parsowaniu danych od użytkownika lub z zewnątrz najpierw sprowadź tekst do jednej wielkości liter (input.toUpperCase()) i umieść wywołanie w bloku try/catch, bo inaczej program wysypie się przy pierwszej złej wartości.

Zachowanie dla każdej stałej

Czasem każda stała musi się inaczej zachowywać, a nie tylko przechowywać inne dane. Możesz dać enumowi metodę abstrakcyjną i pozwolić każdej stałej dostarczyć własną implementację w małym ciele:

enum Operation {
    PLUS  { public int apply(int a, int b) { return a + b; } },
    MINUS { public int apply(int a, int b) { return a - b; } },
    TIMES { public int apply(int a, int b) { return a * b; } };

    public abstract int apply(int a, int b);
}

public class Main {
    public static void main(String[] args) {
        for (Operation op : Operation.values()) {
            System.out.println(op + ": " + op.apply(6, 2));
        }
    }
}

Nazywa się to czasem wzorcem „metody specyficznej dla stałej”. Zastępuje rozbudowany switch po stałych zachowaniem przypiętym bezpośrednio do każdej z nich. Gdy dodasz nową operację, kompilator zmusi cię do zdefiniowania jej apply, więc nie da się pominąć przypadku.

Kiedy sięgać po enum

Używaj enuma zawsze, gdy wartość naturalnie należy do małego, stałego zbioru znanego w czasie kompilacji:

• Stany w procesie (PENDING, SHIPPED, DELIVERED).
• Kategorie, tryby lub rodzaje (READ, WRITE, EXECUTE).
• Każde miejsce, w którym kusiło cię zdefiniowanie grupy stałych public static final int: enum daje te same nazwane wartości, a do tego bezpieczeństwo typów, czytelny toString i obsługę w switch za darmo.

Nie używaj enuma dla zbioru otwartego lub ustalanego w czasie działania programu (nazwy użytkowników, lista krajów pobierana z bazy danych). Enumy są wkompilowane na stałe; jeśli zbiór zmienia się w trakcie działania programu, potrzebujesz zwykłej kolekcji.

Dalej: typy generyczne

Widzisz już, że values() zwraca Planet[], a na wcześniejszych stronach pojawiało się List<Shape>. Składnia <...> to typy generyczne (generics), sposób Javy na napisanie jednej klasy lub metody działającej dla wielu typów przy zachowaniu pełnego bezpieczeństwa typów. Dalej wyjaśnimy, jak naprawdę działają List<String> i Map<K, V> i jak pisać własne typy generyczne.