这可能是php世界中最好的日志库—

这可能是php世界中最好的日志库——monolog

阅读量：5109 次

发布时间：2019-06-13

本文共 3366 字，大约阅读时间需要 11 分钟。

由于一些历史原因，php中并没有内建的日志接口，故长期以来也没一个功能完备并且应用广泛的日志库。在我的工作生涯中，如果系统需要记录一些应用日志的话，基本上就是封装一个日志类，然后把一些要记录的字段写入到磁盘文件。

这样就难免要一遍一遍的造轮子，并且在没有一个规范的情况下，记录下来的日志也是不方便分析的。但是希望读完本文后希望你们可以放弃自己造这种日志类的轮子了，因为几乎你不可能造得比我们今天要介绍的主角：monolog更圆。

monolog是一个为5.3以上版本php开发的日志库，但是需要注意的是现在主干版本只支持php 7以上版本，如果你的服务器环境还是php 5的话，可以使用monolog的1.x版本。

值得一提的是monolog是一个符合psr-3规范的日志类库，并且符合psr-4加载规范。如果有对psr规范不太了解的同学可以参看如下链接：http://www.php-fig.org/psr/，我们在这里就不具体介绍这些规范了，反正知道monolog是复合当前最新行业规范的日志库就够了。

如果想要在你的代码中引入monolog的话只需要执行：

composer require monolog/monolog

mongolog中有几个很重要的概念：

第一个：handler 日志管理器

存放handler的数据结构是一个“栈”，一个日志实例可以有多个handler，通过Logger实例的pushHandler方法压入一个handler，该方法接受一个HandlerInterface类型的参数。如果你设置了多个handler，当你新增一条日志的时候，他会从栈顶开始往下传播，关心这个级别日志的handler将会处理这条日志。所有的handler都会继承AbstractProcessingHandler这个抽象类，并且只需要实现里面的抽象方法write就可以了；同时这个抽象类会继承AbstractHandler这个抽象类，这个抽象类的构造函数有两个参数：level和bubble，前者表示该handler关心的最低日志级别，是个整型，后者表示日志被当前handler处理后是否接着向下传递。参照如下代码：

use Monolog\Logger;

use Monolog\Handler\StreamHandler;

use Monolog\Handler\ErrorLogHandler;

$logger = new Logger('my_logger');

$logger->pushHandler(new StreamHandler(__DIR__.'/my_app.log', Logger::INFO));

$logger->pushHandler(new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Logger::ERROR, false));

$logger->info('码王教育——可能是最具含金量的IT培训');

如上这段代码，这条日志被ErrorLogHandler处理了，并且ErrorLogHandler的bubble参数设置为false，则日志不会被写入my_app.log中了。

第二个：formatter 设置日志格式

每个handler可以单独设置记录的日志格式，AbstractHandler抽象类中有一个setFormatter方法，该参数接受一个FormatterInterface类型的参数。可以看到monolog自带的formatter都继承自NormalizerFormatter，该类实现了format和formatBatch方法。我们修改上面的示例代码，让两个handler记录不同格式的日志：

use Monolog\Logger;

use Monolog\Handler\StreamHandler;

use Monolog\Handler\ErrorLogHandler;

use Monolog\Formatter\JsonFormatter;

$logger = new Logger('my_logger');

$stream_handler = new StreamHandler(__DIR__.'/my_app.log', Logger::INFO);

$stream_handler->setFormatter(new JsonFormatter());

$logger->pushHandler($stream_handler);

$logger->pushHandler(new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Logger::INFO));

$logger->info('码王教育——可能是最具含金量的IT培训');

此时可以看到my_app.log中记录的日志就变为了更方便解析的json格式了。

第三个：processor 日志处理器，用来给日志添加额外信息

存放processor的结构也是一个“栈”，意味着你也可以通过pushProcessor方法给一个Logger实例配置多个processor。我们注意到，这里pushProcessor接受一个callable，也就是需要一个函数或者类方法，但是官方自带的这些processor都是类，随便点进去一个源码就会发现，其实这些类都用到了__invoke魔术方法，所以在被当做callable调用的时候会自动调用__invoke。我们接着修改上面示例，给我们的日志加上更多信息：

use Monolog\Logger;

use Monolog\Handler\StreamHandler;

use Monolog\Handler\ErrorLogHandler;

use Monolog\Formatter\JsonFormatter;

use Monolog\Processor\UidProcessor;

use Monolog\Processor\ProcessIdProcessor;

$logger = new Logger('my_logger');

$stream_handler = new StreamHandler(__DIR__.'/my_app.log', Logger::INFO);

$stream_handler->setFormatter(new JsonFormatter());

$logger->pushHandler($stream_handler);

$logger->pushHandler(new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Logger::INFO));

$logger->pushProcessor(new UidProcessor);