时间戳

首页 > 解决方案 > 如果实体已存在，则返回案例中的实体 - API 平台

error-handling - 如果实体已存在，则返回案例中的实体 - API 平台

问题描述

我有实体Tag，它具有独特的属性tagValue。当我POST使用已经存在时，tagValue我想得到它的回应。

config/validator/tag.yaml：

App\Entity\Tag:
  constraints:
    - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: tagValue
  properties:
    tagValue:
      - NotBlank: ~

src/Entity/Tag.php：

<?php

namespace App\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use DateTimeInterface;
use DateTime;
use Exception;

/**
 * @ORM\Table(name="tag")
 * @ORM\Entity(repositoryClass="App\Repository\TagRepository")
 * @ORM\HasLifecycleCallbacks
 */
class Tag
{
    /**
     * @var int
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @var string
     * @ORM\Column(type="string", length=255)
     */
    private $tagValue;

    // ...
}

当我做一个POST：

curl --request POST \
  --url http://127.0.0.1:8888/api/tags \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-auth-token: xxxxxxxxxxxxxxxx' \
  --data '{
    "tagValue": "test"
}'

我得到了刚刚创建的实体和代码 201 的响应。一切都很好，但是如果我再次发出此请求，如预期的那样，我将收到带有响应正文的响应代码 400：

{
  "type": "https:\/\/tools.ietf.org\/html\/rfc2616#section-10",
  "title": "An error occurred",
  "detail": "tagValue: This value is already used.",
  "violations": [
    {
      "propertyPath": "tagValue",
      "message": "This value is already used."
    }
  ]
}

但我希望存在实体包含在该响应中。

任何想法如何在不违反 REST 规则的情况下做到这一点？

(Symfony 4.2.5, api-platform/api-pack 1.2.0)

标签： error-handlingapi-platform.com

解决方案

最后我在 GitHub 上从maks-rafalko得到了一个答案（我真的很感谢他），如果有人会坚持同样的问题，这是他的解决方案：

你很幸运，我们刚刚在我们的应用程序中实现了它。API-Platform 中没有针对此功能的内置功能，我们必须重写一些类才能添加它。

首先，当 Unique 约束被 vailoated 时，我们的响应是这样的：

{
  "type": "https://tools.ietf.org/html/rfc2616#section-10",
  "title": "An error occurred",
  "detail": "number: This Usage Reference already exists with the same number and channel.",
  "violations": [
    {
      "propertyPath": "number",
      "message": "This Usage Reference already exists with the same number and channel."
    }
  ],
  "existingUniqueEntities": [
    {
      "uniquePropertyPaths": [
        "number",
        "channel"
      ],
      "entity": {
        "id": 1101,
        "number": "23423423435",
        "channel": "/api/channels/1",
        "createdAt": "2019-07-17T07:25:50.721Z"
      }
    }
  ]
}

请注意，您可能有许多独特的违规行为，并且这种模式可以返回许多已经存在并与提供的请求冲突的实体（例如，实体可以有 2 对唯一键，一个通过电子邮件，另一个通过引用)

此外，我们的实现使用的正是那些将通过执​​行 GET /resource 使用的序列化组，其中 resource 是您尝试创建的资源。我们从 api-platform 元数据中获取这些序列化组

所以这里是代码：

<?php

declare(strict_types=1);

namespace App\Serializer;

use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationListInterface;

/**
 * This class completely overrides `ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer` class
 * since it's final
 *
 * Goal of overriding is to add `existingUniqueEntities` key when ViolationList contains unique entity violations
 *
 * @see \ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer
 */
class ConstraintViolationListNormalizer extends AbstractConstraintViolationListNormalizer implements NormalizerAwareInterface
{
    public const FORMAT = 'jsonproblem';
    public const TYPE = 'type';
    public const TITLE = 'title';

    /**
     * @var array<string, string>
     */
    private $defaultContext = [
        self::TYPE => 'https://tools.ietf.org/html/rfc2616#section-10',
        self::TITLE => 'An error occurred',
    ];

    /**
     * @var ResourceMetadataFactoryInterface
     */
    private $resourceMetadataFactory;

    /**
     * @var SerializerInterface
     */
    private $serializer;

    /**
     * @var NormalizerInterface
     */
    private $normalizer;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null, array $defaultContext = [])
    {
        parent::__construct($serializePayloadFields, $nameConverter);

        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
    }

    public function setNormalizer(NormalizerInterface $normalizer): void
    {
        $this->normalizer = $normalizer;
    }

    /**
     * @param mixed $object
     * @param string|null $format
     * @param array $context
     *
     * @return array
     */
    public function normalize($object, $format = null, array $context = []): array
    {
        [$messages, $violations] = $this->getMessagesAndViolations($object);

        $response = [
            'type' => $context[self::TYPE] ?? $this->defaultContext[self::TYPE],
            'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
            'detail' => $messages ? implode("\n", $messages) : (string) $object,
            'violations' => $violations,
        ];

        $existingUniqueEntities = $this->getExistingUniqueEntities($object);

        return \count($existingUniqueEntities) > 0 ?
            array_merge($response, ['existingUniqueEntities' => $existingUniqueEntities])
            : $response;
    }

    private function getExistingUniqueEntities(ConstraintViolationListInterface $constraintViolationList): array
    {
        $existingUniqueEntities = [];

        /** @var ConstraintViolation $violation */
        foreach ($constraintViolationList as $violation) {
            $constraint = $violation->getConstraint();

            if (!$constraint instanceof UniqueEntity) {
                continue;
            }

            $rootEntity = \is_object($violation->getRoot()) ? $violation->getRoot() : null;

            if ($rootEntity === null) {
                continue;
            }

            $existingEntityCausedViolation = $violation->getCause()[0];

            $metadata = $this->resourceMetadataFactory->create(\get_class($existingEntityCausedViolation));

            // get normalization groups for `GET /resource` operation, fallback to global resource groups
            $normalizationContext = $metadata->getItemOperationAttribute('get', 'normalization_context', [], true);
            $groups = $normalizationContext['groups'] ?? [];
            $entityNormalizationContext = \count($groups) > 0 ? ['groups' => $groups] : [];

            $existingUniqueEntities[] = [
                'uniquePropertyPaths' => $constraint->fields,
                'entity' => $this->normalizer->normalize($existingEntityCausedViolation, null, $entityNormalizationContext),
            ];
        }

        return $existingUniqueEntities;
    }
}

一切都在 getExistingUniqueEntities 中，但不幸的是，我们不得不完全覆盖 ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer 类，因为它是最终的，我们无法扩展它。

我们设法使用 Compiler Pass 覆盖它：

# src/Kernel.php

class Kernel extends BaseKernel implements CompilerPassInterface
{

private const CONSTRAINT_VIOLATION_LIST_NORMALIZER_PRIORITY = -780;

...

public function process(ContainerBuilder $container)
{
    ...
    $constraintViolationListNormalizerDefinition = new Definition(
        ConstraintViolationListNormalizer::class,
        [
            $container->getDefinition('api_platform.metadata.resource.metadata_factory.cached'),
            $container->getParameter('api_platform.validator.serialize_payload_fields'),
            $container->hasDefinition('api_platform.name_converter') ? $container->getDefinition('api_platform.name_converter') : null,
            [],
        ]
    );
    $constraintViolationListNormalizerDefinition->addTag('serializer.normalizer', ['priority' => self::CONSTRAINT_VIOLATION_LIST_NORMALIZER_PRIORITY]);

    $container->setDefinition('api_platform.problem.normalizer.constraint_violation_list', $constraintViolationListNormalizerDefinition);
}

因此，该解决方案基于 Symfony Validator 并“监听”UniqueEntity vailoations。如果存在此类违规行为，则此规范器会将已存在的实体添加到响应中。

希望能帮助到你！

推荐阅读