在Yii框架中实现文件下载功能,核心是通过框架提供的response组件处理响应内容,结合流式传输配置可以优化大文件的下载效率,避免一次性加载整个文件到内存导致内存溢出。

Yii框架文件下载的基础实现
Yii框架的yiiwebResponse组件内置了文件下载的相关方法,最常用的是sendFile方法,该方法可以直接将服务器上的文件发送给客户端,触发浏览器的下载行为。
基础的文件下载实现步骤如下:
- 获取要下载的文件路径,确保文件真实存在且有读取权限
- 通过Yii::
$app->response获取响应实例 - 调用响应实例的
sendFile方法,传入文件路径和下载时显示的文件名 - 返回响应实例即可完成下载
下面是一个简单的文件下载示例代码:
<?php
namespace appcontrollers;
use yiiwebController;
use yiiwebNotFoundHttpException;
class FileController extends Controller
{
public function actionDownload()
{
// 要下载的文件路径,这里使用绝对路径
$filePath = Yii::getAlias('@webroot/uploads/test.pdf');
// 下载时显示的文件名
$downloadName = '用户手册.pdf';
// 判断文件是否存在
if (!file_exists($filePath)) {
throw new NotFoundHttpException('请求的文件不存在');
}
// 调用sendFile方法实现下载
return Yii::$app->response->sendFile($filePath, $downloadName);
}
}
流式传输配置说明
当下载的文件体积较大时,使用默认的sendFile方法可能会一次性将文件内容加载到内存中,导致内存占用过高。此时可以配置流式传输,让文件以流的形式分块发送给客户端,减少内存消耗。
Yii框架的sendFile方法本身支持流式传输,只需要调整相关的配置参数即可。核心配置项包括:
mimeType:设置文件的MIME类型,默认会自动识别,也可以手动指定inline:设置为false表示强制下载,设置为true表示在浏览器中直接打开fileSize:手动指定文件大小,流式传输时会根据此值分块发送offset和length:可以指定下载文件的偏移量和长度,实现断点续传的基础功能
下面是配置了流式传输的文件下载示例:
<?php
namespace appcontrollers;
use yiiwebController;
use yiiwebNotFoundHttpException;
class FileController extends Controller
{
public function actionStreamDownload()
{
$filePath = Yii::getAlias('@webroot/uploads/large_video.mp4');
$downloadName = '演示视频.mp4';
if (!file_exists($filePath)) {
throw new NotFoundHttpException('请求的文件不存在');
}
$response = Yii::$app->response;
// 配置流式传输相关参数
$response->sendFile($filePath, $downloadName)
->setMimeType('video/mp4') // 指定MIME类型
->setInline(false); // 强制下载
// 手动设置文件大小,优化流式传输
$fileSize = filesize($filePath);
$response->headers->set('Content-Length', $fileSize);
// 设置分块传输标识
$response->headers->set('Transfer-Encoding', 'chunked');
return $response;
}
}
注意事项
在实现文件下载功能时,需要注意以下几点:
- 文件路径尽量使用别名定义,避免硬编码路径导致部署时出现问题
- 下载前必须校验文件是否存在,避免抛出不必要的错误
- 如果文件存储在非web可访问目录,需要确保PHP进程有文件的读取权限
- 大文件下载时建议开启流式传输,避免内存溢出
- 可以根据需求添加下载权限校验,比如只有登录用户才能下载特定文件
如果需要实现断点续传功能,还需要额外处理请求头中的Range字段,根据客户端请求的偏移量返回对应的文件内容,结合流式传输可以进一步提升大文件下载的用户体验。
Yii框架文件下载流式传输response组件修改时间:2026-07-03 14:24:23