PHP Session和Javascript实现文件上传进度条

在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中进行设置),代码如下:

1. session.upload_progress.enabled = "1" 
2. session.upload_progress.cleanup = "1" 
3. session.upload_progress.prefix = "upload_progress_" 
4. session.upload_progress.name = "PHP_SESSION_UPLOAD_PROGRESS" 
5. session.upload_progress.freq = "1%" 
6. 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 的值,它的值为一个由你自己定义的标识符,如下:

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

接到文件上传的表单后,PHP会在$_SESSION变量中新建键,键名是一个将session.upload_progress.prefix的值与上面你自定义的标识符连接后得到的字符串,可以这样得到,代码如下:

1. $name = ini_get('session.upload_progress.name'); 
2. $key = ini_get('session.upload_progress.prefix') . $_POST[$name]; 
3.  
4.  
5. $_SESSION[$key]; // 这里就是此次文件上传的进度信息了 
6. $_SESSION[$key]这个变量的结构是这样的： 
7.  
8.  
9. <?php 
10. $_SESSION["upload_progress_test"] = array( 
11.  "start_time" => 1234567890,   // 开始时间 
12.  "content_length" => 57343257, // POST请求的总数据长度 
13.  "bytes_processed" => 453489,  // 已收到的数据长度 
14.  "done" => false,   // 请求是否完成 true表示完成，false未完成 
15.  // 单个文件的信息 
16.  "files" => array( 
17.   0 => array( ... ), 
18.   // 同一请求中可包含多个文件 
19.   1 => array( ... ), 
20.  ) 
21. ); 
22. ?> 

这样,我们就可以使用其中的 content_length 和 bytes_processed 两项来得到进度百分比,原理介绍完了,下面我们来完整的实现一个基于PHP和Javascript的文件上传进度条.

上传表单,首先,来编写我们的上传表单页面 index.php,代码如下:

1. <form id="upload-form"action="upload.php" method="POST" enctype="multipart/form-data" 
2.     style="margin:15px 0" target="hidden_iframe"> 
3.  
4.         <input type="hidden" name="<?php echo ini_get("session.upload_progress.name"); ?>" value="test" /> 
5.         <p><input type="file" name="file1" /></p>  
6.         <p><input type="submit" value="Upload" /></p> 
7. </form>      
8.  
9. <iframe id="hidden_iframe" name="hidden_iframe" src="about:blank" style="display:none;"></iframe> 
10.  
11. <div id="progress" class="progress" style="margin-bottom:15px;display:none;"> 
12.         <div class="bar" style="width:0%;"></div> 
13.         <div class="label">0%</div> 
14. </div> 

注意表单中的session.upload_progress.name隐藏项,值设置为了test,表单中仅有一个文件上传input,如果需要,你可以添加多个.

这里需要特别注意一下表单的target属性,这里设置指向了一个当前页面中的iframe,这一点很关键,通过设置target属性,让表单提交后的页面显示在iframe中,从而避免当前的页面跳转,因为我们还得在当前页面显示进度条呢.

#progress 这个div是用来显示进度条的.

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

处理上传的文件:表单的action指向upload.php,我们在upload.php中处理上传的文件,将它转存到当前目录,这里与通常情况下的上传处理没有区别,代码如下:

1. <?php 
2. if(is_uploaded_file($_FILES['file1']['tmp_name'])){ 
3.         move_uploaded_file($_FILES['file1']['tmp_name'], "./{$_FILES['file1']['name']}"); 
4. } 
5. ?> 

Ajax获取进度信息

这一步是关键,我们需要建立一个 progress.php 文件,用来读取session中的进度信息; 然后我们在 index.php 中增加Javascript代码,向 progress.php 发起Ajax请求,然后根据获得的进度信息更新进度条.

progress.php的代码如下:

1. <?php 
2. session_start(); 
3.  
4. $i = ini_get('session.upload_progress.name'); 
5.  
6. $key = ini_get("session.upload_progress.prefix") . $_GET[$i]; 
7.  
8. if (!emptyempty($_SESSION[$key])) { 
9.         $current = $_SESSION[$key]["bytes_processed"]; 
10.         $total = $_SESSION[$key]["content_length"]; 
11.         echo $current < $total ? ceil($current / $total * 100) : 100; 
12. }else{ 
13.         echo 100; 
14. } 
15. ?> 

在这里我们获得$_SESSION变量中的进度信息,然后输出一个进度百分比,在 index.php 中,我们将如下代码添加到页面底部(为简便,这里使用jQuery),代码如下:

1. function fetch_progress(){ 
2.         $.get('progress.php',{ '<?php echo ini_get("session.upload_progress.name"); ?>' : 'test'}, function(data){ 
3.                 var progress = parseInt(data); 
4.  
5.                 $('#progress .label').html(progress + '%'); 
6.                 $('#progress .bar').css('width', progress + '%'); 
7.  
8.                 if(progress < 100){ 
9.                         setTimeout('fetch_progress()', 100); 
10.                 }else{ 
11.             $('#progress .label').html('完成!'); 
12.         } 
13.         }, 'html'); 
14. } 
15.  
16. $('#upload-form').submit(function(){ 
17.         $('#progress').show(); 
18.         setTimeout('fetch_progress()', 100); 
19. }); 

当#upload-form被提交时,我们把进度条显示出来,然后反复调用 fetch_progress() 获得进度信息,并更新进度条,直到文件上传完毕,显示'完成!'.

注意事项:

input标签的位置

name为session.upload_progress.name的input标签一定要放在文件input <input type="file" /> 的前面.

取消上传:

通过设置 $_SESSION[$key]['cancel_upload'] = true 可取消当次上传,但仅能取消正在上传的文件和尚未开始的文件,已经上传成功的文件不会被删除.

setTimeout vs. setInterval

应该通过 setTimeout() 来调用 fetch_progress(),这样可以确保一次请求返回之后才开始下一次请求,如果使用 setInterval() 则不能保证这一点,有可能导致进度条出现’不进反退’.