ADR-002 - Apstrakcija baze podataka
ADR-002: Apstrakcija baze podataka
Section titled “ADR-002: Apstrakcija baze podataka”Zapis odluke o arhitekturi za XOOPS model pristupa objektno orijentiranoj bazi podataka.
Status
Section titled “Status”Prihvaćeno - Osnovni uzorak od XOOPS 2.0
Kontekst
Section titled “Kontekst”XOOPS trebala je strategija interakcije baze podataka koja bi:
- Apstrahirajte SQL sintaksu specifičnu za bazu podataka
- Osigurajte dosljedne CRUD operacije u svim modules
- Omogućite automatsku obradu podataka i izbjegavanje
- Podržite buduće promjene pogona baze podataka
- Pojednostavite uobičajene operacije za programere
Alternative su bile:
- Neobrađeni SQL u cijeloj bazi koda
- Potpuni ORM (doktrina, elokventno)
- Prilagođena lagana apstrakcija
Dijagram odluke
Section titled “Dijagram odluke”graph TB subgraph "Application Layer" A[Module Code] B[Handler Methods] end
subgraph "Abstraction Layer" C[XoopsObjectHandler] D[XoopsPersistableObjectHandler] E[Criteria System] end
subgraph "Database Layer" F[XoopsDatabase] G[MySQLDatabase] H[PDO Wrapper] end
subgraph "Storage" I[(MySQL/MariaDB)] end
A --> B B --> C B --> D C --> E D --> E E --> F F --> G F --> H G --> I H --> IOdluka
Section titled “Odluka”Implementirat ćemo Uzorak rukovatelja sa:
1. XoopsObject - Spremnik podataka
Section titled “1. XoopsObject - Spremnik podataka”Svaki podatkovni entitet proširuje XoopsObject:
class Item extends XoopsObject{ public function __construct() { $this->initVar('id', XOBJ_DTYPE_INT, null, false); $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true, 255); $this->initVar('content', XOBJ_DTYPE_TXTAREA, '', false); $this->initVar('status', XOBJ_DTYPE_INT, 0, false); }}2. Handler - Operations Manager
Section titled “2. Handler - Operations Manager”Svaki objekt ima odgovarajući rukovatelj:
class ItemHandler extends XoopsPersistableObjectHandler{ public function __construct($db) { parent::__construct($db, 'mymodule_items', Item::class, 'id', 'title'); }
// CRUD methods inherited: // - create(), get(), insert(), delete() // - getObjects(), getCount(), getAll()}3. Kriteriji - Query Builder
Section titled “3. Kriteriji - Query Builder”Uvjeti za objektno orijentirani upit:
$criteria = new CriteriaCompo();$criteria->add(new Criteria('status', 1));$criteria->add(new Criteria('created', time() - 86400, '>='));$criteria->setSort('created');$criteria->setOrder('DESC');$criteria->setLimit(10);
$items = $handler->getObjects($criteria);Konstante tipa podataka
Section titled “Konstante tipa podataka”// Variable types with automatic sanitizationXOBJ_DTYPE_INT // IntegerXOBJ_DTYPE_TXTBOX // Single-line text (escaped)XOBJ_DTYPE_TXTAREA // Multi-line text (escaped)XOBJ_DTYPE_EMAIL // Email validationXOBJ_DTYPE_URL // URL validationXOBJ_DTYPE_ARRAY // Serialized arrayXOBJ_DTYPE_OTHER // No processingXOBJ_DTYPE_FLOAT // Floating pointNasljeđivanje rukovatelja
Section titled “Nasljeđivanje rukovatelja”classDiagram class XoopsObjectHandler { <<abstract>> #db: XoopsDatabase +create(): XoopsObject +get(id): XoopsObject +insert(object): bool +delete(object): bool }
class XoopsPersistableObjectHandler { +getObjects(criteria): array +getCount(criteria): int +getAll(criteria): array +deleteAll(criteria): bool +updateAll(field, value, criteria): bool }
class ItemHandler { +getPublishedItems(): array +getByCategory(catId): array }
XoopsObjectHandler <|-- XoopsPersistableObjectHandler XoopsPersistableObjectHandler <|-- ItemHandlerPosljedice
Section titled “Posljedice”Pozitivno
Section titled “Pozitivno”- Dosljednost: Svi modules koriste iste uzorke
- Sigurnost: Automatsko bježanje sprječava ubrizgavanje SQL
- Jednostavnost: Uobičajene operacije zahtijevaju minimalan kod
- Pogodnost održavanja: Promjene na sloju baze podataka ne utječu na modules
- Provjerljivost: Rukovatelji se mogu ismijavati radi testiranja
Negativno
Section titled “Negativno”- Performanse: Dodatni troškovi apstrakcije
- Složenost: Krivulja učenja za nove programere
- Ograničenja: Za složene upite možda će trebati neobrađeni SQL
- N+1 problem: Nema ugrađenog brzog učitavanja
Ublažavanja
Section titled “Ublažavanja”- Performanse: Predmemorirajte objekte kojima se često pristupa
- Složeni upiti: dopustite sirovi SQL kada je potrebno
- N+1: Koristite getAll() s odgovarajućim kriterijima
Evolucija na XOOPS 4.0
Section titled “Evolucija na XOOPS 4.0”flowchart LR subgraph "Current (2.5.x)" A[XoopsDatabase] B[Handlers] C[Criteria] end
subgraph "Future (4.0.x)" D[PDO/DBAL] E[Repository Pattern] F[Query Builder] G[DI Container] end
A --> D B --> E C --> F D --> G E --> GXOOPS 4.0 planovi:
- Doktrina DBAL za apstrakciju baze podataka
- Rukovatelji koji zamjenjuju uzorak spremišta
- Alat za izradu složenih upita
- Potpuna integracija spremnika PSR-11
Primjeri koda
Section titled “Primjeri koda”Osnovni CRUD
Section titled “Osnovni CRUD”$helper = Helper::getInstance();$handler = $helper->getHandler('Item');
// Create$item = $handler->create();$item->setVar('title', 'New Item');$handler->insert($item);
// Read$item = $handler->get($id);$title = $item->getVar('title');
// Update$item->setVar('title', 'Updated Title');$handler->insert($item);
// Delete$handler->delete($item);Složeni upit
Section titled “Složeni upit”$criteria = new CriteriaCompo();$criteria->add(new Criteria('status', 'published'));$criteria->add(new Criteria('category_id', '(1,2,3)', 'IN'));$criteria->add(new Criteria('created', strtotime('-30 days'), '>='));$criteria->setSort('views');$criteria->setOrder('DESC');$criteria->setLimit(10);$criteria->setStart(0);
$items = $handler->getObjects($criteria);$total = $handler->getCount($criteria);Povezane odluke
Section titled “Povezane odluke”- ADR-001: Modularna arhitektura
- ADR-003: Smarty mehanizam predložaka
Reference
Section titled “Reference”- Martin Fowler - Obrasci arhitekture poslovnih aplikacija
- Koncepti dizajna vođeni domenom
- Active Record vs Data Mapper obrasci
#xoops #architecture #adr #database #handler #design-decision