4.1. Service Locator

DIES WIRD ALS EIN ANTI-MUSTER ANGESEHEN!

Der Service Locator gilt für manche Menschen als Anti-Muster. Es verstößt gegen das Prinzip der Dependency Inversion. Service Locator verbirgt Klassenabhängigkeiten, anstatt sie aufzudecken, wie Sie es mit der Dependency Injection tun würden. Im Falle von Änderungen dieser Abhängigkeiten besteht die Gefahr, dass die Funktionalität der Klassen, die diese Abhängigkeiten verwenden, beeinträchtigt wird, was die Wartung Ihres Systems erschwert.

4.1.1. Zweck

Um eine lose gekoppelte Architektur zu erhalten, die testbar, wartbar und erweiterbar ist. Sowohl das Dependency Injection, als auch das Service Locator Pattern sind Implementierungen des Inverse Of Control Patterns.

4.1.2. Verwendung

Mit dem Service Locator kann ein Service anhand eines Interfaces registriert werden. Mit dem Interface kann dann ein Service erhalten und verwendet werden, ohne dass die Anwendung die genaue Implementierung kennen muss. Der Service Locator selbst kann im Bootstrapping der Anwendung konfiguriert und injiziert werden.

4.1.3. UML Diagramm

4.1.4. Code

Du findest den Code auch auf GitHub

Service.php

<?php

namespace DesignPatterns\More\ServiceLocator;

interface Service
{
}

ServiceLocator.php

<?php

declare(strict_types=1);

namespace DesignPatterns\More\ServiceLocator;

use OutOfRangeException;
use InvalidArgumentException;

class ServiceLocator
{
    /**
     * @var string[][]
     */
    private array $services = [];

    /**
     * @var Service[]
     */
    private array $instantiated = [];

    public function addInstance(string $class, Service $service)
    {
        $this->instantiated[$class] = $service;
    }

    public function addClass(string $class, array $params)
    {
        $this->services[$class] = $params;
    }

    public function has(string $interface): bool
    {
        return isset($this->services[$interface]) || isset($this->instantiated[$interface]);
    }

    public function get(string $class): Service
    {
        if (isset($this->instantiated[$class])) {
            return $this->instantiated[$class];
        }

        $object = new $class(...$this->services[$class]);

        if (!$object instanceof Service) {
            throw new InvalidArgumentException('Could not register service: is no instance of Service');
        }

        $this->instantiated[$class] = $object;

        return $object;
    }
}

LogService.php

<?php

declare(strict_types=1);

namespace DesignPatterns\More\ServiceLocator;

class LogService implements Service
{
}

4.1.5. Теst

Tests/ServiceLocatorTest.php

<?php

declare(strict_types=1);

namespace DesignPatterns\More\ServiceLocator\Tests;

use DesignPatterns\More\ServiceLocator\LogService;
use DesignPatterns\More\ServiceLocator\ServiceLocator;
use PHPUnit\Framework\TestCase;

class ServiceLocatorTest extends TestCase
{
    private ServiceLocator $serviceLocator;

    public function setUp(): void
    {
        $this->serviceLocator = new ServiceLocator();
    }

    public function testHasServices()
    {
        $this->serviceLocator->addInstance(LogService::class, new LogService());

        $this->assertTrue($this->serviceLocator->has(LogService::class));
        $this->assertFalse($this->serviceLocator->has(self::class));
    }

    public function testGetWillInstantiateLogServiceIfNoInstanceHasBeenCreatedYet()
    {
        $this->serviceLocator->addClass(LogService::class, []);
        $logger = $this->serviceLocator->get(LogService::class);

        $this->assertInstanceOf(LogService::class, $logger);
    }
}