一個PHP簡單文件緩存類

緩存的工作原理

緩存的工作原理其實並不複雜。它的核心思想是：首先，我們將需要顯示的內容存儲在一個文本文件（即緩存文件）之中。然後，如果有用戶請求某個頁面的內容，我們首先檢查此頁對應的緩存（即那個文本文件）是否存在——如果存在且爲最新的緩存文件，那麼直接將這個文本文件中的內容輸出到客戶端供用戶查看；如果此頁對應的緩存文件不存在或緩存生成的時間不符合要求（太舊），那麼直接執行一次此頁對應的PHP文件，並將顯示內容存儲在緩存文件中。重複上述流程。這樣一來，雖然增加了PHP代碼，但我們最大程度的節省了PHP鏈接到數據庫再提取數據的時間。

接下來，我們編寫一個PHP緩存類來實現以上緩存原理。

任務目標

我們將創建的緩存類包含3個非常重要的過程函數：

• starteCache()
• endCache()
• cleanCache()

PHP緩存類基本骨架

在我們具體編寫這3個過程函數之前，我們需要創建這個PHP類的基本骨架，比如類的內外部變量；我們需要創建這個緩存類的一些變量，以方便使用時控制緩存功能的表現，請注意查看下面代碼中的註釋：

<?php
class Cache {
    var $status    = true;     // 值爲True表示開啓緩存；值False表示關閉緩存功能。
   var $cacheDir  = 'cache/'; //存放緩存文件的默認目錄
   var $cacheFile = '';       //緩存文件的真實文件名
   var $timeOut   = 1000;     // 內容被重複使用的最長時限
   var $startTime = 0;        // 程序執行的開始時間
   var $caching     = true;     // 是否需要對內容進行緩存；值爲False表示直接讀取緩存文件內容
}
?>

除了以上變量聲明外，我們還定義了一個常用函數用於獲取執行此類所花費的時間。這就是getMicroTime()過程函數，如下：

<?php
    function getMicroTime() {
            list($usec, $sec) = explode(" ",microtime());
           return ((float)$usec + (float)$sec);
     }
?>

過程函數startCache()

現在我們開始編寫這個緩存類中最重要的一個過程函數。函數startCache()的作用如下：

• 保存緩存類執行的
• 檢查緩存文件是否存在以及緩存文件的時限（是否過期）。
  • 如果緩存文件存在且沒有超過最長時限，那麼顯示文件中的內容並退出 。
• 如果緩存文件不存在，那麼置緩存標誌Caching爲False。

函數代碼如下：

<?php
   function startCache(){
      $this->startTime = $this->getMicroTime();
      ob_start();
       if ($this->status){ 
         $this->cacheFile = $this-&gt;cacheDir.urlencode( $_SERVER['REQUEST_URI'] );
          if ( (file_exists($this->cacheFile)) && 
               ((fileatime($this->cacheFile) + $this->timeOut)> time()) )
          {
            //從緩存文件中讀取內容
            $handle = fopen($this->cacheFile , "r");
            $html   = fread($handle,filesize($this->cacheFile));
            fclose($handle);
          
            // 顯示內容
            echo $html;

            // 顯示程序執行時間           
           echo '<p>Total time: '
                 .round(($this->getMicroTime())-($this->startTime),4).'</p>';
            
            //退出程序
            exit();
           }
           else
           {
             //置緩存標誌caching爲true
             $this->caching = true;
           }
       }
     }
?>

過程函數endCache()

如果實際頁面尚未被緩存，並且caching標誌被設置成True；那麼此函數將首先將頁面中的所有輸出保存成緩存文件，然後顯示頁面。同樣的，這個函數也會顯示頁面執行時間。我們可以在大數據量的情況下通過對比執行時間，發現緩存的優點。

<?php
   function endCache(){
       if ($this->status){
          if ( $this->caching )
          {
            //首先輸出頁面內容，然後將輸出內容保存在緩存文件中
            $html = ob_get_clean();
             echo $html;
            $handle = fopen($this->cacheFile, 'w' );
            fwrite ($handle, $html );
            fclose ($handle);

            //顯示頁面執行時間            
            echo '<p>Total time: '.round(($this->getMicroTime()-$this->startTime),4).'</p>';
          }
       }       
     } 
?>

過程函數cleanCache()

這是核心函數的最後一個，也非常簡單。此函數僅檢查緩存文件夾是否存在，並移除對應的緩存文件。

<?php
    function cleanCache(){
        if ($handle = opendir($this->cacheDir)) {
           while (false !== ($file = readdir($handle))) {
              if (is_file($this->cacheDir.$file)) unlink($this->cacheDir.$file);
           }

          closedir($handle);       
        }
     }
?>

此PHP緩存類的使用

如果你希望完整的使用此PHP緩存類，你需要稍微對它進行功能拓展，但基本的功能它已經具備了。

在需要用到緩存的頁面中，首先你需要導入我們已經編寫好的緩存類，然後創建一個緩存類對象。在創建好的對象基礎上，調用startCache() 函數，接着在這個函數下方你可以輸出你想輸出的內容，包括文字和HTML代碼。最後，在頁面的最下方，調用 endCache() 函數。這樣，處於StartCache()函數和EndCache()函數之間的任何輸出（比如echo，print，HTML代碼）都將作爲緩存寫入緩存文件之中。

以下爲使用此緩存類進行緩存的一個簡單示例：

<?php
   //導入緩存類
   require_once('cache.class.php');
   //創建一個緩存類對象CacheManager
   $CacheManager = new Cache();
   //調用startCache方法，表示開始緩存
   $CacheManager->startCache();
   //以下區塊所有echo內容都將作爲緩存寫入緩存文件中
    echo "Start Cache example at: ".date('H:i:s')."<br/>";
   sleep(2);
    echo "End Cache example at: ".date('H:i:s')."<br/>";
   
    echo "<br/><a href='clear.php'>Clean the cache</a><br/>";
   //以上區塊所有echo內容都將作爲緩存寫入緩存文件中
   $CacheManager->endCache();
?>