PHP使用Session实现上传进度功能详解

本文实例讲述了PHP使用Session实现上传进度功能,分享给大家供大家参考,具体如下:

实现文件上传进度条基本是依靠JS插件或HTML5的File API来完成,其实PHP配合ajax也能实现此功能。

PHP手册对于session上传进度是这么介绍的:

当 session.upload_progress.enabled INI 选项开启时,PHP 能够在每一个文件上传时监测上传进度。 这个信息对上传请求自身并没有什么帮助,但在文件上传时应用可以发送一个POST请求到终端(例如通过XHR)来检查这个状态

当一个上传在处理中,同时POST一个与INI中设置的session.upload_progress.name同名变量时,上传进度可以在$_SESSION中获得。 当PHP检测到这种POST请求时,它会在$_SESSION中添加一组数据, 索引是 session.upload_progress.prefix 与 session.upload_progress.name连接在一起的值。 通常这些键值可以通过读取INI设置来获得,例如:

  1. <?php
  2. $key = ini_get("session.upload_progress.prefix") . ini_get("session.upload-progress.name");
  3. var_dump($_SESSION[$key]);
  4. ?>

通过将$_SESSION[$key]["cancel_upload"]设置为TRUE,还可以取消一个正在处理中的文件上传。 当在同一个请求中上传多个文件,它仅会取消当前正在处理的文件上传和未处理的文件上传,但是不会移除那些已经完成的上传。 当一个上传请求被这么取消时,$_FILES中的error将会被设置为 UPLOAD_ERR_EXTENSION。

session.upload_progress.freq 和 session.upload_progress.min_freq INI选项控制了上传进度信息应该多久被重新计算一次。 通过合理设置这两个选项的值,这个功能的开销几乎可以忽略不计。

注意:为了使这个正常工作,web服务器的请求缓冲区需要禁用,否则 PHP可能仅当文件完全上传完成时才能收到文件上传请求。 已知会缓冲这种大请求的程序有Nginx。

下面原理介绍:

当浏览器向服务器端上传一个文件时,PHP将会把此次文件上传的详细信息(如上传时间、上传进度等)存储在session当中。然后,随着上传的进行,周期性的更新session中的信息。这样,浏览器端就可以使用Ajax周期性的请求一个服务器端脚本,由该脚本返回session中的进度信息;浏览器端的Javascript即可根据这些信息显示/更新进度条了。

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的相关信息,默认开启,如果需要调试$_SESSION,则应该设为Off。

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]这个变量的结构是这样的:

  1. array (
  2. 'upload_progress_test' => array (
  3. 'start_time' => 1491494993, // 开始时间
  4. 'content_length' => 1410397, // POST请求的总数据长度
  5. 'bytes_processed' => 1410397, // 已收到的数据长度
  6. 'done' => true, // 请求是否完成 true表示完成,false未完成
  7. 'files' => array (
  8. 0 => array (
  9. 'field_name' => 'file1',
  10. 'name' => 'test.jpg',
  11. 'tmp_name' => 'D:\\wamp\\tmp\\phpE181.tmp',
  12. 'error' => 0,
  13. 'done' => true,
  14. 'start_time' => 1491494993,
  15. 'bytes_processed' => 1410096,
  16. ),
  17. ),
  18. ),
  19. );

这样,我们就可以使用其中的 content_length 和 bytes_processed 两项来得到进度百分比。

原理介绍完了,下面我们来完整的实现一个基于PHP和Javascript的文件上传进度条。

上传表单index.php

  1. <?php session_start(); ?>
  2. <!DOCTYPE html>
  3. <html >
  4. <head>
  5. <meta charset="utf-8">
  6. <title>PHP(5.4) Session 上传进度 Demo</title>
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <meta name="keywords" content=""/>
  9. <meta name="description" content=""/>
  10. <meta name="author" content="">
  11. <link href="https://cdn.bootcss.com/bootstrap/4.0.0-alpha.2/css/bootstrap.min.css" rel="external nofollow" rel="stylesheet">
  12. <style type="text/css">
  13. body{
  14. font-size:1em;
  15. color:#333;
  16. font-family: "宋体", Arial, sans-serif;
  17. }
  18. h1, h2, h3, h4, h5, h6{
  19. font-family: "宋体", Georgia, serif;
  20. color:#000;
  21. line-height:1.8em;
  22. margin:0;
  23. }
  24. h1{ font-size:1.8em; }
  25. #wrap{
  26. margin-top:15px;
  27. margin-bottom:50px;
  28. background:#fff;
  29. border-radius:5px;
  30. box-shadow:inset 0 0 3px #000,
  31. 0 0 3px #eee;
  32. }
  33. #header{
  34. border-radius:5px 5px 0 0;
  35. box-shadow:inset 0 0 3px #000;
  36. padding:0 15px;
  37. color:#fff;
  38. background: #333333;
  39. }
  40. #header h1{
  41. color:#fff;
  42. }
  43. #article{
  44. padding:0 15px;
  45. }
  46. #footer{
  47. text-align:center;
  48. border-top:1px solid #ccc;
  49. border-radius:0 0 5px 5px;
  50. }
  51. .progress {
  52. width: 100%;
  53. border: 1px solid #4da8fe;
  54. border-radius: 40px;
  55. height: 20px;
  56. position: relative;
  57. }
  58. .progress .labels {
  59. position: relative;
  60. text-align: center;
  61. }
  62. .progress .bar {
  63. position: absolute;
  64. left: 0;
  65. top: 0;
  66. background: #4D90FE;
  67. height: 20px;
  68. line-height:20px;
  69. border-radius: 40px;
  70. min-width: 20px;
  71. }
  72. .report-file {
  73. display: block;
  74. position: relative;
  75. width: 120px;
  76. height: 28px;
  77. overflow: hidden;
  78. border: 1px solid #428bca;
  79. background: none repeat scroll 0 0 #428bca;
  80. color: #fff;
  81. cursor: pointer;
  82. text-align: center;
  83. float: left;
  84. margin-right:5px;
  85. }
  86. .report-file span {
  87. cursor: pointer;
  88. display: block;
  89. line-height: 28px;
  90. }
  91. .file-prew {
  92. cursor: pointer;
  93. position: absolute;
  94. top: 0;
  95. left:0;
  96. width: 120px;
  97. height: 30px;
  98. font-size: 100px;
  99. opacity: 0;
  100. filter: alpha(opacity=0);
  101. }
  102. .container{
  103. padding-left:0;
  104. padding-right:0;
  105. margin:0 auto;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div class="container">
  111. <div >
  112. <h1>Session上传进度 Demo</h1>
  113. </div>
  114. <div >
  115. <form action="upload.php" method="POST" enctype="multipart/form-data"
  116. target="hidden_iframe">
  117. <input type="hidden" name="<?php echo ini_get("session.upload_progress.name"); ?>" value="test"/>
  118. <div class="report-file">
  119. <span>上传文件…</span><input tabindex="3" size="3" name="file1" class="file-prew" type="file" onchange="document.getElementById('textName').value=this.value">
  120. </div>
  121. <input type="text" />
  122. <p>
  123. <input type="submit" class="btn btn-default" value="上传"/>
  124. </p>
  125. </form>
  126. <div class="progress" >
  127. <div class="bar" ></div>
  128. <div class="labels">0%</div>
  129. </div>
  130. </div> <!-- #article -->
  131. <div >
  132. <p> </p>
  133. </div>
  134. </div><!-- #wrap -->
  135. <iframe name="hidden_iframe" src="about:blank" ></iframe>
  136. <script src="https://cdn.bootcss.com/jquery/3.1.1/jquery.min.js"></script>
  137. <script type="text/javascript">
  138. function fetch_progress() {
  139. $.get('progress.php', {'<?php echo ini_get("session.upload_progress.name"); ?>': 'test'}, function (data) {
  140. var progress = parseInt(data);
  141. $('#progress .labels').html(progress + '%');
  142. $('#progress .bar').css('width', progress + '%');
  143. if (progress < 100) {
  144. setTimeout('fetch_progress()', 500);
  145. } else {
  146. $('#progress .labels').html('100%');
  147. }
  148. }, 'html');
  149. }
  150. $('#upload-form').submit(function () {
  151. $('#progress').show();
  152. //图片比较小,看不出进度条加载效果,初始设33%
  153. $('#progress .labels').html('33%');
  154. $('#progress .bar').css('width', '33%');
  155. setTimeout('fetch_progress()', 500);
  156. });
  157. </script>
  158. </body>
  159. </html>

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

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

上传文件upload.php

  1. <?php
  2. /**
  3. * 上传文件
  4. */
  5. if(is_uploaded_file($_FILES['file1']['tmp_name'])){
  6. //unlink($_FILES['file1']['tmp_name']);
  7. $fileName = 'pic_' . date('YmdHis') . mt_rand(10000,99999);
  8. $ext = substr($_FILES['file1']['name'], strrpos($_FILES['file1']['name'], '.'));
  9. move_uploaded_file($_FILES['file1']['tmp_name'], $fileName . $ext);
  10. }

ajax获取上传进度progress.php

  1. <?php
  2. /**
  3. * AJAX获取上传文件进度
  4. */
  5. session_start();
  6. $i = ini_get('session.upload_progress.name');
  7. //session.upload_progress.name = "PHP_SESSION_UPLOAD_PROGRESS"
  8. $key = ini_get("session.upload_progress.prefix") . $_GET[$i];
  9. //session.upload_progress.prefix = "upload_progress_" . 'test'
  10. if (!emptyempty($_SESSION[$key])) {
  11. $current = $_SESSION[$key]["bytes_processed"]; // 已收到的数据长度
  12. $total = $_SESSION[$key]["content_length"]; // POST请求的总数据长度
  13. echo $current < $total ? ceil($current / $total * 100) : 100;
  14. }else{
  15. echo 100;
  16. }

注意事项:

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

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