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 では、ゲッターがなくなった後、それが挿入された動作の属性であるかどうかを確認する必要があります。

最初に、$this->ensureBehaviors() が呼び出されます。このメソッドは、主に動作がバインドされていることを確認するために前に説明しました。
動作がバインドされていることを確認したら、$this->_behaviors のトラバースを開始します。 Yii は、クラスのすべてのバインドされた動作を yii\base\Component::$_behaviors[] 配列に保存します。
最後に、このプロパティがビヘイビアーの canGetProperty() を通じてバインドされたビヘイビアーの読み取り可能なプロパティであるかどうかを判断し、そうであれば、このビヘイビアーのプロパティ $behavior->name を返します。プロパティの読み取りを完了します。 canGetProperty() については、:ref::property セクションで簡単に説明されており、後で対象を絞った方法で紹介されます。
セッターの場合、コードは似ており、ここではスペースを取りません。

メソッドの注入

__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() メソッドについては、後ほど説明します。

注入されたプロパティとメソッドのアクセス制御

前のセクションでは、動作内のパブリック、プライベート、および保護されたメンバーがバインドされたクラスでアクセスできるかどうかをリストしました。 .具体例。ここではコードレベルからその理由を分析します。

上記の内容では、プロパティにアクセスできるかどうかは主に canGetProperty() と canSetProperty() の動作に依存することがわかります。メソッドを呼び出せるかどうかは、主に hasMethod() の動作に依存します。 yii\base\Behavior は古い友人である yii\base\Object を継承しているため、上記の 3 つの判定メソッドのコードは実際には Object にあります。 1 つずつ見てみましょう:

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);
}

これら 3 つの方法は、実際にはまったく複雑ではありません。この点に関して、次の結論を導き出すことができます。

コンポーネント バインドされた動作に対してプロパティを読み取る (書き込む) 場合、その動作がプロパティのゲッター (セッター) を定義している場合、そのプロパティにアクセスできます。または、ビヘイビアーにこのメンバー変数がある場合、この時点でメンバー変数はパブリック、プライベート、または保護される可能性があります。ただし、最終的にはパブリック メンバー変数のみが正しくアクセスできます。その理由は、注射の原理の説明で説明しました。
コンポーネントにバインドされたビヘイビアのメソッドを呼び出す場合、そのビヘイビアーがメソッドを定義していれば、上記の判定をパスすることができます。現時点では、このメソッドはパブリック、プライベート、または保護のいずれかにできます。ただし、最終的には public メソッドのみを正しく呼び出すことができます。前の理由が理解できれば、ここでも理解できるでしょう。

依存関係注入コンテナ
依存関係注入 (DI) コンテナは、オブジェクトとそれが依存するすべてのオブジェクトを初期化および構成する方法を認識するオブジェクトです。 Martin の記事では、DI コンテナーが役立つ理由をすでに説明しています。ここではYiiが提供するDIコンテナの使い方を中心に説明します。

Dependency Injection

Yii は、yii\di\Container クラスを通じて DI コンテナ機能を提供します。次のタイプの依存関係の注入をサポートしています:

• #コンストラクターの注入;

• セッターとプロパティの注入;

PHP コールバック インジェクション。
コンストラクター インジェクション
パラメーター タイプのヒントを利用して、DI コンテナーはコンストラクター インジェクションを実装します。コンテナーを使用して新しいオブジェクトを作成する場合、タイプ ヒントによって、コンテナーがどのクラスまたはインターフェイスに依存しているかがわかります。コンテナーは、依存するクラスまたはインターフェイスのインスタンスを取得しようとし、コンストラクターを通じてそれを新しいオブジェクトに注入します。例:

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

$foo = $container->get('Foo');
// 上面的代码等价于：
$bar = new Bar;
$foo = new Foo($bar);

セッターとプロパティのインジェクション

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 は、Dependency Intake (DI) コンテナーの上にサービス ロケーターを実装します。サービス ロケーターは、新しいオブジェクト インスタンスを作成しようとすると、呼び出しを DI コンテナに転送します。後者は、上記のように依存関係を自動的に解決します。

以上がこの記事の全内容です。その他の関連コンテンツについては、PHP 中国語 Web サイトをご覧ください。

関連する推奨事項:

Yii フレームワーク コンポーネントとイベント動作管理の分析

Yii2 のバックエンドの構築と実装についてrbac 権限制御

以上がPHPにおけるYiiフレームワークのコンポーネント動作のプロパティインジェクションとメソッドインジェクションについての詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。