API Platform/Symfony类型验证自定义错误消息不生效问题

问题根源 #

实体属性声明为?int $sender_zipcode，当反序列化时传入字符串值，PHP会在赋值阶段直接抛出TypeError，该错误被API Platform捕获并返回默认的hydra错误，此时Symfony Validator的Assert\Type验证逻辑尚未执行，因此自定义错误消息无法显示。

方法一：使用DTO（推荐） #

通过DTO接收请求数据，先完成验证再转换为实体，避免PHP类型错误提前触发。

1. 创建DTO类

// src/Dto/ShipmentInput.php
namespace App\Dto;

use Symfony\Component\Validator\Constraints as Assert;

class ShipmentInput
{
    #[Assert\NotBlank(message:"Sender zipcode is required.")] 
    #[Assert\Type(type:"int", message:"Sender zipcode is in wrong format.")]
    public mixed $senderZipcode;

    // 添加其他需要接收的属性
}

2. 配置API Resource使用DTO作为输入
   修改实体的ApiResource注解，指定input为DTO类：

#[ApiResource(
    input: \App\Dto\ShipmentInput::class,
    denormalizationContext: ['disable_type_enforcement' => true]
)]
class Shipment
{
    // 实体原有代码...
}

3. 创建数据转换器
   实现API Platform的DataTransformerInterface，将DTO转换为实体：

// src/DataTransformer/ShipmentInputTransformer.php
namespace App\DataTransformer;

use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
use App\Entity\Shipment;
use App\Dto\ShipmentInput;

class ShipmentInputTransformer implements DataTransformerInterface
{
    public function transform($object, string $to, array $context = []): Shipment
    {
        $shipment = new Shipment();
        // 转换并赋值属性，确保类型正确
        if (null !== $object->senderZipcode) {
            $shipment->setSenderZipcode((int)$object->senderZipcode);
        }
        // 处理其他属性...
        
        return $shipment;
    }

    public function supportsTransformation($data, string $to, array $context = []): bool
    {
        return Shipment::class === $to && $data instanceof ShipmentInput;
    }
}

完成以上配置后，请求会先验证DTO的属性，触发自定义错误消息；验证通过后再转换为实体，避免PHP类型错误。

方法二：移除实体属性类型声明（快速临时方案） #

如果不想使用DTO，可以暂时移除实体属性的类型声明，让Validator完成类型验证：

1. 修改实体属性和setter

#[ORM\Column(type: 'integer')]
#[Assert\NotBlank(message:"Sender zipcode is required.")] 
#[Assert\Type(type:"int", message:"Sender zipcode is in wrong format.")]   
private $sender_zipcode = null;

public function setSenderZipcode($sender_zipcode): self
{
    $this->sender_zipcode = $sender_zipcode;
    return $this;
}

2. 确保ORM字段类型正确
   #[ORM\Column(type: 'integer')]明确指定数据库字段类型为整数，ORM会自动处理类型转换，确保存入数据库的是整数。

这种方法的缺点是失去了PHP属性类型提示的静态检查能力，适合简单场景快速验证。

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