Null-safe porovnání

Původně mi přišlo, že tento článek je zbytečný, protože to přeci každý zná. Ale nedávno jsem přesně na tuto situaci narazil při řešení provozní chyby v našem produkčním kódu. Takže se zdá, že to smysl zopakovat má.

Často potřebujeme porovnat aktuální hodnotu proměnné s nějakou konstantou a podle toho určit další průchod kódem. Pokud je to v Javě textový řetězec, použijeme metodu .equals(). Tedy něco jako:

if (variable.equals("hodnota")) { … }

Pokud však proměnná variable může být null (což předpokládejte vždycky, ledaže jste si 100% jistí, že tam vaše aplikace null nepustí), je tohle pozvánka pro NullPointerException, aby na nás vyskočil, až se to bude nejméně hodit.

Co s tím? Jako první člověka asi napadne přidat další kontrolu:

if (variable != null && variable.equals("hodnota")) { … }

Což je samo o sobě správně. Akorát je to zbytečně moc písmenek a můžeme to napsat jednodušeji. Stačí otočit pořadí. Vůbec nic nám nebrání porovnávat:

if ("hodnota".equals(variable)) { … }

Implementace metody .equals() pro String má porovnání s null argumentem vyřešeno – jak porovnání dvou objektů pomocí ==, tak operátor instanceof si s null hodnotou poradí. NullPointerException nás ohrožuje pouze tehdy, pokud se .equals() snažíme zavolat na null objekt. A jelikož řetězec "hodnota" logicky nikdy null nebude, máme vyřešeno.

Doporučuji si ještě zvyknout nenechávat podobné řetězce přímo v kódu, ale vytahovat si je jako konstanty:

private static final String HODNOTA = "hodnota";
…
if (HODNOTA.equals(variable)) { … }

I kdybyste ji potřebovali pouze jednou, toto vám pomůže držet definice na jednom místě a v případě potřeby snadno najít, kde provést úpravu. Já často používám napříč aplikací final třídu XYZConstants, která obsahuje pouze public static final definice konstant (a private konstruktor, aby nikoho nenapadlo plevelit aplikaci jejími instancemi) použitelných podle potřeby kdekoliv jinde.

V případě, že se řetězec (String literal) používá v aplikaci vícekrát, má tento návyk přínos pro budoucí údržbu kódu - protože změny bude stačit dělat pouze na jednom místě.

Optional?

Java 8 přinesla novinku v podobě třídy Optional, která je navržena právě pro snazší práci s objekty, které mohou být null. Zrovna tento use-case však příliš nezjednodušuje. Psát bychom museli:

if (Optional.ofNullable(variable).orElse("").equals("hodnota")) { … }

A to je ještě delší než původní varianta s explicitním porovnáním s null. Pokud bychom už optional instanci měli k dispozici, bylo by to o něco lepší, ale pořád ne ideální.

Optional optVar = Optional.ofNullable(variable);
…
if (optVar.orElse("").equals("hodnota")) { … }

Síla Optional objektů se víc projeví až v kombinaci s Lambda výrazy a Streamy, ale o tom až někdy příště.