Kernpunkte

• PSR-3, eine gemeinsame Schnittstelle für Protokollobjekte, erm?glicht es Entwicklern, wiederverwendbaren Code zu schreiben, ohne sich auf eine bestimmte Protokollimplementierung zu verlassen, wodurch die Kompatibilit?t zwischen verschiedenen Protokollbibliotheken in PHP verbessert wird.
Die Schnittstelle
• psr-3 bietet acht Methoden, um Nachrichten unterschiedlicher Schweregradniveau zu verarbeiten, und eine gemeinsame log() -Methode, die alle Schweregradniveaus empfangen kann. Sein Design besteht darin, das Problem der Inkompatibilit?t der Protokollimplementierung zu l?sen.
• Obwohl PSR-3 viele Vorteile hat, unterstützen einige Protokollbibliotheken es nicht nativ. Entwickler k?nnen jedoch PSR-3-konforme Adapter erstellen, indem sie den Adaptermodus nutzen und die in der PSR-/Protokollbibliothek bereitgestellte AbstractLogger -Kl?ufe erweitern.
• Viele wichtige PHP-Projekte, einschlie?lich Monolog, Symfony und Schnurrbart.php, haben Unterstützung für PSR-3 hinzugefügt. Wenn es die Hindernisse für die Wiederverwendung von Code reduziert, wird erwartet, dass mehr Bibliotheken und Frameworks die korrekte Protokollierung verwenden und nützliche Informationen für Entwickler bereitstellen.

Bei der PHP -Entwicklung ist die Protokollierung eine der h?ufigsten Aufgaben. Wir verwenden Protokolle, um Fehlermeldungen zu verfolgen, wichtige Ereignisse zu protokollieren und Codeprobleme zu debugieren. In jedem PHP -Projekt kann der Code mit Anrufen an Protokollbibliotheken gefüllt werden, die diese Vorg?nge für uns verarbeiten. Leider sind Anrufe bei Protokollbibliotheken im gesamten Code verstreut, wodurch der Code von der Verfügbarkeit der Bibliothek abh?ngt, was eindeutig dem Prinzip der Abh?ngigkeitsinversion widerspricht. Auch wenn wir die Abh?ngigkeitsinjektion verwenden, um unsere Objekte auf die Protokollbibliothek zugreifen zu lassen, kann der Unterschied zwischen Protokollbibliotheken bedeutet, dass das Wechsel zwischen ihnen schwierig und zeitaufw?ndig sein kann und ein gro?es Neuaufbau der gesamten Codebibliothek erforderlich ist. Um die Kompatibilit?t zwischen Protokollbibliotheken zu verbessern, hat das PHP-Fig-Team kürzlich PSR-3 ver?ffentlicht, eine gemeinsame Schnittstelle für Protokollobjekte. In diesem Artikel werde ich diskutieren, wie die von PSR-3 definierte Protokollschnittstelle es uns erm?glicht, wiederverwendbaren Code zu schreiben, der nicht von einer bestimmten Protokollimplementierung abh?ngt.

psr-3 schnelles Start

Bevor wir verstehen, wie PSR-3 unseren Code wiederverwendbarer macht, ist es notwendig zu verstehen, was PSR-3 ist. Wenn Sie mit PSR-3 bereits vertraut sind, k?nnen Sie diesen Abschnitt überspringen. Der Kern der Spezifikation ist die Schnittstelle zu Protokollobjekten. Diese Schnittstelle gibt acht M?glichkeiten, Meldungen unterschiedlicher Schweregradniveaus und eine gemeinsame Methode zu verarbeiten, die alle Schweregradniveaus akzeptieren kann. Die von PSR-3 unterstützten acht Schweregraden basieren auf RFC 5424, wie nachstehend beschrieben: log()

• emergency - Das System kann nicht verwendet werden
• alert - Aktion ist erforderlich
• critical - ernsthafte Situation
• error - Fehler, die keine sofortige Aufmerksamkeit ben?tigen, aber überwacht werden sollten
• warning - Ein ungew?hnliches oder unerwünschtes Ereignis, aber kein Fehler
• notice - normale, aber wichtige Ereignisse
• info - Interessante Ereignisse
• debug - Details zum Debuggen

Jede Protokollmethode akzeptiert eine Nachricht, die eine Zeichenfolge oder ein Objekt mit einer __toString() -Methode sein muss. Zus?tzliche Parameter akzeptieren ein Array, mit dem Kontextinformationen für Protokollnachrichten bereitgestellt werden k?nnen. Eine vollst?ndige Beschreibung dieser Methoden und Parameter finden Sie in der PSR-3-Spezifikation.

PSR-3-Datei

Das Erhalten der Dateien, die Sie für die Verwendung von PSR -3 ben?tigen, ist einfach - Sie k?nnen sie im PSR/Protokoll -Github -Repository finden. Sie k?nnen auch Komponist verwenden, um diese Dateien von Packagist zu erhalten. Hier ist ein Beispiel für eine composer.json -Datei zum Abrufen von PSR/Protokolldateien:

{
    "require": {
        "psr/log": "dev-master"
    }
}

So begrenzen Sie die Wiederverwendung der Code -Protokollierung

PHP verfügt über viele verschiedene Protokollbibliotheken, jeweils eine eigene Art, Daten zu sammeln und aufzuzeichnen. Obwohl sie einige Gemeinsamkeiten haben, verfügt jede Bibliothek über ihre einzigartigen Protokollierungsmethoden. Dies bedeutet, dass das Umschalten zwischen Protokollen eine Herausforderung sein kann und h?ufig den Code ?ndern muss, wo die Protokollierung verwendet wird. Dies entspricht dem soliden Prinzip der Code-Wiederverwendung und des objektorientierten Designs. Die Situation, mit der wir konfrontiert sind, ist, dass entweder Abh?ngigkeiten für bestimmte Protokollbibliotheken deklariert werden oder sich insgesamt vermeiden. Um dieses Problem klarer zu veranschaulichen, ist ein bestimmtes Beispiel erforderlich. Angenommen, wir erstellen ein einfaches Mailer -Objekt, um das Senden von E -Mails zu verarbeiten. Wir m?chten, dass Mailer jedes Mal, wenn wir eine E -Mail senden, eine Nachricht protokolliert, und wir beschlossen, die hervorragende Monologbibliothek zu verwenden, um unsere Protokollierungsanforderungen zu erfüllen.

<?php namespace Email;

class Mailer
{
    private $logger;

    public function __construct($logger)
    {
        $this->logger = $logger;
    }

    public function sendEmail($emailAddress)
    {
        // 發(fā)送電子郵件的代碼...

        // 記錄消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}

Wir k?nnen diese Klasse mit dem folgenden Code verwenden:

<?php
// 創(chuàng)建一個Monolog對象
$logger = new Monolog\Logger("Mail");
$logger->pushHandler(new Monolog\Handler\StreamHandler("mail.log"));

// 創(chuàng)建郵件發(fā)送器并發(fā)送電子郵件
$mailer = new Email\Mailer($logger);
$mailer->sendEmail("email@example.com");

Ausführen dieses Codes erstellt einen neuen Eintrag in der Datei mail.log und erfasst die gesendete E -Mail. Zu diesem Zeitpunkt k?nnten wir denken, dass wir ein wiederverwendbares Mailer -Objekt geschrieben haben. Wir verwenden die Abh?ngigkeitsinjektion, um den Protokoll für Mailer verfügbar zu machen, damit wir verschiedene Logger -Konfigurationen austauschen k?nnen, ohne unseren Mailer -Code zu berühren. Es sieht so aus, als h?tten wir dem soliden Prinzip erfolgreich verfolgt und vermieden, harte Abh?ngigkeiten zu schaffen. Nehmen wir jedoch an, wir m?chten die Mailer -Klasse in verschiedenen Projekten wiederverwenden, indem wir analog zur Behandlung von Protokollierungsinteraktionen verwendet werden. Jetzt haben wir ein Problem, weil Analog keine addInfo() -Methode hat. Um mithilfe von Analog über Nachrichten auf Informationsebene aufzuzeichnen, nennen wir Analog::log($message, Analog::INFO). Wir k?nnen die Mailerklasse so ?ndern, dass die analoge Methode wie unten gezeigt verwendet wird.

<?php namespace Email;

class Mailer
{
    public function sendEmail($emailAddress)
    {
        // 發(fā)送電子郵件的代碼...

        // 記錄消息
        Analog::log("Email sent to $emailAddress", Analog::INFO);
    }
}

Wir k?nnen die aktualisierte Mailerklasse mit dem folgenden Code verwenden:

{
    "require": {
        "psr/log": "dev-master"
    }
}

W?hrend dies funktionieren wird, ist es alles andere als ideal. Wir haben die Abh?ngigkeit von Mailer von einer bestimmten Protokollierungsimplementierung begegnet, bei der die Klasse bei der Einführung eines neuen Loggers ge?ndert werden muss. Dies macht die Klasse weniger wiederverwendbar und zwingt uns, sich zwischen der Verfügbarkeit eines bestimmten Loggers zu entscheiden oder die Protokollierung in der Klasse insgesamt aufzugeben.

Verwenden Sie PSR-3, um Logger-Abh?ngigkeiten zu vermeiden

Wie Alejandro Gervasio in seinem hervorragenden Artikel zu diesem Thema erkl?rt, sagt uns das Prinzip der Abh?ngigkeitsinversion, dass wir uns eher auf Abstraktion als auf konkrete Implementierungen verlassen sollten. Bei der Protokollierung war unser aktuelles Problem das Fehlen einer geeigneten Abstraktion, auf die man sich verlassen kann. Hier kommt PSR-3 ins Spiel. PSR-3 wurde entwickelt, um die Inkompatibilit?t der Protokollierungsimplementierung zu überwinden, indem eine gemeinsame Schnittstelle für den Logger bereitgestellt wird (ordnungsgem?? als LoggerInterface). Durch die Bereitstellung einer Schnittstelle, die nicht an eine bestimmte Implementierung gebunden ist, erm?glicht PSR-3 es uns, es zu vermeiden, auf einen bestimmten Protokoll zu stützen. Stattdessen k?nnen wir die Eingabeaufforderung für LoggerInterface eingeben, um einen PSR-3-konformen Logger zu erhalten. Ich habe die folgende Mailerklasse aktualisiert, um dies zu demonstrieren:

<?php namespace Email;

class Mailer
{
    private $logger;

    public function __construct($logger)
    {
        $this->logger = $logger;
    }

    public function sendEmail($emailAddress)
    {
        // 發(fā)送電子郵件的代碼...

        // 記錄消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}

-Konstruktor wurde so ge?ndert, dass der LoggerInterface -implementierer akzeptiert wird, und die sendEmail() -Methode nennt nun die in PSR-3 angegebene info() -Methode. Das Monolog ist bereits PSR-3-konform, und Analog bietet ein Wrapper-Objekt, das LoggerInterface implementiert, sodass wir diese beiden Holzf?ller jetzt verwenden k?nnen, ohne die Mailer-Klasse zu ?ndern. Hier erfahren Sie, wie Sie diese Klasse mit Monolog nennen:

<?php
// 創(chuàng)建一個Monolog對象
$logger = new Monolog\Logger("Mail");
$logger->pushHandler(new Monolog\Handler\StreamHandler("mail.log"));

// 創(chuàng)建郵件發(fā)送器并發(fā)送電子郵件
$mailer = new Email\Mailer($logger);
$mailer->sendEmail("email@example.com");

und analog verwenden:

<?php namespace Email;

class Mailer
{
    public function sendEmail($emailAddress)
    {
        // 發(fā)送電子郵件的代碼...

        // 記錄消息
        Analog::log("Email sent to $emailAddress", Analog::INFO);
    }
}

Jetzt k?nnen wir unser Mailer -Objekt mit einer Bibliothek verwenden, ohne die Mailerklasse zu bearbeiten oder die Art und Weise zu ?ndern, wie wir sie verwenden.

Verwenden Sie den Adaptermodus für Holzf?ller, die PSR-3

Bisher haben wir das Mailer -Objekt erfolgreich von einer bestimmten Protokollierungsimplementierung über den Implementierer entkoppelt, der LoggerInterface beantragt. Aber was ist mit diesen Holzf?llern, die für die PSR-3-Unterstützung noch nicht hinzugefügt wurden? Beispielsweise ist die beliebte Klogger-Bibliothek seit einiger Zeit nicht mehr aktualisiert und ist derzeit mit PSR-3 nicht kompatibel. Glücklicherweise k?nnen wir die durch Klogger ausgesetzten Methoden leicht auf die in LoggerInterface definierten Methoden abbilden, indem wir das Adaptermuster nutzen. Unterstützte Dateien im PSR/Protokoll -Repository erm?glichen es uns, Adapterklassen einfach zu erstellen, indem wir eine AbstractLogger -Klasse bereitstellen, die wir erweitern k?nnen. Eine abstrakte Klasse leitet einfach acht Ebenenspezifische Protokollmethoden weiter, die in LoggerInterface zu einer gemeinsamen log() -Methode definiert sind. Durch Erweiterung der AbstractLogger -Klasses und definiere unsere eigene log() -Methode k?nnen wir problemlos PSR-3-konforme Adapter für Holzf?ller erstellen, die PSR-3 nicht nativ unterstützen. Ich werde dies unten demonstrieren, indem ich einen einfachen Adapter für Klogger erstelle:

{
    "require": {
        "psr/log": "dev-master"
    }
}

log() -Methode ordnet einfach die LoggerInterface -Methode der jeweiligen Klogger -Methode ab, und die Klogger übernimmt die tats?chliche Protokollierungsaktivit?t. Indem wir die Klogger -Klasse auf diese Weise einwickeln, k?nnen wir sie verwenden, ohne den LoggerInterface -Vertrag zu brechen. Wir k?nnen jetzt den Klogger -Adapter mit der Mailerklasse verwenden:

<?php namespace Email;

class Mailer
{
    private $logger;

    public function __construct($logger)
    {
        $this->logger = $logger;
    }

    public function sendEmail($emailAddress)
    {
        // 發(fā)送電子郵件的代碼...

        // 記錄消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}

Mit der Adapterklasse k?nnen wir Klogger verwenden, ohne die Mailerklasse zu ?ndern, und halten uns dennoch an LoggerInterface. Klogger akzeptiert nicht den zweiten Parameter für Debug-Level-Nachrichten, daher entspricht es PSR-3 auch bei einem Adapter nicht vollst?ndig. Klogger zu erweitern, um es vollst?ndig mit PSR-3 kompatibel zu machen, w?re eine triviale Aufgabe, aber das liegt au?erhalb des Rahmens dieses Artikels. Man kann jedoch mit Sicherheit sagen, dass die Verwendung unserer Adapterklasse uns sehr nahe daran ist, vollst?ndig PSR-3-konform zu sein und es uns erm?glicht, LoggerInterface mit der Klogger-Klasse zu verwenden.

Schlussfolgerung

In diesem Artikel haben wir gelernt, wie man PSR-3 verwendet, um uns zu helfen, loggerfreien Code zu schreiben, der nicht von einer bestimmten Protokollierungsimplementierung abh?ngt. Viele wichtige PHP-Projekte haben die Unterstützung für PSR-3, darunter Monolog, Symfony und Schnurrbart, sowie andere bekannte Projekte wie Drupal unterstützt, wie man sie am besten integriert. Da PSR-3 die Hindernisse für die Wiederverwendung von Code verringert, sollten wir mehr Bibliotheken und Frameworks korrekt anhand der Protokollierung sehen, um nützliche Informationen für Entwickler bereitzustellen. Wirkt sich PSR-3 aus, wie Sie die Protokollierung in Ihrer Anwendung verwenden? Bitte teilen Sie uns im Kommentarbereich unten mit.

(Bild aus Fotolien)

(Der FAQ-Teil der PSR-3-Protokollierung wird hier aufgrund von Platzbeschr?nkungen weggelassen. Es kann bei Bedarf hinzugefügt werden.)

Das obige ist der detaillierte Inhalt vonPHP Master | Anmelden mit PSR-3, um die Wiederverwendbarkeit zu verbessern. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!