服务定位器模式（Service Locator）

服务定位器模式被认为是一种反面模式！

服务定位器模式被一些人认为是一种反面模式。它违反了依赖倒置原则。该模式隐藏类的依赖，而不是暴露依赖（如果暴露可通过依赖注入的方式注入依赖）。当某项服务的依赖发生变化时，使用该服务的类的功能将面临被破坏的风险，最终导致系统难以维护。

目的

服务定位器模式能够降低代码的耦合度，以便获得可测试、可维护和可扩展的代码。DI 模式和服务定位器模式是 IOC 模式的一种实现。

用法

使用 ServiceLocator ，你可以为给定的 interface 注册一个服务。通过使用这个 interface，你不需要知道该服务的实现细节，就可以获取并在你应用中使用该服务。你可以在引导程序中配置和注入服务定位器对象。

例子

  • Zend Framework2 使用服务定位器创建和共享框架中使用的服务（EventManager，ModuleManager，以及由模块提供的用户自定义服务等）

UML 图例

file

代码

你也可以在 GitHub 上查看此代码

ServiceLocator.php

  2. <?php
  4. namespace DesignPatterns\More\ServiceLocator;
  6. class ServiceLocator
  7. {
  8.     /**
  9.      * @var array
  10.      */
  11.     private $services = [];
  13.     /**
  14.      * @var array
  15.      */
  16.     private $instantiated = [];
  18.     /**
  19.      * @var array
  20.      */
  21.     private $shared = [];
  23.     /**
  24.      * 相比在这里提供一个类，你也可以为接口存储一个服务。
  25.      *
  26.      * @param string $class
  27.      * @param object $service
  28.      * @param bool $share
  29.      */
  30.     public function addInstance(string $class, $service, bool $share = true)
  31.     {
  32.         $this->services[$class] = $service;
  33.         $this->instantiated[$class] = $service;
  34.         $this->shared[$class] = $share;
  35.     }
  37.     /**
  38.      * 相比在这里提供一个类，你也可以为接口存储一个服务。
  39.      *
  40.      * @param string $class
  41.      * @param array $params
  42.      * @param bool $share
  43.      */
  44.     public function addClass(string $class, array $params, bool $share = true)
  45.     {
  46.         $this->services[$class] = $params;
  47.         $this->shared[$class] = $share;
  48.     }
  50.     public function has(string $interface): bool
  51.     {
  52.         return isset($this->services[$interface]) || isset($this->instantiated[$interface]);
  53.     }
  55.     /**
  56.      * @param string $class
  57.      *
  58.      * @return object
  59.      */
  60.     public function get(string $class)
  61.     {
  62.         if (isset($this->instantiated[$class]) && $this->shared[$class]) {
  63.             return $this->instantiated[$class];
  64.         }
  66.         $args = $this->services[$class];
  68.         switch (count($args)) {
  69.             case 0:
  70.                 $object = new $class();
  71.                 break;
  72.             case 1:
  73.                 $object = new $class($args[0]);
  74.                 break;
  75.             case 2:
  76.                 $object = new $class($args[0], $args[1]);
  77.                 break;
  78.             case 3:
  79.                 $object = new $class($args[0], $args[1], $args[2]);
  80.                 break;
  81.             default:
  82.                 throw new \OutOfRangeException('Too many arguments given');
  83.         }
  85.         if ($this->shared[$class]) {
  86.             $this->instantiated[$class] = $object;
  87.         }
  89.         return $object;
  90.     }
  91. }

LogService.php

  2. <?php
  4. namespace DesignPatterns\More\ServiceLocator;
  6. class LogService
  7. {
  8. }

测试

Tests/ServiceLocatorTest.php

  1. <?php
  3. namespace DesignPatterns\More\ServiceLocator\Tests;
  5. use DesignPatterns\More\ServiceLocator\LogService;
  6. use DesignPatterns\More\ServiceLocator\ServiceLocator;
  7. use PHPUnit\Framework\TestCase;
  9. class ServiceLocatorTest extends TestCase
  10. {
  11.     /**
  12.      * @var ServiceLocator
  13.      */
  14.     private $serviceLocator;
  16.     public function setUp()
  17.     {
  18.         $this->serviceLocator = new ServiceLocator();
  19.     }
  21.     public function testHasServices()
  22.     {
  23.         $this->serviceLocator->addInstance(LogService::class, new LogService());
  25.         $this->assertTrue($this->serviceLocator->has(LogService::class));
  26.         $this->assertFalse($this->serviceLocator->has(self::class));
  27.     }
  29.     public function testGetWillInstantiateLogServiceIfNoInstanceHasBeenCreatedYet()
  30.     {
  31.         $this->serviceLocator->addClass(LogService::class, []);
  32.         $logger = $this->serviceLocator->get(LogService::class);
  34.         $this->assertInstanceOf(LogService::class, $logger);
  35.     }
  36. }