詳解PHP的Yii框架中組件行為的屬性注入和方法注入

行為的屬性和方法注入原理

上面我們了解到了行為的用意在於將自身的屬性和方法注入給所依附的類。 那麼Yii中是如何將一個行為 yii\base\Behavior 的屬性和方法， 注入到一個 yii\base\Component 中的呢？ 對於屬性而言，是通過 __get() 和 __set() 魔術方法來實現的。 對於方法，是通過 __call() 方法。

屬性的注入

以讀取為例，如果訪問 $Component->property1 ，Yii在幕後干了些什麼呢？ 這個看看 yii\base\Component::__get()

public function __get($name)
{
  $getter = 'get' . $name;
  if (method_exists($this, $getter)) {
    return $this->$getter();
  } else {
    // 注意這個 else 分支的內容，正是與 yii\base\Object::__get() 的
    // 不同之處
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
      if ($behavior->canGetProperty($name)) {

        // 屬性在行為中須為 public。否則不可能通過下面的形式訪問呀。
        return $behavior->$name;
      }
    }
  }
  if (method_exists($this, 'set' . $name)) {
    throw new InvalidCallException('Getting write-only property: ' .
      get_class($this) . '::' . $name);
  } else {
    throw new UnknownPropertyException('Getting unknown property: ' .
      get_class($this) . '::' . $name);
  }
}

重點來看 yii\base\Compoent::__get() 與 yii\base\Object::__get() 的不同之處。 就是在於對於未定義getter函數之後的處理， yii\base\Object 是直接拋出異常， 告訴你想要訪問的屬性不存在之類。 但是 yii\base\Component 則是在不存在getter之後，還要看看是不是注入的行為的屬性：

首先，調用了 $this->ensureBehaviors() 。這個方法已經在前面講過了，主要是確保行為已經綁定。
在確保行為已經綁定後，開始遍歷 $this->_behaviors 。 Yii將類所有綁定的行為都保存在 yii\base\Compoent::$_behaviors[] 數組中。
最後，通過行為的 canGetProperty() 判斷這個屬性， 是否是所綁定行為的可讀屬性，如果是，就返回這個行為的這個屬性 $behavior->name 。 完成屬性的讀取。 至於 canGetProperty() 已經在 :ref::property 部分已經簡單講過了， 後面還會有針對性地一個介紹。
對於setter，代碼類似，這裡就不占用篇幅了。

方法的注入

與屬性的注入通過 __get() __set() 魔術方法類似， Yii通過 __call() 魔術方法實現對行為中方法的注入:

public function __call($name, $params)
{
  $this->ensureBehaviors();
  foreach ($this->_behaviors as $object) {
    if ($object->hasMethod($name)) {
      return call_user_func_array([$object, $name], $params);
    }
  }
  throw new UnknownMethodException('Calling unknown method: ' .
    get_class($this) . "::$name()");
}

從上面的代碼中可以看出，Yii還是先是調用了 $this->ensureBehaviors() 確保行為已經綁定。

然後，也是遍歷 yii\base\Component::$_behaviros[] 數組。 通過 hasMethod() 方法判斷方法是否存在。 如果所綁定的行為中要調用的方法存在，則使用PHP的 call_user_func_array() 調用之。 至於 hasMethod() 方法，我們後面再講。

注入屬性與方法的訪問控制

在前面我們針對行為中public和private、protected的成員在所綁定的類中是否可訪問舉出了具體例子。 這裡我們從代碼層面解析原因。

在上面的內容，我們知道，一個屬性可不可訪問，主要看行為的 canGetProperty() 和 canSetProperty() 。 而一個方法可不可調用，主要看行為的 hasMethod() 。 由於 yii\base\Behavior 繼承自我們的老朋友 yii\base\Object ，所以上面提到的三個判斷方法， 事實上代碼都在 Object 中。我們一個一個來看:

public function canGetProperty($name, $checkVars = true)
{
  return method_exists($this, 'get' . $name) || $checkVars &&
    property_exists($this, $name);
}

public function canSetProperty($name, $checkVars = true)
{
  return method_exists($this, 'set' . $name) || $checkVars &&
    property_exists($this, $name);
}

public function hasMethod($name)
{
  return method_exists($this, $name);
}

這三個方法真的談不上復雜。對此，我們可以得出以下結論：

當向Component綁定的行為讀取（寫入）一個屬性時，如果行為為該屬性定義了一個getter (setter)，則可以訪問。 或者，如果行為確實具有該成員變量即可通過上面的判斷，此時，該成員變量可為 public, private, protected。 但最終只有 public 的成員變量才能正確訪問。原因在上面講注入的原理時已經交待了。
當調用Component綁定的行為的一個方法時，如果行為已經定義了該方法，即可通過上面的判斷。 此時，這個方法可以為 public, private, protected。 但最終只有 public 的方法才能正確調用。如果你理解了上一款的原因，那麼這裡也就理解了。

依賴注入容器
依賴注入（Dependency Injection，DI）容器就是一個對象，它知道怎樣初始化並配置對象及其依賴的所有對象。Martin 的文章 已經解釋了 DI 容器為什麼很有用。這裡我們主要講解 Yii 提供的 DI 容器的使用方法。

依賴注入

Yii 通過 yii\di\Container 類提供 DI 容器特性。它支持如下幾種類型的依賴注入：

• 構造方法注入;
• Setter 和屬性注入;
• PHP 回調注入.
• 構造方法注入

在參數類型提示的幫助下，DI 容器實現了構造方法注入。當容器被用於創建一個新對象時，類型提示會告訴它要依賴什麼類或接口。容器會嘗試獲取它所依賴的類或接口的實例，然後通過構造器將其注入新的對象。例如：

class Foo
{
  public function __construct(Bar $bar)
  {
  }
}

$foo = $container->get('Foo');
// 上面的代碼等價於：
$bar = new Bar;
$foo = new Foo($bar);

Setter 和屬性注入

Setter 和屬性注入是通過配置提供支持的。當注冊一個依賴或創建一個新對象時，你可以提供一個配置，該配置會提供給容器用於通過相應的 Setter 或屬性注入依賴。例如：

use yii\base\Object;

class Foo extends Object
{
  public $bar;

  private $_qux;

  public function getQux()
  {
    return $this->_qux;
  }

  public function setQux(Qux $qux)
  {
    $this->_qux = $qux;
  }
}

$container->get('Foo', [], [
  'bar' => $container->get('Bar'),
  'qux' => $container->get('Qux'),
]);

PHP 回調注入

這種情況下，容器將使用一個注冊過的 PHP 回調創建一個類的新實例。回調負責解決依賴並將其恰當地注入新創建的對象。例如：

$container->set('Foo', function () {
  return new Foo(new Bar);
});

$foo = $container->get('Foo');

注冊依賴關系

可以用 yii\di\Container::set() 注冊依賴關系。注冊會用到一個依賴關系名稱和一個依賴關系的定義。依賴關系名稱可以是一個類名，一個接口名或一個別名。依賴關系的定義可以是一個類名，一個配置數組，或者一個 PHP 回調。

$container = new \yii\di\Container;

// 注冊一個同類名一樣的依賴關系，這個可以省略。
$container->set('yii\db\Connection');

// 注冊一個接口
// 當一個類依賴這個接口時，相應的類會被初始化作為依賴對象。
$container->set('yii\mail\MailInterface', 'yii\swiftmailer\Mailer');

// 注冊一個別名。
// 你可以使用 $container->get('foo') 創建一個 Connection 實例
$container->set('foo', 'yii\db\Connection');

// 通過配置注冊一個類
// 通過 get() 初始化時，配置將會被使用。
$container->set('yii\db\Connection', [
  'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
  'username' => 'root',
  'password' => '',
  'charset' => 'utf8',
]);

// 通過類的配置注冊一個別名
// 這種情況下，需要通過一個 “class” 元素指定這個類
$container->set('db', [
  'class' => 'yii\db\Connection',
  'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
  'username' => 'root',
  'password' => '',
  'charset' => 'utf8',
]);

// 注冊一個 PHP 回調
// 每次調用 $container->get('db') 時，回調函數都會被執行。
$container->set('db', function ($container, $params, $config) {
  return new \yii\db\Connection($config);
});

// 注冊一個組件實例
// $container->get('pageCache') 每次被調用時都會返回同一個實例。
$container->set('pageCache', new FileCache);

Tip: 如果依賴關系名稱和依賴關系的定義相同，則不需要通過 DI 容器注冊該依賴關系。
通過 set() 注冊的依賴關系，在每次使用時都會產生一個新實例。可以使用 yii\di\Container::setSingleton() 注冊一個單例的依賴關系：

$container->setSingleton('yii\db\Connection', [
  'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
  'username' => 'root',
  'password' => '',
  'charset' => 'utf8',
]);

解決依賴關系

注冊依賴關系後，就可以使用 DI 容器創建新對象了。容器會自動解決依賴關系，將依賴實例化並注入新創建的對象。依賴關系的解決是遞歸的，如果一個依賴關系中還有其他依賴關系，則這些依賴關系都會被自動解決。

可以使用 yii\di\Container::get() 創建新的對象。該方法接收一個依賴關系名稱，它可以是一個類名，一個接口名或一個別名。依賴關系名或許是通過 set() 或 setSingleton() 注冊的。你可以隨意地提供一個類的構造器參數列表和一個configuration 用於配置新創建的對象。例如：

// "db" 是前面定義過的一個別名
$db = $container->get('db');

// 等價於： $engine = new \app\components\SearchEngine($apiKey, ['type' => 1]);
$engine = $container->get('app\components\SearchEngine', [$apiKey], ['type' => 1]);

代碼背後，DI 容器做了比創建對象多的多的工作。容器首先將檢查類的構造方法，找出依賴的類或接口名，然後自動遞歸解決這些依賴關系。

如下代碼展示了一個更復雜的示例。UserLister 類依賴一個實現了 UserFinderInterface 接口的對象；UserFinder 類實現了這個接口，並依賴於一個 Connection 對象。所有這些依賴關系都是通過類構造器參數的類型提示定義的。通過屬性依賴關系的注冊，DI 容器可以自動解決這些依賴關系並能通過一個簡單的 get('userLister') 調用創建一個新的 UserLister 實例。

namespace app\models;

use yii\base\Object;
use yii\db\Connection;
use yii\di\Container;

interface UserFinderInterface
{
  function findUser();
}

class UserFinder extends Object implements UserFinderInterface
{
  public $db;

  public function __construct(Connection $db, $config = [])
  {
    $this->db = $db;
    parent::__construct($config);
  }

  public function findUser()
  {
  }
}

class UserLister extends Object
{
  public $finder;

  public function __construct(UserFinderInterface $finder, $config = [])
  {
    $this->finder = $finder;
    parent::__construct($config);
  }
}

$container = new Container;
$container->set('yii\db\Connection', [
  'dsn' => '...',
]);
$container->set('app\models\UserFinderInterface', [
  'class' => 'app\models\UserFinder',
]);
$container->set('userLister', 'app\models\UserLister');

$lister = $container->get('userLister');

// 等價於:

$db = new \yii\db\Connection(['dsn' => '...']);
$finder = new UserFinder($db);
$lister = new UserLister($finder);

實踐中的運用

當在應用程序的入口腳本中引入 Yii.php 文件時，Yii 就創建了一個 DI 容器。這個 DI 容器可以通過 Yii::$container 訪問。當調用 Yii::createObject() 時，此方法實際上會調用這個容器的 yii\di\Container::get() 方法創建新對象。如上所述，DI 容器會自動解決依賴關系（如果有）並將其注入新創建的對象中。因為 Yii 在其多數核心代碼中都使用了 Yii::createObject() 創建新對象，所以你可以通過 Yii::$container 全局性地自定義這些對象。

例如，你可以全局性自定義 yii\widgets\LinkPager 中分頁按鈕的默認數量:

\Yii::$container->set('yii\widgets\LinkPager', ['maxButtonCount' => 5]);

這樣如果你通過如下代碼在一個視圖裡使用這個掛件，它的 maxButtonCount 屬性就會被初始化為 5 而不是類中定義的默認值 10。

echo \yii\widgets\LinkPager::widget();

然而你依然可以覆蓋通過 DI 容器設置的值：

echo \yii\widgets\LinkPager::widget(['maxButtonCount' => 20]);

另一個例子是借用 DI 容器中自動構造方法注入帶來的好處。假設你的控制器類依賴一些其他對象，例如一個旅館預訂服務。你可以通過一個構造器參數聲明依賴關系，然後讓 DI 容器幫你自動解決這個依賴關系。

namespace app\controllers;

use yii\web\Controller;
use app\components\BookingInterface;

class HotelController extends Controller
{
  protected $bookingService;

  public function __construct($id, $module, BookingInterface $bookingService, $config = [])
  {
    $this->bookingService = $bookingService;
    parent::__construct($id, $module, $config);
  }
}

如果你從浏覽器中訪問這個控制器，你將看到一個報錯信息，提醒你 BookingInterface 無法被實例化。這是因為你需要告訴 DI 容器怎樣處理這個依賴關系。

\Yii::$container->set('app\components\BookingInterface', 'app\components\BookingService');
現在如果你再次訪問這個控制器，一個 app\components\BookingService 的實例就會被創建並被作為第三個參數注入到控制器的構造器中。

什麼時候注冊依賴關系

由於依賴關系在創建新對象時需要解決，因此它們的注冊應該盡早完成。如下是推薦的實踐：

如果你是一個應用程序的開發者，你可以在應用程序的入口腳本或者被入口腳本引入的腳本中注冊依賴關系。
如果你是一個可再分發擴展的開發者，你可以將依賴關系注冊到擴展的引導類中。
總結

依賴注入和服務定位器都是流行的設計模式，它們使你可以用充分解耦且更利於測試的風格構建軟件。強烈推薦你閱讀 Martin 的文章，對依賴注入和服務定位器有個更深入的理解。

Yii 在依賴住入（DI）容器之上實現了它的服務定位器。當一個服務定位器嘗試創建一個新的對象實例時，它會把調用轉發到 DI 容器。後者將會像前文所述那樣自動解決依賴關系。