4.2. Lokalizator usług (Service Locator)

TEN WZORZEC PROJEKTOWY JEST UZNAWANY ZA ANTY-WZORZEC!

Lokalizator usług (ang. Service Locator) jest uważany przez część środowiska za anty-wzorzec. Łamie zasadę odwrócenia zależności ze zbioru zasad SOLID. Lokalizator usług ukrywa zależności danej klasy zamiast je udostępniać, jak ma to miejsce we wzorcu Wstrzykiwania zależności (ang. Dependency Injection). W przypadku zmiany w zależnościach ryzykujemy problemami z niepoprawnym działaniem klas, które z tych zależności korzystają. Powoduje to, że system staje się trudniejszy w utrzymaniu.

4.2.1. Przeznaczenie

Lokalizator usług jest używany do stworzenia luźno powiązanej architektury, w celu uzyskania kodu łatwiejszego w testowaniu, utrzymaniu i rozszerzaniu. Wzorce Wstrzykiwania zależności i Lokalizatora usług są implementacją wzorca Odwrócenia sterowania.

4.2.2. Użycie

Przy użyciu Lokalizatora usług możemy zarejestrować usługę pod daną nazwą interfejsu. Używając nazwy interfejsu możemy pobrać daną usługę i wykorzystywać ją dalej w klasach bez znajomości jej implementacji. Konfigurację i wstrzykiwanie obiektu Lokalizatora usług możemy ustawić na poziomie boostrapu aplikacji.

4.2.3. Przykłady

  • Zend Framework 2 wykorzystuje Lokalizator usług do tworzenia i udostępniania usług używanych w tym frameworku (np. EventManager, ModuleManager, dedykowane usługi udostępnione przez moduły, itp.).

4.2.4. Diagram UML

Alt ServiceLocator UML Diagram

4.2.5. Kod

Ten kod znajdziesz również na GitHub.

ServiceLocator.php

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?php

namespace DesignPatterns\More\ServiceLocator;

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

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

    /**
     * @var array
     */
    private $shared = [];

    /**
     * instead of supplying a class here, you could also store a service for an interface
     *
     * @param string $class
     * @param object $service
     * @param bool $share
     */
    public function addInstance(string $class, $service, bool $share = true)
    {
        $this->services[$class] = $service;
        $this->instantiated[$class] = $service;
        $this->shared[$class] = $share;
    }

    /**
     * instead of supplying a class here, you could also store a service for an interface
     *
     * @param string $class
     * @param array $params
     * @param bool $share
     */
    public function addClass(string $class, array $params, bool $share = true)
    {
        $this->services[$class] = $params;
        $this->shared[$class] = $share;
    }

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

    /**
     * @param string $class
     *
     * @return object
     */
    public function get(string $class)
    {
        if (isset($this->instantiated[$class]) && $this->shared[$class]) {
            return $this->instantiated[$class];
        }

        $args = $this->services[$class];

        switch (count($args)) {
            case 0:
                $object = new $class();
                break;
            case 1:
                $object = new $class($args[0]);
                break;
            case 2:
                $object = new $class($args[0], $args[1]);
                break;
            case 3:
                $object = new $class($args[0], $args[1], $args[2]);
                break;
            default:
                throw new \OutOfRangeException('Too many arguments given');
        }

        if ($this->shared[$class]) {
            $this->instantiated[$class] = $object;
        }

        return $object;
    }
}

LogService.php

1
2
3
4
5
6
7
<?php

namespace DesignPatterns\More\ServiceLocator;

class LogService
{
}

4.2.6. Testy

Tests/ServiceLocatorTest.php

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<?php

namespace DesignPatterns\More\ServiceLocator\Tests;

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

class ServiceLocatorTest extends TestCase
{
    /**
     * @var ServiceLocator
     */
    private $serviceLocator;

    public function setUp()
    {
        $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);
    }
}