FosRestBundle PATCH操作阻止使用null/默认值更新实体


FosRestBundle PATCH action prevent update entity with null/default values

我在serverController上创建了一个可工作的patchAction,以更新现有服务器中的一个或多个字段。

事实上,我的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

"无法猜测如何从请求信息中获取条令实例。"

因为我无法同时获得我想要修补的服务器和主体(使用ParamConverter)。

您可以使用规范中解释的PATCH方法(正确的方法)来防止这种情况的发生。

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

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

因此,如果您发送每个属性及其相应的值,您的补丁将被正确应用。

示例:

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

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

这个常见的坏用法有一个很好的参考,那就是威廉·杜兰德的《不要像白痴一样打补丁》。

编辑

我错了。

您不需要完全更新资源即可正确使用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对象作为合并的中间步骤
请参阅这个通过FOSRest处理PATCH请求的好例子。

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

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

应用程序''实体''服务器

use Doctrine'Common'Inflector'Inflector;
public class Server {
    public function setParameters($params) {
        foreach ($params as $k => $p) {
            if (!is_null($p)) { // here is the if statement
                $key = Inflector::camelize($k);
                if (property_exists($this, $key)) {
                    $this->{'set' . ucfirst($key)}($p);
                }
            }
        }
        return $this;
    }
}

App''Controller''ServerApiController

public function patchAction(Server $server, Request $request, ConstraintViolationListInterface $validationErrors)
{
    if ($validationErrors->count() > 0) {
        return $this->handleBodyValidationErrorsView($validationErrors);
    }
    $data = json_decode($request->getContent());
    $em->persist($server->setParameters($data););
    $em->flush();
    return $this->view([$server]);
}

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