Laravel config/compile.php providersについて

Question

環境

Laravel v5.0.33

前提

artisan optimizeを試してみたいと思い、 config/compile.php に以下のように記述し artisan optimize を実行しました。
この記載は以前のデフォルト設定とほぼ同等の記載です。

return [
	'files' => [
		realpath(__DIR__.'/../app/Providers/AppServiceProvider.php'),
		realpath(__DIR__.'/../app/Providers/BusServiceProvider.php'),
		realpath(__DIR__.'/../app/Providers/ConfigServiceProvider.php'),
		realpath(__DIR__.'/../app/Providers/EventServiceProvider.php'),
		realpath(__DIR__.'/../app/Providers/RouteServiceProvider.php'),
	],

	'providers' => [
		//
	],
];

その後 Providers 配下のファイルが files に記載されているのが気持ち悪かったので、 providers に上記設定を移動しました。

return [
	'files' => [
                //  
	],

	'providers' => [
		'App\Providers\AppServiceProvider',
		'App\Providers\BusServiceProvider',
		'App\Providers\ConfigServiceProvider',
		'App\Providers\EventServiceProvider',
		'App\Providers\RouteServiceProvider',
	],
];

そして、以前に生成されたファイルを削除し、再度 artisan optimize を実行しました。

このとき生成された services.json と compiled.php それぞれdiffを取ってみたところ、services.json に差異はありませんでした。
一方の compiled.php を比較したところ、files に記載していた際に生成された以下の箇所が、 providers に記載して生成した compiled.php には存在しませんでした。

namespace App\Providers {
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
    }
    public function register()
    {
        $this->app->bind('Illuminate\\Contracts\\Auth\\Registrar', 'App\\Services\\Registrar');
    }
}
}

namespace App\Providers {
use Illuminate\Bus\Dispatcher;
use Illuminate\Support\ServiceProvider;
class BusServiceProvider extends ServiceProvider
{
    public function boot(Dispatcher $dispatcher)
    {
        $dispatcher->mapUsing(function ($command) {
            return Dispatcher::simpleMapping($command, 'App\\Commands', 'App\\Handlers\\Commands');
        });
    }
    public function register()
    {
    }
}
}

namespace App\Providers {
use Illuminate\Support\ServiceProvider;
class ConfigServiceProvider extends ServiceProvider
{
    public function register()
    {
        config(array());
    }
}
}

namespace App\Providers {
use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
    protected $listen = array('event.name' => array('EventListener'));
    public function boot(DispatcherContract $events)
    {
        parent::boot($events);
    }
}
}

namespace App\Providers {
use Illuminate\Routing\Router;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
class RouteServiceProvider extends ServiceProvider
{
    protected $namespace = 'App\\Http\\Controllers';
    public function boot(Router $router)
    {
        parent::boot($router);
    }
    public function map(Router $router)
    {
        $router->group(array('namespace' => $this->namespace), function ($router) {
            require app_path('Http/routes.php');
        });
    }
}
}

質問

ここで疑問が生じたのですが、providers に記載したのに生成されていないということは、 config/compile.php の files providers にはそれぞれ何をどのように記載をするのが正しいのでしょうか。
よろしくお願いします。

Answer 1

config/compile.phpのfilesは文字通り、
optimize実行時のコンパイルファイルに含ませたいソースコードのファイルを指定します。

providersは、サービスプロバイダのクラス名が記述できますが、
最適化ファイルに含めるために、サービスプロバイダでcompilesという静的メソッドを記述しなければいけません。

このcompilesメソッドへの記述は以下のようになります

    /**
     * {@inheritdoc}
     */
    public static function compiles()
    {
        return [
            base_path() . '/vendor/fluent/logger/src/Entity.php',
            base_path() . '/vendor/fluent/logger/src/Exception.php',
            base_path() . '/vendor/fluent/logger/src/FluentLogger.php',
            base_path() . '/vendor/fluent/logger/src/JsonPacker.php',
            base_path() . '/vendor/fluent/logger/src/LoggerInterface.php',
            base_path() . '/vendor/fluent/logger/src/PackerInterface.php',
        ];
    }

上記のように記述することでoptimize実行時に
Illuminate\Foundation\Console\OptimizeCommand内の下記コードが実行されます

foreach ($app['config']->get('compile.providers', []) as $provider) {
    $files = array_merge($files, forward_static_call([$provider, 'compiles']));
}

この機能は主にパッケージ開発などで利用できます。
(ほとんどの方がこの機能を使っていないので、仕組みを知らないと思います)

用途としては、フレームワーク内にありますOptimize/config.phpと同じですので、
ファイルの読み込みを減らして多少の高速化を図ることができます。

Comments

[退会済みユーザー]

回答ありがとうございます。
パッケージのソースコードが含まれるのですね。