Laravel daily日志保留N天源码分析

daily日志保留N天源码分析

loggin.php 配置

'channels' => [
        'stack' => [
            'driver' => 'stack',
            // 管道只采用每日记录
            'channels' => ['daily'],
            'ignore_exceptions' => false,
        ],

        'daily' => [
            'driver' => 'daily',
            'path' => storage_path('logs/laravel.log'),
            'level' => env('LOG_LEVEL', 'debug'),
            // 保留一天
            'days' => 1,
        ]
        ....
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

controller 代码

class Controller extends BaseController
{
    public function test()
    {
        $message = "test";
        Log::emergency($message);
        return "success";
    }
}
1
2
3
4
5
6
7
8
9

堆栈追踪：

1. Illuminate\Support\Facades\Facade：调用方法 __callStatic，得知Log门面实例类为：Illuminate\Log\LogManager
2. Illuminate\Log\LogManager：调用方法emergency
3. Illuminate\Log\LogManager：调用方法Get解析出日志驱动
4. Illuminate\Log\Logger：调用__call
5. Monolog\Logger：调用getHandlers
6. Illuminate\Support\Collection：调用map
7. 中间省略…
8. Monolog\Handler\RotatingFileHandler：调用write方法写入日志

protected function write(array $record): void
    {
        // on the first record written, if the log is new, we should rotate (once per day)
        // 翻译过来就是：第一次记录写入，如果日志是新的，我们就应该转换(每天一次) 
        if (null === $this->mustRotate) {
            $this->mustRotate = null === $this->url || !file_exists($this->url);
        }

		// 这里没有用，nextRotation设置的是明天 
        if ($this->nextRotation <= $record['datetime']) {
            $this->mustRotate = true;
            $this->close();
        }

        parent::write($record);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

9. 中间省略…
10. 最终 RotatingFileHandler 继承自 StreamHandler 继承自 AbstractProcessingHandler 继承自 AbstractHandler 继承自 vendor/monolog/monolog/src/Monolog/Handler/Handler.php
    在 抽象类 Handler 的__destruct析构方法

public function __destruct()
 {
     try {
     	// 调用了RotatingFileHandler的close
         $this->close();   
     } catch (\Throwable $e) {
         // do nothing
     }
 }
1
2
3
4
5
6
7
8
9

11. Monolog\Handler\RotatingFileHandler调用close

 /**
     * Rotates the files.
     */
    protected function rotate(): void
    {
        // update filename
        $this->url = $this->getTimedFilename();
        $this->nextRotation = new \DateTimeImmutable('tomorrow');

        // skip GC of old logs if files are unlimited
        if (0 === $this->maxFiles) {
            return;
        }

        $logFiles = glob($this->getGlobPattern());
        if (false === $logFiles) {
            // failed to glob
            return;
        }

        if ($this->maxFiles >= count($logFiles)) {
            // no files to remove
            return;
        }

        // Sorting the files by name to remove the older ones
        // 这里通过文件名排序
        usort($logFiles, function ($a, $b) {
            return strcmp($b, $a);
        });

		// 通过array_slice获取符合条件的文件路径信息
        foreach (array_slice($logFiles, $this->maxFiles) as $file) {
            if (is_writable($file)) {
                // suppress errors here as unlink() might fail if two processes
                // are cleaning up/rotating at the same time
                set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline): bool {
                    return false;
                });
                // 这里执行文件的删除
                unlink($file);
                restore_error_handler();
            }
        }

        $this->mustRotate = false;
    }
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

门面源码分析

先总结：其实就是根据配置的好的别名与实现类的绑定关系，通过魔术方法 __callStatic 进行方法的动态调用

问：那么 Illuminate\Support\Facades\Log 这个东西的意义在哪，直接循环配置文件的数组不就好了?
答：为了phpstorm的代码提示功能

---

借助这次查询daily日志程序，分析门面是源码的堆栈执行
Illuminate\Support\Facades\Log::emergency($message);

1. Illuminate\Support\Facades\Log 继承了 Illuminate\Support\Facades\Facade
2. Illuminate\Support\Facades\Log 调用静态方法 emergency，找不到。于是走到了Facade的魔术方法 __callStatic
3. __callStatic 做了两件事
   a. 根据 getFacadeRoot 方法解析出门面调用的实例类。
   这里又是如何解析的呢?跟踪代码 __callStatic 调用 getFacadeRoot 方法

   public static function getFacadeRoot()
   {
       // static::getFacadeAccessor()  这里就访问到了 Illuminate\Support\Facades\Log 里面的 getFacadeAccessor()
       // 获取到别名为Log
       return static::resolveFacadeInstance(static::getFacadeAccessor());
   }
   1
   2
   3
   4
   5
   6

   获取到别名后，通过 static::resolveFacadeInstance 获取到别名的实例
   系统内的别名与实例类的绑定配置在 Illuminate\Foundation\Application 中

   public function registerCoreContainerAliases()
   {
       foreach ([
           ...省略其他
           'log' => [\Illuminate\Log\LogManager::class, \Psr\Log\LoggerInterface::class],
           ...
       ] as $key => $aliases) {
       	// 循环以log做key，给出一个静态数组
           foreach ($aliases as $alias) {
               $this->alias($key, $alias);
           }
       }
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13

   b. 调用方法 emergency
4. Illuminate\Log\LogManager 调用方法 emergency

public function emergency($message, array $context = [])
  {
      $this->driver()->emergency($message, $context);
  }
1
2
3
4

$this->deriver() 获取驱动，其实就是解析出配置文件的内容

'daily' => [
          'driver' => 'daily',
          'path' => storage_path('logs/laravel.log'),
          'level' => env('LOG_LEVEL', 'debug'),
          'days' => 1,
      ],
1
2
3
4
5
6

这时候又出现了driver驱动，再次一系列转换
调用创建驱动方法

/**
    * Create an instance of the daily file log driver.
    *
    * @param  array  $config
    * @return \Psr\Log\LoggerInterface
    */
   protected function createDailyDriver(array $config)
   {
       return new Monolog($this->parseChannel($config), [
           $this->prepareHandler(new RotatingFileHandler(
               $config['path'], $config['days'] ?? 7, $this->level($config),
               $config['bubble'] ?? true, $config['permission'] ?? null, $config['locking'] ?? false
           ), $config),
       ]);
   }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

总算是兜兜转转到了 RotatingFileHandler 这个类