laravel框架实现saas架构，介绍一个实现了多数据库租约和域识别的扩展：stancl/tenancy

Laravel  /  管理员 发布于 3年前   4088

介绍：

Laravel 应用程序的自动多租户。

您不必更改应用程序代码中的任何内容。

...

git地址:

https://github.com/archtechx/tenancy

安装

首先，使用composer来安装这个扩展:

composer require stancl/tenancy

然后，运行 tenancy:install 命令:

php artisan tenancy:install

这条命令会自动创建几个文件：迁移文件、配置文件、路由文件和服务提供者。

紧接着让我们来执行迁移:

php artisan migrate

在config/app.php中注册服务提供者。确保它与下面的代码片段中的位置相同:

/*
 * Application Service Providers...
 */
App\Providers\AppServiceProvider::class,
App\Providers\AuthServiceProvider::class,
// App\Providers\BroadcastServiceProvider::class,
App\Providers\EventServiceProvider::class,
App\Providers\RouteServiceProvider::class,
App\Providers\TenancyServiceProvider::class, // <-- 这里

创建一个租户模型(model)

现在你需要创建一个租户模型。这个扩展包带有一个默认的租户模型，它包含了许多功能，但它大部分并不是对外开放的，因此，我们需要创建一个自定义模型来使用域名和数据库。像下面这样创建app/Models/Tenant.php文件：

<?php
namespace App\Models;
use Stancl\Tenancy\Database\Models\Tenant as BaseTenant;
use Stancl\Tenancy\Contracts\TenantWithDatabase;
use Stancl\Tenancy\Database\Concerns\HasDatabase;
use Stancl\Tenancy\Database\Concerns\HasDomains;
class Tenant extends BaseTenant implements TenantWithDatabase
{
    use HasDatabase, HasDomains;
}

请注意：如果你的模型文件夹在其他位置，你应该相应调整本教程的代码和命令。

现在我们需要告诉扩展包使用这个自定义模型。打开config/tenancy.php文件，修改下面这一行:

'tenant_model' => \App\Models\Tenant::class,

事件

这里的默认设置是开箱即用的，但简短的解释一下会对你更有帮助。 app/Providers 目录中的 TenancyServiceProvider 文件将租户事件映射到监听器。 默认情况下，当一个租户被创建时，它会运行一个 JobPipeline（扩展的这部分比较智能），它确保 CreateDatabase、MigrateDatabase 和可选的其他工作（例如 SeedDatabase）按顺序运行。

换句话说，它会在租户创建后自动创建并迁移他的数据库——而且它会以正确的顺序执行此操作，因为正常的事件监听器映射会以某种愚蠢的顺序执行监听器，这会导致诸如数据库之类的事情在它被迁移之前被迁移 在迁移之前创建或填充。

中心路由

我们将对 app/Providers/RouteServiceProvider.php 文件进行一些小的更改。 具体来说，我们将确保中心路由仅在中心域上注册。

protected function mapWebRoutes()
{
    foreach ($this->centralDomains() as $domain) {
        Route::middleware('web')
            ->domain($domain)
            ->namespace($this->namespace)
            ->group(base_path('routes/web.php'));
    }
}
protected function mapApiRoutes()
{
    foreach ($this->centralDomains() as $domain) {
        Route::prefix('api')
            ->domain($domain)
            ->middleware('api')
            ->namespace($this->namespace)
            ->group(base_path('routes/api.php'));
    }
}
protected function centralDomains(): array
{
    return config('tenancy.central_domains');
}

从你的RouteServiceProvider的boot()方法手动调用这些方法，而不是调用$this->routes()。

public function boot()
{
    $this->configureRateLimiting();
    $this->mapWebRoutes();
    $this->mapApiRoutes();
}

中心域名

现在我们需要具体的指定一个中心域名。中心域名是为你的 "SAAS应用 "内容服务的域名，例如租户注册的登陆页面。打开config/tenancy.php文件，把它们加进去:

'central_domains' => [
    'saas.test', // Add the ones that you use. I use this one with Laravel Valet.
],

如果你使用的是Laravel Sail，不需要做任何改变，默认值就可以了:

'central_domains' => [
    '127.0.0.1',
    'localhost',
],

租户路由

你的租户路由默认会是这样的:

Route::middleware([
    'web',
    InitializeTenancyByDomain::class,
    PreventAccessFromCentralDomains::class,
])->group(function () {
    Route::get('/', function () {
        return 'This is your multi-tenant application. The id of the current tenant is ' . tenant('id');
    });
});

这些路由将只能在租户（非中心域名）域名上访问--PreventAccessFromCentralDomains中间件强制执行这一点。

让我们做一个小改动，把数据库中的所有用户都打印出来，这样我们就能真正看到多租户的工作流程。打开文件routes/tenant.php并进行以下修改：

Route::get('/', function () {
    dd(\App\Models\User::all());
    return 'This is your multi-tenant application. The id of the current tenant is ' . tenant('id');
});

迁移

为了在租户数据库中拥有用户，让我们把users 表迁移（文件database/migrations/2014_10_12_000000_create_users_table.php或类似文件）移到database/migrations/tenant。这将防止该表在中央数据库中被创建，而当租户被创建时，这个表将在租户数据库中被创建--这得感谢我们的事件设置。

创建租户

为了测试，我们将在tinker中创建一个租户--暂时没必要浪费时间创建控制器和视图文件。

$ php artisan tinker
>>> $tenant1 = App\Models\Tenant::create(['id' => 'foo']);
>>> $tenant1->domains()->create(['domain' => 'foo.localhost']);
>>>
>>> $tenant2 = App\Models\Tenant::create(['id' => 'bar']);
>>> $tenant2->domains()->create(['domain' => 'bar.localhost']);

现在我们将在每个租户的数据库内创建一个用户:

App\Models\Tenant::all()->runForEach(function () {
    App\Models\User::factory()->create();
});

尝试一下吧

现在我们在浏览器中访问foo.localhost，用之前修改的config/tenancy.php文件中的central_domains的其中一个值替换localhost。我们应该看到一个用户表的打印，我们看到列出了一些用户。如果我们访问bar.localhost，这时我们应该会看到一个不同的用户表的信息。

完