Symfony 6 VichUploader无法更新/删除文件问题解决

执行更新或删除文件操作时，均触发以下错误：

Expected argument of type "string", "null" given at property path "filename".

细节说明：

• 删除操作：实体被正常删除，文件也正确移至回收站，但仍会抛出上述错误；
• 更新操作：无法完成执行，仅显示该错误，且过程中会调用media->setFile()，media->updatedAt字段会被修改，之后才触发错误。

相关代码

实体代码

<?php

namespace My\CoreBundle\Entity;

use Doctrine\DBAL\Types\Types;
use My\CoreBundle\Repository\MediaRepository;
use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Contract\Entity\TimestampableInterface;
use Knp\DoctrineBehaviors\Model\Timestampable\TimestampableTrait;
use Vich\UploaderBundle\Mapping\Annotation as Vich;
use Symfony\Component\HttpFoundation\File\File;

#[ORM\Table(name: 'my_media')]
#[Vich\Uploadable]
#[ORM\Entity(repositoryClass: MediaRepository::class)]
class Media implements TimestampableInterface
{
    use TimestampableTrait;

    #[Vich\UploadableField(mapping: 'media', fileNameProperty: 'filename')]
    private ?File $file = null;

    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column(length: 255,  unique: true)]
    private ?string $name = null;

    #[ORM\Column(type: Types::TEXT)]
    private ?string $caption = null;

    #[ORM\Column(length: 255, unique: true)]
    private ?string $filename = null;

    // ##################### Custom methods #####################
    public function __toString()
    {
        return $this->name;
    }

    public function getUrl(): ?string
    {
        return sprintf('/uploads/images/%s', $this->filename);
    }

    public function setFile(?File $file = null): void
    {
        $this->file = $file;
        
        if (null !== $file) {
            // It is required that at least one field changes if you are using doctrine
            // otherwise the event listeners won't be called and the file is lost
            $this->updatedAt = new \DateTimeImmutable();
        }
    }

    public function getFile(): ?File
    {
        return $this->file;
    }

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

    public function getName(): ?string
    {
        return $this->name;
    }

    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    public function getCaption(): ?string
    {
        return $this->caption;
    }

    public function setCaption(string $caption): self
    {
        $this->caption = $caption;

        return $this;
    }

    public function getFilename(): ?string
    {
        return $this->filename;
    }

    public function setFilename(string $filename): self
    {
        $this->filename = $filename;

        return $this;
    }
}

Admin控制器代码

// [...]
final class MediaAdmin extends AbstractAdmin
{

    protected function configureFormFields(FormMapper $formMapper): void
    {
        $formMapper
            ->add('name')
            ->add('caption')
            ->add('file', VichImageType::class, ['required' => false])
            ->end();
    }
// [...]
}

Vich配置

vich_uploader:
    db_driver: orm
    storage: flysystem

    mappings:
       media:
           uri_prefix: /uploads/images
           upload_destination: default.storage
           namer: Vich\UploaderBundle\Naming\SmartUniqueNamer

解决方案 #

使用VichUploader时，需对filename属性做两处修改：

1. 在ORM注解中添加nullable: true，允许数据库字段为null；
2. 修改setFilename方法的参数类型，允许传入null（添加?）。

警告：两处修改必须同时完成，否则仍会触发非空错误！

修正后的实体代码（关键部分）

<?php

namespace My\CoreBundle\Entity;

// […]

#[ORM\Table(name: 'my_media')]
#[Vich\Uploadable]
#[ORM\Entity(repositoryClass: MediaRepository::class)]
class Media implements TimestampableInterface
{
    use TimestampableTrait;

    #[Vich\UploadableField(mapping: 'media', fileNameProperty: 'filename')]
    private ?File $file = null;

    //[…]

    #[ORM\Column(length: 255, nullable: true)]
    private ?string $filename = null;

    //[…]

    public function setFilename(?string $filename): self // <<<<<<<< 重要：添加'?'允许参数为null
    {
        $this->filename = $filename;

        return $this;
    }
}

内容的提问来源于stack exchange，提问作者mysterty