Comment gérer les requêtes S/DQL personnalisées sur différents moteurs de base de données avec DoctrineExpression

Dans le processus de création de projets Symfony robustes, il arrive souvent un point où de simples méthodes de référentiel d'entités telles que findBy() ne suffisent plus. Pour moi, ce point est arrivé et j'ai exploité la puissance des requêtes DQL personnalisées pour gérer des besoins de récupération de données plus complexes. À l'époque, j'utilisais MySQL comme base de données par défaut. Tout a parfaitement fonctionné jusqu'à ce que je conteneurise mon projet et décide de passer à PostgreSQL pour des performances et une flexibilité des fonctionnalités.

Mais, oh non ! Mes requêtes DQL ont immédiatement commencé à générer des erreurs ?‍?. Qu'est-ce qui n'a pas fonctionné ? Ma syntaxe DQL personnalisée était parfaitement conçue pour les bizarreries et les fonctions de MySQL, mais était incompatible avec PostgreSQL. Le choix était désormais entre deux voies difficiles :

Option 1 : revenez à MySQL pour assurer la sécurité.

Mais et si je voulais partager le projet avec un développeur qui préfère PostgreSQL ?

Option 2 : Réécrire mon DQL pour prendre en charge PostgreSQL.

Mais que se passe-t-il si je dois revenir à MySQL plus tard ? Ou que se passe-t-il si j'utilise un outil qui prend uniquement en charge MySQL ?

Choisir entre ces options n’a pas été facile : les deux options pouvaient m’enfermer dans un environnement de base de données unique, limitant ainsi la flexibilité dans les choix technologiques futurs. J'ai donc décidé d'adopter une approche différente et créé une solution pour gérer dynamiquement les requêtes spécifiques à une base de données de manière propre et réutilisable.

Présentation de DoctrineExpression

DoctrineExpression est une bibliothèque PHP conçue pour permettre des requêtes DQL et SQL multiplateformes et indépendantes des bases de données dans Symfony ou tout projet utilisant la doctrine. Avec DoctrineExpression, vous pouvez définir une syntaxe personnalisée pour chaque plate-forme de base de données (MySQL, PostgreSQL, SQLite, etc.), et elle sélectionnera l'expression correcte en fonction du pilote de base de données actuel. Cela fonctionne comme ceci :

1. Définir plusieurs expressions : écrivez une syntaxe différente pour chaque pilote de base de données, en spécifiant des requêtes uniques qui correspondent aux fonctions et aux particularités de chaque plate-forme.
2. Détection automatique des pilotes : DoctrineExpression vérifie la plate-forme Doctrine utilisée, puis applique automatiquement la syntaxe correcte pour MySQL, PostgreSQL ou toute autre base de données prise en charge.
3. Flexibilité à l'épreuve du temps : en vous permettant de changer facilement de base de données, DoctrineExpression pérennise votre code, garantissant que vous pouvez prendre en charge plusieurs bases de données sans réécritures approfondies.

Maintenant, avec DoctrineExpression, j'ai la possibilité d'utiliser MySQL ou PostgreSQL (ou même SQLite), en gardant mon code propre et maintenable. Je peux changer de plateforme en fonction des exigences du projet, des préférences de l'équipe ou de considérations de performances sans me soucier de refactoriser chaque requête personnalisée.

Comment DoctrineExpression résout le problème

Regardons un exemple simple dans lequel nous devons récupérer les utilisateurs qui se sont inscrits au cours des dernières 24 heures. Ceci est souvent géré différemment dans MySQL et PostgreSQL.

Sans DoctrineExpression

1. MySQL : utilise DATE_SUB(NOW(), INTERVAL 1 DAY) pour rechercher des enregistrements au cours des dernières 24 heures.
2. PostgreSQL : utilise NOW() - INTERVAL '1 day' pour la même requête.

Voici comment vous pouvez les écrire séparément sans DoctrineExpression :

// MySQL Query
$mysqlQuery = $entityManager->createQuery(
    "SELECT u FROM App\Entity\User u WHERE u.registeredAt > DATE_SUB(NOW(), INTERVAL 1 DAY)"
);

Si vous utilisiez PostgreSQL, vous écririez dans ce format :

// PostgreSQL Query
$postgresQuery = $entityManager->createQuery(
    "SELECT u FROM App\Entity\User u WHERE u.registeredAt > NOW() - INTERVAL '1 day'"
);

Si vous changez de base de données, vous devrez modifier ce code, ce qui est peu pratique et sujet aux erreurs.

Avec DoctrineExpression

Avec DoctrineExpression, vous définissez les deux syntaxes et laissez la bibliothèque gérer le reste :

use Ucscode\DoctrineExpression\DoctrineExpression;
use Ucscode\DoctrineExpression\DriverEnum;

// Create an expression instance with an EntityManager argument
$expression = new DoctrineExpression($entityManager);

// Registration S/DQL for varying database
$expression
    ->defineQuery(DriverEnum::PDO_MYSQL, function($entityManager) {
        return $entityManager->createQuery(
            "SELECT u FROM App\Entity\User u WHERE u.registeredAt > DATE_SUB(NOW(), INTERVAL 1 DAY)"
        );
    })
    ->defineQuery(DriverEnum::PDO_PGSQL, function($entityManager) {
        return $entityManager->createQuery(
            "SELECT u FROM App\Entity\User u WHERE u.registeredAt > NOW() - INTERVAL '1 day'"
        );
    });

// Fet any of the defined query based on the active doctine driver being used
$query = $expression->getCompatibleResult();

Désormais, DoctrineExpression vérifie la plateforme de base de données utilisée et insère dynamiquement la syntaxe correcte pour l'environnement actuel. Peu importe que vous utilisiez MySQL ou PostgreSQL, il sélectionnera l'expression correcte, vous évitant ainsi d'avoir à modifier vos requêtes à chaque fois que vous changez de plate-forme et supprime également le passe-partout consistant à utiliser if-else à plusieurs reprises

En conclusion:

DoctrineExpression vous fait gagner du temps et des efforts en vous permettant d'utiliser différentes bases de données sans réécrire vos requêtes. Il est particulièrement utile dans les projets conteneurisés ou multi-environnements où vous devez utiliser une syntaxe personnalisée, mais les préférences de base de données peuvent changer en fonction des besoins de déploiement ou de la familiarité de l'équipe. Essayez-le et dites-moi comment cela fonctionne pour vous !

Découvrez DoctrineExpression sur GitHub

Bon codage !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!