Bir sipariş entity’si:

@Enumerated
private OrderStatus status;
enum OrderStatus { PENDING, SHIPPED, CANCELLED }

@Enumerated anotasyonunun varsayılan değeri EnumType.ORDINAL. Yani veritabanına enum’un adı değil, sıra numarası yazılır.

PENDING   → 0
SHIPPED   → 1
CANCELLED → 2

Birkaç ay sonra yeni bir durum gerekiyor: ödeme alındı ama henüz kargolanmadı. Geliştirici mantıklı bir yere ekliyor:

enum OrderStatus { PENDING, PAID, SHIPPED, CANCELLED }

Deploy ediyor.

Veritabanında 1 olarak saklanan bütün kargolanmış siparişler artık PAID olarak okunuyor. 2 olan iptal edilmiş siparişler SHIPPED görünüyor.

Kod derlendi. Testler geçti. Hiçbir hata yok.

Ama veritabanındaki bütün sipariş durumlarının anlamı değişti.

Ordinal bir sözleşme değil

Bir enum’daki sıra, kodun okunabilirliği için seçilir. Değerleri mantıksal bir sırayla dizmek doğal bir davranıştır.

ORDINAL ile saklandığında bu sıra, veritabanındaki verinin anlamına bağlanır. Bir değeri eklemek, silmek veya yer değiştirmek, kalıcı veriyi sessizce bozar.

Sadece sona eklemek güvenlidir. Ama bu kuralın her geliştirici tarafından her zaman hatırlanacağını varsaymak gerçekçi değil.

STRING

Daha güvenli seçenek:

@Enumerated(EnumType.STRING)
private OrderStatus status;

Veritabanında SHIPPED, CANCELLED gibi okunabilir değerler saklanır. Enum’a yeni değerler istenen yere eklenebilir, sıra değiştirilebilir.

Bir bonus: veritabanını doğrudan sorgulayan biri, status = 2 yerine status = 'SHIPPED' görür. Raporlar ve hata ayıklama kolaylaşır.

Bedeli birkaç byte fazla depolama. Pratikte ihmal edilebilir.

Yeniden adlandırma hâlâ tehlikeli

STRING kullanıldığında da bir risk kalır: enum değerinin adını değiştirmek.

CANCELLED değerini CANCELED olarak düzeltmek, veritabanındaki mevcut CANCELLED kayıtlarının okunamamasına yol açar. Hibernate bilinmeyen değeri enum’a çeviremez ve exception fırlatır.

Yeniden adlandırma gerekiyorsa, bir migration ile mevcut değerlerin de güncellenmesi gerekir. Ve rolling deploy sırasında eski kodun yeni değeri okuyamayacağı da hesaba katılmalı. Yine expand and contract: önce iki değeri de tanıyan kod, sonra migration, sonra eski değerin kaldırılması.

Kod ile veritabanı değerini ayırmak

Daha esnek bir yaklaşım, enum’a veritabanında saklanacak sabit bir kod vermek:

enum OrderStatus {
    PENDING("P"), PAID("A"), SHIPPED("S"), CANCELLED("C");
    final String code;
}

Bir AttributeConverter ile bu kod veritabanına yazılır ve okunur. Enum sabitlerinin adı istenildiği gibi değiştirilebilir, veritabanındaki değer sabit kalır.

Kısa kodlar okunabilirliği biraz azaltır. Ama dış sistemlerle paylaşılan veya yıllarca saklanacak değerler için bu kararlılık değerli.

Veritabanında kontrol

Veritabanı seviyesinde geçerli değerleri sınırlamak da faydalı bir güvenlik ağı:

ALTER TABLE orders
ADD CONSTRAINT chk_orders_status
CHECK (status IN ('PENDING', 'PAID', 'SHIPPED', 'CANCELLED'));

Yeni bir değer eklendiğinde constraint’in de migration ile güncellenmesi gerekir. Biraz ekstra iş. Ama uygulamanın bir bug’ı veya başka bir sistem, tabloya geçersiz bir değer yazamaz.

PostgreSQL’in kendi ENUM tipi de bir seçenek. Ama değer silmek veya yeniden adlandırmak daha zahmetli olduğu için, birçok ekip CHECK constraint’li bir text kolonu daha esnek buluyor.

JPA’nın varsayılan değerleri genellikle makuldür.

EnumType.ORDINAL ise, değiştirilmesi gereken nadir varsayılanlardan biri.