ApiPlatform 3 Symfony 6自定义Property Filter：参数格式调整求助

有两种可行方案解决这个问题，推荐优先选择自定义Filter的方式，更贴合ApiPlatform的架构设计：

方案一：自定义PropertyFilter（推荐） #

直接继承官方的PropertyFilter，重写获取参数的逻辑，将逗号分隔的字符串转换为数组：

1. 创建自定义Filter类

<?php

namespace App\Filter;

use ApiPlatform\Core\Serializer\Filter\PropertyFilter;
use Symfony\Component\HttpFoundation\Request;

class CommaSeparatedPropertyFilter extends PropertyFilter
{
    protected function getProperties(Request $request): ?array
    {
        $propertiesParam = $request->query->get('properties');
        
        // 处理逗号分隔的字符串格式
        if (is_string($propertiesParam)) {
            // 拆分后过滤空值，避免无效字段
            return array_filter(explode(',', $propertiesParam));
        }
        
        // 兼容原有的数组格式（可选保留）
        return parent::getProperties($request);
    }
}

2. 替换实体上的Filter配置
   在实体注解或资源配置中，将默认的PropertyFilter替换为自定义的类：

use App\Filter\CommaSeparatedPropertyFilter;
use ApiPlatform\Core\Annotation\ApiFilter;
use ApiPlatform\Core\Annotation\ApiResource;

/**
 * @ApiResource()
 * @ApiFilter(CommaSeparatedPropertyFilter::class)
 */
class YourEntity
{
    // 实体字段定义
}

如果用YAML配置：

api_platform:
    resources:
        App\Entity\YourEntity:
            filters:
                - App\Filter\CommaSeparatedPropertyFilter

方案二：事件监听器修改请求参数 #

如果不想重写Filter，可以通过高优先级的kernel.request事件监听器，在Filter处理前将逗号分隔的参数转换为数组格式：

1. 创建事件监听器

<?php

namespace App\EventListener;

use Symfony\Component\HttpKernel\Event\RequestEvent;

class PropertyParamConverterListener
{
    public function __invoke(RequestEvent $event): void
    {
        // 只处理主请求
        if (!$event->isMainRequest()) {
            return;
        }

        $request = $event->getRequest();
        $properties = $request->query->get('properties');

        // 将逗号分隔字符串转为数组，覆盖原参数
        if (is_string($properties) && trim($properties) !== '') {
            $request->query->set('properties', explode(',', trim($properties)));
        }
    }
}

2. 注册监听器并设置高优先级
   在services.yaml中配置监听器，确保优先级高于ApiPlatform的ReadListener（默认优先级0）：

services:
    App\EventListener\PropertyParamConverterListener:
        tags:
            - { name: kernel.event_listener, event: kernel.request, priority: 100 }

为什么之前的监听器无效？ #

你之前使用的pre-read优先级（默认-100）低于ApiPlatform的ReadListener（优先级0），导致监听器执行时Filter已经完成了参数解析，所以修改不会生效。设置更高的优先级（比如100）就能确保在Filter处理前修改请求参数。

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