依存注入コンテナ

依存注入 (DI) コンテナは、オブジェクトとそれが依存するすべてのブジェクトを、インスタンス化し、設定する方法を知っているオブジェクトです。なぜ DI コンテナが便利なのかは、Martin の記事の説明がわかりやすいでしょう。ここでは、主に Yii の提供する DI コンテナの使用方法を説明します。

依存注入

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

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

セッター/プロパティ·インジェクションは、構成情報を通してサポートされます。依存がそれに対応するセッターまたはプロパティを通して注入される場合、依存関係を登録するときや、新しいオブジェクトを作成するときに、依存注入のためにコンテナが使用する構成情報を提供することが出来ます。たとえば

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'),
]);

Info|情報: [[yii\di\Container::get()]] メソッドは三番目のパラメータを、生成されるオブジェクトに適用されるべき構成情報配列として受け取ります。クラスが [[yii\base\Configurable]] インタフェイスを実装している場合 (例えば、クラスが [[yii\base\Object]] である場合) には、この構成情報配列がクラスのコンストラクタの最後のパラメータとして渡されます。そうでない場合は、構成情報はオブジェクトが生成された後で適用されることになります。

PHP コーラブル・インジェクション

この場合、コンテナは、登録された PHP のコーラブルを使用して、クラスの新しいインスタンスを構築します。 [[yii\di\Container::get()]] が呼ばれるたびに、対応するコーラブルが起動されます。このコーラブルが、依存関係を解決し、新しく作成されたオブジェクトに適切に依存を注入する役目を果たします。たとえば

$container->set('Foo', function () {
    $foo = new Foo(new Bar);
    // ... その他の初期化 ...
    return $foo;
});

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

新しいオブジェクトを構築するための複雑なロジックを隠蔽するために、PHP コーラブルを返すスタティックなクラスメソッドを使うことが出来ます。例えば、

class FooBuilder
{
    public static function build()
    {
        return function () {
            $foo = new Foo(new Bar);
            // ... その他の初期化 ...
            return $foo;
       };
    }
}

$container->set('Foo', FooBuilder::build());

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

ご覧のように、PHP コーラブルが FooBuilder::build() メソッドによって返されています。このようにすれば、Foo クラスを構成しようとする人は、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);

補足: 依存の名前が対応する依存の定義と同じである場合は、それを 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() を介して登録されていたりされていなかったりする可能性があります。オプションで、クラスのコンストラクタのパラメータのリストや、新しく作成されたオブジェクトを設定するための設定情報を渡すことができます。たとえば

// "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()|get()]] メソッドを呼び出しています。前述のとおり、DI コンテナは(もしあれば)自動的に依存関係を解決し、新しく作成されたオブジェクトにそれらを注入します。 Yii は、新しいオブジェクトを作成するさい、そのコアコードのほとんどで [[Yii::createObject()]] を使用しているため、これは、 [[Yii::$container]] を扱えばグローバルにオブジェクトをカスタマイズすることができることを意味しています。

たとえば、 [[yii\widgets\LinkPager]] のページネーションボタンのデフォルト個数をグローバルにカスタマイズすることができます:

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

次のコードでビューでウィジェットを使用すれば、 maxButtonCount プロパティは、クラスで定義されているデフォルト値 10 の代わりに 5 で初期化されます。

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 のインスタンスが作成され、コントローラのコンストラクタに3番目のパラメータとして注入されるようになります。

いつ依存関係を登録するか

依存関係は、新しいオブジェクトが作成されるとき必要とされるので、それらの登録は可能な限り早期に行われるべきです。推奨プラクティス以下のとおりです:

あなたがアプリケーションの開発者である場合、アプリケーションのエントリスクリプト内、またはエントリスクリプトにインクルードされるスクリプト内で、依存関係を登録することができます。
あなたが再配布可能なエクステンションの開発者である場合は、エクステンションのブートストラップクラス内で依存関係を登録することができます。

まとめ

依存注入とサービスロケータはともに、疎結合でよりテストしやすい方法でのソフトウェア構築を可能にする、定番のデザインパターンです。依存注入とサービスロケータへのより深い理解を得るために、 Martin の記事を読むことを強くお勧めします。

Yii はそのサービスロケータを、依存注入 (DI) コンテナの上に実装しています。サービスロケータは、新しいオブジェクトのインスタンスを作成しようとするとき、DI コンテナに呼び出しを転送します。後者は、依存関係を、上で説明したように自動的に解決します。