FosRestBundle PATCH操作阻止具有null / default值的更新实体

时间:2016-03-31 14:03:29

标签: php symfony fosrestbundle

我已在我的patchAction上使用了serverController来更新现有服务器中的一个或多个字段。

其实我的patchAction看起来像这样

/*
 * @ParamConverter("updatedServer", converter="fos_rest.request_body")
 *
 * @return View
 */
public function patchAction(Server $server, Server $updatedServer, ConstraintViolationListInterface $validationErrors)
{
    if ($validationErrors->count() > 0) {
        return $this->handleBodyValidationErrorsView($validationErrors);
    }

    $server->setAlias($updatedServer->getAlias())
        ->setMac($updatedServer->getMac())
        ->setSshUser($updatedServer->getSshUser())
        ->setSshPort($updatedServer->getSshPort())
        ->setIpmiAddress($updatedServer->getIpmiAddress())
        ->setIpmiLogin($updatedServer->getIpmiLogin())
        ->setIpmiPassword($updatedServer->getIpmiPassword())
        ->setMysqlHost($updatedServer->getMysqlHost())
        ->setMysqlRoot($updatedServer->getMysqlRoot())
        ->setWebServer($updatedServer->getWebServer())
        ->setWebServerSslListen($updatedServer->getWebServerSslListen())
        ->setWebServerSslPort($updatedServer->getWebServerSslPort())
        ->setMysqlServer($updatedServer->getMysqlServer())
        ->setSuphp($updatedServer->getSuphp())
        ->setFastcgi($updatedServer->getFastcgi())
        ->setNadminCompliant($updatedServer->getNadminCompliant())
        ->setEmailCompliant($updatedServer->getEmailCompliant())
        ->setAvailable($updatedServer->getAvailable())
        ->setEnvironment($updatedServer->getEnvironment())
        ->setInstalledAt($updatedServer->getInstalledAt());

    if (null !== $updatedServer->getOs()) {
        $os = $this->getDoctrine()->getRepository('AppBundle:Os')->findBy(['id' => $updatedServer->getOs()->getId()]);
        $server->setOs($os[0]);
    }

    if (null !== $updatedServer->getPuppetClasses()) {
        $puppetClass = $this->getDoctrine()->getRepository('AppBundle:PuppetClass')->findBy(['id' => $updatedServer->getPuppetClasses()[0]->getId()]);
        $server->setPuppetClasses($puppetClass);
    }

    if (null !== $updatedServer->getPuppetTemplates()) {
        $puppetTemplate = $this->getDoctrine()->getRepository('AppBundle:PuppetTemplate')->findBy(['id' => $updatedServer->getPuppetTemplates()[0]->getId()]);
        $server->setPuppetTemplates($puppetTemplate);
    }

    if (null !== $updatedServer->getBackupModel()) {
        $backupModel = $this->getDoctrine()->getRepository('AppBundle:BackupModel')->findBy(['id' => $updatedServer->getBackupModel()->getId()]);
        $server->setBackupModel($backupModel[0]);
    }

    $em = $this->getDoctrine()->getManager();

    $em->persist($server);
    $em->flush();

    return $this->view([$updatedServer, $server]);
}

问题在于尝试仅更新一个或几个字段时。我设置了一个JSON主体来改变数据。

{
    "mac": "ff:ff:ff:ff:ff:ff"
}

发送请求后,JSON正文将如下所示

// This is what $updatedServer get in my controller
{
    "id": null,
    "name": null,
    "alias": null,
    "notes": null,
    "hosted_domain": null,
    "mac": "ff:ff:ff:ff:ff:ff",
    // ...
}

正如您在我的控制器中看到的那样,我设置了每个可更新字段

$server->setAlias($updatedServer->getAlias())
    ->setMac($updatedServer->getMac())
    ->setSshUser($updatedServer->getSshUser())
    // ...

因此,如果正文请求中的值为null,则控制器会将其设置为null,它将对实体内部设置的默认值执行相同操作

我有想法为每个可更新字段设置一个if条件,但我内部会有> 20 条件...

如何使用通用且可重复使用的系统阻止它附加?

如果在执行请求之前未设置这些值,是否可以忽略这些值?

也许在我的实体类中创建callback

由于

修改

我的Server $server是我想要更新的当前服务器对象。它随着请求而来。我发送此请求/api/servers/2时的例子我得到ID为2的服务器正文。

Server $updatedServer是具有更新数据的正文。

我尝试了第二次修改,但得到了500 error

  

“无法猜测如何从请求信息中获取Doctrine实例。”

因为我无法在同一时间内获取要修补的服务器和正文(使用ParamConverter)。

2 个答案:

答案 0 :(得分:1)

您可以使用PATCH方法阻止这种情况,因为the specification解释它(正确的方法)。

顾名思义,PATCH方法用于发送更新现有资源的补丁。

要正确使用它,您需要发送资源的全新状态 换句话说,您必须发送资源的所有属性,包括未更改的属性。

因此,如果您使用相应的值发送每个属性,则会正确应用您的补丁。

示例:

{
    "id": 1, # Identifier, never change
    "name": [oldValue],
    "alias": [oldValue],
    "notes": [oldValue],
    "hosted_domain": [oldValue],
    "mac": "ff:ff:ff:ff:ff:ff",
    // ...    
}

就像这样,不需要为每个属性写一个支票。

威廉·杜兰德(William Durand)提到Don't PATCH like an idiot这个常见的错误用法很好。

修改

我错了。

您无需完全更新资源即可正确使用PATCH。 您需要发送一组更改,如给定链接中所述。

我能给你的更好的建议是使用ParamConverter来检索你的标识符,并根据你提供的字段为你做更新。

<强> EDIT2

我的意思是:

/*
 * @ParamConverter("server", converter="fos_rest.request_body")
 *
 * @return View
 */
public function patchAction(Server $server, ConstraintViolationListInterface $validationErrors)
{
    if ($validationErrors->count() > 0) {
        return $this->handleBodyValidationErrorsView($validationErrors);
    }

    $em = $this->getDoctrine()->getManager();

    $em->persist($server);
    $em->flush();

    // ...
}

否则,您需要一个Assembler对象作为合并的中间步骤 请参阅handling PATCH requests through FOSRest的这个很好的例子。

答案 1 :(得分:0)

我刚刚找到了这个问题的答案

在您的实体中使用设置参数函数,该函数将更新您将在请求正文中提供的字段

App \ Entity \ Server

b

App \ Controller \ ServerApiController

binary_search()

它应该返回服务器的内容+请求主体的字段更新,这将在$ server-> setParameter($ data)

中更改