「PSR 规范」PSR-3 日志接口规范
本规范的主要目的,是为了让日志类库以简单通用的方式,通过接收一个 Psr\Log\LoggerInterface
对象,来记录日志信息。
框架以及CMS内容管理系统如有需要,可以 对此接口进行扩展,但需遵循本规范,
这才能保证在使用第三方的类库文件时,日志接口仍能正常对接。
关于「能愿动词」的使用
为了避免歧义,文档大量使用了「能愿动词」,对应的解释如下:
必须 (MUST)
:绝对,严格遵循,请照做,无条件遵守;一定不可 (MUST NOT)
:禁令,严令禁止;应该 (SHOULD)
:强烈建议这样做,但是不强求;不该 (SHOULD NOT)
:强烈不建议这样做,但是不强求;可以 (MAY)
和可选 (OPTIONAL)
:选择性高一点,在这个文档内,此词语使用较少;
LoggerInterface
接口对外定义了八个方法,分别用来记录 中定义的八个等级的日志:debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
以上每个方法都接受一个字符串类型或者是有 方法的对象作为记录信息参数,这样,实现者就能把它当成字符串来处理,否则实现者 必须 自己把它转换成字符串。
-
其中占位符 必须 与上下文数组中的键名保持一致。
占位符的名称 必须 由一个左花括号
{
以及一个右括号}
包含。但花括号与名称之间 一定不可有空格符。占位符的名称 应该 只由
A-Z
、a-z
、0-9
、下划线_
、以及英文的句号.
组成,其它字符作为将来占位符规范的保留。实现者 可以 通过对占位符采用不同的转义和转换策略,来生成最终的日志。
而使用者在不知道上下文的前提下,不该 提前转义占位符。以下是一个占位符使用的例子:
每个记录函数都接受一个上下文数组参数,用来装载字符串类型无法表示的信息。它 可以 装载任何信息,所以实现者 必须 确保能正确处理其装载的信息,对于其装载的数据, 一定不可 抛出异常,或产生PHP出错、警告或提醒信息(error、warning、notice)。
Psr\Log\AbstractLogger
类使得只需继承它和实现其中的 方法,就能够很轻易地实现LoggerInterface
接口,而另外八个方法就能够把记录信息和上下文信息传给它。同样地,使用
Psr\Log\LoggerTrait
也只需实现其中的log
方法。不过,需要特别注意的是,在 traits 可复用代码块还不能实现接口前,还需要implement LoggerInterface
。在没有可用的日志记录器时,
Psr\Log\NullLogger
接口 可以 为使用者提供一个备用的日志「黑洞」。不过,当上下文的构建非常消耗资源时,带条件检查的日志记录或许是更好的办法。Psr\Log\LoggerAwareInterface
接口仅包括一个setLogger(LoggerInterface $logger)
方法,框架可以使用它实现自动连接任意的日志记录实例。Psr\Log\LogLevel
类装载了八个记录等级常量。