關於PHP中Yii框架的組件行為的屬性注入與方法注入

這篇文章主要介紹了詳解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 容器。後者將會像前文所述那樣自動解決依賴關係。

以上就是本文的全部內容，希望對大家的學習有所幫助，更多相關內容請關注PHP中文網！

相關推薦：

Yii框架元件與事件行為管理的解析

關於Yii2建置後台並實作rbac權限控制

以上是關於PHP中Yii框架的組件行為的屬性注入與方法注入的詳細內容。更多資訊請關注PHP中文網其他相關文章！