PHP PSR-3 日志接口規(guī)范

darryrzhong 發(fā)布于2019-06-27 11:37 / 676人閱讀

摘要：實現(xiàn)者可以通過對占位符采用不同的轉義和轉換策略，來生成最終的日志。日志信息變量中可以包含格式如代表的占位符，它將會由上下文數(shù)組中鍵名為的鍵值替代。

日志接口規(guī)范

本文制定了日志類庫的通用接口規(guī)范。

本規(guī)范的主要目的，是為了讓日志類庫以簡單通用的方式，通過接收一個 PsrLogLoggerInterface 對象，來記錄日志信息。
框架以及CMS內(nèi)容管理系統(tǒng)如有需要，可以對此接口進行擴展，但需遵循本規(guī)范，
這才能保證在使用第三方的類庫文件時，日志接口仍能正常對接。

關鍵詞 “必須”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“將會”("SHALL")、“不會”("SHALL NOT")、“應該”("SHOULD")、“不該”("SHOULD NOT")、
“推薦”("RECOMMENDED")、“可以”("MAY")和”可選“("OPTIONAL")的詳細描述可參見 [RFC 2119][] 。

本文中的 實現(xiàn)者 指的是實現(xiàn)了 LoggerInterface 接口的類庫或者框架，反過來講，他們就是 LoggerInterface 的 使用者。

規(guī)范說明

1.1 基本規(guī)范

LoggerInterface 接口對外定義了八個方法，分別用來記錄 [RFC 5424][] 中定義的八個等級的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。

第九個方法 —— log，其第一個參數(shù)為記錄的等級?？墒褂靡粋€預先定義的等級常量作為參數(shù)來調(diào)用此方法，必須與直接調(diào)用以上八個方法具有相同的效果。如果傳入的等級常量參數(shù)沒有預先定義，則必須拋出 PsrLogInvalidArgumentException 類型的異常。在不確定的情況下，使用者不該使用未支持的等級常量來調(diào)用此方法。

1.2 記錄信息

以上每個方法都接受一個字符串類型或者是有 __toString() 方法的對象作為記錄信息參數(shù)，這樣，實現(xiàn)者就能把它當成字符串來處理，否則實現(xiàn)者必須自己把它轉換成字符串。

記錄信息參數(shù)可以攜帶占位符，實現(xiàn)者可以根據(jù)上下文將其它替換成相應的值。

其中占位符必須與上下文數(shù)組中的鍵名保持一致。

占位符的名稱必須由一個左花括號 { 以及一個右括號 } 包含。但花括號與名稱之間一定不能有空格符。

占位符的名稱應該只由 A-Z、 a-z,0-9、下劃線 _、以及英文的句號 .組成，其它字符作為將來占位符規(guī)范的保留。

實現(xiàn)者可以通過對占位符采用不同的轉義和轉換策略，來生成最終的日志。
而使用者在不知道上下文的前提下，不該提前轉義占位符。

以下是一個占位符使用的例子：

/**
 * 用上下文信息替換記錄信息中的占位符
 */
function interpolate($message, array $context = array())
{
    // 構建一個花括號包含的鍵名的替換數(shù)組
    $replace = array();
    foreach ($context as $key => $val) {
        $replace["{" . $key . "}"] = $val;
    }

    // 替換記錄信息中的占位符，最后返回修改后的記錄信息。
    return strtr($message, $replace);
}

// 含有帶花括號占位符的記錄信息。
$message = "User {username} created";

// 帶有替換信息的上下文數(shù)組，鍵名為占位符名稱，鍵值為替換值。
$context = array("username" => "bolivar");

// 輸出 "Username bolivar created"
echo interpolate($message, $context);

1.3 上下文

每個記錄函數(shù)都接受一個上下文數(shù)組參數(shù)，用來裝載字符串類型無法表示的信息。它可以裝載任何信息，所以實現(xiàn)者必須確保能正確處理其裝載的信息，對于其裝載的數(shù)據(jù)，一定不能 拋出異常，或產(chǎn)生PHP出錯、警告或提醒信息（error、warning、notice）。

如需通過上下文參數(shù)傳入了一個 Exception 對象，必須以 "exception" 作為鍵名。
記錄異常信息是很普遍的，所以如果它能夠在記錄類庫的底層實現(xiàn)，就能夠讓實現(xiàn)者從異常信息中抽絲剝繭。
當然，實現(xiàn)者在使用它時，必須確保鍵名為 "exception" 的鍵值是否真的是一個 Exception，畢竟它可以裝載任何信息。

1.4 助手類和接口

PsrLogAbstractLogger 類使得只需繼承它和實現(xiàn)其中的 log 方法，就能夠很輕易地實現(xiàn) LoggerInterface 接口，而另外八個方法就能夠把記錄信息和上下文信息傳給它。

同樣地，使用 PsrLogLoggerTrait 也只需實現(xiàn)其中的 log 方法。不過，需要特別注意的是，在traits可復用代碼塊還不能實現(xiàn)接口前，還需要 implement LoggerInterface。

在沒有可用的日志記錄器時， PsrLogNullLogger 接口可以為使用者提供一個備用的日志“黑洞”。不過，當上下文的構建非常消耗資源時，帶條件檢查的日志記錄或許是更好的辦法。

PsrLogLoggerAwareInterface 接口僅包括一個
setLogger(LoggerInterface $logger) 方法，框架可以使用它實現(xiàn)自動連接任意的日志記錄實例。

PsrLogLoggerAwareTrait trait可復用代碼塊可以在任何的類里面使用，只需通過它提供的 $this->logger，就可以輕松地實現(xiàn)等同的接口。

PsrLogLogLevel 類裝載了八個記錄等級常量。

包

上述的接口、類和相關的異常類，以及一系列的實現(xiàn)檢測文件，都包含在 psr/log 文件包中。

PsrLogLoggerInterface

PsrLogLoggerAwareInterface

PsrLogLogLevel


轉自Github(PizzaLiu)

GPU云服務器云服務器日志規(guī)范 api接口規(guī)范 java本地接口規(guī)范 php規(guī)范

文章版權歸作者所有，未經(jīng)允許請勿轉載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉載請注明本文地址：http://systransis.cn/yun/21159.html

PHP PSR規(guī)范

摘要：前言試問現(xiàn)在的碼農(nóng)對規(guī)范了解多少。寫了幾年代碼的我，居然因不了解規(guī)范被鄙視特此來交下學費網(wǎng)上資料有很多，本文只做鏈接指引什么是是的簡稱，這個是組織制定的一套規(guī)范。前言試問現(xiàn)在php的碼農(nóng)對psr規(guī)范了解多少。寫了幾年代碼的我，居然因不了解規(guī)范被鄙視！特此來交下學費網(wǎng)上資料有很多，本文只做鏈接指引什么是PSR PSR是PHP Standards Recommendatio...

weknow619 2019-07-01 11:06 評論0 收藏0
【PHP】PSR簡要規(guī)范

摘要：是一系列關于開發(fā)的規(guī)范，分有好幾個版本，自己學的也較為膚淺，但還是希望能時常查看規(guī)范，為了方便記憶和遵循，我把關鍵詞為必須的撿拾出來，做個簡單地必要規(guī)范的記錄。所有文件必須使用作為行的結束符。 PSR是一系列關于PHP開發(fā)的規(guī)范，分有好幾個版本，自己學的也較為膚淺，但還是希望能時常查看規(guī)范，為了方便記憶和遵循，我把關鍵詞為必須的撿拾出來，做個簡單地必要規(guī)范的記錄。(就是個搬磚的。。。)...

Steve_Wang_ 2019-06-27 11:39 評論0 收藏0
PHP 標準規(guī)范

摘要：標準規(guī)范簡介是的簡寫，由組織制定的規(guī)范，是開發(fā)的實踐標準。具體標準有有了統(tǒng)一編碼風格規(guī)范，更有利于查看和學習各個框架或類庫，不不需要每次都適應新的編碼風格。同時在開發(fā)團隊內(nèi)部使用統(tǒng)一的編碼規(guī)范更有利于代碼審查版本控制團隊內(nèi)部交流。 PHP 標準規(guī)范 PSR PSR 簡介 PSR 是 PHP Standard Recommendations 的簡寫，由 PHP FIG 組織制定的 PHP...

FuisonDesign 2019-07-01 10:06 評論0 收藏0
php-psr-chinese psr規(guī)范總結

摘要：公認規(guī)范總結規(guī)范中文版大部分來源翻譯部分包含例子，附錄包含了一些規(guī)范的實現(xiàn)基本編碼標準編碼風格指南日志接口規(guī)范自動加載規(guī)范規(guī)范英文版未使用草案已棄用規(guī)范原理實現(xiàn)實現(xiàn)自動加載實現(xiàn)原理資料來源與參考 PSR公認規(guī)范總結 PSR規(guī)范中文版(大部分來源google翻譯)(cn) 部分psr包含例子，附錄包含了一些規(guī)范的實現(xiàn) PSR-1：基本編碼標準 PSR-2：編碼風格指南 PSR-3：日志...

tuomao 2019-06-27 16:56 評論0 收藏0
PSR-4——新鮮出爐的PHP規(guī)范

摘要：制定的規(guī)范，簡稱，是開發(fā)的事實標準。原本有四個規(guī)范，分別是自動加載基本代碼規(guī)范代碼樣式日志接口年底，新出了第個規(guī)范。區(qū)別在于的規(guī)范比較干凈，去除了兼容以前版本的內(nèi)容，有一點升級版的感覺。 FIG制定的PHP規(guī)范，簡稱PSR，是PHP開發(fā)的事實標準。 PSR原本有四個規(guī)范，分別是： PSR-0 自動加載 PSR-1 基本代碼規(guī)范 PSR-2 代碼樣式 PSR-3 日志接口 20...

Fundebug 2019-06-27 10:31 評論0 收藏0