CakePHP 4：优雅地处理文件上传验证，避免空文件时的错误

在CakePHP 4中处理文件上传时，经常会遇到一个问题：当用户没有上传文件时，文件类型的验证规则仍然会被触发，导致出现不必要的错误。这篇教程将提供一种更优雅的方式来解决这个问题，避免在每个验证规则中都添加额外的判断逻辑。

问题描述

正如摘要中所述，当使用CakePHP 4验证文件上传时，即使没有上传任何文件，mimeType等验证规则仍然会被执行，从而导致验证失败。例如，以下代码：

public function validationDefault(Validator $validator): Validator
{
$validator = parent::validationDefault($validator);
$validator
->allowEmptyFile('image')
->add('image', 'uploadError', [
'rule' => function ($value, $context) {
foreach ($value as $v) {
return Validation::uploadError($v, true);
}
},
'last' => true,
'message' => 'Upload error'
])
->add('image', 'mimeType', [
'rule' => function ($value, $context) {
foreach ($value as $v) {
return Validation::mimeType($v, [
'image/png',
'image/gif',
'image/pjpeg',
'image/jpeg'
]);
}
},
'message' => 'Bad mime type.',
]);
}

这段代码在没有上传文件时，会触发mimeType验证错误。一种常见的解决方法是在mimeType规则中添加额外的判断：

->add('image', 'mimeType', [
'rule' => function ($value, $context) {
// Added to avoid mimeType validation when no file is uploaded
if ($value[0]->getError() === UPLOAD_ERR_NO_FILE) {
return true;
}
foreach ($value as $v) {
return Validation::mimeType($v, [
'image/png',
'image/gif',
'image/pjpeg',
'image/jpeg'
]);
}
},
'message' => 'Bad mime type.',
]);

虽然这种方法有效，但需要在每个验证规则中重复添加判断，显得不够优雅。

立即学习“PHP免费学习笔记（深入）”；

解决方案：使用 beforeMarshal 事件

一个更优雅的解决方案是使用Model.beforeMarshal事件。这个事件在创建或修补实体之前运行，允许我们在验证之前修改请求数据。我们可以利用这个事件来移除空的上传文件字段，从而避免不必要的验证。

以下是如何在beforeMarshal事件中实现这个功能的示例代码：

use Cake\Event\EventInterface;
use ArrayAccess;
use ArrayObject;
use Psr\Http\Message\UploadedFileInterface;
public function beforeMarshal(
EventInterface $event,
ArrayAccess $data,
ArrayObject $options
): void {
if (
isset($data['image'][0]) &&
$data['image'][0] instanceof UploadedFileInterface &&
$data['image'][0]->getError() === UPLOAD_ERR_NO_FILE
) {
unset($data['image']);
}
}

这段代码检查image字段是否是一个数组，并且数组的第一个元素是否是一个空的上传文件对象。如果是，则从数据中移除image字段。

解释：

• EventInterface $event: 事件对象，包含了事件的相关信息。
• ArrayAccess $data: 包含了请求数据的数组，可以通过数组的方式访问和修改数据。
• ArrayObject $options: 包含了传递给 marshal 方法的选项。
• UploadedFileInterface: PSR-7 定义的文件上传接口。

注意事项：

• 确保引入了Psr\Http\Message\UploadedFileInterface。
• 此方法适用于处理单个或多个文件上传的情况。

简化验证规则

通过在beforeMarshal事件中移除空的上传文件字段，我们可以简化验证规则，使其只关注有效的文件上传。例如，对于只允许单个文件上传的模型，我们可以使用以下验证规则：

$validator
->add('image', 'exactlyOneUploadedFile', [
'rule' => function ($value, $context) {
if (
is_array($value) &&
count($value) === 1 &&
$value[0] instanceof UploadedFileInterface
) {
return true;
}
return false;
},
'message' => 'Must be exactly one uploaded file.'
])
->add('image', 'mimeType', [
'rule' => ['mimeType', ['image/png', 'image/gif', 'image/pjpeg', 'image/jpeg']],
'message' => 'Invalid file type.'
]);

这段代码首先验证image字段是否是一个包含一个UploadedFileInterface对象的数组，然后验证文件的MIME类型。由于空的上传文件字段已经被移除，因此这些验证规则只会针对有效的文件上传执行。

对于允许上传多个文件的模型，可以使用以下验证规则：

$validator
->add('image', 'onlyUploadedFiles', [
'rule' => function ($value, $context) {
if (
!is_array($value) ||
count($value) < 1
) {
return false;
}
foreach ($value as $upload) {
if (!($upload instanceof UploadedFileInterface)) {
return false;
}
}
return true;
},
'message' => 'Must be an array of uploaded files.'
]);

这段代码验证image字段是否是一个包含一个或多个UploadedFileInterface对象的数组。

重要提示：

务必确保验证规则足够严格，以防止未经验证的文件上传。例如，要检查数组中是否只包含UploadedFileInterface对象，并且所有必需的验证规则都已应用。

总结

通过使用beforeMarshal事件来预处理文件上传数据，我们可以避免在没有文件上传时触发不必要的验证错误，并简化验证规则。这种方法提高了代码的可读性和可维护性，使文件上传验证更加优雅。

记住，严格的验证规则对于确保应用程序的安全至关重要。始终验证所有输入数据，并确保只允许上传符合预期的文件。

参考资料

• Cookbook > Database Access & ORM > Saving Data > Modifying Request Data Before Building Entities