PHP 5.4+ 利用 session.upload_progress 实现文件上传进度条

PHP文件上传进度条实现概述

Web应用常需文件上传功能，如用户头像或相册图片。大文件上传时，提供进度条显示很有必要。

在PHP 5.4以前，实现上传进度条较难，主要有三种方法：

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

第一种方法依赖第三方浏览器插件，通用性不足且易带来安全隐患。因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新特性。

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的完整实现示例

程序示例

原理介绍完毕，下面我们来完整实现一个基于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()则不能保证这一点，有可能导致进度条出现'不进反退'。