PHP并发下安全读写文件函数

小畅 625 次浏览 0

众所周知，在高并发的状态下，直接使用 PHP 读写同一个文件时，可能会导致文件内容丢失，于是乎就需要额外的代码来解决这个问题。大致的思路是先使用 flock 函数对原文件进行锁死，再来读写。

下面的这个函数是从大名鼎鼎的可道云的代码中找到的。太开心可道云相信大家都不会陌生，它是一个无数据库的程序，因此配置存储全都是靠这个函数完成的，所以这段代码的安全性和普适性绝对毋庸置疑，可以放心的用于项目中（注意尽量保留原作者的版权信息就行了）。

代码的原版位于可道云的 /app/function/file.function.php 第 729 行左右。原版代码的逻辑是 写文件时如果原文件不存在，则直接返回 false，我把这一部分稍微修改了一下，改成了 如果目标文件不存在，则创建文件并写入。dog13

不多说了，全部的代码如下：

PHP
  1. <?php
  2.  
  3. /**
  4.  * @link http://kodcloud.com/
  5.  * @author warlee | e-mail:kodcloud@qq.com
  6.  * @copyright warlee 2014.(Shanghai)Co.,Ltd
  7.  * @license http://kodcloud.com/tools/license/license.txt
  8.  */
  9.  
  10.  
  11. /**
  12.  * 安全读取文件，避免并发下读取数据为空
  13.  * 
  14.  * @param $file 要读取的文件路径
  15.  * @param $timeout 读取超时时间 
  16.  * @return 读取到的文件内容 | false - 读取失败
  17.  */
  18. function file_read_safe($file, $timeout = 5) {
  19.     if (!$file || !file_exists($file)) return false;
  20.     $fp = @fopen($file, 'r');
  21.     if (!$fp) return false;
  22.     $startTime = microtime(true);
  23.     
  24.     // 在指定时间内完成对文件的独占锁定
  25.     do {
  26.         $locked = flock($fp, LOCK_EX | LOCK_NB);
  27.         if (!$locked) {
  28.             usleep(mt_rand(1, 50) * 1000);     // 随机等待1~50ms再试
  29.         }
  30.     }
  31.     while ((!$locked) && ((microtime(true) - $startTime) < $timeout));
  32.     
  33.     if ($locked && filesize($file) >= 0) {
  34.         $result = @fread($fp, filesize($file));
  35.         flock($fp, LOCK_UN);
  36.         fclose($fp);
  37.         if (filesize($file) == 0) {
  38.             return '';
  39.         }
  40.         return $result;
  41.     } else {
  42.         flock($fp, LOCK_UN);
  43.         fclose($fp);
  44.         return false;
  45.     }
  46. }
  47.  
  48. /**
  49.  * 安全写文件，避免并发下写入数据为空
  50.  * 
  51.  * @param $file 要写入的文件路径
  52.  * @param $buffer 要写入的文件二进制流（文件内容）
  53.  * @param $timeout 写入超时时间 
  54.  * @return 写入的字符数 | false - 写入失败
  55.  */
  56. function file_write_safe($file, $buffer, $timeout = 5) {
  57.     clearstatcache();
  58.     if (strlen($file) == 0 || !$file) return false;
  59.     
  60.     // 文件不存在则创建
  61.     if (!file_exists($file)) {
  62.         @file_put_contents($file, '');
  63.     }
  64.     if(!is_writeable($file)) return false;    // 不可写
  65.     
  66.     // 在指定时间内完成对文件的独占锁定
  67.     $fp = fopen($file, 'r+');
  68.     $startTime = microtime(true);
  69.     do {
  70.         $locked = flock($fp, LOCK_EX); 
  71.         if (!$locked) {
  72.             usleep(mt_rand(1, 50) * 1000);   // 随机等待1~50ms再试
  73.         }
  74.     }
  75.     while ((!$locked) && ((microtime(true) - $startTime) < $timeout));    
  76.     
  77.     if ($locked) {
  78.         $tempFile = $file.'.temp';
  79.         $result = file_put_contents($tempFile, $buffer, LOCK_EX);
  80.         
  81.         if (!$result || !file_exists($tempFile)) {
  82.             flock($fp, LOCK_UN);
  83.             fclose($fp);
  84.             return false;
  85.         }
  86.         @unlink($tempFile);
  87.         
  88.         ftruncate($fp, 0);
  89.         rewind($fp);
  90.         $result = fwrite($fp, $buffer);
  91.         flock($fp, LOCK_UN);
  92.         fclose($fp);
  93.         clearstatcache();
  94.         return $result;
  95.     } else {
  96.         flock($fp, LOCK_UN);
  97.         fclose($fp);
  98.         return false;
  99.     }
  100. }
复制 文本 高亮

后记

可道云的代码里其实还有大量的封装好的非常好用的函数，仔细研究研究绝对受益匪浅。

本文作者为小畅，转载请注明。

发表评论 取消回复
表情 图片 链接 代码

分享