基于FosRestBundle的无表单实体更新可复用优化服务实现方案

嘿，我来帮你搞定这个可复用且优化的实体更新服务！基于你现在用FosRestBundle构建API的场景，咱们可以把重复的实体更新逻辑从控制器里抽离出来，做成一个通用服务，这样后续其他实体的更新也能直接复用，还能让控制器保持清爽的单一职责。

咱们先写一个通用的更新服务，核心是利用Symfony的PropertyAccess组件来安全复制属性，同时可以配置跳过某些不需要更新的字段（比如主键id、创建时间createdAt这类），还能集成验证逻辑，避免无效更新。

// src/Service/EntityUpdater.php
namespace App\Service;

use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

class EntityUpdater
{
    private $propertyAccessor;
    private $validator;
    private $entityManager;

    public function __construct(
        PropertyAccess $propertyAccess,
        ValidatorInterface $validator,
        EntityManagerInterface $entityManager
    ) {
        $this->propertyAccessor = $propertyAccess->createPropertyAccessor();
        $this->validator = $validator;
        $this->entityManager = $entityManager;
    }

    /**
     * 更新实体，跳过指定字段
     * @param object $originalEntity 数据库中已存在的实体
     * @param object $updateEntity 从请求体解析来的更新实体
     * @param array $skipFields 不需要更新的字段列表
     * @return object 更新后的实体
     */
    public function update(object $originalEntity, object $updateEntity, array $skipFields = ['id', 'createdAt']): object
    {
        // 获取更新实体的所有公开属性
        $reflectionClass = new \ReflectionClass($updateEntity);
        $properties = $reflectionClass->getProperties(\ReflectionProperty::IS_PUBLIC);

        foreach ($properties as $property) {
            $propertyName = $property->getName();
            // 跳过指定字段，以及值为null的字段（可选，根据你的业务需求调整）
            if (in_array($propertyName, $skipFields) || $this->propertyAccessor->getValue($updateEntity, $propertyName) === null) {
                continue;
            }

            // 安全赋值到原始实体
            $this->propertyAccessor->setValue(
                $originalEntity,
                $propertyName,
                $this->propertyAccessor->getValue($updateEntity, $propertyName)
            );
        }

        // 验证更新后的实体合法性
        $errors = $this->validator->validate($originalEntity);
        if (count($errors) > 0) {
            $errorMessages = [];
            foreach ($errors as $error) {
                $errorMessages[$error->getPropertyPath()] = $error->getMessage();
            }
            throw new BadRequestHttpException(json_encode($errorMessages));
        }

        // 持久化并保存（也可以选择在控制器里统一flush，看你的事务管理需求）
        $this->entityManager->persist($originalEntity);
        $this->entityManager->flush();

        return $originalEntity;
    }
}

现在你的控制器只需要处理请求参数的获取，然后调用这个通用服务就行，代码会简洁很多，完全符合“控制器只做请求响应处理”的原则：

/**
 * @Rest\Put("/enseignes/{enseigne_id}",
 * requirements={"enseigne_id" = "\d+"})
 * @ParamConverter("enseigne", options={"id":"enseigne_id"})
 * @ParamConverter("enseigneUpdate", converter="fos_rest.request_body")
 *
 * @Rest\View()
 */
public function updateEnseigneAction(Enseigne $enseigne, Enseigne $enseigneUpdate, EntityUpdater $entityUpdater)
{
    // 自定义跳过的字段，比如这里额外跳过自动更新的updatedAt字段
    $updatedEnseigne = $entityUpdater->update($enseigne, $enseigneUpdate, ['id', 'createdAt', 'updatedAt']);
    
    return $updatedEnseigne;
}

• 灵活处理空值：上面的服务里跳过了null值的更新，如果你希望允许把字段设为null，可以去掉那个判断，或者做成可配置的参数传入。
• 关联实体更新：如果你的实体有关联关系（比如ManyToOne），可以在服务里添加逻辑，比如通过ID查找关联实体再赋值，或者单独处理关联字段的更新逻辑。
• 服务通用性：这个服务已经是通用的了，只要是Doctrine实体，都可以用它来更新，比如更新User实体时，直接调用$entityUpdater->update($user, $userUpdate)就行。
• 事务管理：如果你的更新操作涉及多个实体，可以在控制器里用EntityManagerInterface的事务包裹，或者在服务里添加事务支持方法。
• 请求体前置验证：可以给enseigneUpdate添加验证注解（比如@Assert\NotBlank()），这样在ParamConverter阶段就会先验证请求体格式，提前拦截无效请求。

这样一来，你的更新逻辑就完全复用了，后续维护和扩展也更方便，控制器代码也更简洁易读。

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