VichUploaderBundle中多映射实体文件删除问题的解决方案

问题背景

在使用VichUploaderBundle处理文件上传时，开发者可能会遇到一个常见场景：同一个实体类需要根据不同的关联关系将文件存储到不同的位置。例如，一个Photo实体可能关联到Signalement或DemandeIntervention两种不同的实体，每种关联需要将上传的文件存储到不同的目录结构中。

典型实现方案

开发者通常会采用以下方式实现：

class Photo
{
    #[Vich\UploadableField(mapping: 'signalement_photo', fileNameProperty: 'file')]
    private ?File $uploadFileSignalement = null;

    #[Vich\UploadableField(mapping: 'intervention_photo', fileNameProperty: 'file')]
    private ?File $uploadFileDemandeIntervention = null;
    
    // 其他属性和关联关系...
}

对应的配置可能如下：

vich_uploader:
    mappings:
        signalement_photo:
            directory_namer:
                service: vich_uploader.namer_directory_property
                options: { property: 'signalement.id' }
        intervention_photo:
            directory_namer:
                service: vich_uploader.namer_directory_property
                options: { property: 'demandeIntervention.id' }

遇到的问题

当尝试删除一个只关联了DemandeIntervention的Photo实体时，系统会抛出异常：

PropertyAccessor requires a graph of objects or arrays to operate on, but it found type "NULL" while trying to traverse path "signalement.id" at property "id".

这是因为VichUploaderBundle在删除文件时，会尝试检查所有映射配置，即使某些映射实际上并未使用。当它尝试访问不存在的关联实体属性时，就会抛出上述异常。

解决方案

自定义目录命名器

最优雅的解决方案是创建一个自定义的目录命名器，该命名器能够智能地处理可能为null的关联关系：

use Vich\UploaderBundle\Mapping\PropertyMapping;
use Vich\UploaderBundle\Naming\DirectoryNamerInterface;

class ConditionalDirectoryNamer implements DirectoryNamerInterface
{
    public function directoryName($object, PropertyMapping $mapping): string
    {
        $mappingName = $mapping->getMappingName();
        
        if ($mappingName === 'signalement_photo') {
            return $object->getSignalement() ? (string)$object->getSignalement()->getId() : '';
        }
        
        if ($mappingName === 'intervention_photo') {
            return $object->getDemandeIntervention() ? (string)$object->getDemandeIntervention()->getId() : '';
        }
        
        return '';
    }
}

配置调整

然后更新配置文件，使用这个自定义命名器：

vich_uploader:
    mappings:
        signalement_photo:
            directory_namer:
                service: App\Naming\ConditionalDirectoryNamer
        intervention_photo:
            directory_namer:
                service: App\Naming\ConditionalDirectoryNamer

实现原理

这个解决方案的核心在于：

1. 自定义命名器会根据当前映射名称决定检查哪个关联关系
2. 只有当关联实体存在时才会尝试访问其ID属性
3. 对于不存在的关联关系，返回空字符串作为目录名

这样，当VichUploaderBundle尝试删除文件时，即使检查未使用的映射配置，也不会因为访问null对象的属性而抛出异常。

最佳实践建议

1. 分离实体考虑：如果业务允许，考虑将不同用途的照片分为不同的实体类，这样可以避免复杂的条件逻辑。

2. 单一职责原则：评估是否真的需要在一个实体中处理多种上传场景，有时分离功能会更清晰。

3. 空值处理：在所有自定义命名器中都应该加入适当的空值检查，提高代码健壮性。

4. 测试覆盖：确保为自定义命名器编写全面的测试用例，覆盖所有可能的关联关系组合。

通过这种解决方案，开发者可以灵活地处理多映射场景下的文件上传和删除操作，同时保持代码的健壮性和可维护性。