pátek 10. července 2009

Závislosti polí ve formuláři

Ve svém vůbec prvním blogu bych se rád podíval na řešení závislostí polí ve formuláři. Nechci popisovat konkrétní technologii pro psaní webových aplikací nebo například tlustých klientů. Zajímá mě obecný problém, kdy máme aplikaci pracující s množstvým formulářů, které jsou „složité“ a jejich složitost je tvořena mimo jiné i závislostmi mezi poli, která obsahují. Závislostí polí ve formuláři myslím některou z následujících možností:
  • Viditelnost nebo přístupnost pole závisí na hodnotě jiného pole nebo polí.
  • Seznam přípustných hodnot pro nějaké pole závisí na hodnotě jiného pole nebo polí.
  • Změna hodnoty pole (nebo polí) způsobí změnu stavu (tzn. přístupnosti nebo hodnoty) jiného pole nebo polí.
  • Libovolnou jinou závislost.
V tomto blogu se nezaměřím na konkrétní technologií vytváření GUI aplikací, chci spíše popsat obecný postup, který lze implementovat při tvorbě webových aplikací, tlustých klientů nebo třeba i ajaxových webů. Příklady v blogu jsou naprogramované v Javě, ale diskutovaný problém i jeho řešení se na Javu omezovat nemusí.

Většina frameworků a aplikací má dnes spolehlivě vyřešené problémy jako binding formulářových dat na doménový model aplikace, validace jednotlivých polí, lokalizace a další problémy, které musí typické GUI řešit. Ještě jsem se ale nesetkal s aplikací, která by závislostí polí ve formuláři řešila způsobem, který by byl přehledný, do budoucna udržovatelný a hlavně, který by byl testovatelný (ve smyslu unit testů). Domnívám se, že závislosti polí jsou často v návrhu aplikací opomíjeny, a chci proto představit jednoduchý návod, jak závislosti řešit. Jistě nejde o žádnou převratnou inovaci, ale podobný postup jsem zatím nikde zdokumentovaný a hlavně použitý nenašel. Smysl tohoto blogu tedy vidím v tom, že některým čtenářům pomůže uvědomit si problém a jeho nepříjemným důsledkům se vyhnout.

Příklad

Budu používat příklad převzatý z bankovní aplikace, která řeší evidenci nemovitostí pro účely pořízení a schvalování žádosti o hypoteční úvěr. Aplikace eviduje tři typy nemovitostí – parcely, budovy a bytové jednotky. Pro svůj příklad se zaměřím na parcely. Atributy parcely a jejich závislosti jsou popsány následující tabulkou:

Popis parcelyČeské KÚ?Má číslo?Typ?OvěřitelnéČísloČíslo LVPomocná identifikaceZdroj PZE
Parcela katastru nemovitostíanoanoKNanopřístupné, povinnépřístupné, povinnénepřístupné, nullnepřístupné, null
Parcela zjednodušené evidenceanoanoZEanopřístupné, povinnépřístupné, povinnénepřístupné, nullpřístupné, povinné
Budoucí parcelaanonenepřístupné, nullnenepřístupné, nullnepřístupné, nullpřístupné, povinnénepřístupné, null
Zahraniční parcelanenepřístupné, nullnepřístupné, nullnenepřístupné, nullnepřístupné, nullpřístupné, povinnénepřístupné, null

Sloupce tabulky popisují atributy a vlastnosti parcely, řádky popisují čtyři možné typy parcel. První tři atributy můžeme chápat jako „diskriminant“ parcely – jejich hodnoty podmiňují přístupnost, povinnost a přednastavené hodnoty jejich dalších atributů. Závislosti polí nemusí být vždy specifikovány tabulkou, asi nejčastěji jsou podobné závislosti popsány sadou podmínek („if – then“). Bohužel není výjimkou, že podobná specifikace úplně chybí a předpokládá se nějaká implicitní znalost. V reálné aplikaci jsou definice parcely a závislostí jejich atributů mírně složitější. Snažil jsem se zadání zjednodušit, ale přitom ho ponechat dostatečně ilustrativní.

Jak by takové zadání řešila typická aplikace? Nejčastěji se setkávám s tím, že se podobné závislosti neřeší systematicky, že jsou řešeny množstvím podmínek na různých místech nebo vrstvách aplikace. Podmínky mohou být často rozhozeny mezi view a controllery (ve smyslu MVC návrhu). Například událost změny katastrálního území parcely (KÚ) může vyvolat akci na serveru (ve smyslu volání metody controlleru Springu MVC nebo volání akce Struts 2), která změní KÚ a pokud nová hodnota znamená:
  • České KÚ - vynuluje ještě hodnoty pomocné identifikace a zdoje PZE;
  • Zahraniční KÚ - nastaví typ parcely na null, stejně tak její číslo a číslo LV a vynuluje také hodnotu zdroje PZE.
Později se ještě nová hodnota KÚ bude muset zohlednit ve view, kde se podle ní rozhodne o přístupnosti / nepřístupnosti dalších polí formuláře. Pokud si teď představíme běžnou situaci, kdy má programátor rozhodnout, jestli je specifikace správně implementovaná, není to jednoduchý úkol. Jinak než uživatelským testováním není jednoduché zjistit:
  • Kde všude se závislosti polí vyhodnocují?
  • Dochází někde k duplikacím kódu pro vyhodnocování závislostí?
  • Jaký dopad to má na doménový model aplikace?
  • Kde všude se vyhodnocuje přístupnost polí formuláře?
  • Jak si s tím později poradí validace?
  • … a podobné otázky.
Pokud je formulářů a závislostí hodně, začne být velkým problémem, že závislosti nejsou zachycené explicitně, tzn. že neexistuje něco jako stav přístupnosti polí formuláře a jednotný mechanismus pro jeho vyhodnocování. Viděl jsem už několik projektů, u kterých mě mrzelo, že kód jinak rozumně a vhodně navržené aplikace byl znehodnocen . Netvrdím samozřejmě, že jsou to právě závislosti formulářových polí, které vždy degradují kvalitu zdrojového kódu, domnívám se ale, že jde o jeden z typických problémů.

Návrh řešení

Představme si, že parcelu máme reprezentovanou třídou Plot.
public class Plot {
private boolean locatedInCR;
private boolean numberAssigned;
private String plotType;
private String number;
private String ownershipNumber;
private String auxiliaryId;
private String simplifiedEvidenceSource;
...
}
Obecně pro každé pole formuláře můžeme uvažovat čtyři stavy:
  • Přístupné, nepovinné
  • Přístupné, povinné
  • Nepřístupné
  • Skryté
Mějme tyto stavy reprezentované třídou FieldState.
public class FieldState {
public static final FieldState ENABLED_OPTIONAL = new FieldState("ENABLED_OPTIONAL", true, true, false);
public static final FieldState ENABLED_MANDATORY = new FieldState("ENABLED_MANDATORY", true, true, true);
public static final FieldState ENABLED = ENABLED_OPTIONAL;
public static final FieldState DISABLED = new FieldState("DISABLED", true, false, false);
public static final FieldState HIDDEN = new FieldState("HIDDEN", false, false, false);

private String code;
private boolean visible;
private boolean enabled;
private boolean mandatory;

public boolean isVisible() { return visible; }
public boolean isEnabled() { return enabled; }
public boolean isMandatory() { return mandatory; }

@Override
public String toString() { return code; }

private FieldState(String code, boolean visible,
boolean enabled, boolean mandatory)
{
this.code = code;
this.visible = visible;
this.enabled = enabled;
this.mandatory = mandatory;
}
}
Jako „zkratka“ je ve třídě ještě reprezentovaná hodnota „přístupné“ (ENABLED), která vlastně přesně znamená „přístupné, nepovinné“.

Pokud budeme uvažovat formulář pro editaci dané parcely, můžeme stav jeho polí reprezentovat třídou PlotFieldState. Třída popisuje přístupnost jednotlivých polí.
public class PlotFieldState {
private FieldState numberAssigned = FieldState.ENABLED;
private FieldState plotType = FieldState.ENABLED;
private FieldState verifiable = FieldState.ENABLED;
private FieldState number = FieldState.ENABLED;
private FieldState ownershipNumber = FieldState.ENABLED;
private FieldState auxiliaryId = FieldState.ENABLED;
private FieldState simplifiedEvidenceSource = FieldState.ENABLED;
...
}
Předpokládejme, že existuje mechanismus, který pro každou kombinaci hodnot parcely (tzn. libovolnou instanci třídy Plot), umí vyhodnotit stav formuláře parcela (tzn. přístupnost a povinnost jeho polí). Mějme tento výpočet reprezentovaný rozhranním PlotDependencySolver.
public interface PlotDependencySolver {
void solveDependencies(Plot plot, PlotFieldState state);
}
Interface PlotDependencySolver obdrží jako parametry aktuální hodnoty parcely a stav odpovídajících polí formuláře. Provede vyhodnocení a výsledek - tzn. změněné hodnoty a změněný stav - reflektuje do těchto parametrů.

Explicitní reprezentaci stavu polí formuláře (reprezentovanou třídou PlotFieldState) můžeme použít pro následující činnosti:
  • Zobrazování (konstrukci view) formuláře.
    • Stačí pouze procházet pole formuláře, kde pro každé z nich mám k dispozici stav, který říká, jestli dané pole vykreslit, resp. jestli bude přístupné. Důležité je, že viditelnost a přístupnost polí nemusím řešit složitými podmínkami (např. v JSP, u mnoha elementů typicky v atributu disabled), ale jednoduchým dotazem na stav (PlotFieldState).
  • Validace hodnot z formuláře.
    • Opět stačí procházet hodnoty polí z formuláře, pro každé z nich ihned vím, jestli je povinné / nepovinné, tedy jestli ho mám validovat.
    • Pokud by bylo požadavkem validovat i kombinace hodnot polí (např. kombinace hodnot combo boxů – „auto Škoda, model Octavia“), mohu třídu PlotFieldState rozšířit i o reprezentaci přípustných hodnot pro pole formuláře. Snahou je přípravit si takovou stavovou informaci, která mi dovolí iterovat přes pole formuláře a validovat jedno po druhém.
  • Testování závislosti polí.
    • Mám-li stav formuláře explicitně reprezentovaný třídou a mechanismus pro zjišťování stavu, mohu tento mechanismus testovat (tzn. testovat závislost polí formuláře).
Hlavní myšlenka je tedy v tom mít explicitní reprezentaci polí formuláře a mechanismus, jak ho vyhodnotit. Výrazně nám to zjednoduší jinak potenciálně složité akce jako je zobrazování formuláře, validace hodnot a testování závislosti polí.

Následující ukázka kódu demonstruje možný postup při validaci parcely.
public class PlotValidationHelper {
public void validate(Plot plot, PlotFieldState state) {
if (state.getNumber().isMandatory() && !isNumber(plot.getNumber())) {
// report error
}
if (state.getOwnershipNumber().isMandatory() && !isNumber(plot.getOwnershipNumber())) {
// report error
}
if (state.getAuxiliaryId().isMandatory() && plot.getAuxiliaryId() == null) {
// report error
}
if (state.getSimplifiedEvidenceSource().isMandatory() && plot.getSimplifiedEvidenceSource() == null) {
// report error
}
}
...
}
Další ukázka kódu představuje jednoduchý JUnit test case pro testivání závislostí polí.
public class Test1 extends TestCase {
public void testLandRegister() {
Plot plot = new Plot();
plot.setLocatedInCR(true);
plot.setNumberAssigned(true);
plot.setPlotType("KN");

PlotFieldState state = new PlotFieldState();

getSolver().solveDependencies(plot, state);

assertEquals(FieldState.ENABLED, state.getVerifiable());
assertEquals(FieldState.ENABLED_MANDATORY, state.getNumber());
assertEquals(FieldState.ENABLED_MANDATORY, state.getOwnershipNumber());
assertEquals(FieldState.DISABLED, state.getAuxiliaryId());
assertNull(plot.getAuxiliaryId());
assertEquals(FieldState.DISABLED, state.getSimplifiedEvidenceSource());
assertNull(plot.getSimplifiedEvidenceSource());
}

}

Implementace

Zbývá už jen zamyslet se nad implementací mechanismu pro vyhodnocování nového stavu formuláře, tedy implementaci rozhranní PlotDependencySolver. Pro implementaci můžeme zvážit dvě možnosti - přímou implementaci prostředky Javy a implementaci pomocí rule engine.

Nebude žádným překvapením, že prostředky Javy můžeme metodu solveDependencies implementovat prostě jako sadu if – then statementů.
public class JavaPlotDependencySolver implements PlotDependencySolver {
@Override
public void solveDependencies(Plot plot, PlotFieldState state) {
if (plot.isLocatedInCR() && plot.isNumberAssigned() && "KN".equals(plot.getPlotType())) {
// Land register
state.setNumberAssigned(FieldState.ENABLED);
state.setPlotType(FieldState.ENABLED);
state.setVerifiable(FieldState.ENABLED);
state.setNumber(FieldState.ENABLED_MANDATORY);
state.setOwnershipNumber(FieldState.ENABLED_MANDATORY);
state.setAuxiliaryId(FieldState.DISABLED);
state.setSimplifiedEvidenceSource(FieldState.DISABLED);

plot.setAuxiliaryId(null);
plot.setSimplifiedEvidenceSource(null);
} else if (!plot.isLocatedInCR()) {
// Foreign plot
state.setNumberAssigned(FieldState.DISABLED);
state.setPlotType(FieldState.DISABLED);
state.setVerifiable(FieldState.DISABLED);
state.setNumber(FieldState.DISABLED);
state.setOwnershipNumber(FieldState.DISABLED);
state.setAuxiliaryId(FieldState.ENABLED_MANDATORY);
state.setSimplifiedEvidenceSource(FieldState.DISABLED);

plot.setNumberAssigned(false);
plot.setPlotType(null);
plot.setNumber(null);
plot.setOwnershipNumber(null);
plot.setSimplifiedEvidenceSource(null);
} else { ... }
}
}
Takový přímočará implementace má ale i některá omezení:
  • Musíme sestavit deterministický postup (algoritmus), kdy všechny podmínky a závislosti vyhodnotíme a reflektujeme do nového stavu.
  • Pokud si vyhodnocování závislostí představíme v nějakém "vyhodnocovacím stromě" (uvádím v uvozovkách a doufám, že intuitivní chápání pojmu tady postačí), může a bude se pravděpodobně stávat, že některé podstromy výpočtu se budou opakovat, protože musí reflektovat, že stav formuláře se během vyhodnocování mění (každá jednotlivá podmínka může do stavu něčím přispět). Mířím k tomu, že sestavit takový algoritmus nemusí být vždy jednoduché.
Přesto platí, že dostat vyhodnocování závislostí na jedno místo, reprezentované rozhranním PlotDependencySolver, vidím jako úspěch s jasným pozitivním dopadem na přehlednost a udržovatelnost kódu aplikace. U složitějších závislostí se dá přiklonit k rozšiřitelnějšímu řešení – mohu např. vytvořit „pluggable“ mechanismus, kde jednotlivé implementace PlotDependencySolver-u budou zohledňovat jednotlivé typy parcel (viz. zadání příkladu výše).

Z uvedených důvodů je elegantní a preferovanou možností zapojení rule engine (např. Drools), které nám dovolí většinu zmíněných výhrad jednoduše překonat. Protože vidím tuto možnost jako velmi vhodnou a zajímavou, budu jí věnovat další samostatný blog.

Shrnutí

V tomto blogu snažím klást důraz hlavně na myšlenku explicitní reprezentace stavu formuláře, ne na její implementaci. Důležité je dosáhnout toho, že závislosti polí budou vyhodnocovány na jednom místě a stav formuláře bude důsledně používaný. Pojďme si nakonec shrnout výhody a nevýhody řešení s explicitní reprezentací stavu polí formuláře. Postup přináší následující výhody:
  • Závislosti polí ve formuláři jsou definovány na jednom místě.
    • Abych závislosti zmapoval, pochopil nebo upravil, nemusím je hledat na různých místech / vrstvách aplikace.
    • Odpadávají duplicity vyhodnocování závislostí. Stejný kód pro vyhodnocení stavu formuláře mi poslouží pro vykreslení polí ve view jako i pro validaci jejich hodnot.
  • Přehledný, snadno čitelný kód pro vykreslování view a pro validace hodnot z formuláře.
    • Procházím pole jedno po druhém, vyhodnocuji jenom, jakým způsobem (ne)zobrazit a jak validovat.
  • Testovatelnost závislostí.
    • Testovatelnost závislostí vidím jako největší výhodu tohoto řešení.
Řešení má samozřejmě i nevýhody:
  • Režie navíc.
    • Samostatná reprezentace stavu polí formuláře jako i práce s explicitně definovanými stavy může být pro jednodušší aplikace zbytečná. Vedle doménových tříd reprezentujích strukturu informací tu mám ještě další, speciální třídy pro zachycení stavu polí ve formuláři.
  • Kombinace přístupu explicitního stavu polí s jiným řešením může smazat výhody explicitních stavů a vytvořit nepřehledný, těžko udržovatelný kód.
    • To je ale obecná poznámka aplikovatelná snad na jakékoliv řešení. Pokud někdo nedodrží domluvené návrhové vzory, přehlednost a udržovatelnost kódu tím samozřejmě trpí vždy.
Pokud jste blog dočetli až sem, děkuji za pozornost a trpělivost. Jak závislosti polí řešíte vy? Považuje explicitní reprezentaci stavu formuláře za dobrý nápad? Pokud vás problematika zaujala, doporučuji svůj další blog, který bude popisovat implementaci závislostí s pomocí Drools.