Symfony / API 平台 - 自定义操作 - 使用 VichUploaderBundle 替换文件的 PUT 方法答案

【问题标题】：Symfony / API Platform - Custom Operation - PUT method for file replacement using VichUploaderBundleSymfony / API 平台 - 自定义操作 - 使用 VichUploaderBundle 替换文件的 PUT 方法
【发布时间】：2020-01-06 09:43:36
【问题描述】：

我将 Vich Uploader Bundle 与 API 平台结合使用来存储文件。我已按照官方文档中的说明进行操作 https://api-platform.com/docs/core/file-upload/#handling-file-upload

除了我想包含 PUT 调用来替换现有的 MediaObject 实体之外，一切都运行良好。我的尝试如下：

我创建了一个自定义操作，并将其映射到实体中的PUT方法如下：


<?php
// api/src/Entity/MediaObject.php

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Controller\CreateMediaObject;
use App\Controller\EditMediaObject;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\HttpFoundation\File\File;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;
use Vich\UploaderBundle\Mapping\Annotation as Vich;

/**
 * @ORM\Entity
 * @ApiResource(
 * 
 *     ...
 * 
 *     itemOperations={
 *         "get",
 *         "put"={
 *             "controller"=EditMediaObject::class,
 *             "deserialize"=false,
 *             "validation_groups"={"Default", "media_object_create"},
 *             "swagger_context"={
 *                 "consumes"={
 *                     "multipart/form-data",
 *                 },
 *                 "parameters"={
 *                     {
 *                         "in"="formData",
 *                         "name"="file",
 *                         "type"="file",
 *                         "description"="The file to upload",
 *                     },
 *                 },
 *             },
 *         },
 *         "delete"
 *     },
 * )
 * @Vich\Uploadable
 */
class MediaObject
{
    /**
     * @var int|null
     *
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue
     * @ORM\Id
     */
    protected $id;

    /**
     * @var string|null
     *
     * @ApiProperty(iri="http://schema.org/contentUrl")
     * @Groups({"media_object_read"})
     */
    public $contentUrl;

    /**
     * @var File|null
     *
     * @Assert\NotNull(groups={"media_object_create"})
     * @Vich\UploadableField(mapping="media_object", fileNameProperty="filePath")
     */
    public $file;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true)
     */
    public $filePath;

    public function getId(): ?int
    {
        return $this->id;
    }
}

对应的Controller：

<?php
// api/src/Controller/EditMediaObject.php

namespace App\Controller;

use App\Entity\MediaObject;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

final class EditMediaObject
{
    /**
    * @var RequestStack
    */
    private $requestStack;


    public function __construct(RequestStack $requestStack)
    {
        $this->requestStack = $requestStack;
    }
    public function __invoke(MediaObject $data): MediaObject
    {
        $request = $this->requestStack->getCurrentRequest();
        $uploadedFile = $request->attributes->get('file');
        if (!$uploadedFile) {
            throw new BadRequestHttpException ('"file" is required');
        }
        $data->file = $uploadedFile;

        return $data;
    }
}

$data 对象已成功填充。但是我无权访问初始请求参数（特别是“文件”）。

这是因为初步的 OPTIONS 调用吗？如果是这样，我如何转发/保留文件以将其附加到 MediaObject？

提前致谢

编辑：

如果有人感兴趣，在 PHP 中不能通过 PUT 请求发送文件参数。（来源：PHP multipart form data PUT request?）

【问题讨论】：

标签： php rest symfony api-platform.com vichuploaderbundle

【解决方案1】：

你为什么看$request->attributes？你应该看看$request->files。

见https://symfony.com/doc/current/components/http_foundation.html#accessing-request-data

【讨论】：

谢谢，FileBag 也是空的

【解决方案2】：

你需要发送一个带有额外参数的 POST 请求，_method = PUT，它将改变 POST 请求，就好像它是一个 PUT 请求。

【讨论】：

【解决方案3】：

我最近遇到了一个非常相似的问题，不过，我没有使用整个 symfony 库，我使用的是 HttpFoundation/Request 和 HttpFoundation/Response 对象。

起初我对请求似乎完全是空的感到困惑。

在花费了比我希望的更多的时间来研究它之后，这个问题可以追溯到 PHP 的内部。

我找到了this PECL extension

我对 pecl 不是很熟悉，而且似乎无法使用 pear 让它工作。但我使用的是 CentOS 和 Remi PHP，它们有一个 yum 包。

我运行了yum install php-pecl-apfd，它直接解决了这个问题。我相信在各种风格的 linux 中还有其他软件包，我相信任何对 pear/pecl/general php 扩展有更多了解的人都可以让它在 windows 或 mac 上运行而没有问题。

固定，我的意思是，我的请求对象按预期填充（例如request->all() 和request->files）。

这似乎适用于 PUT 和 PATCH 有和没有文件的请求（使用多部分表单）。

如果您使用的是 Docker，则需要重新启动容器。

【讨论】：