[2009–08–19|c2ebb91] Důležitá změna API ServiceLocator (+ konfigurace)

V aktuální revizi došlo ke zpětně nekompatibilní změně v ServiceLocator a IComponent API.

ServiceLocator patří do core vrstvy frameworku a pokud jej nepoužíváte (tj. nevoláte metody addService() nebo getService()), můžete následující dva odstavce přeskočit. Hned za ním bude následovat vysvětlení, jakou novou funkčnost změny přinášejí.

Pro ostatní ukázka starého a nového API ServiceLocator. Klíčovou změnou je přehození prvního a druhého parametru u metody addService() – stačí tedy v kódu oba parametry prohodit a mělo by vše fungovat. Dřívější pořadí parametrů bylo velmi matoucí. Pokud jako službu uvádíte callback na továrnu ve tvaru „Trida::metoda()“, odstraňte závorky (smysl závorek padl se změnou oddělovače jmenných prostorů v PHP 5.3). Dále metoda getService() nemá druhý parametr $need – pokud potřebujete zjišťovat existenci služby, využijte metodu hasService().

Druhá změna se týká IComponent (ukázka starého a nového API), kde byla odstraněna experimentální podpora pro ServiceLocator. Vlastní locator pro komponenty se nikdy neujal, praxe ukazuje, že lokátor je potřeba spíš mimo strukturu komponent. API se tak zjednodušuje a je to první krok k tomu, aby bylo možno zprovoznit serializaci komponent. Pokud jste ServiceLocator u komponent používali a změna se vás dotkla, napište, najdeme nějaké řešení.

Chytřejší ServiceLocator + config.ini

Mít chytřejší ServiceLocator (a hloupější objekty) jsem měl v plánu docela dlouho, leč na úpravu stále nějak nebyl čas. U vylepšeného lokátoru lze určit, jestli je služba singleton a podle toho při každém požadavku (getService()) ji buď znovuvytvoří, nebo vrátí vždy tentýž objekt. Dále je možné továrně předat pole uživatelských parametrů – čtvrtý parametr addService() nebo druhý parametr getService() v případě ne-singletonů.

Zajímavé to začíná být ve spojení s konfigurací přes config.ini. Původní zjednodušená syntax

[common]
service.Nette-Security-IAuthenticator = Users

může být rozšířena (tj. jsou podporovány oba typy zápisu):

[common]
service.Nette-Security-IAuthenticator.factory = Model::createAuthenticator  ; nebo lze uvést jméno třídy
service.Nette-Security-IAuthenticator.singleton = TRUE ; což je i výchozí hodnota
service.Nette-Security-IAuthenticator.option.caseSensitive = TRUE
service.Nette-Security-IAuthenticator.option.useHash = FALSE

Takto je možno v konfiguraci podrobně popsat vytvářenou službu, tj. uvést všechny parametry metody addService().

Při prvním požadavku na službu (tj. při zavolání getService('Nette\Security\IAuthenticator')) se zavolá továrna, tedy statická metoda Model::createAuthenticator($options), kde $options je asociativní pole tvořené dvěma prvky uvedenými v konfiguraci. Továrnička vrátí objekt, ten se uloží a vrátí při každém dalším požadavku na stejnou službu. Kdyby bylo nastaveno singleton = FALSE, bude továrnička volána pokaždé znovu.

Navíc je možné službu nechat nastartovat. To se může hodit v případě, že si vytvoříme továrničku například na RobotLoader nebo Session. Konfigurace a registrace RobotLoaderu se tak může z bootstrap.php klidně přesunout do config.ini:

service.RobotLoader.factory = Nette\Configurator::createRobotLoader
service.RobotLoader.option.directory[] = "%appDir%"
service.RobotLoader.option.directory[] = "%libsDir%"
service.RobotLoader.run = TRUE ; spustí službu ihned po Environment::loadConfig()

V příkladu uvedená továrnička Nette\Configurator::createRobotLoader skutečně existuje. Její implementace nevyžaduje seznam indexovaných adresářů – pokud je vynecháme, použije se výchozí hodnota, což jsou právě cesty %appDir% a %libsDir%. Tudíž oba řádky service.RobotLoader.option.directory můžeme v tomto případě vynechat. Dokonce tato továrna je už předdefinovaná pod službou Nette\Loaders\RobotLoader – tedy vlastně stačí udělat jediné – službu nastartovat:

[common]
service.Nette-Loaders-RobotLoader.run = TRUE

Tento jeden řádek v config.ini eliminuje potřebu aktivovat RobotLoader v bootstrap.php.

Konfigurační soubor tak získává na síle. Mým záměrem je sjednotit možnosti konfigurace klíčových služeb a mít tak možnost nastavovat parametry Session nebo Application přímo v config.ini. Samozřejmě je čistě na programátorovi, který přístup použije.

Chytřejší třída Environment

Služby uložené v globálním service locatoru ve třídě Environment lze získat přes:

$service = Environment::getService('Nette\Web\IHttpRequest');

// což lze nahradit pohodlnějším a kratším
$service = Environment::getHttpRequest();

Nyní je možné v PHP 5.3 podobné aliasy uživatelsky definovat:

Environment::setServiceAlias('Nette\Web\IHttpRequest', 'xyz');
$service = Environment::getXyz();