Estudando a Arquitetura Multi Tenancy com vários Bancos de Dados usando Laravel

Acompanhamento do estudo da arquitetura multi tenancy com múltiplos bancos de dados, usando Laravel, com o treinamento da EspecializaTi.

Objetivo

Isolar clientes com banco de dados diferentes, usando a mesma aplicação e código-fonte.

Arquitetura

• Um banco central que terá os dados dos inquilinos (tenants) cadastrados
  • Inquilinos podem ser empresas, lojas, etc. Depende da regra de negócio
• Planos e formas de pagamento também ficam no banco central
• O cadastro de tenants inclui os dados de acesso ao banco de dados próprio
  • isso permite ter o servidor de banco de dados separado
• O acesso de cada tenant é por domínio
• A conexão com o banco de dados é setada dinamicamente a cada acesso
• Migrações rodam para cada tenant de forma independente do banco de dados central
  • existe um comando personalizado para rodar essas migrations
• O cadastro de novos tenants e gerenciamento só é feito pelo domínio principal
  • a criação de um novo tenant gera o banco de dados automaticamente
  • a criação do banco depende do evento disparado

Fluxo de Desenvolvimento

1. Criar modelo de tenants

   php artisan make:model Company -m

   • definir os dados que serão salvos do tenant
   • adicionar dados referentes à conexão do banco de dados do tenant

   $table->string('name');
   $table->string('domain')->unique();
   $table->string('db_database')->unique();
   $table->string('db_hostname');
   $table->string('db_username');
   $table->string('db_password');

2. Definir nova configuração de banco de dados em config/database.php

   • basicamente duplicar a entrada para o mysql e renomear para tenant
   • isso mantém a conexão padrão mysql para o banco de dados central
   • alterar a chave default DB_CONNECTION para tenant

3. Criar arquivo de configuração config/tenant.php

       return [
           'main_domain' => 'dominio-principal.com'
       ];

4. Criar classe app\Tenant\ManagerTenant.php

   • responsável por gerenciar tenants
   • desconecta conexão padrão tenant
   • seta nova conexão dinamicamente para tenant

5. Mudar conexão com o banco de dados dinamicamente pelo domínio através de middleware

   php artisan make:middleware Tenant\\TenantMiddleware

   • registrar middleware como global em app/Http/Kernel.php

   protected $middleware = [
       ...
       TenantMiddleware::class,
   ];

6. Criar pasta database/migrations/tenant

   • migrations específicas de cada tenant
   • copiar as migrations padrão do Laravel
   • composer dumpautoload

7. Criar comando Artisan para migrations de Tenant

   • php artisan make:command Tenant\\TenantMigrations
   • conecta em cada banco de dados de tenant ou apenas um tenant específico
   • roda o comando migrate com force usando a pasta migrations/tenant

8. Criar arquivo routes/tenant.php

   • responsável pelas rotas de gerenciamento de tenant
   • apenas o domínio principal pode acessar

9. Restringir o acesso das rotas de tenant usando middleware

   php artisan make:middleware Tenant\\CheckMainDomain

   • registrar como middleware de rota em app/Http/Kernel.php

     protected $routeMiddleware = [
         ...
         'check.main.domain' => CheckMainDomain::class,
     ];

10. Registrar as rotas de tenant em app/Providers/RouteServiceProvider.php

    Route::prefix('tenants')
        ->middleware('web','check.main.domain')
        ->namespace($this->namespace)
        ->group(base_path('routes/tenant.php'));

11. Criar classe app\Tenant\Database\DatabaseManager.php

    • responsável por manipular o banco de dados diretamente

12. Criar o evento e ouvinte de criação de banco de dados para o Tenant

    • adicionar entrada em app/Providers/EventServiceProvider.php

      use ...;
      use App\Events\Tenant\DatabaseCreated;
      use App\Listeners\Tenant\RunMigrationsTenant;
      ...
      protected $listen = [
          ...,
          DatabaseCreated::class => [
              RunMigrationsTenant::class
          ]
      ];

    • o evento é disparado quando é criado o banco de dados e é responsável por rodar as migrations de tenants

13. Criar o evento e ouvinte de criação de Tenant

    • adicionar entrada em app/Providers/EventServiceProvider.php

      use ...;
      use App\Events\Tenant\CompanyCreated;
      use App\Listeners\Tenant\CreateCompanyDatabase;
      ...
      protected $listen = [
          ...,
          CompanyCreated::class => [
              CreateCompanyDatabase::class
          ]
      ];

    • mesmo que as classes não existam, o Laravel irá criar depois
    • php artisan event:generate
    • o evento é disparado quando cria um Tenant e o ouvinte se prepara para criar o novo banco de dados

14. Criar controlador e rota para gerenciar os Tenants (CRUD)

    • php artisan make:controller Tenant\\CompanyController
    • método store() chama o evento CompanyCreated