laravel singleton 单例模式使用

laravel singleton 单例模式使用

1、简介

在 Laravel 中，singleton 是用于将一个类注册为单例模式的服务，也就是说，整个应用程序生命周期内，Laravel 只会实例化一次该服务。这个服务可以在多个地方共享同一个实例，而不是每次请求时都创建一个新的实例。

2、使用场景

• 当你希望某个类只被实例化一次，并且可以在整个应用程序中共享。
• 例如，某个服务类需要维护某种状态，且这个状态需要在整个应用程序中保持一致。

3、示例

1. 在服务提供者中定义单例

首先，假设我们有一个服务类 SomeService，我们希望它以单例的形式提供给整个应用程序。

namespace App\Services;

class SomeService
{
    protected $data;

    public function __construct()
    {
        $this->data = [];
    }

    public function addData($key, $value)
    {
        $this->data[$key] = $value;
    }

    public function getData($key)
    {
        return $this->data[$key] ?? null;
    }
}

接下来，我们需要在 AppServiceProvider 或者你自定义的服务提供者中注册这个服务为单例。

2. 在 AppServiceProvider 中注册单例

打开 app/Providers/AppServiceProvider.php 文件，找到 register 方法并将 SomeService 注册为单例。

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use App\Services\SomeService;

class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        // 注册 SomeService 为单例
        $this->app->singleton(SomeService::class, function ($app) {
            return new SomeService();
        });
    }

    public function boot()
    {
        //
    }
}

3. 在控制器中使用单例服务

现在 SomeService 已经被注册为单例，你可以通过 依赖注入 的方式在控制器中使用它。

namespace App\Http\Controllers;

use App\Services\SomeService;

class SomeController extends Controller
{
    protected $someService;

    public function __construct(SomeService $someService)
    {
        $this->someService = $someService;
    }

    public function index()
    {
        // 调用 SomeService 的方法
        $this->someService->addData('name', 'Laravel');

        $name = $this->someService->getData('name');

        return response()->json(['name' => $name]);
    }
}

4. 共享状态

因为 SomeService 是单例，所有使用该服务的地方都会共享同一个实例。因此，如果在应用的不同地方修改了服务的内部状态，其他地方也会受影响。

// 第一个控制器
$this->someService->addData('key', 'value');

// 第二个控制器中
$storedValue = $this->someService->getData('key');  // 返回 'value'

4、总结

通过 singleton 注册服务后，SomeService 将在应用程序中只实例化一次，并且在不同的请求或地方都会共享同一个实例。