Laravel 谨慎使用Storage::append

时间:2024-07-07 07:13:59

driverlocal 时,Storage::append()在高并发下,会存在丢失数据问题,文件被覆写,而非尾部添加,如果明确是本地文件操作,像日志写入,建议使用 Illuminate\Filesystem\Filesystem或者php原生方法file_put_content(),通过 storage_path() app_path() public_path() 等方法也能达到类似效果。

源码 分析:

  1. Storage::append()driverlocal 时,调用的是 vendor/laravel/framework/src/Illuminate/Filesystem/FilesystemAdapter.php 提供的方法,那么其中定义的 append() 是这样的:
/**
 * Append to a file.
 *
 * @param  string  $path
 * @param  string  $data
 * @param  string  $separator
 * @return int
 */
public function append($path, $data, $separator = PHP_EOL)
{
    if ($this->exists($path)) {
        return $this->put($path, $this->get($path).$separator.$data);
    }

    return $this->put($path, $data);
}

可以明显的看出这里的 append方法是将文件读出来拼接再写入的,那么当文件非常大时,io 消耗和内存消耗肯定会存在问题

  1. 那么看看 Filesystemappend
/**
 * Append to a file.
 *
 * @param  string  $path
 * @param  string  $data
 * @return int
 */
public function append($path, $data)
{
    return file_put_contents($path, $data, FILE_APPEND);
}

可以看到这里是调用的 php原生方法 file_put_contents(),那么为什么这个原生方法不会有问题?

  1. file_put_contents() 的实现

php 官方文档在介绍 file_put_contents()时是这样描述的:

image.png

可以看到,它也并没有调用 php 在应对高并发时的应对函数 flock()

image.png

那么当使用 FILE_APPEND模式时,php 是如何操作的,我们注意到在描述 fwirte()时,特别标注了 可安全用于二进制对象

image.png

那么它的含义是什么?

image.png

看到这里,也明白了 fwrite是能保证在追加模式下的多进程调用都写入到文件尾部

总结:php_put_contents在使用追加模式时,其实是fwrite()函数在追加模式下能保证文件安全的都实现内容追加到尾部,phpfwrite 调用的是系统的 write() 并使用参数 O_APPEND

image.png