如何为 Laravel 中的文件上传功能编写 PHPUnit 单元测试

冬枫同学_7059

冬枫同学_7059

2026-08-14

461人浏览

原创

如何为 Laravel 中的文件上传功能编写 PHPUnit 单元测试

本文详解如何在不调用 HTTP 路由的前提下,通过构造合法 UploadedFile 实例并正确绑定到 Illuminate\Http\Request,实现对 Laravel 文件上传逻辑(如控制器中 $request->file())的精准单元测试。

本文详解如何在不调用 http 路由的前提下,通过构造合法 `uploadedfile` 实例并正确绑定到 `illuminate\http\request`,实现对 laravel 文件上传逻辑(如控制器中 `$request->file()`)的精准单元测试。

在 Laravel 单元测试中,直接 new 一个 Request 并传入 UploadedFile 实例(如 new UploadedFile(...))往往无法使 $request->file('document') 正常返回文件对象——这是因为 Laravel 的 Request 类内部依赖 Symfony\Component\HttpFoundation\FileBag 来管理上传文件,而手动构造的 Request 并未自动初始化该文件袋(files 属性),导致 $request->file() 始终返回 null。

✅ 正确做法是:使用 Illuminate\Http\UploadedFile::fake() 创建模拟文件,并通过 Illuminate\Http\Request::create() 或 Illuminate\Foundation\Testing\TestResponse::call() 等 Laravel 测试辅助方法构建请求,确保文件被正确注入 files 参数。

但注意:你明确要求 不走 HTTP 路由层(即不调用 $this->post() 或 $this->action()),而是纯单元测试方式调用控制器方法(如 uploadDocument($request, $profileId))。此时需手动补全 Request 的 files 属性,使其符合 Laravel 内部预期结构:

use Illuminate\Http\Request;
use Illuminate\Http\UploadedFile;
use Tests\TestCase;

public function testUploadDocumentSuccess()
{
    // 1. 创建模拟上传文件(推荐使用 fake(),它会生成临时文件并设置正确 MIME 类型)
    $uploadedFile = UploadedFile::fake()->image('test-document.jpg', '1024');

    // 2. 手动构建 Request,并显式设置 files 参数(关键!)
    $request = Request::create('/dummy', 'POST', [
        'fileType' => 'profile',
    ], [], [
        'document' => $uploadedFile, // ← 必须放在 files 数组中,而非普通 input
    ]);

    // 3. 调用被测方法
    $response = $this->documentService->uploadDocument($request, 1);

    // 4. 断言
    $this->assertIsArray($response);
    $this->assertArrayHasKey('name', $response); // 假设返回包含 hashName
}

⚠️ 关键点说明:

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载
  • Request::create() 是 Laravel 提供的安全构造方式,它会自动初始化 files、query、request 等参数容器;
  • 文件必须作为 $files 参数(第 4 个参数)传入,且键名需与控制器中 $request->file('document') 的字段名完全一致(此处为 'document');
  • 不要将 UploadedFile 放入 $input(第 3 个参数),否则 $request->file() 无法识别;
  • 若使用 new Request([...]),需手动设置 $request->files = new Symfony\Component\HttpFoundation\FileBag([...]),但易出错,强烈推荐使用 Request::create()。

? 进阶建议:若上传逻辑涉及 S3 存储,应配合 Storage::fake() 隔离外部依赖:

use Illuminate\Support\Facades\Storage;

public function testUploadDocumentWithS3Fake()
{
    Storage::fake('s3'); // 假设配置了名为 's3' 的磁盘

    $request = Request::create('/dummy', 'POST', ['fileType' => 'profile'], [], [
        'document' => UploadedFile::fake()->image('avatar.png'),
    ]);

    $this->documentService->uploadDocument($request, 1);

    // 验证文件是否按预期路径存入 fake disk
    Storage::disk('s3')->assertExists('profile/avatar.png');
}

? 总结:Laravel 的 $request->file() 依赖底层 FileBag 结构,单元测试中务必通过 Request::create() 的 $files 参数注入 UploadedFile 实例,而非简单填充 input 数据。这是绕过路由层、实现高内聚、可复用单元测试的核心实践。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

12464

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

7181

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2235

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4528

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

5234

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

4111

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5957

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4682

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12482

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习