Symfony / Doctrine：关于存储库注入的 Restful API 设计和设计模式

Question

我是 Symfony 的新手，这些问题是在最近的学习过程中提出的。

以商店为例，我将创建两个实体，Product 和 Category，它们具有双向多对一关系。

class Product
{
    private $id;
    private $name;
    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\Category", inversedBy="products")
     * @ORM\JoinColumn(name="category_id", referencedColumnName="id", nullable=false)
     */
    private $category;
}

class Category
{
    private $id;
    private $name;
    /**
     * @ORM\OneToMany(targetEntity="App\Entity\Product", mappedBy="category")
     */
    private $products;
}

所以我的第一个问题是：

如果我想获取特定类别中的所有产品，URL应该是

/categories?categoryId=1&limit=20&orderBy=name （我知道这有点傻，但是 Category 记录应该包含所有 Product 信息吗？）

或

/products?categoryId=1&limit=20&orderBy=name

对于后一个问题，这里是第二个问题：

我将 ProductRepository 注入到 ProductController

class ProductController extends Controller
{
    private $productRepository;

    public function __construct(ProductRepository $productRepository)
    {
        $this->productRepository = $productRepository;
    }

    ...
}

为了获取一个类别中的所有产品，我写了一个这样的方法：

public function findByCategory(Category $category): array
{
    return $this->createQueryBuilder('p')
        ->andWhere('p.category = :category')
        ->setParameter('category', $category)
        ->orderBy('p.name', 'ASC')
        ->setMaxResults(20)
        ->getQuery()
        ->getResult()
    ;
}

那么，在 ProductController 中，我应该如何从 URL 中的查询字符串 'categoryId' 中获取 Category 对象？我应该也注入 CategoryRepository 还是应该简单地注入一个实体管理器对象？

Answer 1

Marco Pivetta aka Ocramius（Doctrine 的主要开发者之一）说：

避免双向关联

双向关联是开销

只编写您的域逻辑工作所需的代码

破解复杂的 DQL 查询，而不是通过双向性使它们变得更简单

所以也许 you don't need bi-directional association这里。

对于您的第一个问题，我认为第二个解决方案更好：

/products?categoryId=1&limit=20&orderBy=name

对于你的第二个问题，是的，如果你想访问 Category 对象，你应该注入 CategoryRepository，即使可能，也要避免访问控制器中的整个 entityManager。

您应该在控制器中注入 服务。您的服务应该公开公共方法以通过data mappers 对数据库执行自定义 CRUD 访问。请注意，repository 不是数据映射器，而是它

在域和数据映射层之间进行调解，就像内存中的域对象集合一样。

EAA 目录的 P - Martin Fowler

Repositories are services 实际上可以将它们注入控制器。

有些人认为存储库不应包含 CREATE、UPDATE 或 DELETE，而应仅包含 READ。他们说这些操作使集合（可通过存储库访问）不一致。

这篇文章也可以提供帮助：How should a model be structured in MVC?

Answer 2

对我来说，这里的问题是 ORM 在 Symfony 中的作用与数据库设计、建模和查询之间非常明显的混淆。

在数据库中（使用 PhpMyAdmin），您会注意到 product 表中有一个名为 category（或 category_id）的列。保持简单，要获得属于某个类别的产品，您只需要 category_id 即可。将这些知识带到 Symfony，您不需要类别对象，请使用您从请求中获得的类别 ID。此外，只需在控制器中使用 EntityManager，不要使事情复杂化，尤其是因为您似乎才刚刚开始。

use Symfony\Component\HttpFoundation\Request;

class ProductController extends Controller
{
    public function get_product_from_categoryAction(Request $request)
    {
        $category_id = (int) $request->get('category');
        $limit = (int) $request->get('limit');
        $orderBy = strip_tags($request->get('orderBy'));

        $em = $this->getDoctrine()->getManager();
        $products = $em
            ->getRepository('AppBundle:Products')
            ->queryProductsByCategoryId($category_id, $limit, $orderBy);

    }

    ...
}

还有回购

public function queryProductsByCategoryId(int $category_id, int $limit = 10, string $orderBy = 'name')
{
    return $this->createQueryBuilder('p')
        ->andWhere('p.category = :category')
        ->setParameter('category', $category_id)
        ->orderBy('p.name', 'ASC')
        ->setMaxResults($limit)
        ->getQuery()
        ->getResult()
    ;
}

保持简单，然后当你需要更高级时，如果你愿意，可以尝试更花哨的东西。