PHP Master | Pembalakan dengan PSR-3 untuk meningkatkan kebolehgunaan

mata teras

PSR-3, antara muka objek log biasa, membolehkan pemaju menulis kod yang boleh diguna semula tanpa bergantung pada sebarang pelaksanaan log tertentu, dengan itu meningkatkan keserasian antara perpustakaan log yang berbeza dalam PHP.
• Antara muka PSR-3 menyediakan lapan kaedah untuk mengendalikan mesej tahap keparahan yang berbeza, dan kaedah
biasa yang dapat menerima tahap keparahan. Reka bentuknya adalah untuk menyelesaikan masalah ketidakserasian pelaksanaan log.
• log() Walaupun PSR-3 mempunyai banyak manfaat, beberapa perpustakaan log tidak menyokongnya secara asli. Walau bagaimanapun, pemaju boleh membuat penyesuai yang mematuhi PSR-3 dengan memanfaatkan mod penyesuai dan memperluaskan kelas
yang disediakan di perpustakaan PSR/LOG.
• AbstractLogger Banyak projek PHP utama, termasuk Monolog, Symfony, dan Mustache.php, telah menambah sokongan untuk PSR-3. Memandangkan ia mengurangkan halangan untuk digunakan semula kod, lebih banyak perpustakaan dan rangka kerja dijangka menggunakan pembalakan dengan betul, memberikan maklumat berguna untuk pemaju.
Dalam pembangunan PHP, pembalakan adalah salah satu tugas yang paling biasa. Kami menggunakan log untuk mengesan mesej ralat, log peristiwa penting, dan isu kod debug. Dalam mana -mana projek PHP, kod itu boleh diisi dengan panggilan untuk log perpustakaan yang mengendalikan operasi ini untuk kami. Malangnya, panggilan ke perpustakaan log bertaburan di seluruh kod, yang menjadikan kod itu bergantung kepada ketersediaan perpustakaan, yang jelas bertentangan dengan prinsip penyongsangan ketergantungan. Walaupun kita menggunakan suntikan ketergantungan untuk membiarkan objek kami mengakses perpustakaan log, perbezaan antara perpustakaan log bermakna beralih di antara mereka boleh menjadi sukar dan memakan masa, yang memerlukan refactoring utama keseluruhan perpustakaan kod. Untuk meningkatkan keserasian antara perpustakaan log, pasukan PHP-FIG baru-baru ini mengeluarkan PSR-3, antara muka objek log biasa. Dalam artikel ini, saya akan membincangkan bagaimana antara muka log yang ditakrifkan PSR-3 membolehkan kita menulis kod yang boleh diguna semula yang tidak bergantung kepada pelaksanaan log tertentu.

PSR-3 Quick Start

Sebelum kita memahami bagaimana PSR-3 menjadikan kod kita lebih banyak boleh diguna semula, adalah perlu untuk memahami apa PSR-3. Jika anda sudah biasa dengan PSR-3, anda boleh melangkau bahagian ini. Inti spesifikasi adalah antara muka untuk log objek. Antara muka ini mendedahkan lapan cara untuk mengendalikan mesej tahap keparahan yang berbeza, dan kaedah biasa yang boleh menerima tahap keparahan. Lapan tahap keparahan yang disokong oleh PSR-3 adalah berdasarkan RFC 5424, seperti yang diterangkan di bawah:

• emergency - Sistem tidak boleh digunakan
• alert - Tindakan diperlukan
• critical - Situasi Serius
• error - kesilapan yang tidak memerlukan perhatian segera tetapi perlu dipantau
• warning - peristiwa yang tidak biasa atau tidak diingini, tetapi bukan ralat
• notice - peristiwa biasa tetapi penting
• info - Acara Menarik
• debug - butiran untuk debugging

Setiap kaedah log menerima mesej yang mesti menjadi rentetan atau objek dengan kaedah __toString(). Parameter tambahan menerima array yang dapat memberikan maklumat konteks untuk mesej log. Penerangan lengkap mengenai kaedah dan parameter ini boleh didapati dalam spesifikasi PSR-3.

Dapatkan fail psr-3

Mendapatkan fail yang anda perlukan untuk menggunakan PSR -3 adalah mudah - anda boleh menemui mereka dalam repositori PSR/Log GitHub. Anda juga boleh menggunakan komposer untuk mendapatkan fail ini dari Packagist. Berikut adalah contoh fail composer.json untuk mendapatkan fail psr/log:

<code class="language-json">{
    "require": {
        "psr/log": "dev-master"
    }
}</code>

bagaimana untuk mengehadkan penggunaan semula kod pembalakan

PHP mempunyai banyak perpustakaan log yang berbeza, masing -masing dengan cara sendiri untuk mengumpul dan merakam data. Walaupun mereka mempunyai beberapa persamaan, setiap perpustakaan mempunyai set kaedah pembalakan tersendiri. Ini bermakna beralih antara balak boleh mencabar, selalunya memerlukan perubahan kod di mana sahaja pembalakan digunakan. Ini bertentangan dengan prinsip pepejal penggunaan semula kod dan reka bentuk berorientasikan objek. Keadaan yang kita hadapi adalah sama ada mengisytiharkan kebergantungan pada perpustakaan log tertentu atau mengelakkan pembalakan sama sekali. Untuk menggambarkan isu ini dengan lebih jelas, contoh khusus diperlukan. Katakan kami membuat objek pengirim mudah untuk mengendalikan menghantar e -mel. Kami mahu Mailer log mesej setiap kali kami menghantar e -mel, dan kami memutuskan untuk menggunakan perpustakaan monolog yang sangat baik untuk mengendalikan keperluan pembalakan kami.

<code class="language-php"><?php namespace Email;

class Mailer
{
    private $logger;

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

    public function sendEmail($emailAddress)
    {
        // 发送电子邮件的代码...

        // 记录消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}</code>

kita boleh menggunakan kelas ini dengan kod berikut:

<code class="language-php"><?php
// 创建一个Monolog对象
$logger = new Monolog\Logger("Mail");
$logger->pushHandler(new Monolog\Handler\StreamHandler("mail.log"));

// 创建邮件发送器并发送电子邮件
$mailer = new Email\Mailer($logger);
$mailer->sendEmail("email@example.com");</code>

Menjalankan kod ini akan membuat entri baru dalam fail mail.log, merakam e -mel yang dihantar. Pada ketika ini, kami mungkin berfikir bahawa kami telah menulis objek pengirim yang boleh diguna semula. Kami menggunakan suntikan ketergantungan untuk membuat logger tersedia untuk pengirim, jadi kami boleh menukar konfigurasi logger yang berbeza tanpa menyentuh kod pengirim kami. Nampaknya kami telah berjaya mengikuti prinsip yang kukuh dan mengelakkan mewujudkan sebarang kebergantungan yang keras. Tetapi katakan kami ingin menggunakan semula kelas Mailer dalam projek yang berbeza menggunakan analog untuk mengendalikan interaksi pembalakan. Sekarang kita mempunyai masalah kerana analog tidak mempunyai kaedah addInfo(). Untuk merekodkan mesej peringkat maklumat menggunakan analog, kami panggil Analog::log($message, Analog::INFO). Kami boleh mengubah suai kelas Mailer untuk menggunakan kaedah analog seperti yang ditunjukkan di bawah.

<code class="language-php"><?php namespace Email;

class Mailer
{
    public function sendEmail($emailAddress)
    {
        // 发送电子邮件的代码...

        // 记录消息
        Analog::log("Email sent to $emailAddress", Analog::INFO);
    }
}</code>

kita boleh menggunakan kelas Mailer yang dikemas kini dengan kod berikut:

<code class="language-json">{
    "require": {
        "psr/log": "dev-master"
    }
}</code>

Walaupun ini akan berfungsi, ia jauh dari ideal. Kami menghadapi kebergantungan Mailer pada pelaksanaan pembalakan tertentu, yang memerlukan perubahan kelas ketika memperkenalkan logger baru. Ini menjadikan kelas kurang boleh diguna semula dan memaksa kita memilih antara bergantung pada ketersediaan logger tertentu atau peninggalan pembalakan di kelas sama sekali.

Gunakan PSR-3 untuk mengelakkan kebergantungan logger

sebagai Alejandro Gervasio menerangkan dalam artikelnya yang sangat baik mengenai topik ini, prinsip penyongsangan ketergantungan memberitahu kita bahawa kita harus bergantung pada abstraksi dan bukannya pelaksanaan konkrit. Dalam kes pembalakan, masalah semasa kami adalah kekurangan abstraksi yang sesuai yang boleh dipercayai. Di sinilah PSR-3 bermain. PSR-3 direka untuk mengatasi ketidakcocokan pelaksanaan pembalakan dengan menyediakan antara muka yang sama untuk logger (bernama LoggerInterface). Dengan menyediakan antara muka yang tidak terikat kepada sebarang pelaksanaan tertentu, PSR-3 membolehkan kita mengelakkan bergantung pada logger tertentu-kita boleh menaip Prompt untuk LoggerInterface untuk mendapatkan logger patuh PSR-3. Saya telah mengemas kini kelas Mailer berikut untuk menunjukkan ini:

<code class="language-php"><?php namespace Email;

class Mailer
{
    private $logger;

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

    public function sendEmail($emailAddress)
    {
        // 发送电子邮件的代码...

        // 记录消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}</code>

Pembina

telah diubahsuai untuk menerima pelaksana LoggerInterface, dan kaedah sendEmail() kini memanggil kaedah info() yang dinyatakan dalam PSR-3. Monolog sudah patuh PSR-3, dan Analog menyediakan objek pembalut yang melaksanakan LoggerInterface, jadi kini kita boleh menggunakan kedua-dua pembalak ini tanpa mengubah kelas Mailer. Inilah cara memanggil kelas ini menggunakan monolog:

<code class="language-php"><?php
// 创建一个Monolog对象
$logger = new Monolog\Logger("Mail");
$logger->pushHandler(new Monolog\Handler\StreamHandler("mail.log"));

// 创建邮件发送器并发送电子邮件
$mailer = new Email\Mailer($logger);
$mailer->sendEmail("email@example.com");</code>

dan gunakan analog:

<code class="language-php"><?php namespace Email;

class Mailer
{
    public function sendEmail($emailAddress)
    {
        // 发送电子邮件的代码...

        // 记录消息
        Analog::log("Email sent to $emailAddress", Analog::INFO);
    }
}</code>

Sekarang kami dapat menggunakan objek Mailer kami dengan mana -mana perpustakaan tanpa mengedit kelas Mailer atau mengubah cara kami menggunakannya.

Gunakan mod penyesuai untuk pembalak yang tidak menyokong PSR-3

Setakat ini, kami telah berjaya memadamkan objek pengirim dari mana -mana pelaksanaan pembalakan tertentu melalui pelaksana yang meminta LoggerInterface. Tetapi bagaimana dengan pembalak yang belum ditambah untuk sokongan PSR-3? Sebagai contoh, perpustakaan Klogger yang popular belum dikemas kini untuk seketika dan kini tidak serasi dengan PSR-3. Mujurlah, kita dapat dengan mudah memetakan kaedah yang terdedah oleh Klogger kepada yang ditakrifkan dalam LoggerInterface dengan memanfaatkan corak penyesuai. Fail yang disokong dalam repositori PSR/log membolehkan kami dengan mudah membuat kelas penyesuai dengan menyediakan kelas AbstractLogger yang boleh kami lanjutkan. Kelas abstrak semata-mata meneruskan lapan kaedah log khusus peringkat yang ditakrifkan dalam LoggerInterface ke kaedah log() biasa. Dengan memperluaskan kelas AbstractLogger dan menentukan kaedah log() kami sendiri, kami dapat dengan mudah membuat penyesuai patuh PSR-3 untuk pembalak yang tidak menyokong PSR-3 secara asli. Saya akan menunjukkan ini di bawah dengan membuat penyesuai mudah untuk Klogger:

<code class="language-json">{
    "require": {
        "psr/log": "dev-master"
    }
}</code>

Kaedah

log() hanya memetakan kaedah LoggerInterface ke kaedah klogger masing -masing, dan klogger mengendalikan aktiviti pembalakan sebenar. Dengan membungkus kelas Klogger dengan cara ini, kami dapat menggunakannya tanpa melanggar kontrak LoggerInterface. Sekarang kita boleh menggunakan penyesuai Klogger dengan kelas Mailer:

<code class="language-php"><?php namespace Email;

class Mailer
{
    private $logger;

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

    public function sendEmail($emailAddress)
    {
        // 发送电子邮件的代码...

        // 记录消息
        $this->logger->addInfo("Email sent to $emailAddress");
    }
}</code>

Dengan kelas penyesuai, kami dapat menggunakan Klogger tanpa mengubah kelas pengirim dan masih mematuhi LoggerInterface. Klogger tidak menerima parameter kedua mesej tahap debug, jadi ia tidak sepenuhnya mematuhi PSR-3 walaupun dengan penyesuai. Memperluas Klogger untuk menjadikannya serasi sepenuhnya dengan PSR-3 akan menjadi tugas remeh, tetapi itu di luar skop artikel ini. Walau bagaimanapun, adalah selamat untuk mengatakan bahawa menggunakan kelas penyesuai kami menjadikan kami sangat dekat dengan patuh PSR-3 sepenuhnya dan membolehkan kami menggunakan LoggerInterface dengan kelas Klogger.

Kesimpulan

Dalam artikel ini, kami telah belajar bagaimana menggunakan PSR-3 untuk membantu kami menulis kod bebas logger yang tidak bergantung kepada pelaksanaan pembalakan tertentu. Banyak projek PHP utama telah menambah sokongan untuk PSR-3, termasuk Monolog, Symfony, dan Mustache.php, serta projek terkenal lain seperti Drupal sedang membincangkan cara terbaik untuk mengintegrasikannya. Oleh kerana PSR-3 mengurangkan halangan untuk digunakan semula kod, kita harus melihat lebih banyak perpustakaan dan kerangka menggunakan pembalakan dengan betul untuk memberikan maklumat berguna kepada pemaju. Adakah PSR-3 akan mempengaruhi bagaimana anda menggunakan pembalakan dalam permohonan anda? Tolong beritahu kami di bahagian komen di bawah.

(gambar dari fotolia)

(bahagian FAQ pembalakan PSR-3 ditinggalkan di sini kerana batasan ruang. Ia boleh ditambah seperti yang diperlukan.)

Atas ialah kandungan terperinci PHP Master | Pembalakan dengan PSR-3 untuk meningkatkan kebolehgunaan. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!