Dotaz: Zásady správného návrhu - mají třídy uchovávat ID dílčích "objektů" nebo jejich instance?

[nr]

Hezké ráno,

zajímalo by mě co se čistoty kódu týče a vašich názorů/preferencí následující: jazyk PHP, v databázi uživatelé, role, nějaké atributy. V PHP mám třídu User, která obsahuje ID rolí, jejichž je uživatel členem. Pokud je potřeba, pak název role a další informace o ní získávám ze třídy Role, kterou vytvoří nějaká "Manager" class po předání ID role.

Co je lepší: aby třída User uchovávala ID rolí nebo přímo instance třídy Role?

To samé řeším s atributy. Uživatel může mít různé atributy, každý atribut má nějakou syntaxi (SyntaxID). Je lepší uchovávat instanci třídy AttrSyntax (popis a kontrola syntaxe/hodnoty atributu) nebo jen IDčka a podle potřeby si AttrSyntax instanciovat?

Oba přístupy mají něco do sebe a mě by zajímalo, čemu vy nebo čemu se v praxi dává přednost a proč? Děkuji.

Odpovědi

[Kit]

Nejlépe ty role v objektu vůbec nedržet. Vždyť je mám v databázi, takže v každém SQL dotazu si mohu snadno ověřit, zda uživatel na požadovanou akci má či nemá právo.

[OldFrog {Ondra Nemecek}]

Používá se oboje. Záleží na struktuře databáze a na tom, jak často se data mění a jaké jsou důsledky, pokud nebudou data v aplikaci aktuální vůči databázi. Dále jde o balanc mezi objemem přenesených data a množstvím dotazů do databáze.

Pokud jde o zabezpečení a role musí být na 100% aktuální vůči databázi, je třeba oprávnění ošetřit rovnou v databázi např. pomocí transakcí, triggerů, pomocí vhodně formulovaných sql dotazů. To asi nebude Váš případ - v php běží skript jen krátce a všechna data natažená z databáze se po skončení skriptu hned zapomenou (pokud se nepoužívá nějaká persistentní cache).

Ve vašem případě by se tedy nejspíš hned načetly všechny sloupce tabulky (eager loading), zatímco odkazované hodnoty by se natáhly teprve na požádání (lazy loading). Pouze BLOBy bych tahal na požádání vždy, pokud tam nějaké jsou.

Čili konkrétně v případě rolí: Pokud může být jen jedna role, načetlo by její id hned (ze sloupce v tabulce uživatelů) ale parametry role až v případě potřeby (ze sloupců v tabulce rolí). A pokud může být rolí více, tak by se načítala až v případě potřeby i idčka rolí (z vazební tabulky) a k nim rovnou jejich parametry (ze sloupců v tabulce rolí). Čili byste měl granularitu po tabulkách.

V ORM frameworcích se tohle dá obvykle nastavit. Až si napíšete svoje třídy a získáte s tím zkušenost, koukněte třeba na PropelORM. Umí tuhle práci udělat za vás a to docela dobře.

[nr]

A co je lepší používat pro změnu členství v rolích (přidání/odebrání)?

$role = RoleManager::getRoleById(x); // kde x je ID role
$user->addRole($role);

nebo

$user->addRole(x); // kde x je ID role

a jaké z toho plynou budoucí výhody/nevýhody?

[Josef Kufner]

To ID musíš znát. Je značně nepraktické zadrátovat podivné konstanty někam do kódu. Ovšem je zcela jedno, zda máš konstantu o řádek výš nebo níž.

[OldFrog {Ondra Nemecek}]

Myslím že tam autor zapomněl $, tj tam mělo být $x.

[OldFrog {Ondra Nemecek}]

První varianta je upovídanější, ale praktičtější a univerzálnější. Univerálnější a praktičtější proto, že tu roli můžete získat libovolnou cestou (ostatně ani nemusí být ta role ještě uložená v databázi) a můžete s ní taky cokoli před vložením dělat (případně i po vložení).

Není problém, aby tam byly obě metody, ovšem asi by se tím zkomplikovaly závislosti, protože by vás to asi svádělo k tomu, že budete ve třídě User používat RoleManager (a to si pak rovnou rozmyslete, jestli jedete podle ActiveRecord vzoru nebo jinak).

Opravdu se podívejte, jak to dělají jiné frameworky. Já v php používám akorát PropelORM (ve verzi 1.x http://propelorm.org/Propel/documentation/ ) a nenarazil jsem na problém, v podstatě si udělám databázi, nechám si z ní vygeneroval model a mám vše hotové a hned po ruce. Pokud to uděláte i vy, bude vám IDE napovídat všechny metody a z toho hned pochopíte, jak to funguje. Psát vlastní třídy má smysl jen pro sebevzdělání a snadnější pochopení lepších nástrojů

[nr]

Není problém, aby tam byly obě metody, ovšem asi by se tím zkomplikovaly závislosti, protože by vás to asi svádělo k tomu, že budete ve třídě User používat RoleManager (a to si pak rovnou rozmyslete, jestli jedete podle ActiveRecord vzoru nebo jinak).

Prošel jsem si PropelORM a tohle ale přesně dělá. Respektive dělá to oklikou. Tj. něco jako bych měl objekt RoleCollection a ten by se sám plnil, tj. v něm by se používalo RoleManager.

[OldFrog {Ondra Nemecek}]

Prošel jsem si PropelORM a tohle ale přesně dělá.

Ano, však PropelORM je taky podle ActiveRecord vzoru - záznamy ukládají samy sebe. Ve Vašem návrhu máte ale na ukládání Manager. Rozhodněte se pro jeden přístup a ten dodržujte. To jsem měl na mysli.

Je spousta nuancí, jak komponenty skládat - pamatujte na to, že budete potřebovat nejen základní CRUD operace, ale i uživatelsky definované dotazy, stránkování a podmínky. Pak už je docela těžké, aby byly závislosti přehledné a jednotlivé komponenty třeba i nahraditelné. Dobrá otázka dále například je, zde mají být záznamy snadno automaticky serializovatelné třeba do XML nebo do JSON - a do jaké hloubky má serializace probíhat. A odlišujte, jak vypadá váš systém uvnitř a jak vypadá pro použití programátorem. Interně mohou záznamy používat nějaký Manager, ale zvenčí se třeba používají jako ActiveRecord.

[nr]

Pak je ale otázka jak třeba vyřešit lazy loading. Na to by bylo ideální zkombinovat ten Manager (DataMapper vzor) se samonačtením (spíš Active Record). Na DataMapper úrovni je to řešené třeba na http://stackoverflow.com/questions/7575751/how-to-load-child-objects-lazily-with-the-data-mapper-pattern:

...
        $user = new User( $userData );
        $user->addresses = new ModelRelation(
            $this->_addressesMapper,
            'getAddressesByUserId',
            array( $id )
        );
...

V čem je horší přístup, kdyby místo výše uvedeného bylo použito toto?

...
        $user = new User( $userData );
        $user->addresses = new UserAddressList();
...

Samozřejmě ta instance UserAddressList by se dělala přímo v User automaticky při prvním dotazu typu getAddresses(). UserAddressList by byla speciálně třída pro tuto funkci a ta by si sama získávala instanci Managera.

[OldFrog {Ondra Nemecek}]

Úplně nerozumím - bez znalosti implementace UserAddressList se asi nedá hodnotit. A neschází tam v tom konstruktoru nějaké parametry?

ModelRelation se snaží zdá se o co největší abstrakci a automatiku, nicméně pokud by mělo být těch pár řádku uvedených výše veřejné rozhraní, tak to nic moc - volat metody podle názvu uloženého ve stringu je náchylné na překlepy a dost nepraktické (např. nefunguje IDE completion).

Nastavování členských proměnných bych řešil spíš gettery a settery. Resp. sám to dělám, že pokud mám jednoduchý objekt sloužící jen pro ukládání hodnot (DTO), tak pak někdy nastavuju členské proměnné přímo, ale pokud je objekt složitější a má i nějakou funkčnost (další metody), tak pak většinou jdu přes gettery a settery.

[OldFrog {Ondra Nemecek}]

PS: Při programování doporučuju postupovat cca takto:

1. napíšete si položky datového modelu
2. napíšete si, co to má navenek umět
3. rozepíšete na jednotlivé komponenty
4. napíšete signatury veřejných rozhraní
5. ...pak teprve programujete v pc...
6. po skončení projektu si napíšete, na co jste v 1-4 zapomněl, abyste stejnou chybu příště neopakoval

Papír, nůžky a velký stůl jsou v 1-3 dobrý pomocník.