摘要：实现者可以通过对占位符采用不同的转义和转换策略，来生成最终的日志。日志信息变量中可以包含格式如代表的占位符，它将会由上下文数组中键名为的键值替代。
日志接口规范
本文制定了日志类库的通用接口规范。
本规范的主要目的，是为了让日志类库以简单通用的方式，通过接收一个 PsrLogLoggerInterface 对象，来记录日志信息。
框架以及CMS内容管理系统如有需要，可以对此接口进行扩展，但需遵循本规范，
这才能保证在使用第三方的类库文件时，日志接口仍能正常对接。
关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、
“将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、
“推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 [RFC 2119][] 。
本文中的 实现者 指的是实现了 LoggerInterface 接口的类库或者框架，反过来讲，他们就是 LoggerInterface 的 使用者。
规范说明
LoggerInterface 接口对外定义了八个方法，分别用来记录 [RFC 5424][] 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九个方法 —— log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义，则必须抛出 PsrLogInvalidArgumentException 类型的异常。在不确定的情况下，使用者不该使用未支持的等级常量来调用此方法。
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，毕竟它可以装载任何信息。
PsrLogAbstractLogger 类使得只需继承它和实现其中的 log 方法，就能够很轻易地实现 LoggerInterface 接口，而另外八个方法就能够把记录信息和上下文信息传给它。
同样地，使用 PsrLogLoggerTrait 也只需实现其中的 log 方法。不过，需要特别注意的是，在traits可复用代码块还不能实现接口前，还需要 implement LoggerInterface。
在没有可用的日志记录器时， PsrLogNullLogger 接口可以为使用者提供一个备用的日志“黑洞”。不过，当上下文的构建非常消耗资源时，带条件检查的日志记录或许是更好的办法。
PsrLogLoggerAwareInterface 接口仅包括一个
setLogger(LoggerInterface $logger) 方法，框架可以使用它实现自动连接任意的日志记录实例。
PsrLogLoggerAwareTrait trait可复用代码块可以在任何的类里面使用，只需通过它提供的 $this->logger，就可以轻松地实现等同的接口。
PsrLogLogLevel 类装载了八个记录等级常量。
包
上述的接口、类和相关的异常类，以及一系列的实现检测文件，都包含在 psr/log 文件包中。
PsrLogLoggerInterface
PsrLogLoggerAwareInterface
PsrLogLogLevel
转自Github(PizzaLiu)
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/21159.html
摘要：是一系列关于开发的规范，分有好几个版本，自己学的也较为肤浅，但还是希望能时常查看规范，为了方便记忆和遵循，我把关键词为必须的捡拾出来，做个简单地必要规范的记录。所有文件必须使用作为行的结束符。 PSR是一系列关于PHP开发的规范，分有好几个版本，自己学的也较为肤浅，但还是希望能时常查看规范，为了方便记忆和遵循，我把关键词为必须的捡拾出来，做个简单地必要规范的记录。(就是个搬砖的。。。)...
摘要：标准规范简介是的简写，由组织制定的规范，是开发的实践标准。具体标准有有了统一编码风格规范，更有利于查看和学习各个框架或类库，不不需要每次都适应新的编码风格。同时在开发团队内部使用统一的编码规范更有利于代码审查版本控制团队内部交流。 PHP 标准规范 PSR PSR 简介 PSR 是 PHP Standard Recommendations 的简写，由 PHP FIG 组织制定的 PHP...
摘要：公认规范总结规范中文版大部分来源翻译部分包含例子，附录包含了一些规范的实现基本编码标准编码风格指南日志接口规范自动加载规范规范英文版未使用草案已弃用规范原理实现实现自动加载实现原理资料来源与参考 PSR公认规范总结 PSR规范中文版(大部分来源google翻译)(cn) 部分psr包含例子，附录包含了一些规范的实现 PSR-1：基本编码标准 PSR-2：编码风格指南 PSR-3：日志...
摘要：制定的规范，简称，是开发的事实标准。原本有四个规范，分别是自动加载基本代码规范代码样式日志接口年底，新出了第个规范。区别在于的规范比较干净，去除了兼容以前版本的内容，有一点升级版的感觉。 FIG制定的PHP规范，简称PSR，是PHP开发的事实标准。 PSR原本有四个规范，分别是： PSR-0 自动加载 PSR-1 基本代码规范 PSR-2 代码样式 PSR-3 日志接口 20...
阅读 3652·2021-10-11 10:58
阅读 2245·2021-10-08 10:05
阅读 2023·2021-09-27 13:34
阅读 3558·2019-08-30 15:53
阅读 2723·2019-08-30 14:02
阅读 3551·2019-08-29 16:55
阅读 614·2019-08-29 15:41
阅读 1061·2019-08-29 15:23
