Modèle de conception Singleton : gestion des états globaux dans vos applications

Vous êtes-vous déjà retrouvé face à un objet qui doit être partagé entre plusieurs parties de votre application, peut-être une connexion à une base de données, un client WebSocket ou un gestionnaire de configuration ?

Comment gérer un tel objet pour qu'il reste cohérent et accessible tout au long du cycle de vie de l'application ou du processus ? C'est là que le Singleton Design Pattern entre en jeu.

Aperçu

Singleton est un modèle de conception créatif , qui est une catégorie de modèles de conception qui traite des différents problèmes liés à la manière native de créer des objets avec le nouveau mot-clé ou opérateur.

Le Singleton Design Pattern se concentre sur la résolution de deux problèmes principaux :

1. Comment pouvons-nous fournir un point d'accès mondial à notre instance ?
2. Comment pouvons-nous nous assurer qu'une classe ou un type spécifique d'objets n'a qu'une seule instance ?

Cela peut simplifier et standardiser la façon dont nous gérons un type ou un type spécifique d'état global tel que les connexions à une base de données, les clients WebSocket, les services de mise en cache ou tout ce dont nous avons besoin pour persister et muter en mémoire pendant tout le cycle de vie de l'application.

Comment pouvons-nous implémenter le modèle de conception Singleton ?

Le schéma ci-dessus se traduit par cette classe TypeScript :

Exemple TypeScript

class Singleton {
  private static instance: Singleton
  // other properties...
  public authorName: string

  private constructor({ authorName }: { authorName: string }) {
    this.authorName = authorName
  }

  public static getInstance(params) {
    if (!this.instance) {
      this.instance = new Singleton(params)
    }
    return this.instance
  }
  // other methods...
}

• La classe doit définir une propriété statique pour stocker l'instance partageable de manière unique.

Le mot-clé static signifie que l'objet instance n'est pas associé aux instances de la classe mais à la définition de la classe elle-même.

• Le constructeur de la classe doit être marqué comme privé. La seule façon d’obtenir une instance de notre classe est d’appeler la méthode statique getInstance.

const instance = Singleton.getInstance({ authorName: "Sidali Assoul" })


// let's imagine
const instance1 = Singleton.getInstance({ authorName: "Sidali Assoul" }) // "Sidali Assoul"
const instance2 = Singleton.getInstance({ authorName: "John Doe" }) // "Sidali Assoul"

Nous pouvons utiliser la classe ci-dessus en appelant la méthode statique getInstance qui est associée à la classe Singleton.

La méthode getInstance nous garantit que nous obtenons toujours la même instance même si nous avons instancié notre classe plusieurs fois à différents emplacements de notre base de code.

Ainsi, les deux variables (instance1 et instance2) partagent la même instance singleton.

Premier scénario pratique

Prisma est un ORM bien connu dans l'écosystème JavaScript. Pour utiliser Prisma dans votre application, vous devez importer un PrismaClient puis instancier un objet à partir de celui-ci.

class Singleton {
  private static instance: Singleton
  // other properties...
  public authorName: string

  private constructor({ authorName }: { authorName: string }) {
    this.authorName = authorName
  }

  public static getInstance(params) {
    if (!this.instance) {
      this.instance = new Singleton(params)
    }
    return this.instance
  }
  // other methods...
}

Le client Prisma se connecte à la base de données de manière paresseuse, ou en d'autres termes, uniquement lorsque vous essayez pour la première fois d'interroger ou de muter une entité.

const instance = Singleton.getInstance({ authorName: "Sidali Assoul" })


// let's imagine
const instance1 = Singleton.getInstance({ authorName: "Sidali Assoul" }) // "Sidali Assoul"
const instance2 = Singleton.getInstance({ authorName: "John Doe" }) // "Sidali Assoul"

Chaque fois que le prismaClient est importé dans un fichier, une nouvelle instance sera créée à partir du PrismaClient. Par conséquent, de nombreuses connexions à la base de données seront établies chaque fois que nous utiliserons ces instances.

import { PrismaClient } from "@prisma/client"

export const prismaClient = new PrismaClient()

De nombreuses connexions de bases de données ouvertes dégraderont les performances de votre application et peuvent même entraîner l'arrêt de la base de données, car les bases de données ne peuvent généralement gérer qu'un nombre limité de connexions.

Le Singleton Design Pattern peut nous aider à éviter un tel problème en évitant d'avoir plus d'une instance de la classe PrismaClient et en fournissant un point unique pour y accéder via la méthode statique PrismaClientSingleton.getInstance().

import { prismaClient } from "@/db"

const users = await prismaClient.user.findMany() // query on the users table

Deuxième scénario pratique

Un autre scénario pratique que nous allons parcourir est un service de limiteur de débit en mémoire.

Les utilisateurs ou les pirates peuvent spammer un point de terminaison spécifique en lui faisant une tonne de requêtes. Cela peut entraîner des vulnérabilités, des coûts inattendus ou des pannes de serveur.

Pour éviter cela, nous pouvons implémenter un service de base de limiteur de débit en mémoire.

Le service doit limiter le nombre de requêtes par adresse IP pendant un intervalle de temps spécifique (60 secondes, par exemple).

export const prismaClient = new PrismaClient() // a new instance is created every time it gets imported then used.

La classe RateLimiterService stocke une carte qui suit le nombre de requêtes (requests[ip].count) effectuées par un utilisateur spécifique identifié par une adresse IP (la clé de la carte) dans une fenêtre temporelle donnée (requests[ip].lastRequestTime).

Notre RateLimiterService est destiné à être utilisé globalement, ou en d'autres termes, nous ne voulons pas réinitialiser les valeurs d'état internes constituées de la carte des requêtes, de la limite et des variables de fenêtre à chaque fois que le RateLimiterService est importé.

Conclusion

Le Singleton Design Pattern est un outil puissant pour gérer efficacement les ressources partagées dans nos applications

Points clés à retenir :

1. Singleton garantit qu'une classe n'a qu'une seule instance et lui fournit un point d'accès global.
2. C'est utile pour gérer les ressources partagées telles que les connexions à la base de données, les paramètres de configuration ou les caches.
3. Les applications pratiques incluent l'optimisation des connexions aux bases de données avec des ORM comme Prisma et la mise en œuvre de services de limitation de débit.

Contact

Si vous avez des questions ou souhaitez discuter davantage de quelque chose, n'hésitez pas à me contacter ici.

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!