So filtern/bereinigen/validieren Sie Anforderungsparameter in Rest-API-Vorgängen für Symfony 5.4

Question

Ich bin relativ neu bei Symfony 5.4 und habe kürzlich meine erste API mit dieser Version erstellt

Für meinen spezifischen API-Endpunkt ist einer der Parameter ein Array von IDs.

Ich muss das Array validieren über:

• Stellen Sie sicher, dass es sich um ein Array handelt;
• Stellen Sie sicher, dass sich die IDs im Array tatsächlich auf Datenbankeinträge beziehen;

Ich habe es auf einfache Weise implementiert, indem ich das Array überprüft habe, bevor ich die Entität mithilfe von Typumwandlung und vorhandenem Repository beibehalten habe:

$parentPropertyIds = (array)$request->request->get('parent_property_ids');
if ($parentPropertyIds) {
   $parentCount = $doctrine->getRepository(Property::class)->countByIds($parentPropertyIds);

   if ($parentCount !== count($parentPropertyIds)) {
       return $this->json([
            'status'  => 'error',
            'message' => 'parent_property_id_invalid'
       ], 422);
   }

   foreach ($parentPropertyIds as $parentPropertyId) {
      $parentProperty = $doctrine->getRepository(Property::class)->find($parentPropertyId);
      $property->addParent($parentProperty);
   }
}

Allerdings ist meine Controller-Aktion dadurch zu „körperpositiv“ und fühlt sich an wie etwas, das eleganter umgesetzt werden könnte.

Ich kann in der Symfony 5.4-Dokumentation nichts finden.

Derzeit möchte ich wissen, ob:

• Es gibt eine Möglichkeit, Anforderungsparameter in Symfony zu filtern/zu bereinigen;
• Es gibt eine elegante integrierte Möglichkeit, benutzerdefinierte Validator-Einschränkungen auf Anforderungsparameter anzuwenden (ähnlich der gut dokumentierten Entitätsfeldvalidierung).

Vollständiger Endpunktcode:

/**
     * @Route("/property", name="property_new", methods={"POST"})
     */
    public function create(ManagerRegistry $doctrine, Request $request, ValidatorInterface $validator): Response
    {
        $entityManager = $doctrine->getManager();

        $property = new Property();
        $property->setName($request->request->get('name'));
        $property->setCanBeShared((bool)$request->request->get('can_be_shared'));

        $parentPropertyIds = (array)$request->request->get('parent_property_ids');
        if ($parentPropertyIds) {
            $parentCount = $doctrine
                ->getRepository(Property::class)
                ->countByIds($parentPropertyIds);

            if ($parentCount !== count($parentPropertyIds)) {
                return $this->json([
                    'status'  => 'error',
                    'message' => 'parent_property_id_invalid'
                ], 422);
            }

            foreach ($parentPropertyIds as $parentPropertyId) {
                $parentProperty = $doctrine->getRepository(Property::class)->find($parentPropertyId);
                $property->addParent($parentProperty);
            }
        }

        $errors = $validator->validate($property);

        if (count($errors) > 0) {
            $messages = [];
            foreach ($errors as $violation) {
                $messages[$violation->getPropertyPath()][] = $violation->getMessage();
            }
            return $this->json([
                'status'   => 'error',
                'messages' => $messages
            ], 422);
        }

        $entityManager->persist($property);
        $entityManager->flush();

        return $this->json([
            'status' => 'ok',
            'id'     => $property->getId()
        ]);
    }

Answer 1

您可以将数据传输对象 (DTO) 与 验证服务。有许多预定义约束，或者您可以创建一个自定义约束。

例如，如何使用简单约束作为注释：

class PropertyDTO {
  /**
   * @Assert\NotBlank
   */
  public string $name = "";
  public bool $shared = false;
}

然后将数据分配给DTO：

$propertyData = new PropertyDTO();
$propertyData->name = $request->request->get('name');
...

在某些情况下，最好在 DTO 中定义构造函数，然后从 请求并立即传递给DTO：

$data = $request->getContent(); // or $request->getArray(); depends on your content type
$propertyData = new PropertyDTO($data);

然后验证它：

$errors = $validator->validate($propertyData);

if (count($errors) > 0) {
    /*
     * Uses a __toString method on the $errors variable which is a
     * ConstraintViolationList object. This gives us a nice string
     * for debugging.
     */
    $errorsString = (string) $errors;

    return $this->json([
                'status'  => 'error',
                'message' => 'parent_property_id_invalid'
            ], 422);
}

//...