PHP代码规范之PSR-3
  在 PHP 分类下   暂无评论

PHP代码规范之PSR-3

  在 PHP 分类下   暂无评论

PSR-3 日志接口规范

本文制定了日志类库的通用接口规范。

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

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

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

规范说明

基本规范

记录信息

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

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

占位符的名称应该只由 A-Za-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);

上下文

助手类和接口

PsrLogLoggerInterface

<?php

namespace Psr\Log;

/** * 日志记录实例 * * 日志信息变量 —— message, **必须**是一个字符串或是实现了 __toString() 方法的对象。 * * 日志信息变量中**可以**包含格式如 “{foo}” (代表foo) 的占位符, * 它将会由上下文数组中键名为 "foo" 的键值替代。 * * 上下文数组可以携带任意的数据,唯一的限制是,当它携带的是一个 exception 对象时,它的键名 必须 是 "exception"。 * * 详情可参阅: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md */
interface LoggerInterface
{
    /** * 系统不可用 * * @param string $message * @param array $context * @return null */
    public functionemergency($message, array $context = array());

    /** * **必须**立刻采取行动 * * 例如:在整个网站都垮掉了、数据库不可用了或者其他的情况下,**应该**发送一条警报短信把你叫醒。 * * @param string $message * @param array $context * @return null */
    public functionalert($message, array $context = array());

    /** * 紧急情况 * * 例如:程序组件不可用或者出现非预期的异常。 * * @param string $message * @param array $context * @return null */
    public functioncritical($message, array $context = array());

    /** * 运行时出现的错误,不需要立刻采取行动,但必须记录下来以备检测。 * * @param string $message * @param array $context * @return null */
    public functionerror($message, array $context = array());

    /** * 出现非错误性的异常。 * * 例如:使用了被弃用的API、错误地使用了API或者非预想的不必要错误。 * * @param string $message * @param array $context * @return null */
    public functionwarning($message, array $context = array());

    /** * 一般性重要的事件。 * * @param string $message * @param array $context * @return null */
    public functionnotice($message, array $context = array());

    /** * 重要事件 * * 例如:用户登录和SQL记录。 * * @param string $message * @param array $context * @return null */
    public functioninfo($message, array $context = array());

    /** * debug 详情 * * @param string $message * @param array $context * @return null */
    public functiondebug($message, array $context = array());

    /** * 任意等级的日志记录 * * @param mixed $level * @param string $message * @param array $context * @return null */
    public functionlog($level, $message, array $context = array());
}

PsrLogLoggerAwareInterface

<?php

namespace Psr\Log;

/** * logger-aware 定义实例 */
interface LoggerAwareInterface
{
    /** * 设置一个日志记录实例 * * @param LoggerInterface $logger * @return null */
    public functionsetLogger(LoggerInterface $logger);
}

PsrLogLogLevel

<?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';
}
评论已关闭