Php 日志 分析 源码,laravel框架源码解析1--log模块源码简读

众所周知，laravel框架的源码目录在vendor/laravel/framework/src/Illuminate,这些系统框架如何在业务逻辑中被调用呢？今天咱们从该目录下的log开始，一步步解读laravel系统框架代码，毕竟阅读大神的代码也是提高自身编码能力的一种方法。

图中红框的部分为今天的主角

image.png

Log的系统扩展的文件数和代码量还是比较少的，所以用来作为首个模块来引入laravel框架的解读。

咱们先大体看一下Log目录下这几个文件

Events/MessageLogged.php 日志消息实体类，定义了日志级别、日志内容和上下文内容

composer.json Log扩展的composer init 文件，从该文件中的authors属性可以看出，这个模块是laravel框架作者Taylor Otwell所写

LICENESE.md 开源软件MIT协议(附阮大神的开源协议介绍)

Logger.php 实现了 Psr\Log\LoggerInterface 接口(Psr-3)

LogManager.php 同样也实现了 Psr\Log\LoggerInterface 接口，它与Logger.php有啥区别，咱后面再细看

LogServiceProvider.php Log服务提供者，将'log'绑定到app中去

ParsesLogConfiguration.php 抽离的trait文件，Log八个日志级别绑定Mongolog中的定义

下面来详细介绍以上五个php文件

MessageLogged.php

namespace Illuminate\Log\Events;

class MessageLogged

{

/**

* The log "level".

*

* @var string

*/

public $level;

/**

* The log message.

*

* @var string

*/

public $message;

/**

* The log context.

*

* @var array

*/

public $context;

/**

* Create a new event instance.

*

* @param string $level

* @param string $message

* @param array $context

* @return void

*/

public function __construct($level, $message, array $context = [])

{

$this->level = $level;

$this->message = $message;

$this->context = $context;

}

}

定义了日志级别、日志内容和上下文内容；以及初始化的构造方法

ParsesLogConfiguration.php

namespace Illuminate\Log;

use InvalidArgumentException;

use Monolog\Logger as Monolog;

trait ParsesLogConfiguration

{

/**

* The Log levels.

*

* @var array

*/

protected $levels = [

'debug' => Monolog::DEBUG,

'info' => Monolog::INFO,

'notice' => Monolog::NOTICE,

'warning' => Monolog::WARNING,

'error' => Monolog::ERROR,

'critical' => Monolog::CRITICAL,

'alert' => Monolog::ALERT,

'emergency' => Monolog::EMERGENCY,

];

/**

* Get fallback log channel name.

*

* @return string

*/

abstract protected function getFallbackChannelName();

/**

* Parse the string level into a Monolog constant.

*

* @param array $config

* @return int

*

* @throws \InvalidArgumentException

*/

protected function level(array $config)

{

$level = $config['level'] ?? 'debug';

if (isset($this->levels[$level])) {

return $this->levels[$level];

}

throw new InvalidArgumentException('Invalid log level.');

}

/**

* Extract the log channel from the given configuration.

*

* @param array $config

* @return string

*/

protected function parseChannel(array $config)

{

return $config['name'] ?? $this->getFallbackChannelName();

}

}

定义了log八个日志级别与monolog对应关系

getFallbackChannelName() ：抽象方法，获取日志的渠道名

level() 从config 配置中获取日志级别

parseChannel() 从config配置中获取日志的渠道名

LogServiceProvider.php

namespace Illuminate\Log;

use Illuminate\Support\ServiceProvider;

class LogServiceProvider extends ServiceProvider

{

/**

* Register the service provider.

*

* @return void

*/

public function register()

{

$this->app->singleton('log', function () {

return new LogManager($this->app);

});

}

}

将'log'服务注册到app，系统中的log服务初始化具体对应 LogManager类，接下来来看 LogManager 类

LogManager.php

代码量有点儿多，在此处就不粘贴了，可以对照自己本地的代码来看

首先LogManager实现了Psr\Log\LoggerInterface接口中的方法

其次 可以结合config/logging配置文件来看，主要是laravel日志stack,daily,slack,syslog 等几种渠道代码逻辑，主要是应用了策略模式，将几种渠道各自对应的create***Driver统筹起来

每个create***Driver方法中会执行 prepareHandler(),去格式化日志

Logger.php

代码量有点儿多，在此处就不粘贴了，可以对照自己本地的代码来看

Logger 类同样实现了Psr\Log\LoggerInterface接口中的方法

LogManager 类中多处也是new 的Logger类的对象