日志

hyperf/logger 组件是基于 psr/logger 实现的，默认使用 monolog/monolog 作为驱动，在 hyperf-skeleton 项目内默认提供了一些日志配置，默认使用 Monolog\Handler\StreamHandler, 由于 Swoole 已经对 fopen, fwrite 等函数进行了协程化处理，所以只要不将 useLocking 参数设置为 true，就是协程安全的。

安装

  1. composer require hyperf/logger

配置

在 hyperf-skeleton 项目内默认提供了一些日志配置，默认情况下，日志的配置文件为 config/autoload/logger.php ，示例如下：

  1. <?php
  3. return [
  4.     'default' => [
  5.         'handler' => [
  6.             'class' => \Monolog\Handler\StreamHandler::class,
  7.             'constructor' => [
  8.                 'stream' => BASE_PATH . '/runtime/logs/hyperf.log',
  9.                 'level' => \Monolog\Logger::DEBUG,
  10.             ],
  11.         ],
  12.         'formatter' => [
  13.             'class' => \Monolog\Formatter\LineFormatter::class,
  14.             'constructor' => [
  15.                 'format' => null,
  16.                 'dateFormat' => null,
  17.                 'allowInlineLineBreaks' => true,
  18.             ]
  19.         ],
  20.     ],
  21. ];

使用

  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Service;
  7. use Psr\Container\ContainerInterface;
  8. use Hyperf\Logger\LoggerFactory;
  10. class DemoService
  11. {
  13.     /**
  14.      * @var \Psr\Logger\LoggerInterface
  15.      */
  16.     protected $logger;
  18.     public function __construct(LoggerFactory $loggerFactory)
  19.     {
  20.         // default 对应 config/autoload/logger.php 内的 key
  21.         $this->logger = $loggerFactory->get('default');
  22.     }
  24.     public function method()
  25.     {
  26.         // Do somthing.
  27.         $this->logger->info("Your log message.");
  28.     }
  29. }

关于 monolog 的基础知识

我们结合代码来看一些 monolog 中所涉及到的基础概念:

  1. use Monolog\Formatter\LineFormatter;
  2. use Monolog\Handler\FirePHPHandler;
  3. use Monolog\Handler\StreamHandler;
  4. use Monolog\Logger;
  6. // 创建一个 Channel，参数 log 即为 Channel 的名字
  7. $log = new Logger('log');
  9. // 创建两个 Handler，对应变量 $stream 和 $fire
  10. $stream = new StreamHandler('test.log', Logger::WARNING);
  11. $fire = new FirePHPHandler();
  13. // 定义时间格式为 "Y-m-d H:i:s"
  14. $dateFormat = "Y n j, g:i a";
  15. // 定义日志格式为 "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"
  16. $output = "%datetime%||%channel||%level_name%||%message%||%context%||%extra%\n";
  17. // 根据 时间格式 和 日志格式，创建一个 Formatter
  18. $formatter = new LineFormatter($output, $dateFormat);
  20. // 将 Formatter 设置到 Handler 里面
  21. $stream->setFormatter($formatter);
  23. // 讲 Handler 推入到 Channel 的 Handler 队列内
  24. $log->pushHandler($stream);
  25. $log->pushHandler($fire);
  27. // clone new log channel
  28. $log2 = $log->withName('log2');
  30. // add records to the log
  31. $log->warning('Foo');
  33. // add extra data to record
  34. // 1. log context
  35. $log->error('a new user', ['username' => 'daydaygo']);
  36. // 2. processor
  37. $log->pushProcessor(function ($record) {
  38.     $record['extra']['dummy'] = 'hello';
  39.     return $record;
  40. });
  41. $log->pushProcessor(new \Monolog\Processor\MemoryPeakUsageProcessor());
  42. $log->alert('czl');
  • 首先, 实例化一个 Logger, 取个名字, 名字对应的就是 channel
  • 可以为 Logger 绑定多个 Handler, Logger 打日志, 交由 Handler 来处理
  • Handler 可以指定需要处理那些 日志级别 的日志, 比如 Logger::WARNING, 只处理日志级别 >=Logger::WARNING 的日志
  • 谁来格式化日志? Formatter, 设置好 Formatter 并绑定到相应的 Handler 上
  • 日志包含那些部分: "%datetime%||%channel||%level_name%||%message%||%context%||%extra%\n"
  • 区分一下日志中添加的额外信息 context 和 extra: context 由用户打日志时额外指定, 更加灵活; extra 由绑定到 Logger 上的 Processor 固定添加, 比较适合收集一些 常见信息

更多用法

封装 Log 类

可能有些时候您更想保持大多数框架使用日志的习惯，那么您可以在 App 下创建一个 Log 类，并通过 __callStatic 魔术方法静态方法调用实现对 Logger 的取用以及各个等级的日志记录，我们通过代码来演示一下：

  1. namespace App;
  3. use Hyperf\Logger\Logger;
  4. use Hyperf\Utils\ApplicationContext;
  6. /**
  7.  * @method static Logger get($name)
  8.  * @method static void log($level, $message, array $context = array())
  9.  * @method static void emergency($message, array $context = array())
  10.  * @method static void alert($message, array $context = array())
  11.  * @method static void critical($message, array $context = array())
  12.  * @method static void error($message, array $context = array())
  13.  * @method static void warning($message, array $context = array())
  14.  * @method static void notice($message, array $context = array())
  15.  * @method static void info($message, array $context = array())
  16.  * @method static void debug($message, array $context = array())
  17.  */
  18. class Log
  19. {
  20.     public static function __callStatic($name, $arguments)
  21.     {
  22.         $container = ApplicationContext::getContainer();
  23.         $factory = $container->get(\Hyperf\Logger\LoggerFactory::class);
  24.         if ($name === 'get') {
  25.             return $factory->get(...$arguments);
  26.         }
  27.         $log = $factory->get('default');
  28.         $log->$name(...$arguments);
  29.     }
  30. }

默认使用 default 的 Channel 来记录日志，您也可以通过使用 Log::get($name) 方法获得不同 Channel 的 Logger, 强大的 容器(Container) 帮您解决了这一切

stdout 日志

框架组件所输出的日志在默认情况下是由 Hyperf\Contract\StdoutLoggerInterface 接口的实现类 Hyperf\Framework\Logger\StdoutLogger 提供支持的，该实现类只是为了将相关的信息通过 print_r() 输出在 标准输出(stdout)，即为启动 Hyperf 的 终端(Terminal) 上，也就意味着其实并没有使用到 monolog 的，那么如果想要使用 monolog 来保持一致要怎么处理呢？

是的, 还是通过强大的 容器(Container).

  • 首先, 实现一个 StdoutLoggerFactory 类，关于 Factory 的用法可在 依赖注入 章节获得更多详细的说明。
  1. <?php
  2. declare(strict_types=1);
  4. namespace App;
  6. use Psr\Container\ContainerInterface;
  8. class StdoutLoggerFactory
  9. {
  10.     public function __invoke(ContainerInterface $container)
  11.     {
  12.         return Log::get('sys');
  13.     }
  14. }
  • 申明依赖, 使用 StdoutLoggerInterface 的地方, 由实际依赖的 StdoutLoggerFactory 实例化的类来完成
  1. // config/dependencies.php
  2. return [
  3.     'dependencies' => [
  4.         \Hyperf\Contract\StdoutLoggerInterface::class => \App\StdoutLoggerFactory::class,
  5.     ],
  6. ];

不同环境下输出不同格式的日志

上面这么多的使用, 都还只在 monolog 中的 Logger 这里打转, 这里来看看 Handler 和 Formatter

  1. // config/autoload/logger.php
  2. $appEnv = env('APP_ENV', 'dev');
  3. if ($appEnv == 'dev') {
  4.     $formatter = [
  5.         'class' => \Monolog\Formatter\LineFormatter::class,
  6.         'constructor' => [
  7.             'format' => "||%datetime%||%channel%||%level_name%||%message%||%context%||%extra%\n",
  8.             'allowInlineLineBreaks' => true,
  9.             'includeStacktraces' => true,
  10.         ],
  11.     ];
  12. } else {
  13.     $formatter = [
  14.         'class' => \Monolog\Formatter\JsonFormatter::class,
  15.         'constructor' => [],
  16.     ];
  17. }
  19. return [
  20.     'default' => [
  21.         'handler' => [
  22.             'class' => \Monolog\Handler\StreamHandler::class,
  23.             'constructor' => [
  24.                 'stream' => 'php://stdout',
  25.                 'level' => \Monolog\Logger::INFO,
  26.             ],
  27.         ],
  28.         'formatter' => $formatter,
  29.     ],
  30. ]
  • 默认配置了名为 default 的 Handler, 并包含了此 Handler 及其 Formatter 的信息
  • 获取 Logger 时, 如果没有指定 Handler, 底层会自动把 default 这一 Handler 绑定到 Logger 上
  • dev(开发)环境: 日志使用 php://stdout 输出到 标准输出(stdout), 并且 Formatter 中设置 allowInlineLineBreaks, 方便查看多行日志
  • 非 dev 环境: 日志使用 JsonFormatter, 会被格式为 json, 方便投递到第三方日志服务