【Laravel初心者向け】サービスコンテナと結合(バインド)について徹底解説

1 サービスコンテナへの結合
2 bindの基本的な使い方
- 2.1 プロバイダでMyServiceを結合
- 2.2 testServiceを利用

サービスコンテナへの結合

サービスコンテナは、必要なサービス類を全て自動的に組み込みます。ただ、クラス内で「ここでインスタンスを組み込みます」といった明示的な処理はありません。サービスコンテナが自動的にインスタンスを作成し、組み込んでいます。こうしたインスタンスの組み込み処理を「結合」と呼びます。

Laravel公式サービスコンテナ

この結合は勝手にやってくれる際は便利なのですが、時としてインスタンス作成を明示的に行いたい場合もあります。このような場合に、「どのようにインスタンスがサービスコンテナに結合されるか」を理解しておく必要があります。

インスタンスのサービスコンテナへの結合はサービスコンテナに用意されるbindメソッドを使用して行われます。

app()->bind(クラス名 , function($app)) {
    //--インスタンス生成処理--
    return インスタンス;
}

app()->bind(クラス名 , function($app)) {

//--インスタンス生成処理--

return インスタンス;

}

bindメソッドは結合するクラス名と、実際に結合に使うインスタンを返すクロージャ(関数)を引数に指定します。クロージャ内でインスタンスを作成し、returnすれば、そのインスタンスがサービスコンテナに結合されます。

サービスコンテナについて詳しく知りたい方はここを押してください。

bindの基本的な使い方

では実際にbindを使用してみましょう。

クラス構成について詳しく知りたい方はこちらの記事を参照ください

testServiceクラスを修正し、引数なしでインスタンスを作成し、後からIDを設定できるように修正しましょう。

<?php

namespace App\TestClasses;

class TestService
{
    private $intId = -1;
    private $strMsg = 'idがありません';
    private $aryData = ['one', 'two', 'three'];

    public function __construct() {
    }

    public function setId($intId) {
        $this->intId = $intId;
        if ($intId >= 0 && $intId < count($this->aryData)) {
            $this->strMsg = "select id:" . $intId
                . ", data:" . $this->aryData[$intId];
        }
    }

    public function say() {
        return $this->strMsg;
    }

    public function data(int $intId) {
        return $this->aryData[$intId];
    }

    public function alldata() {
        return $this->aryData;
    }
}

<?php

namespace App\TestClasses;

class TestService

{

private $intId = -1;

private $strMsg = 'idがありません';

private $aryData = ['one', 'two', 'three'];

public function __construct() {

}

public function setId($intId) {

$this->intId = $intId;

if ($intId >= 0 && $intId < count($this->aryData)) {

$this->strMsg = "select id:" . $intId

. ", data:" . $this->aryData[$intId];

}

public function say() {

return $this->strMsg;

}

public function data(int $intId) {

return $this->aryData[$intId];

}

public function alldata() {

return $this->aryData;

}

プロバイダでMyServiceを結合

上記で修正したtestserviceクラスを結合しましょう。システム全体で結合が反映されることを考えて、プロバイダを利用することをおすすめします。

app/Providers/AppServiceProvider.php を開きbootメソッドを下記の様に修正しましょう。

use App\TestClasses\TestService;

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        app()->bind("App\TestClasses\TestService", function($app) {
            $testservice = new TestService();
            $testservice->setId(0);
            return $testservice;
        });
    }

use App\TestClasses\TestService;

/**

* Bootstrap any application services.

* @return void

public function boot()

{

app()->bind("App\TestClasses\TestService", function($app) {

$testservice = new TestService();

$testservice->setId(0);

return $testservice;

});

}

上記でbindを使用してtestServiceの結合を行っております。クロージャでは、まずnew testServiceでインスタンスを作成し、setid(0)を0に設定しておきましょう。

testServiceを利用

では、testService利用してみましょう。

app/Http/Controllers/HelloController.php@indexを下記の様に修正してください。

    public function index(TestService $testservice ,int $intId = -1)
    {
        $testservice->setId($intId);
        $data = [
            'strMsg' => $testservice->say($intId),
            'aryData' => $testservice->alldata()
        ];
        return view('hello.index', $data);
    }