日志接口规范

    本规范的主要目的，是为了让日志类库以简单通用的方式，通过接收一个 Psr\Log\LoggerInterface 对象，来记录日志信息。
    框架以及CMS内容管理系统如有需要，可以对此接口进行扩展，但需遵循本规范，
    这才能保证在使用第三方的类库文件时，日志接口仍能正常对接。

    关键词 “必须”(“MUST”)、“一定不可/一定不能”(“MUST NOT”)、“需要”(“REQUIRED”)、
    “将会”(“SHALL”)、“不会”(“SHALL NOT”)、“应该”(“SHOULD”)、“不该”(“SHOULD NOT”)、
    “推荐”(“RECOMMENDED”)、“可以”(“MAY”)和”可选“(“OPTIONAL”)的详细描述可参见 RFC 2119 。

    本文中的 实现者 指的是实现了 LoggerInterface 接口的类库或者框架，反过来讲，他们就是 LoggerInterface 的 使用者。

    • LoggerInterface 接口对外定义了八个方法，分别用来记录 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。

    • 第九个方法 —— log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义，则必须抛出 Psr\Log\InvalidArgumentException 类型的异常。在不确定的情况下，使用者不该使用未支持的等级常量来调用此方法。

    • 以上每个方法都接受一个字符串类型或者是有 __toString() 方法的对象作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者必须自己把它转换成字符串。

    • 其中占位符必须与上下文数组中的键名保持一致。

      占位符的名称必须由一个左花括号 以及一个右括号 } 包含。但花括号与名称之间一定不能有空格符。

      占位符的名称应该只由 A-Z、 a-z,0-9、下划线 _、以及英文的句号 .组成，其它字符作为将来占位符规范的保留。

      实现者可以通过对占位符采用不同的转义和转换策略，来生成最终的日志。
      而使用者在不知道上下文的前提下，不该提前转义占位符。

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

    • Psr\Log\AbstractLogger 类使得只需继承它和实现其中的 方法，就能够很轻易地实现 LoggerInterface 接口，而另外八个方法就能够把记录信息和上下文信息传给它。

    • 同样地，使用 Psr\Log\LoggerTrait 也只需实现其中的 log 方法。不过，需要特别注意的是，在traits可复用代码块还不能实现接口前，还需要 implement LoggerInterface。

    • 在没有可用的日志记录器时， Psr\Log\NullLogger 接口可以为使用者提供一个备用的日志“黑洞”。不过，当上下文的构建非常消耗资源时，带条件检查的日志记录或许是更好的办法。

    • Psr\Log\LoggerAwareInterface 接口仅包括一个
      setLogger(LoggerInterface $logger) 方法，框架可以使用它实现自动连接任意的日志记录实例。

    • Psr\Log\LoggerAwareTrait trait可复用代码块可以在任何的类里面使用，只需通过它提供的 $this->logger，就可以轻松地实现等同的接口。