flock
(PHP 4, PHP 5)
flock — 輕便的諮詢文件鎖定
說明
bool flock ( int $handle , int $operation [, int &$wouldblock ] )
PHP 支援以諮詢方式(也就是說所有存取程式必須使用相同方式鎖定, 否則它不會工作)鎖定全部檔案的一種輕便方法。
Note:
在 Windows 下 flock() 將會強制執行。
flock() 操作的 handle 必須是一個已經開啟的檔案指標。 operation 可以是下列值之一:
要取得共用鎖定(讀取的程式),將 operation 設為 LOCK_SH(PHP 4.0.1 先前的版本設為 1)。
要取得獨佔鎖定(寫入的程式),將 operation 設為 LOCK_EX(PHP 4.0.1 先前的版本設定為 2)。
要釋放鎖定(無論共用或獨佔),將 operation 設為 LOCK_UN(PHP 4.0.1 先前的版本中設為 3)。
如果不希望 flock() 在鎖定時堵塞,則給 operation 加上 LOCK_NB(PHP 4.0.1 以前的版本中設定為 4)。
flock() 允許執行一個簡單的可以在任何平台中使用的讀取/寫入模型(包括大部分的 Unix 派生版和甚至是 Windows)。如果鎖定會阻塞的話(EWOULDBLOCK 錯誤碼情況下),可選的第三個參數會被設定為 TRUE。鎖定操作也可以被 fclose() 釋放(程式碼執行完畢時也會自動呼叫)。
成功時回傳TRUE, 或失敗時回傳FALSE.
Example #1 flock() 範例
$fp = fopen("/tmp/lock.txt", "w ");
if (flock($fp, LOCK_EX)) { // 進行排它型鎖定
fwrite($fp, "Write something here ");
flock($fp, LOCK_UN); // 釋放鎖定} else {
echo "Couldn't lock the file !";
}
fclose($fp);
?>
Note:
由於flock() 需要一個檔案指針, 因此可能不得不用一個特殊的鎖定檔案來保護打算透過寫入模式開啟的檔案的存取(在fopen() 函數中加入"w " 或"w ")。
Warning
flock() 不能用於 NFS 以及其它一些網路檔案系統。詳細資料查看自己作業系統的文件。
在部分作業系統中 flock() 以行程級實作。當用一個多執行緒伺服器 API(例如 ISAPI)時,可能不可以依靠 flock() 來保護文件,因為運行於同一伺服器實例中其它並行執行緒的 PHP 腳本可以對該文件進行處理。
flock() 不支援舊的檔案系統,如 FAT 以及它的衍生系統。因此,在此環境下總是會傳回 FALSE(尤其是對 Windows 98 使用者來說)。
php中檔案鎖定函數flock函數用法簡介:
語法:
bool flock ( int $handle , int $operation [, int &$wouldblock ] )
flock() 操作的handle 必須是一個已經打開的檔案指標。 operation 可以是以下值之一:
1. 要取得共享鎖定(讀取程式),將operation 設為LOCK_SH(PHP 4.0.1 先前的版本設為1)
2. 要取得獨佔鎖定(寫入程式),將operation 設為LOCK_EX(PHP 4.0.1 先前的版本中設為2)
3. 要釋放鎖定(無論共用或獨佔),將operation 設為LOCK_UN(PHP 4.0.1 以前的版本中設定為3)
4. 如果你不希望flock() 在鎖定時堵塞,則給operation 加上LOCK_NB(PHP 4.0.1 以前的版本中設定為4)
看下面代碼:
a.php
$file = “temp.txt”;
$fp = fopen($file , 'w');
if(flock($fp , LOCK_EX)){
fwrite( $fp , “abc”);
sleep(10);
fwrite($fp , “123”);
flock($fp , LOCK_UN);
}
fclose($ fp);
?>
b.php
$file = “temp.txt”;
$fp = fopen($file , 'r');
echo fread($fp , 100);
fclose($fp);
?>
運行a.php 後,馬上運行b.php ,可以看到輸出:
abc
等a.php 運行完後運行b.php ,可以看到輸出:
abc
123
顯然,當a.php 寫檔案時資料太大,導致時間比較長時,這時b.php 讀取資料不完整,在對b.php做修改
修改b.php 為:
$file = “ temp.txt」;
$fp = fopen($file , 'r');
if(flock($fp , LOCK_EX)){
echo fread($fp , 100);
flock($fp , LOCK_UN);
} else{
echo “Lock file failed…”;
}
fclose($fp);
?>
運行a.php 後,馬上運行b.php ,可以發現b.php 會等到a.php 運行完成後(即10 秒後)才顯示:
abc
123
讀取資料完整,但時間過長,他要等待寫鎖釋放,再對b.php做修改。
修改b.php 為:
php
$file = “temp.txt”;
$fp = fopen($file , 'r');
if(flock($fp , LOCK_SH | LOCK_NB)){
echo fread ($fp , 100);
flock($fp , LOCK_UN);
} else{
echo “Lock file failed…”;
}
fclose($fp);
?>
運行a.php 後,馬上運行b.php ,可以看到輸出:
Lock file failed…
證明可以回傳鎖定檔案失敗狀態,而不是向上面一樣要等很久。
腳本之家小編結論:
建議作檔案快取時,選好相關的鎖,不然可能導致讀取資料不完整,或重複寫入資料。
file_get_contents 好像選擇不了鎖,不知道他預設用的什麼鎖,反正和不鎖得到的輸出一樣,是不完整的資料。