4.1. Service Locator

CECI EST CONSIDÉRÉ COMME UN ANTI-PATTERN !

Le Service Locator est considéré par certains comme un anti-pattern. Il viole le principe d’inversion des dépendances. Le Service Locator cache les dépendances des classes au lieu de les exposer comme vous le feriez en utilisant l’injection de dépendances. En cas de modification de ces dépendances, vous risquez de casser la fonctionnalité des classes qui les utilisent, ce qui rend votre système difficile à maintenir.

4.1.1. Rôle

Mettre en œuvre une architecture faiblement couplée afin d’obtenir un code plus facile à tester, à maintenir et à étendre. Le modèle DI et le modèle Service Locator sont une mise en œuvre du modèle Inverse of Control.

4.1.2. Rôle

Avec ServiceLocator, vous pouvez enregistrer un service pour une interface donnée. En utilisant l’interface, vous pouvez récupérer le service et l’utiliser dans les classes de l’application sans connaître son implémentation. Vous pouvez configurer et injecter l’objet Service Locator au démarrage.

4.1.3. Diagramme UML

4.1.4. Code

Vous pouvez également trouver ce code sur 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);
    }
}