Dependency Injection – Symfony inspired & Nella implementation – porting to Nette

Již poměrně dlouhou dobu používám(e) v Nella Frameworku pokročilejší implementaci Dependency Injection (dále DI). Nicméně toto DI bylo naroubované na stávajíci Nette a to bez jediného zásahu přímo do Nette. V tomto důsledku mělo k dokonalosti hodně daleko, kvůli nejrůznějším omezením (hlavně nutnosti implementovat Nette\DI\IContext a dědit Nette\DI\Configurator).

Poměrně dlouhou dobu mě v hlavě ležel nápad s pár vylepšeními a hlavně myšlenka portace do Nette. A tak jsem se do toho konečně pustil. Už je to rozdělané. Budu se snažit to průběžně házet na github (testovatelné řešení by mohlo být v průběhu dneška – zatím je tam pracovní verze – budou i testy (až se mě je podaří odbugovat)!).

Implementace je inspirovaná Symfony 2. Několik měsíců v praxi testována a vylaďována v „ostrém“ prostředí (pominuli několik málo změn).

Seznam nejdůležitějších změn a novinek

• sloučení config & variables (nyní už pouze jako variables)
• přesun toho všeho do Nette\DI\Context
• aliasy pro služby (jmenné)
• lepší konfigurovatelnost služeb díky „univerzální“ továrničce na služby
• Nette\DI\Configurator předělán na kompilátory + detekce prostředí přesunuta do Nette\Environment

Jak to celé funguje

Environment::loadConfig(); spustí Nette\DI\ContextBuilder který má za úkol vytvořit a naplnit Nette\DI\Context. Provede to za pomoci dvou kompilátorů a to Nette\DI\DefaultServicesCompilator (inicializace základních služeb) a Nette\DI\ConfigCompilator (zpracování config.neon / config.ini). Pokud pak chcete z Environmentu vytáhnout službu / proměnnou prostředí tak ve skutečnosti voláte context.

Změny samotného Nette\DI\Context

Pro celkově lepší práci se službami vznikl contextův pomocník Nette\DI\ServiceFactory. Ten má nastarosti právě vytváření služeb a držení informací o tom jak to má dělat.

Praxe

Simple class

PHP:

$context->addService('App\MyService', 'App\MyServiceClass');

Neon:

common:
	services:
		App\MyService = App\MyServiceClass
		#nebo
		App\MyService:
			class = App\MyServiceClass

Simple factory

PHP:

class MyService
{
	function create()
	{
		return new self;
	}
}

$context->addService('App\MyService', 'App\MyService::create');
//nebo
$context->addService('App\MyService', array('App\MyService', 'create'));
//nebo
$context->addService('App\MyService', callback('App\MyService', 'create'));
//nebo
$context->addService('App\MyService', function() {
	return new App\MyService;
});

Neon:

common:
	services:
		App\MyService = App\MyServiceClass::create
		#nebo
		App\MyService:
			factory = App\MyServiceClass::create

Class s parametry konstruktoru

PHP:

$context->addService('App\MyService', 'App\MyServiceClass')->setArguments(array('foo', 'bar'));
//nebo
$context->addService('App\MyService', 'App\MyServiceClass')->addArgument('foo')->addArgument('bar');

NEON:

common:
	services:
		App\MyService:
			class = App\MyServiceClass
			arguments = [foo,bar]

Továrnička s parametry

PHP:

$context->addService('App\MyService', function($first, $second) {
	return new App\MyService($first, $second);
})->setArguments(array('foo', 'bar'));
//nebo
$context->addService('App\MyService', function($first, $second) {
	return new App\MyService($first, $second);
})->addArgument('foo')->addArgument('bar');

NEON:

common:
	services:
		App\MyService:
			factory = App\MyServiceClass::create # function create($first, $second) { ... }
			arguments = [foo,bar]

Vstřikování pomocí metod

PHP:

$context->addService('App\MyService', 'App\MyServiceClass')->addMethodCall('setFoo', array('foo', 'bar');
// provede toto:
$test = new App\MyServiceClass;
$test->setFoo('foo', 'bar');
// tj je ekvivalentem pro
$context->addService('App\MyService', function() {
	$test = new App\MyServiceClass;
	$test->setFoo('foo', 'bar');
	return $test;
});

NEON:

common:
	services:
		App\MyService:
			factory = App\MyServiceClass
			methods:
				- {method: setFoo, arguments: ['foo','bar']}

Metod můžeme volat samozřejmě kolik chceme.

Konfigurátor

PHP:

$context->addService('App\MyService', 'App\MyServiceClass')->setConfigurator(function($service) {
	$service->setFoo('foo', 'bar');
	return $service;
});

NEON:

common:
	services:
		App\MyService:
			class = App\MyServiceClass
			configurator = App\MyServiceClass::configurate # function($service) { ... }

Specialitky argumentů:

Argumenty konstruktorů, továrniček a metod nemusejí být jenom skalární data ale i něco lepšího.

Environment variable

common:
	services:
		App\MyService:
			class = App\MyServiceClass
			arguments = ['%foo%'] # %foo% bude nahrazeno za "test"
	foo = "test"

Jednoduže řečeno cokoli mezi dvěma znaky % bude nahrazeno za data z proměnné prostředí se stejným názvem.

Service

common:
	services:
		App\MyService:
			class = App\MyServiceClass
			arguments = ['@Nette\Caching\IStorage'] # bude nahrazeno za instanci cache úložiště získaného pomocí služeb

Argument začínající zavináčem bude nahrazen za instanci služby se stejnám názvem.

Editoval Patrik Votoček (25. 4. 2011 1:43)