Vložek odvisnosti v XOOPS
Pregled
Section titled “Pregled”Vstavljanje odvisnosti (DI) je vzorec načrtovanja, ki komponentam omogoča, da prejmejo svoje odvisnosti iz zunanjih virov, namesto da bi jih ustvarile interno. XOOPS 4.0 uvaja PSR-11 združljivo podporo za vsebnik DI.
Zakaj vbrizgavanje odvisnosti?
Section titled “Zakaj vbrizgavanje odvisnosti?”Brez DI (tesna povezava)
Section titled “Brez DI (tesna povezava)”class ArticleService{ private ArticleRepository $repository; private EventDispatcher $dispatcher;
public function __construct() { // Hard dependencies - difficult to test and modify $this->repository = new ArticleRepository(new XoopsDatabase()); $this->dispatcher = new EventDispatcher(); }}Z DI (ohlapna spojka)
Section titled “Z DI (ohlapna spojka)”class ArticleService{ public function __construct( private readonly ArticleRepositoryInterface $repository, private readonly EventDispatcherInterface $dispatcher ) {}}PSR-11 Posoda
Section titled “PSR-11 Posoda”Osnovna uporaba
Section titled “Osnovna uporaba”use Psr\Container\ContainerInterface;
// Get the container$container = \Xmf\Module\Helper::getHelper('mymodule')->getContainer();
// Retrieve a service$articleService = $container->get(ArticleService::class);
// Check if service existsif ($container->has(ArticleService::class)) { // Use the service}Konfiguracija vsebnika
Section titled “Konfiguracija vsebnika”use Psr\Container\ContainerInterface;
return [ // Simple class instantiation ArticleRepository::class => ArticleRepository::class,
// Interface to implementation binding ArticleRepositoryInterface::class => ArticleRepository::class,
// Factory function ArticleService::class => function (ContainerInterface $c): ArticleService { return new ArticleService( $c->get(ArticleRepositoryInterface::class), $c->get(EventDispatcherInterface::class) ); },
// Shared instance (singleton) 'database' => function (): XoopsDatabase { return XoopsDatabaseFactory::getDatabaseConnection(); },];Registracija storitve
Section titled “Registracija storitve”Samodejno ožičenje
Section titled “Samodejno ožičenje”// The container automatically resolves dependencies// when type hints are available
class ArticleController{ public function __construct( private readonly ArticleService $service, private readonly ViewRenderer $renderer ) {}}
// Container creates ArticleController with its dependencies$controller = $container->get(ArticleController::class);Ročna registracija
Section titled “Ročna registracija”return [ ArticleService::class => [ 'class' => ArticleService::class, 'arguments' => [ ArticleRepositoryInterface::class, EventDispatcherInterface::class, ], 'shared' => true, // Singleton ],
'article.handler' => [ 'factory' => [ArticleHandlerFactory::class, 'create'], 'arguments' => ['@database'], // Reference other service ],];Vbrizgavanje konstruktorja
Section titled “Vbrizgavanje konstruktorja”Prednostni pristop
Section titled “Prednostni pristop”final class ArticleService{ public function __construct( private readonly ArticleRepositoryInterface $repository, private readonly EventDispatcherInterface $dispatcher, private readonly LoggerInterface $logger ) {}
public function create(CreateArticleDTO $dto): Article { $this->logger->info('Creating article', ['title' => $dto->title]);
$article = Article::create($dto); $this->repository->save($article); $this->dispatcher->dispatch(new ArticleCreatedEvent($article));
return $article; }}Metoda Injekcija
Section titled “Metoda Injekcija”Za neobvezne odvisnosti
Section titled “Za neobvezne odvisnosti”class ArticleController{ public function __construct( private readonly ArticleService $service ) {}
public function show(int $id, ?CacheInterface $cache = null): Response { $cacheKey = "article_{$id}";
if ($cache && $cached = $cache->get($cacheKey)) { return $this->render($cached); }
$article = $this->service->findById($id);
$cache?->set($cacheKey, $article, 3600);
return $this->render($article); }}Vezava vmesnika
Section titled “Vezava vmesnika”Definirajte vmesnike
Section titled “Definirajte vmesnike”interface ArticleRepositoryInterface{ public function findById(int $id): ?Article; public function save(Article $article): void; public function delete(Article $article): void;}Implementacija povezovanja
Section titled “Implementacija povezovanja”return [ ArticleRepositoryInterface::class => XoopsArticleRepository::class,
// Or with factory ArticleRepositoryInterface::class => function (ContainerInterface $c) { return new XoopsArticleRepository( $c->get('database') ); },];Testiranje z DI
Section titled “Testiranje z DI”Lahko norčevanje
Section titled “Lahko norčevanje”class ArticleServiceTest extends TestCase{ public function testCreateArticle(): void { // Create mocks $repository = $this->createMock(ArticleRepositoryInterface::class); $dispatcher = $this->createMock(EventDispatcherInterface::class); $logger = $this->createMock(LoggerInterface::class);
// Inject mocks $service = new ArticleService($repository, $dispatcher, $logger);
// Set expectations $repository->expects($this->once())->method('save'); $dispatcher->expects($this->once())->method('dispatch');
// Test $dto = new CreateArticleDTO('Title', 'Content'); $article = $service->create($dto);
$this->assertInstanceOf(Article::class, $article); }}XOOPS Legacy Integration
Section titled “XOOPS Legacy Integration”Premostitev starega in novega
Section titled “Premostitev starega in novega”// Get service from container in legacy codefunction mymodule_get_articles(int $limit): array{ $container = \Xmf\Module\Helper::getHelper('mymodule')->getContainer(); $service = $container->get(ArticleService::class);
return $service->findRecent($limit);}Ovijanje podedovanih obdelovalcev
Section titled “Ovijanje podedovanih obdelovalcev”return [ 'article.handler' => function () { return xoops_getModuleHandler('article', 'mymodule'); },
ArticleRepositoryInterface::class => function (ContainerInterface $c) { return new LegacyArticleRepository( $c->get('article.handler') ); },];Najboljše prakse
Section titled “Najboljše prakse”- Inject Interfaces – odvisno od abstrakcij, ne od implementacij
- Constructor Injection - Dajte prednost konstruktorju kot setter injekciji
- Ena odgovornost - Vsak razred mora imeti nekaj odvisnosti
- Izogibajte se zavedanju vsebnika – Storitve ne bi smele vedeti za vsebnik
- Konfiguriraj, ne kodiraj - Uporabite konfiguracijske datoteke za ožičenje
Povezana dokumentacija
Section titled “Povezana dokumentacija”- ../07-XOOPS-4.0/Implementation-Guides/PSR-11-Dependency-Injection-Guide - PSR-11 implementacija
- ../03-Module-Development/Patterns/Service-Layer - Servisni vzorec
- ../03-Module-Development/Best-Practices/Testing - Testiranje z DI
- ../07-XOOPS-4.0/XOOPS-4.0-Architecture - Pregled arhitekture