使用接口

接口是系统架构师的实用工具，通常用于应用编程接口（API）的原型设计。接口不包含实际的代码，但可以包含方法的名称以及方法的签名。

{% hint style=”info” %} 接口中标识的所有方法的可见性级别均为 public。 {% endhint %}

如何做…

1.接口标识的方法不能包含实际的代码实现。 但是，您可以指定方法参数的数据类型。

2.在这个例子中，ConnectionAwareInterface 标识了一个方法 setConnection() ，它需要一个 Connection 的实例作为参数：

  1. interface ConnectionAwareInterface
  2. {
  3.   public function setConnection(Connection $connection);
  4. }

3.要使用该接口，请在定义该类的空白行之后添加关键字 Implements。 我们定义了两个类，CountryList 和 CustomerList ，这两个类都需要通过 setConnection() 方法访问 Connection 类。 为了识别这种依赖性，两个类都实现 ConnectionAwareInterface ：

  1. class CountryList implements ConnectionAwareInterface
  2. {
  3.   protected $connection;
  4.   public function setConnection(Connection $connection)
  5.   {
  6.     $this->connection = $connection;
  7.   }
  8.   public function list()
  9.   {
  10.     $list = [];
  11.     $stmt = $this->connection->pdo->query(
  12.       'SELECT iso3, name FROM iso_country_codes');
  13.     while ($country = $stmt->fetch(PDO::FETCH_ASSOC)) {
  14.       $list[$country['iso3']] =  $country['name'];
  15.     }
  16.     return $list;
  17.   }
  19. }
  20. class CustomerList implements ConnectionAwareInterface
  21. {
  22.   protected $connection;
  23.   public function setConnection(Connection $connection)
  24.   {
  25.     $this->connection = $connection;
  26.   }
  27.   public function list()
  28.   {
  29.     $list = [];
  30.     $stmt = $this->connection->pdo->query(
  31.       'SELECT id, name FROM customer');
  32.     while ($customer = $stmt->fetch(PDO::FETCH_ASSOC)) {
  33.       $list[$customer['id']] =  $customer['name'];
  34.     }
  35.     return $list;
  36.   }
  38. }

4.接口可用于满足类型提示。 下面的类 ListFactory 包含一个 factory() 方法，该方法将初始化任何实现 ConnectionAwareInterface 的类。 该接口可确保定义了 setConnection() 方法。 将类型提示设置为接口，而不是特定的类实例，使工厂方法更通用：

  1. namespace Application\Generic;
  3. use PDO;
  4. use Exception;
  5. use Application\Database\Connection;
  6. use Application\Database\ConnectionAwareInterface;
  8. class ListFactory
  9. {
  10.   const ERROR_AWARE = 'Class must be Connection Aware';
  11.   public static function factory(
  12.     ConnectionAwareInterface $class, $dbParams)
  13.   {
  14.     if ($class instanceof ConnectionAwareInterface) {
  15.         $class->setConnection(new Connection($dbParams));
  16.         return $class;
  17.     } else {
  18.         throw new Exception(self::ERROR_AWARE);
  19.     }
  20.     return FALSE;
  21.   }
  22. }

5.如果一个类实现了多个接口，如果方法签名不匹配，就会发生命名冲突。在这个例子中，有两个接口，DateAware 和 TimeAware。除了定义 setDate() 和 setTime() 方法外，它们都定义了 setBoth()。拥有重复的方法名并不是问题，尽管它不被认为是最佳实践。问题在于方法的签名不同：

  1. interface DateAware
  2. {
  3.   public function setDate($date);
  4.   public function setBoth(DateTime $dateTime);
  5. }
  7. interface TimeAware
  8. {
  9.   public function setTime($time);
  10.   public function setBoth($date, $time);
  11. }
  13. class DateTimeHandler implements DateAware, TimeAware
  14. {
  15.   protected $date;
  16.   protected $time;
  17.   public function setDate($date)
  18.   {
  19.     $this->date = $date;
  20.   }
  21.   public function setTime($time)
  22.   {
  23.     $this->time = $time;
  24.   }
  25.   public function setBoth(DateTime $dateTime)
  26.   {
  27.     $this->date = $date;
  28.   }
  29. }

6.由于该代码块的存在，将产生一个致命的错误（不能被捕获！）。为了解决这个问题，首选的方法是从任意一个接口中删除setBoth()的定义。或者，你也可以调整方法签名来匹配。

{% hint style=”info” %} 最佳实践

不要定义有重复或重叠方法定义的接口。 {% endhint %}

如何运行…

在 Application/Database 文件夹中，创建一个文件，ConnectionAwareInterface.php。插入前面第2步中讨论的代码。

接下来，在 Application/Generic文件夹中，创建两个文件，CountryList.php 和 CustomerList.php。插入步骤3中讨论的代码。

接下来，在与 Application 目录平行的目录下，创建一个源代码文件，chap_04_oop_simple_interfaces_example.php，该文件初始化自动加载器并包含数据库参数：

  1. <?php
  2. define('DB_CONFIG_FILE', '/../config/db.config.php');
  3. require __DIR__ . '/../Application/Autoload/Loader.php';
  4. Application\Autoload\Loader::init(__DIR__ . '/..');
  5. $params = include __DIR__ . DB_CONFIG_FILE;

在这个例子中，数据库参数被假定在 DB_CONFIG_FILE 常量所指示的数据库配置文件中。

现在您可以使用 ListFactory::factory() 来生成 CountryList 和 CustomerList 对象。请注意，如果这些类没有实现 ConnectionAwareInterface，就会抛出一个错误：

  1.   $list = Application\Generic\ListFactory::factory(
  2.     new Application\Generic\CountryList(), $params);
  3.   foreach ($list->list() as $item) echo $item . '';

以下是国家列表的输出：

使用接口 - 图1

你也可以使用工厂方法来生成一个 CustomerList 对象并使用它：

  1.  $list = Application\Generic\ListFactory::factory(
  2.     new Application\Generic\CustomerList(), $params);
  3.   foreach ($list->list() as $item) echo $item . '';

下面是 CustomerList 的输出：

如果您想研究当实现了多个接口，但方法签名不同时，会发生什么情况，将前面第4步所示的代码输入一个文件，chap_04_oop_interfaces_collisions.php。当您尝试运行这个文件时，会产生一个错误，如图所示：

使用接口 - 图2

如果您在 TimeAware 接口中进行以下调整，就不会产生错误：

  1. interface TimeAware
  2. {
  3.   public function setTime($time);
  4.   // 这会引起麻烦
  5.   public function setBoth(DateTime $dateTime);
  6. }