如何使用Hyperf框架进行文件下载

如何使用Hyperf框架进行文件下载

引言：
在使用Hyperf框架开发Web应用程序时，文件下载是一个常见的需求。本文将介绍如何使用Hyperf框架进行文件下载，包括具体的代码示例。

一、准备工作
在开始之前，确保你已经安装好了Hyperf框架并成功创建了一个Hyperf应用程序。

二、创建文件下载控制器
首先，我们需要创建一个控制器来处理文件下载的请求。打开终端，进入Hyperf项目的根目录，执行以下命令以生成一个下载控制器：

php bin/hyperf.php generate:controller DownloadController

生成的控制器文件位于app/Controller目录下，打开该文件，修改index()方法如下：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;
use HyperfHttpMessageStreamSwooleStream;
use HyperfUtilsCodecEncode;
use HyperfUtilsCodecJson;
use HyperfUtilsCodecXml;

/**
 * @Controller
 */
class DownloadController
{
    /**
     * 下载文件
     * @RequestMapping(path="/download", methods="get")
     */
    public function index()
    {
        // 文件路径
        $file = '/path/to/file'; // 替换成实际文件路径

        // 文件名
        $filename = 'filename.ext'; // 替换成实际文件名

        // 设置响应头
        return response()
            ->header('Content-Type', 'application/octet-stream')
            ->header('Content-Disposition', 'attachment; filename=' . $filename)
            ->stream(new SwooleStream(file_get_contents($file)));
    }
}

这里我们使用response()函数创建一个响应实例，通过header()方法设置响应头，stream()方法用于发送文件内容。你需要将$file变量替换为实际的文件路径，将$filename变量替换为实际的文件名。

三、配置路由
接下来，我们需要配置一个路由来访问下载控制器。打开 config/routes.php 文件，添加如下代码：

<?php
//...
use AppControllerDownloadController;
//...
Router::get('/download', [DownloadController::class, 'index']);
//...

这样就配置好了一个GET请求的路由，当访问/download时，将会执行DownloadController的index方法。

四、启动服务器
启动Hyperf服务器，以监听HTTP请求。在终端中进入Hyperf项目根目录，执行以下命令：

php bin/hyperf.php start

服务器启动后，就可以通过访问http://localhost:9501/download来进行文件下载了。

结论：
本文介绍了如何使用Hyperf框架进行文件下载，包括创建下载控制器、配置路由和启动服务器。通过本文的示例代码，你可以轻松地在Hyperf项目中实现文件下载功能。希望本文对你有所帮助！