4.1. Service Locator

È CONSIDERATO UN ANTI-PATTERN

Il Service Locator è considerato per alcune persone come un anti-pattern. Viola il principio di inversione delle dipendenze. Il service locator nasconde le dipendenze delle classi invece di esporle come si farebbe utilizzando la Dependency Injection. Nel caso di cambiamenti di queste dipendenze rischiate di rompere le funzionalità delle classi che state utilizzando, rendendo il vostro sistema difficile da manutenere.

4.1.1. Scopo

Implementare un’architettura a basso accoppiamento in modo da ottenere codice più testabile, manutenibile ed estendibile. Questo pattern e il DI sono implementazioni del pattern di inversione del controllo.

4.1.2. Utilizzo

Con un ServiceLocator, potete registrare un servizio per una data interfaccia. Utilizzando questa interfaccia potete recuperare il servizio e utilizzarlo nelle classi dell’applicazione senza conoscere la sua implementazione. Potete configurare e iniettare il Service Locator all’avvio.

4.1.3. Diagramma UML

4.1.4. Codice

Potete trovare questo codice anche su 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. Test

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);
    }
}