Web應(yīng)用中常需要提供文件上傳的功能。典型的場景包括用戶頭像上傳、相冊圖片上傳等。當(dāng)需要上傳的文件比較大的時候，提供一個顯示上傳進(jìn)度的進(jìn)度條就很有必要了。

在PHP 5.4以前，實(shí)現(xiàn)這樣的進(jìn)度條并不容易，主要有三種方法:

• 使用Flash, Java, ActiveX

• 使用PHP的APC擴(kuò)展

• 使用HTML5的File API

相關(guān)學(xué)習(xí)推薦：PHP編程從入門到精通

第一種方法依賴第三方的瀏覽器插件，通用性不足，且易帶來安全隱患。不過由于Flash的使用比較廣泛，因此還是有很多網(wǎng)站使用Flash作為解決方案。

第二種方法的不足在于，它需要安裝PHP的APC擴(kuò)展庫，要求用戶能夠控制服務(wù)器端的配置。另外，如果安裝APC僅僅是為了實(shí)現(xiàn)一個上傳進(jìn)度條，那么顯然有點(diǎn)殺雞用牛刀的意思。

第三種方法應(yīng)該是最為理想的方法，不需要服務(wù)器端的支持，僅在瀏覽器端使用Javascript即可。但是由于HTML5標(biāo)準(zhǔn)尚未確立，各瀏覽器廠商的支持也不相同，所以暫時這種方法還難以普及。

PHP 5.4中引入的基于session的上傳進(jìn)度監(jiān)視功能(session.upload_progress)，它提供了一個服務(wù)器端的上傳進(jìn)度監(jiān)視解決方案。升級到PHP 5.4之后，可以不必安裝APC擴(kuò)展，僅使用原生PHP和前端的Javascript即可實(shí)現(xiàn)上傳進(jìn)度條。

下面我們就詳細(xì)介紹一下 PHP 5.4 的這個 session.upload_progress 新特性。

原理介紹

當(dāng)瀏覽器向服務(wù)器端上傳一個文件時，PHP將會把此次文件上傳的詳細(xì)信息(如上傳時間、上傳進(jìn)度等)存儲在session當(dāng)中。然后，隨著上傳的進(jìn)行，周期性的更新session中的信息。這樣，瀏覽器端就可以使用Ajax周期性的請求一個服務(wù)器端腳本，由該腳本返回session中的進(jìn)度信息；瀏覽器端的Javascript即可根據(jù)這些信息顯示/更新進(jìn)度條了。

那么，文件上傳信息具體是如何存儲的？我們要如何訪問它呢？下面我們來詳細(xì)說明。

PHP 5.4 中引入了一些配置項(xiàng)(在php.ini中進(jìn)行設(shè)置)

代碼如下:

session.upload_progress.enabled = "1" session.upload_progress.cleanup = "1" session.upload_progress.prefix = "upload_progress_" session.upload_progress.name = "PHP_SESSION_UPLOAD_PROGRESS" session.upload_progress.freq = "1%" session.upload_progress.min_freq = "1"

其中enabled控制upload_progress功能的開啟與否，默認(rèn)開啟；cleanup 則設(shè)置當(dāng)文件上傳的請求提交完成后，是否清除session的相關(guān)信息，默認(rèn)開啟。

prefix 和 name 兩項(xiàng)用來設(shè)置進(jìn)度信息在session中存儲的變量名/鍵名。關(guān)于這兩項(xiàng)的詳細(xì)使用見下文。

freq 和 min_freq 兩項(xiàng)用來設(shè)置服務(wù)器端對進(jìn)度信息的更新頻率。合理的設(shè)置這兩項(xiàng)可以減輕服務(wù)器的負(fù)擔(dān)。

在上傳文件的表單中，需要為該次上傳設(shè)置一個標(biāo)識符，并在接下來的過程中使用該標(biāo)識符來引用進(jìn)度信息。具體的，在上傳表單中需要有一個隱藏的input，它的name屬性為php.ini中 session.upload_progress.name 的值；它的值為一個由你自己定義的標(biāo)識符。如下：

代碼如下:

<input type="hidden"     name="<?php echo ini_get('session.upload_progress.name'); ?>"     value="test" />

接到文件上傳的表單后，PHP會在$_SESSION變量中新建鍵，鍵名是一個將session.upload_progress.prefix的值與上面你自定義的標(biāo)識符連接后得到的字符串，可以這樣得到：

代碼如下:

$name = ini_get('session.upload_progress.name'); $key = ini_get('session.upload_progress.prefix') . $_POST[$name]; $_SESSION[$key]; // 這里就是此次文件上傳的進(jìn)度信息了

$_SESSION[$key]這個變量的結(jié)構(gòu)是這樣的：

代碼如下:

$_SESSION["upload_progress_test"] = array(  "start_time" => 1234567890,   // 開始時間  "content_length" => 57343257, // POST請求的總數(shù)據(jù)長度  "bytes_processed" => 453489,  // 已收到的數(shù)據(jù)長度  "done" => false,              // 請求是否完成 true表示完成，false未完成  // 單個文件的信息  "files" => array(   0 => array( ... ),   // 同一請求中可包含多個文件   1 => array( ... ),  ) );

這樣，我們就可以使用其中的 content_length 和 bytes_processed 兩項(xiàng)來得到進(jìn)度百分比。

程序示例

原理介紹完了，下面我們來完整的實(shí)現(xiàn)一個基于PHP和Javascript的文件上傳進(jìn)度條。

上傳表單

首先，來編寫我們的上傳表單頁面 index.php，代碼如下：

代碼如下:

<form id="upload-form"     action="upload.php" method="POST" enctype="multipart/form-data"     style="margin:15px 0" target="hidden_iframe">         <input type="hidden" name="" value="test" />         <p><input type="file" name="file1" /></p>          <p><input type="submit" value="Upload" /></p> </form>     <iframe id="hidden_iframe" name="hidden_iframe" src="about:blank" style="display:none;"></iframe> <p id="progress" class="progress" style="margin-bottom:15px;display:none;">         <p class="bar" style="width:0%;"></p>         <p class="label">0%</p> </p>

注意表單中的session.upload_progress.name隱藏項(xiàng)，值設(shè)置為了test。表單中僅有一個文件上傳input，如果需要，你可以添加多個。

這里需要特別注意一下表單的target屬性，這里設(shè)置指向了一個當(dāng)前頁面中的iframe。這一點(diǎn)很關(guān)鍵，通過設(shè)置target屬性，讓表單提交后的頁面顯示在iframe中，從而避免當(dāng)前的頁面跳轉(zhuǎn)。因?yàn)槲覀冞€得在當(dāng)前頁面顯示進(jìn)度條呢。

#progress 這個p是用來顯示進(jìn)度條的。

注意 別忘了在index.php的最開始加上session_start()。

處理上傳的文件

表單的action指向upload.php，我們在upload.php中處理上傳的文件，將它轉(zhuǎn)存到當(dāng)前目錄。這里與通常情況下的上傳處理沒有區(qū)別。

代碼如下:

if(is_uploaded_file($_FILES['file1']['tmp_name'])){         move_uploaded_file($_FILES['file1']['tmp_name'], "./{$_FILES['file1']['name']}"); } ?>

Ajax獲取進(jìn)度信息

這一步是關(guān)鍵，我們需要建立一個 progress.php 文件，用來讀取session中的進(jìn)度信息; 然后我們在 index.php 中增加Javascript代碼，向 progress.php 發(fā)起Ajax請求，然后根據(jù)獲得的進(jìn)度信息更新進(jìn)度條。

progress.php 的代碼如下：

代碼如下:

session_start(); $i = ini_get('session.upload_progress.name'); $key = ini_get("session.upload_progress.prefix") . $_GET[$i]; if (!empty($_SESSION[$key])) {         $current = $_SESSION[$key]["bytes_processed"];         $total = $_SESSION[$key]["content_length"];         echo $current < $total ? ceil($current / $total * 100) : 100; }else{         echo 100; } ?>

在這里我們獲得$_SESSION變量中的進(jìn)度信息，然后輸出一個進(jìn)度百分比。

在 index.php 中，我們將如下代碼添加到頁面底部 (為簡便，這里使用jQuery):

代碼如下:

function fetch_progress(){         $.get('progress.php',{ '' : 'test'}, function(data){                 var progress = parseInt(data);                 $('#progress .label').html(progress + '%');                 $('#progress .bar').css('width', progress + '%');                 if(progress < 100){                         setTimeout('fetch_progress()', 100);                 }else{             $('#progress .label').html('完成!');         }         }, 'html'); } $('#upload-form').submit(function(){         $('#progress').show();         setTimeout('fetch_progress()', 100); });

當(dāng)#upload-form被提交時，我們把進(jìn)度條顯示出來，然后反復(fù)調(diào)用 fetch_progress() 獲得進(jìn)度信息，并更新進(jìn)度條，直到文件上傳完畢，顯示'完成!'。

注意事項(xiàng)

input標(biāo)簽的位置

name為session.upload_progress.name的input標(biāo)簽一定要放在文件input <input type="file" /> 的前面。

取消上傳

通過設(shè)置 $_SESSION[$key]['cancel_upload'] = true 可取消當(dāng)次上傳。但僅能取消正在上傳的文件和尚未開始的文件。已經(jīng)上傳成功的文件不會被刪除。

setTimeout vs. setInterval

應(yīng)該通過 setTimeout() 來調(diào)用 fetch_progress()，這樣可以確保一次請求返回之后才開始下一次請求。如果使用 setInterval() 則不能保證這一點(diǎn)，有可能導(dǎo)致進(jìn)度條出現(xiàn)'不進(jìn)反退'。