从请求中填充实体的更好方法是什么?

时间:2012-12-27 19:57:25

标签: php doctrine-orm symfony-2.1

我正在使用Symfony 2.1应用程序,我通过POST请求发送了很多参数,我正在寻找一种更智能的方法来获取每个请求参数并填充我的实体类。我希望避免为$entity->setMyParam($my_param)请求参数编写n个表达式。例如,这是我的实体的片段:

namespace Brea\ApiBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * Brea\ApiBundle\Entity\Distributions
 *
 * @ORM\Table(name="distributions")
 * @ORM\Entity
 */
class Distributions
{
  /**
   * @var string $recordType
   *
   * @ORM\Column(name="record_type", type="string", nullable=false)
   * @Assert\NotBlank()
   * @Assert\Choice(choices = {"a", "b", "c", "d", "e"}, message = "Choose a valid record type")
   */
  private $recordType;

  /**
   * Set recordType
   *
   * @param string $recordType
   */
  public function setRecordType($recordType)
  {
    $this->recordType = $recordType;
  }

  /**
   * Get recordType
   *
   * @return string 
   */
  public function getRecordType()
  {
    return $this->recordType;
  }
}

我的控制器尝试接受每个请求,查看参数并将请求参数的值设置为实体:

public function createRecordAction(Request $request, $id)
{
  $distribution = new Distributions();
  $params = $request->request;

  foreach ($request->request->all() as $param=>$value)
  {
    if ($param == "_method")
      continue;

    $function = "set".str_replace(' ','',ucwords(preg_replace('/[^A-Z^a-z^0-9]+/',' ',$param)));
    $distribution->$function($value);
  }
}

它有效,但我对这种方法的不满是我需要在每个执行类似操作的控制器中运行此代码。我可以将它重构为父类,作为避免重复代码的方法,但我很好奇这是否是一个好习惯。我在Symfony框架中寻找了一些已经完成此任务的东西,但我能找到的只是将请求绑定到表单的示例。

2 个答案:

答案 0 :(得分:1)

首先:警告!!

正如我之前评论的那样,我会非常小心地使用原始帖子中提供的代码,因为你说的是​​来自POST请求的数据,这意味着客户端可以在其中注入任何类型的数据并调用您可能不希望在对象上使用的函数(或者只是通过向您发送不存在的函数名来导致脚本失败)。

我实际上会先阅读结论..! :)然后回到Alt。 1& 2。


备选方案1:

话虽如此,对您的问题的另一种解决方案是让对象负责获取自己的数据。使用粒度足够的对象,您不应该得到膨胀的代码,并且您可以在每个类中定义要查找的参数和要调用的函数(以及在对类进行更改时本地化更改):

class BookInformation{
  private $publisher;
  private $name;
  private $price;

  public static createFromRequest($req){
    $publisher = Publisher::createFromRequest($req);
    $book = new BookInformation($publisher, $req['book_name'], $req['book_price']);
    $book->setABC($req['abc']);
    //...
    return $book;
  }

  public __construct($publisher, $name, $price){
    //...
  }
}

class Publisher{
  private $name;
  private $address;

  public static createFromRequest($req){
    return new Publisher($req['publisher_name'], $req['publisher_address']);
  }

  public __construct($name, $address){
    //...
  }
}

就像我之前说过的,这个方法的一个很大的优点是,如果你需要为这些类中的任何一个添加新属性,你根本不必编辑控制器,只需编辑你的“从请求方法初始化” ”。 未来的更改将本地化为修改后的类。

当然,不要忘记验证从用户请求发送的任何数据(但这只是常识)。


备选方案2:

请注意,第一个替代方法与Factory pattern非常相似(基于GoF的抽象工厂),您还可以使用该模式实现解决方案:

class BookFactory{
  public createBookInformation($req){
    $publisher = $this->createPublisher($req);
    $book = new BookInformation($publisher, $req['book_name'], $req['book_price']);
    $book->setABC($req['abc']);
    //...
    return $book;
  }

  public createPublisher($req){
    return new Publisher($req['publisher_name'], $req['publisher_address']);
  }

  //createAnythingRelatedToBooks($req)...
}

这样,你就拥有了一个非常有凝聚力的类中的所有初始化过程,只有责任是根据请求对象初始化某个对象系列(这是一件非常好的事情)。但是,如果将属性添加到其中一个类,则还必须编辑相应的Factory方法。


<强>结论

请注意,这两种选择实际上并不是替代品......它们可以与您的初始代码一起使用(尤其是工厂代码)。它们实际上只解决了你的最后一个问题(“放置代码的地方”问题)。

但是,即使您确实对POST请求进行了清理并仅调用了已注释的函数(如前所述),我也不会建议它,因为我觉得更复杂的业务规则会破坏设计得相当快(但也许你已经把它全部覆盖了(?))。也就是说,我不认为你可以在初始化过程中轻松插入业务规则,因为它是全自动的(它不能对值进行任何验证,因为它可能是任何类型的值)并且我觉得你是在初始化之后结束“撤消”的东西(我个人讨厌......有很多错误的空间)!

例如,在备选方案1 BookInformationPublisher)中使用相同的两个类。

假设Book Publisher只有Publisher已经在数据库中注册并且其地址已经确认(新发布者需要使用其他界面创建)然后在将它们链接到一本书之前确认其地址。

否则,无论请求数据如何,publisher都应设置为XYZ。我有感觉(我可能错了),为了支持这些规则,你必须实际构建对象(自动)然后销毁/重新分配publisher属性它与某些规则不符。现在,如果内存中有这些Publisher个对象的池,您还需要记住删除该池中错误创建的Publisher。这只是一条规则!

你可以用你的代码“解决”这个问题的一件事就是为每个setter设置一个验证方法(validXYZ()),但是这开始看起来像一个设计,如果验证很快就会崩溃依赖于其他对象/数据...

我真的没有其他任何东西可以阻止你使用该代码,但是如果你这样做,请在一两年后让我们了解它的运作方式(一旦添加了一些维护/新功能,等...)。

答案 1 :(得分:1)

  

我在Symfony框架中寻找了一些已经做到这一点的东西,但我能找到的只是将请求绑定到表单的示例。

我会使用Form来做到这一点。即使没有从HTMl表单执行HTTP请求,您也可以将Request绑定到表单实例:它将处理所有数据注入和验证。

而且,如果你需要HTML表单,你可以准备好^^。