Datenbankverbindungen in Paketen erweitern

​

Den Erweiterungspunkt wählen

​

Erweiterungen für Verbindungsnamen haben Vorrang vor Treibernamen

• DB::extend('reporting', ...) gilt für database.connections.reporting.
• DB::extend('mysql', ...) gilt für Verbindungen mit dem driver mysql, für deren Verbindungsnamen keine Erweiterung existiert.
• Beide nutzen dieselbe Erweiterungsregistrierung. Berücksichtigen Sie auch Kollisionen zwischen Verbindungs- und Treibernamen und verwenden Sie paketspezifische Namen.
• extend() erzeugt kein Konfigurations-Array. Wenn Sie nur die Erweiterung registrieren und keine Verbindungskonfiguration unter dem angegebenen Namen existiert, wird eine Ausnahme ausgelöst.

​

Einen eigenen Treibernamen explizit auswählen

<?php

namespace Acme\DatabaseBridge;

use Illuminate\Database\Connection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\ServiceProvider;

final class DatabaseBridgeServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        $app = $this->app;

        DB::extend('acme-sqlite', function (array $config, string $name) use ($app): Connection {
            $config['driver'] = 'sqlite';

            return $app->make('db.factory')->make($config, $name);
        });
    }
}

'acme_reports' => [
    'driver' => 'acme-sqlite',
    'database' => database_path('reports.sqlite'),
    'prefix' => '',
    'foreign_key_constraints' => true,
],

use Illuminate\Support\Facades\DB;

$connection = DB::connection('acme_reports');
$rows = $connection->select('select 1 as value');

​

Der Austausch durch eine Connection-Unterklasse hat eine andere Reichweite

• Geben Sie im Callback eine Connection-Unterklasse für die Ziel-DB zurück. Mit der Basis-Connection allein bleiben DB-spezifische Grammar- oder Processor-Klassen nicht erhalten.
• Die Factory trennt createConnector() und createConnection(). Eine Registrierung mit resolverFor() allein stellt keinen PDO-Connector für einen unbekannten Treiber bereit.
• Wenn ein eigener Resolver von DB::extend() die Standard-Factory nicht nutzt, wird auch die Prüfung von resolverFor() innerhalb der Factory nicht durchlaufen.
• Eine erneute Registrierung für denselben Treiber überschreibt die vorherige. Prüfen Sie Konflikte mit anderen Paketen und das Übertragen in andere Tests innerhalb desselben PHP-Prozesses.

​

reconnect und purge unterscheiden

​

Registrierung und Erzeugung des Pakets testen

<?php

namespace Acme\DatabaseBridge\Tests;

use Acme\DatabaseBridge\DatabaseBridgeServiceProvider;
use Illuminate\Database\SQLiteConnection;
use Orchestra\Testbench\TestCase;

final class DatabaseBridgeTest extends TestCase
{
    protected function getPackageProviders($app): array
    {
        return [DatabaseBridgeServiceProvider::class];
    }

    protected function defineEnvironment($app): void
    {
        $app['config']->set('database.default', 'testing');
        $app['config']->set('database.connections.acme_reports', [
            'driver' => 'acme-sqlite',
            'database' => ':memory:',
            'prefix' => '',
        ]);
    }

    public function test_registration_does_not_create_connections(): void
    {
        $manager = $this->app->make('db');

        $this->assertSame('testing', $manager->getDefaultConnection());
        $this->assertArrayNotHasKey('acme_reports', $manager->getConnections());
    }

    public function test_connection_is_reused_and_purge_creates_a_new_one(): void
    {
        $manager = $this->app->make('db');
        $first = $manager->connection('acme_reports');

        $this->assertInstanceOf(SQLiteConnection::class, $first);
        $this->assertSame('acme_reports', $first->getName());
        $this->assertSame('sqlite', $first->getDriverName());
        $this->assertSame(1, (int) $first->selectOne('select 1 as value')->value);
        $this->assertSame($first, $manager->connection('acme_reports'));
        $this->assertSame($first, $manager->reconnect('acme_reports'));

        $manager->purge('acme_reports');

        $second = $manager->connection('acme_reports');

        $this->assertNotSame($first, $second);
        $this->assertSame(1, (int) $second->selectOne('select 1 as value')->value);
    }
}

• Dass der Resolver des Verbindungsnamens Vorrang vor dem Resolver des Treibernamens hat.
• Dass eine erneute Registrierung unter demselben Namen und forgetExtension() erzeugte Connections nicht ersetzen.
• Ausnahmen bei fehlender Pflichtkonfiguration und das Verhalten bei Verbindungsfehlern.
• Zugesagte Funktionen auf den unterstützten Datenbanken, etwa Migrationen, Transaktionen und read/write-Trennung.
• Dass sich Registrierungen und Verbindungszustände bei langlebigen Workern oder im Zusammenspiel mit mehreren Paketen nicht vermischen.

​

Prüfpunkte für die Wartung

• Wird über einen eigenen Namen per Opt-in aktiviert, ohne die Standardverbindung oder eingebaute Treiber stillschweigend zu überschreiben?
• Landen keine Closures oder Verbindungsobjekte im Konfigurations-Cache, und liegt die Erzeugungslogik im Provider?
• Werden Verbindungsziele und Zugangsdaten als vertrauenswürdige Anwendungskonfiguration verwaltet?
• Wurden die Argumente von extend(), die Erzeugungsreihenfolge der Factory und die von reconnect() übertragenen Elemente für die unterstützten Laravel-Versionen erneut geprüft?
• Werden Nutzer über das Vorgehen zur Neuerzeugung nach Konfigurationsänderungen und den Neustart von Workern informiert?

​

Verwandte Seiten

• Paketentwicklung
• Lebenszyklus von Paket-Services gestalten
• Zusammenführen und Cachen von Paketkonfigurationen
• Veröffentlichen und Aktualisieren von Paket-Migrationen

​

Herangezogene Primärquellen

• Laravel offiziell: Datenbank und mehrere Verbindungen
• Laravel offiziell: Service Provider für Pakete
• DatabaseManager: Erzeugungsreihenfolge, Erweiterungsregistrierung, Vorhalten und Neuverbinden von Verbindungen
• ConnectionFactory: Verzögerte PDO-Erzeugung und Connection-Resolver
• Connection: resolverFor und getResolver
• DatabaseServiceProvider: Registrierung von db und db.factory