Service Providers

Giới thiệu

Service providers là trung tâm của việc khởi tạo tất cả các ứng dụng Laravel. Ứng dụng của bạn, cũng như các thành phần core của Laravel được khởi tạo từ service providers.

Nhưng, "bootstrapped" nghĩa là sao? Đơn giản, ý là đăng ký, bao gồm đăng kí các liên kết tới service container, event listeners, middleware, và thậm chí các route. Service providers là trung tâp để cấu hình ứng dụng của bạn.

Nếu bạn mở file config/app.php nằm trong Laravel, bạn sẽ thấy một mảng providers. Tất cả những service provider class này sẽ được load vào trong ứng dụng. Tất nhiên, nhiều trong số đó được gọi là "deferred" providers, nghĩa là chúng không phải được load trong mọi request, chỉ khi có service nào yêu cầu thì mới thực hiện cung cấp.

Trong phần tổng quát này, bạn sẽ học cách viết service providers riêng của bạn và đăng kí chúng với Laravel.

Viết Service Providers

Tất cả các service providers đều kế thừa từ class Illuminate\Support\ServiceProvider. Hầu hết service providers chứa một phương thức registerboot. Trong phương thức register, bạn nên chỉ đăng ký vào trong service container. Bạn đừng bao giờ cố gắng đăng kí bất kì các event listeners, routes hay bất kì chắc năng nào khác vào trong hàm register.

Artisan CLI có thể dễ dàng sinh ra một provider mới thông qua lệnh make:provider:

php artisan make:provider RiakServiceProvider

Phương thức register

Như đã đề cập ở trước, bên trong hàm register, bạn chỉ nên thực hiện đăng kí vào trong service container. Bạn không nên bao giờ cố gắng đăng kí bất kì event listeners, routes hay bất kì các chức năng nào khác vào trong hàm register. Nếu không, bạn có thể vô tình sử dụng một service được cung cấp bởi một service provider mà chưa được tải.

Hãy xem một ví dụ service provider cơ bản bên dưới. Trong bất kỳ phương thức service provider, bạn có thể truy cập thuộc tính $app nó cung cấp để truy cập vào service container:

<?php

namespace App\Providers;

use Riak\Connection;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider
{
    /**
     * Register bindings in the container.
     *
     * @return  void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection(config('riak'));
        });
    }
}

Service provider này chỉ khai báo đúng một hàm register, và sử dụng nó để implementation Riak\Connection trong service container. Nếu bạn không hiểu cách hoạt động của service container, xem tại Service Container.

Phương thức Boot

Vậy nếu như chúng ta muốn đăng kí một view composer vào trong service provider thì sao? Điều này có thể thực hiện bên trong hàm boot. Hàm này được gọi sau khi tất cả các service providers đã được đăng kí, nghĩa là bạn có thể truy cập vào trong tất cả các services đã được đăng kí vào trong framework:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class ComposerServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return  void
     */
    public function boot()
    {
        view()->composer('view', function () {
            //
        });
    }
}

Boot Method Dependency Injection

Bạn có thể type-hint dependencies cho service provider của bạn ở hàm boot. service container sẽ tự động inject bất cứ dependencies nào bạn cần:

use Illuminate\Contracts\Routing\ResponseFactory;

public function boot(ResponseFactory $response)
{
    $response->macro('caps', function ($value) {
        //
    });
}

Đăng ký Providers

Tất cả các service provider được đăng kí bên trong file cấu hình config/app.php. File này chứa một mảng các providers danh sách tên của các service providers. Mặc định, một tập hợp các core service provider của Laravel nằm trong mảng này. Những provider này làm nhiệm vụ khởi tạo các thành phần core của Laravel, ví dụ như mailer, queue, cache, và các thành phần khác.

To register your provider, simply add it to the array:

'providers' => [
    // Other Service Providers

    App\Providers\ComposerServiceProvider::class,
],

Deferred Providers

Nếu bạn muốn provider chỉ đăng ký bindings trong service container, bạn có thể chọn trì hoãn việc đăng kí cho tới khi nào cần thiết. Việc trì hoãn quá trình tải một provider sẽ cải thiện performance của ứng dụng, vì nó không load từ filesystem trong mọi yêu cầu.

Laravel biên dịch và lưu một danh sách tất cả các services cung cấp bởi service providers trì hoãn, cùng với tên class service provider. Khi đó, chỉ khi nào bạn cần resolve một trong những service này thì Laravel mới thực hiện load service provider.

Để trì hoàn việc load một provider, set thuộc tính defer thành true avà định nghĩa một phương thức provides. Phương thức provides sẽ trả về bind service container mà provider này đăng kí:

<?php

namespace App\Providers;

use Riak\Connection;
use Illuminate\Support\ServiceProvider;

class RiakServiceProvider extends ServiceProvider
{
    /**
     * Indicates if loading of the provider is deferred.
     *
     * @var  bool
     */
    protected $defer = true;

    /**
     * Register the service provider.
     *
     * @return  void
     */
    public function register()
    {
        $this->app->singleton(Connection::class, function ($app) {
            return new Connection($app['config']['riak']);
        });
    }

    /**
     * Get the services provided by the provider.
     *
     * @return  array
     */
    public function provides()
    {
        return [Connection::class];
    }

}
Nguồn: https://laravel.com/docs/5.3/providers