程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> PHP綜合 >> PHP中使用Session配合Javascript實現文件上傳進度條功能

PHP中使用Session配合Javascript實現文件上傳進度條功能

編輯:PHP綜合

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

在PHP 5.4以前,實現這樣的進度條並不容易,主要有三種方法:

1.使用Flash, Java, ActiveX
2.使用PHP的APC擴展
3.使用HTML5的File API

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

第二種方法的不足在於,它需要安裝PHP的APC擴展庫,要求用戶能夠控制服務器端的配置。另外,如果安裝APC僅僅是為了實現一個上傳進度條,那麼顯然有點殺雞用牛刀的意思。

第三種方法應該是最為理想的方法,不需要服務器端的支持,僅在浏覽器端使用Javascript即可。但是由於HTML5標准尚未確立,各浏覽器廠商的支持也不相同,所以暫時這種方法還難以普及。

PHP 5.4中引入的基於session的上傳進度監視功能(session.upload_progress),它提供了一個服務器端的上傳進度監視解決方案。升級到PHP 5.4之後,可以不必安裝APC擴展,僅使用原生PHP和前端的Javascript即可實現上傳進度條。

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

原理介紹

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

那麼,文件上傳信息具體是如何存儲的?我們要如何訪問它呢?下面我們來詳細說明。

PHP 5.4 中引入了一些配置項(在php.ini中進行設置)

復制代碼 代碼如下:
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功能的開啟與否,默認開啟;cleanup 則設置當文件上傳的請求提交完成後,是否清除session的相關信息,默認開啟。

prefix 和 name 兩項用來設置進度信息在session中存儲的變量名/鍵名。關於這兩項的詳細使用見下文。

freq 和 min_freq 兩項用來設置服務器端對進度信息的更新頻率。合理的設置這兩項可以減輕服務器的負擔。

在上傳文件的表單中,需要為該次上傳設置一個標識符,並在接下來的過程中使用該標識符來引用進度信息。具體的,在上傳表單中需要有一個隱藏的input,它的name屬性為php.ini中 session.upload_progress.name 的值;它的值為一個由你自己定義的標識符。如下:

復制代碼 代碼如下:
<input type="hidden"
    name="<?php echo ini_get('session.upload_progress.name'); ?>"
    value="test" />

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

復制代碼 代碼如下:
$name = ini_get('session.upload_progress.name');
$key = ini_get('session.upload_progress.prefix') . $_POST[$name];

$_SESSION[$key]; // 這裡就是此次文件上傳的進度信息了

$_SESSION[$key]這個變量的結構是這樣的:

復制代碼 代碼如下:
$_SESSION["upload_progress_test"] = array(
 "start_time" => 1234567890,   // 開始時間
 "content_length" => 57343257, // POST請求的總數據長度
 "bytes_processed" => 453489,  // 已收到的數據長度
 "done" => false,              // 請求是否完成 true表示完成,false未完成

 // 單個文件的信息
 "files" => array(
  0 => array( ... ),
  // 同一請求中可包含多個文件
  1 => array( ... ),
 )
);

這樣,我們就可以使用其中的 content_length 和 bytes_processed 兩項來得到進度百分比。

程序示例

原理介紹完了,下面我們來完整的實現一個基於PHP和Javascript的文件上傳進度條。

上傳表單

首先,來編寫我們的上傳表單頁面 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>

<div id="progress" class="progress" style="margin-bottom:15px;display:none;">
        <div class="bar" style="width:0%;"></div>
        <div class="label">0%</div>
</div>

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

這裡需要特別注意一下表單的target屬性,這裡設置指向了一個當前頁面中的iframe。這一點很關鍵,通過設置target屬性,讓表單提交後的頁面顯示在iframe中,從而避免當前的頁面跳轉。因為我們還得在當前頁面顯示進度條呢。

#progress 這個div是用來顯示進度條的。

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

處理上傳的文件

表單的action指向upload.php,我們在upload.php中處理上傳的文件,將它轉存到當前目錄。這裡與通常情況下的上傳處理沒有區別。
復制代碼 代碼如下:
if(is_uploaded_file($_FILES['file1']['tmp_name'])){
        move_uploaded_file($_FILES['file1']['tmp_name'], "./{$_FILES['file1']['name']}");
}
?>

Ajax獲取進度信息

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

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變量中的進度信息,然後輸出一個進度百分比。

在 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);
});

當#upload-form被提交時,我們把進度條顯示出來,然後反復調用 fetch_progress() 獲得進度信息,並更新進度條,直到文件上傳完畢,顯示'完成!'。

Done!

完整代碼下載:http://xiazai.jb51.net/201410/tools/samples-master.rar

注意事項

input標簽的位置

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

取消上傳

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

setTimeout vs. setInterval

應該通過 setTimeout() 來調用 fetch_progress(),這樣可以確保一次請求返回之後才開始下一次請求。如果使用 setInterval() 則不能保證這一點,有可能導致進度條出現'不進反退'。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved