PSR-3 PHP日志接口规范

概述

主要目标是允许库以简单和通用的方式接收 Psr\Log\LoggerInterface 对象并将日志写入其中。 具有特殊需求的框架和CMS内容管理系统, 可以扩展接口以用于它们自己的目的,但是应该保持与该文档的兼容性。 这可确保应用程序使用的第三方库可以写入集中式应用程序日志

1: 规范详解

  • 1.1 基础

    • LoggerInterface公开了8个方法来将日志写入八个RFC 5424中定义的级别(调试,信息,通知,警告,错误,严重,警报,紧急情况)
    • 第9个方法log(), 它接受日志级别作为第一个参数。 使用上述其中一个日志级别常量调用此方法必须与调用特定级别的方法具有相同的结果。 如果实现类不知道该级别,则使用未由此规范定义的级别调用此方法, 必须抛出 Psr\Log\InvalidArgumentException。 用户不应该在不确定当前实现是否支持的情况下使用自定义级别。
  • 1.2 日志消息

    • 每个方法都接受一个字符串,或一个带有__toString()方法的对象作为日志消息。 实现类可以对传递的对象进行特殊处理。 如果没有做过特殊处理,实现类必须将其转换为字符串。
    • 消息可以包含占位符,实现类可以替换上下文数组中的值。

占位符名称必须对应于上下文数组中的键。

占位符名称必须用一个左括号 { 和一个右括号 } 分隔。 分隔符和占位符名称之间不能有任何空格。

占位符名称应该仅由字符A-Z,a-z,0-9,下划线_和句点组成。其他字符的使用保留用于将来修改占位符规范。

实现者可以使用占位符来实现各种转义策略并转换日志以供显示。 用户不应预先转义占位符值,因为他们无法知道数据将在哪个上下文中显示。

以下是占位符插值的示例实现,仅供参考:

<?php
/**
 * 将上下文值插值到消息占位符中
 * @param $message
 * @param $context array
 * @return string
 */
function interpolate($message, $context = [])
{
    // build a replacement array with braces around the context keys
    $replace = [];
    foreach ($context as $key => $val) {
        // check that the value can be casted to string
        if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
            $replace['{' . $key . '}'] = $val;
        }
    }

    // 替换插入值并返回
    return strtr($message, $replace);
}

// 包含占位符的自复查
$message = "User {username} created";

// 占位符数组
$context = array('username' => 'bolivar');

// 输出 "User bolivar created"
echo interpolate($message, $context);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
  • 1.3 上下文

    • 每个方法都接受一个数组作为上下文数据 这意味着保存任何不适合字符串的无关信息。 该数组可以包含任何内容。 实现类必须确保他们尽可能温和的对待上下文数据。 上下文中的给定值不得抛出异常,也不得引发任何php错误,警告或通知。
    • 如果在上下文数据中传递了Exception对象,则这个对象的键值key必须是exception。 记录异常是一种常见的模式,这允许实现类在输出日志时, 可以从中异常中提取堆栈跟踪数组。 在使用它之前,实现类必须验证'exception'键的值为Exception对象, 然后再使用。
  • 1.4 帮助类和接口列表

    • Psr\Log\AbstractLogger类使您可以通过扩展它并实现通用log()方法来非常轻松地实现LoggerInterface。其他八种方法是将消息和上下文转发给它。
    • 同样,使用Psr\Log\LoggerTrait只需要实现通用log()方法。请注意,由于traits无法实现接口,因此在这种情况下,您仍然必须实现LoggerInterface。
    • Psr\Log\NullLogger 与接口一起提供。如果没有为它们提供记录器,接口的用户可以使用它来提供后备“黑洞”实现。但是,如果上下文数据创建很繁琐,则条件记录可能是更好的方法。
    • Psr\Log\LoggerAwareInterface 只包含一个setLogger(LoggerInterface $ logger)方法,框架可以使用该方法使用记录器自动连接任意实例。
    • Psr\Log\LoggerAwareTrait Trait可用于在任何类中轻松实现等效接口。它允许您访问 $this->logger。
    • Psr\Log\LogLevel 类保存八个日志级别的常量。

2: 库文件包

以上描述的接口, 类, 相关的异常类和用于验证实现的测试套件是作为 psr/log 包的一部分提供的

3: Psr\Log\LoggerInterface 原定义

<?php
namespace Psr\Log;
/**
 * Describes a logger instance.
 *
 * The message MUST be a string or object implementing __toString().
 *
 * The message MAY contain placeholders in the form: {foo} where foo
 * will be replaced by the context data in key "foo".
 *
 * The context array can contain arbitrary data, the only assumption that
 * can be made by implementors is that if an Exception instance is given
 * to produce a stack trace, it MUST be in a key named "exception".
 *
 * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
 * for the full interface specification.
 */
interface LoggerInterface
{
    /**
     * System is unusable.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function emergency($message, array $context = array());

    /**
     * Action must be taken immediately.
     *
     * Example: Entire website down, database unavailable, etc. This should
     * trigger the SMS alerts and wake you up.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function alert($message, array $context = array());

    /**
     * Critical conditions.
     *
     * Example: Application component unavailable, unexpected exception.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function critical($message, array $context = array());

    /**
     * Runtime errors that do not require immediate action but should typically
     * be logged and monitored.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function error($message, array $context = array());

    /**
     * Exceptional occurrences that are not errors.
     *
     * Example: Use of deprecated APIs, poor use of an API, undesirable things
     * that are not necessarily wrong.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function warning($message, array $context = array());

    /**
     * Normal but significant events.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function notice($message, array $context = array());

    /**
     * Interesting events.
     *
     * Example: User logs in, SQL logs.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function info($message, array $context = array());

    /**
     * Detailed debug information.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function debug($message, array $context = array());

    /**
     * Logs with an arbitrary level.
     *
     * @param mixed $level
     * @param string $message
     * @param array $context
     * @return void
     */
    public function log($level, $message, array $context = array());
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

4. Psr\Log\LoggerAwareInterface

<?php
namespace Psr\Log;

/**
 * Describes a logger-aware instance.
 */
interface LoggerAwareInterface
{
    /**
     * Sets a logger instance on the object.
     *
     * @param LoggerInterface $logger
     * @return void
     */
    public function setLogger(LoggerInterface $logger);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

5. Psr\Log\LogLevel

<?php
namespace Psr\Log;

/**
 * Describes log levels.
 */
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';
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

PSR-3 PHP日志接口规范解读与应用场景