PHP下载文件限速X-sendfile

Posted 2021-03-31 php带你从入门到放弃

走过路过不要错过

点击蓝字关注我

PHP

是世界上最好的语言

▼

❶普通文件下载

1、laravel框架HTTP响应的download方法

$pathToFile = 'myfile.csv';//参数一：绝对路径
$downloadName = 'downloadFile.csv';//参数二：下载后的文件名
//download 参数三：HTTP头信息
return response()->download($pathToFile, $downloadName);

2、php实现

$pathToFile = 'myfile.csv';//文件绝对路径
 $downloadName = 'downloadFile.csv';//下载后的文件名

 //输入文件标签
 Header("Content-type: application/octet-stream");
 Header("Accept-Ranges: bytes");
 Header("Accept-Length: " . filesize($pathToFile));
 Header("Content-Disposition: filename=" . $downloadName);

 //输出文件内容
 $file = fopen($pathToFile, "r");
 echo fread($file, filesize($pathToFile));
 fclose($file);
 //或
 //readfile($pathToFile);

其中fread（）与readfile（）的区别可以参考https://segmentfault.com/q/1010000000647226
但是有时候为了节省带宽，避免瞬时流量过大而造成网络堵塞，就要考虑下载限速的问题。

❷下载文件限速

$pathToFile = 'myfile.csv';//文件绝对路径
  $downloadName = 'downloadFile.csv';//下载后的文件名
  $download_rate = 30;// 设置下载速率(30 kb/s)
  if (file_exists($pathToFile) && is_file($pathToFile)) {
      header('Cache-control: private');// 发送 headers
      header('Content-Type: application/octet-stream');
      header('Content-Length: ' . filesize($pathToFile));
      header('Content-Disposition: filename=' . $downloadName);
      flush();// 刷新内容
      $file = fopen($pathToFile, "r");
      while (!feof($file)) {
          print fread($file, round($download_rate * 1024));// 发送当前部分文件给浏览者
          flush();// flush 内容输出到浏览器端
          sleep(1);// 终端1秒后继续
      }
      fclose($file);// 关闭文件流
  } else {
      abort(500, '文件' . $pathToFile . '不存在');
  }

此时出现一个问题，当download_rate>1kb时，文件正常下载，当download_rate<1kb时，文件要等一会儿才下载，究其原因是因为buffer的问题。

在没有开启缓存时，脚本输出的内容都在服务器端处于等待输出的状态，flush()可以将等待输出的内容立即发送到客户端。

开启缓存后，脚本输出的内容存入了输出缓存中，这时没有处于等待输出状态的内容，你直接使用flush()不会向客户端发出任何内容。而ob_flush()的作用就是将本来存在输出缓存中的内容取出来，设置为等待输出状态，但不会直接发送到客户端，这时你就需要先使用ob_flush()再使用flush()，客户端才能立即获得脚本的输出。

以及这篇文章同样讲述了ob_flush()和flush()的区别http://www.laruence.com/2010/04/15/1414.html

但是这种方法将文件内容从磁盘经过一个固定的 buffer 去循环读取到内存，再发送给前端 web 服务器，最后才到达用户。当需要下载的文件很大的时候，这种方式将消耗大量内存，甚至引发 php 进程超时或崩溃，接下来就使用到X-Sendfile。

❸X-Sendfile

X-Sendfile 是一种将文件下载请求由后端应用转交给前端 web服务器处理的机制，它可以消除后端程序既要读文件又要处理发送的压力，从而显著提高服务器效率，特别是处理大文件下载的情形下。

我是用的nginx，所以apache请参考https://tn123.org/mod_xsendfile/
1、首先在配置文件中添加

location /download/ {
  internal;
  root   /some/path;//绝对路径
}

internal 表示这个路径只能在 Nginx 内部访问，不能用浏览器直接访问防止未授权的下载

注意添加在location / {...}的前面

这样你在代码中使用时，文件路径就可以写成“/download/myfile.csv”

2、重启nginx，写代码

$pathToFile = 'myfile.csv';//文件绝对路径
$downloadName = 'downloadFile.csv';//下载后的文件名
$download_rate = 30;// 设置下载速率(30 kb/s)
if (file_exists($pathToFile) && is_file($pathToFile)) {
    return (new Response())->withHeaders([
      'Content-Type'        => 'application/octet-stream',
      'Content-Disposition' => 'attachment;filename=' . $downloadName,
      'X-Accel-Redirect'    => $pathToFile,//让Xsendfile发送文件
      'X-Sendfile'          => $pathToFile,
      'X-Accel-Limit-Rate'  => $download_rate,
    ]);
}else {
    abort(500, '文件' . $pathToFile . '不存在');
}

如果你还想了解更多关于X-sendfile,请自行查阅