flock

编辑

(PHP 4, PHP 5, PHP 7)

flock — 轻便的咨询文件锁定

PHP中文网词条详解语法

flock(file,lock,block)

flock() 函数锁定或释放文件。

允许执行一个简单的可以在任何平台中使用的读取/写入模型(包括大部分的 Unix 派生版和甚至是 Windows)。

在 PHP 5.3.2版本之前,锁也会被 fclose() 释放(在脚本结束后会自动调用)。


PHP中文网词条详解参数

参数描述
file必需。规定要锁定或释放的已打开的文件。
lock必需。规定要使用哪种锁定型。
block可选。若设置为 1 或 true,则当进行锁定时阻挡其他进程。

flock() 操作的 file 必须是一个已经打开的文件指针。

lock 参数可以是以下值之一:

  • 要取得共享锁定(读取的程序),将 lock 设为 LOCK_SH(PHP 4.0.1 以前的版本设置为 1)。

  • 要取得独占锁定(写入的程序),将 lock 设为 LOCK_EX(PHP 4.0.1 以前的版本中设置为 2)。

  • 要释放锁定(无论共享或独占),将 lock 设为 LOCK_UN(PHP 4.0.1 以前的版本中设置为 3)。

  • 如果不希望 flock() 在锁定时堵塞,则给 lock 加上 LOCK_NB(PHP 4.0.1 以前的版本中设置为 4)。


PHP中文网词条详解返回值

成功时返回 TRUE, 或者在失败时返回 FALSE。

PHP中文网词条详解更新日志

版本说明
5.3.2在文件资源句柄关闭时不再自动解锁。现在要解锁必须手动进行。
4.0.1增加了常量 LOCK_XXX。        之前你必须使用 1 代表 LOCK_SH,2 代表LOCK_EX,3 代表LOCK_UN,4 代表LOCK_NB

PHP中文网词条详解范例


Example #1 flock() 例子

<?php
$file = fopen("test.txt","w+");
// 排它性的锁定
if (flock($file,LOCK_EX))
{
  fwrite($file,"Write something");
  // 释放锁定
  flock($file,LOCK_UN);
}
else
{
  echo "Error locking file!";
}
fclose($file);
?>

以上例程会在test.txt文件中输入:

Write something


PHP中文网词条详解注释

1. 由于 flock() 需要一个文件指针, 因此可能不得不用一个特殊的锁定文件来保护打算通过写模式打开的文件的访问(在 fopen() 函数中加入 "w" 或 "w+")。

2. 在部分操作系统中 flock() 以进程级实现。当用一个多线程服务器 API(比如 ISAPI)时,可能不可以依靠 flock() 来保护文件,因为运行于同一服务器实例中其它并行线程的 PHP 脚本可以对该文件进行处理。

flock() 不支持旧的文件系统,如 FAT 以及它的派生系统。因此,此环境下总是返回 FALSE(尤其是对 Windows 98 用户来说)。

参考资料
词条标签:
flock