{"id":166,"date":"2024-09-21T15:53:00","date_gmt":"2024-09-21T13:53:00","guid":{"rendered":"https:\/\/jagullo.fr\/blog\/?p=166"},"modified":"2024-09-21T15:53:48","modified_gmt":"2024-09-21T13:53:48","slug":"le-design-pattern-singleton-en-php","status":"publish","type":"post","link":"https:\/\/jagullo.fr\/blog\/le-design-pattern-singleton-en-php\/","title":{"rendered":"Le design pattern Singleton en php"},"content":{"rendered":"\n

D\u00e9finition du Singleton<\/h2>\n\n\n\n

En math\u00e9matique le Singleton repr\u00e9sente un ensemble constitu\u00e9 d’un \u00e9l\u00e9ment unique. En POO (programmation orient\u00e9e objet) le patron de conception Singleton <\/strong>reprend ce concept en permettant \u00e0 une classe de renvoyer la m\u00eame instance lorsqu’on l’appelle \u00e0 diff\u00e9rent endroit du programme. Savoir bien optimiser son code est une t\u00e2che importante du m\u00e9tier de d\u00e9veloppeur web ou du de la programmation en g\u00e9n\u00e9ral. Plus la r\u00e9ponse du serveur est rapide, plus le site se chargera rapidement dans le navigateur du client ce qui am\u00e9liore aussi le r\u00e9f\u00e9rencement. En optimisant au mieux la RAM sur le serveur, ce dernier peut r\u00e9pondre \u00e0 plus de requ\u00eates en m\u00eame temps.<\/p>\n\n\n\n

\"\"
Le Singleton repr\u00e9sente une classe statique qui renvoie sa propre instance<\/figcaption><\/figure>\n\n\n\n

Prenons l’exemple d’une classe Translator<\/code><\/strong><\/code> permettant de g\u00e9rer les diff\u00e9rentes langues d’une application. Elle charge le fichier de traduction concernant la locale et renvoie les donn\u00e9e s’y trouvant. Cette classe peut \u00eatre appel\u00e9e \u00e0 diff\u00e9rents niveaux de l’application web, dans une vue, un contr\u00f4leur ou un module. Si \u00e0 chaque fois on instancie la classe quand on en a besoin, alors on augmente les ressources m\u00e9moires allou\u00e9es au script en cours d’ex\u00e9cution. Ce design pattern am\u00e9liore donc la clart\u00e9 du code tout en optimisant la RAM du serveur.<\/p>\n\n\n\n

Exemple concret de ce patron de conception<\/h2>\n\n\n\n

Pour \u00e9viter de devoir instancier la classe \u00e0 chaque utilisation, on va stocker la classe dans une propri\u00e9t\u00e9 statique <\/strong>afin d’y acc\u00e9der \u00e0 la prochaine utilisation. Il suffit d’appeler une fonction statique nomm\u00e9e g\u00e9n\u00e9ralement getInstance<\/strong> qui renvoie cet attribut s’il n’est pas nul. Au premier appel de la fonction getInstance, le script d\u00e9tecte si la classe a d\u00e9j\u00e0 \u00e9t\u00e9 cr\u00e9\u00e9e et retourne l’objet statique. Voici un exemple d’un Singleton classique en PHP avec la classe Translator :<\/p>\n\n\n\n

class Translator {\n    private static $instance;\n    public static function getInstance():static {\n        if (is_null(static::$instance)) {\n            static::$instance = new Translator();\n        }\n        return static::$instance;\n    }\n}\n$translator = Translator::getInstance();<\/code><\/pre>\n\n\n\n
Un peu d’optimisation<\/h2>\n\n\n\n
Ce script fait plusieurs lignes \u00e0 ajouter au d\u00e9but de toutes les classes que l’on souhaite exploiter sous forme de Singleton. Nous pouvons factoriser le code<\/strong> en utilisant le principe des traits en PHP<\/a>. Les traits sont une forme d’extension de classe pour inclure des propri\u00e9t\u00e9s et des m\u00e9thodes communes \u00e0 l’int\u00e9rieur d’une classe. Pour \u00e9tendre un trait, il suffit de l’appeler en utilisant le mot cl\u00e9 use<\/strong>. En d\u00e9veloppement web, ce m\u00e9canisme est tr\u00e8s pratique pour appeler facilement quelques fonctions redondantes qui sont communes \u00e0 plusieurs classes.<\/p>\n\n\n\n
trait Singleton {\n    private static $instance;\n    public static function getInstance():static {\n        if (is_null(static::$_instance)) {\n            $class = static::class;\n            static::$_instance = new $class;\n        }\n        return static::$instance;\n    }\n}\nclass Translator {\n    use Singleton;\n}\n$translator = Translator::getInstance();<\/code><\/pre>\n\n\n\n
Comparaison avec Python<\/h2>\n\n\n\n
Ci-dessous un script Python<\/strong> pour comparer le design pattern Singleton entre PHP et ce dernier. On peut remarquer que ce dernier permet d’\u00e9viter l’utilisation d’une fonction getInstance pour r\u00e9cup\u00e9rer la classe. On peut utiliser directement le nom de la classe qui va appeler l’instance en cours.<\/p>\n\n\n\n
class Translator:\n    _instance = None\n\n    def __new__(cls):\n        if cls._instance is None:\n            cls._instance = super().__new__(cls)\n        return cls._instance\n\ntranslator = Translator()<\/code><\/pre>\n\n\n\n
Cas d’utilisation du Singleton<\/h2>\n\n\n\n
Pour finir, on peut citer quelques cas d’utilisation<\/strong> de ce patron de conception dans une application web :<\/p>\n\n\n\n
    \n
  • Gestionnaire de configuration<\/li>\n\n\n\n
  • Gestionnaire de journalisation (pour g\u00e9rer les logs)<\/li>\n\n\n\n
  • Gestionnaire de connexion \u00e0 la base de donn\u00e9es ou autres<\/li>\n\n\n\n
  • Gestionnaire de cache<\/li>\n\n\n\n
  • Gestionnaire de ressources<\/li>\n\n\n\n
  • Gestionnaire de plugins<\/li>\n\n\n\n
  • Gestion des pr\u00e9f\u00e9rences utilisateur<\/li>\n<\/ul>\n\n\n\n
    Ce design pattern tr\u00e9s pratique est l’un des plus populaires et des plus utilis\u00e9s. De nombreux d\u00e9veloppeurs l’utilisent au quotidien. On le retrouve dans des frameworks connus comme Symfony ou m\u00eame dans des plugins WordPress.<\/p>\n\n\n\n\n