PHP⽇志记录规范PSR-3
本⽂制定了⽇志类库的通⽤接⼝规范。
本规范的主要⽬的，是为了让⽇志类库以简单通⽤的⽅式，通过接收⼀个 Psr\Log\LoggerInterface 对象，来记录⽇志信息。 框架以及CMS内容管理系统如有需
要，可以对此接⼝进⾏扩展，但需遵循本规范， 这才能保证在使⽤第三⽅的类库⽂件时，⽇志接⼝仍能正常对接。
关键词 “必须”(“MUST”)、“⼀定不可/⼀定不能”(“MUST NOT”)、“需要”(“REQUIRED”)、 “将会”(“SHALL”)、“不会”(“SHALL NOT”)、
“应该”(“SHOULD”)、“不该”(“SHOULD NOT”)、 “推荐”(“RECOMMENDED”)、“可以”(“MAY”)和”可选“(“OPTIONAL”)的详细描述可参
见 RFC 2119 。
本⽂中的 实现者 指的是实现了 LoggerInterface 接⼝的类库或者框架，反过来讲，他们就是 LoggerInterface 的 使⽤者。
1. 规范说明
1.1 基本规范
LoggerInterface 接⼝对外定义了⼋个⽅法，分别⽤来记录 RFC 5424 中定义的⼋个等级的⽇志：debug、 info、 notice、 warning、 error、 critical、 alert 以及
emergency 。
第九个⽅法 —— log，其第⼀个参数为记录的等级。可使⽤⼀个预先定义的等级常量作为参数来调⽤此⽅法，必须与直接调⽤以上⼋个⽅法具有相同的效果。如果传⼊的等级常
量参数没有预先定义，则必须抛出 Psr\Log\InvalidArgumentException 类型的异常。在不确定的情况下，使⽤者不该使⽤未⽀持的等级常量来调⽤此⽅法。
1.2 记录信息
以上每个⽅法都接受⼀个字符串类型或者是有 __toString() ⽅法的对象作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者必须⾃⼰把它转换成字符串。
记录信息参数可以携带占位符，实现者可以根据上下⽂将其它替换成相应的值。
其中占位符必须与上下⽂数组中的键名保持⼀致。
占位符的名称必须由⼀个左花括号 { 以及⼀个右括号 } 包含。但花括号与名称之间⼀定不能有空格符。
占位符的名称应该只由 A-Z、 a-z,0-9、下划线 _、以及英⽂的句号 .组成，其它字符作为将来占位符规范的保留。
实现者可以通过对占位符采⽤不同的转义和转换策略，来⽣成最终的⽇志。 ⽽使⽤者在不知道上下⽂的前提下，不该提前转义占位符。
以下是⼀个占位符使⽤的例⼦：
/** * ⽤上下⽂信息替换记录信息中的占位符 */
function interpolate($message, array $context = array()){
// 构建⼀个花括号包含的键名的替换数组
$replace = array();
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = $val;
}
// 替换记录信息中的占位符，最后返回修改后的记录信息。
return strtr($message, $replace);
}
// 含有带花括号占位符的记录信息。
$message = "User {username} created";
// 带有替换信息的上下⽂数组，键名为占位符名称，键值为替换值。
$context = array('username' => 'bolivar');
// 输出 "Username bolivar created"
echo interpolate($message, $context);
1.3 上下⽂
每个记录函数都接受⼀个上下⽂数组参数，⽤来装载字符串类型⽆法表⽰的信息。它可以装载任何信息，所以实现者必须确保能正确处理其装载的信息，对于其装载的数据，⼀
定不能 抛出异常，或产⽣PHP出错、警告或提醒信息（error、warning、notice）。
如需通过上下⽂参数传⼊了⼀个 Exception 对象， 必须以 ‘exception’ 作为键名。 记录异常信息是很普遍的，所以如果它能够在记录类库的底层实现，就能够让实现者从异
常信息中抽丝剥茧。 当然，实现者在使⽤它时，必须确保键名为 ‘exception’ 的键值是否真的是⼀个 Exception，毕竟它可以装载任何信息。
1.4 助⼿类和接⼝
Psr\Log\AbstractLogger 类使得只需继承它和实现其中的 log ⽅法，就能够很轻易地实现 LoggerInterface 接⼝，⽽另外⼋个⽅法就能够把记录信息和上下⽂信息传给它。
同样地，使⽤ Psr\Log\LoggerTrait 也只需实现其中的 log ⽅法。不过，需要特别注意的是，在traits可复⽤代码块还不能实现接⼝前，还需要 implement
LoggerInterface。
在没有可⽤的⽇志记录器时， Psr\Log\NullLogger 接⼝可以为使⽤者提供⼀个备⽤的⽇志“⿊洞”。不过，当上下⽂的构建⾮常消耗资源时，带条件检查的⽇志记录或许是
更好的办法。
Psr\Log\LoggerAwareInterface 接⼝仅包括⼀个 setLogger(LoggerInterface $logger) ⽅法，框架可以使⽤它实现⾃动连接任意的⽇志记录实例。
Psr\Log\LoggerAwareTrait trait可复⽤代码块可以在任何的类⾥⾯使⽤，只需通过它提供的 $this->logger，就可以轻松地实现等同的接⼝。
Psr\Log\LogLevel 类装载了⼋个记录等级常量。
上述的接⼝、类和相关的异常类，以及⼀系列的实现检测⽂件，都包含在 psr/log ⽂件包中。
3. Psr\Log\LoggerInterface
<?php
php 数组字符串转数组
namespace Psr\Log;
/** * ⽇志记录实例 * * ⽇志信息变量 —— message， **必须**是⼀个字符串或是实现了 __toString() ⽅法的对象。 * * ⽇志信息变量中**可以**包含格式如 “{foo}” (代表foo) 的占位符， * 它将会由上下⽂数组中键名为 "foo" 的键值替代。 * * 上下⽂数组interface LoggerInterface
{
/** * 系统不可⽤ * * @param string $message * @param array $context * @return null */
public function emergency($message, array $context = array());
/** * **必须**⽴刻采取⾏动 * * 例如：在整个⽹站都垮掉了、数据库不可⽤了或者其他的情况下，**应该**发送⼀条警报短信把你叫醒。 * * @param string $message * @param array $context * @return null */
public function alert($message, array $context = array());
/** * 紧急情况 * * 例如：程序组件不可⽤或者出现⾮预期的异常。 * * @param string $message * @param array $context * @return null */
public function critical($message, array $context = array());
/** * 运⾏时出现的错误，不需要⽴刻采取⾏动，但必须记录下来以备检测。 * * @param string $message * @param array $context * @return null */
public function error($message, array $context = array());
/** * 出现⾮错误性的异常。 * * 例如：使⽤了被弃⽤的API、错误地使⽤了API或者⾮预想的不必要错误。 * * @param string $message * @param array $context * @return null */    public function warning($message, array $context = array());
/** * ⼀般性重要的事件。 * * @param string $message * @param array $context * @return null */
public function notice($message, array $context = array());
/** * 重要事件 * * 例如：⽤户登录和SQL记录。 * * @param string $message * @param array $context * @return null */
public function info($message, array $context = array());
/** * debug 详情 * * @param string $message * @param array $context * @return null */
public function debug($message, array $context = array());
/** * 任意等级的⽇志记录 * * @param mixed $level * @param string $message * @param array $context * @return null */
public function log($level, $message, array $context = array());
}
4. Psr\Log\LoggerAwareInterface
<?php
namespace Psr\Log;
/** * logger-aware 定义实例 */
interface LoggerAwareInterface
{
/** * 设置⼀个⽇志记录实例 * * @param LoggerInterface $logger * @return null */
public function setLogger(LoggerInterface $logger);
}
5. Psr\Log\LogLevel
<?php
namespace Psr\Log;
/** * ⽇志等级常量定义 */
class LogLevel
{
const EMERGENCY = 'emergency';
const ALERT    = 'alert';
const CRITICAL  = 'critical';
const ERROR    = 'error';
const WARNING  = 'warning';
const NOTICE    = 'notice';
const INFO      = 'info';
const DEBUG    = 'debug';
}

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。