使用原则 2 将实体保存到 REST API 而不是数据库

2022-08-30 16:43:00

这与我的另一个问题有关:使用 REST API 持久化实体

对于Symfony2中的项目,我需要能够使用远程(第三方)RESTful API来持久化实体。我还希望能够从该 API 中检索包含数据的实体。

换句话说,我的对象保存在第三方数据库中它们不会保存在我自己的数据库中。每当我需要保存数据或查找数据时,我都会使用他们的 REST API。

有人指给我看好几个图书馆,包括一个由教义本身建立的图书馆。但是,它们都没有为我提供我想要的东西。Doctrine制作的那个是最好的选择,但使用Active Record模式,并没有提供所有甜蜜的Torism 2的东西。不要误会我的意思,我已经使用Active Record实现很长时间了,但我现在已经爱上了 Doctrine 的数据映射器模式。

理想情况下,我希望能够使用 Doctrine 的 ORM,并简单地将特定于数据库的部分替换为使用 API 调用保存实体的逻辑。(当然,使用相同的API检索它们)。通过这种方式,我可以使用大致相同的语法保存我的实体:

// current way to save $entity in database:
$em = $this->getDoctrine()->getManager();
$em->persist($entity);
$em->flush();

// desired way to save $entity using REST API:
// (just an example, it doesn't have to be exactly like this)
$em = $this->getDoctrine()->getManager('rest');
$em->persist($entity);
$em->flush();

请注意,我不是在尝试构建自己的API,我只是尝试与第三方API进行通信以保存我的实体。我对教义比较陌生,但到目前为止,我很喜欢它。我真的很喜欢将持久性逻辑与实体分离的想法,但到目前为止,我无法找到如何使用它来使用API保存它们。

Symfony的文档中有一篇文章描述了如何使用多个实体管理器。我正在寻找一个类似的解决方案,但是使用实体管理器,使我能够使用REST而不是DB。

我一直试图自己调整 Doctrine 的 ORM,但我最终只重写了一半的代码,因为它(似乎)与特定于数据库的逻辑过于紧密耦合。当然,我可能正在做一些愚蠢的事情。

所以我的问题是,有没有办法用自定义部分替换/覆盖学说ORM的数据库特定部分?不重写很多所有持久化方法都应该通用的东西?以前做过吗?还是根本不可能,因为学说旨在与数据库一起使用,并且对于其他用途不够灵活?

我自己的进步

CakePHP似乎能够通过让您定义自定义数据源来做到这一。这样,您可以使用SQL数据库保存模型,也可以使用API,会话等保存模型。我想做大致相同的事情,但使用教义而不是CakePHP。

更新 1

实际的数据库查询似乎是由 Doctrine\ORM\Persisters\BasicEntityPersister 类执行的。还有其他几个xxxPersister类,用于处理不同类型的继承。也许可以用我们自己的类替换xxxPersister类,这样我们就可以用REST API代码替换DB代码。

持久化器对象是在 Doctrine\ORM\UnitOfWork 类的方法中创建的。类名是硬编码的,因此,如果我们要使用自己的持久化器,则需要重写。getEntityPersister()Doctrine\ORM\UnitOfWork

更新 2

Doctrine\ORM\UnitOfWork似乎被硬编码到 Doctrine\ORM\EntityManager 中,所以我们也需要覆盖它。但是,此类似乎包含一些特定于数据库的部分。例如,它的构造函数需要一个对象作为参数。也许最好创建我们自己的EntityManger(实现接口),只要这不会花费太多时间/精力。Doctrine\DBAL\ConnectionDoctrine\Common\Persistence\ObjectManager

更新 3

用于检索/加载/查找对象的特定于数据库的代码与用于持久化/删除等的代码位于同一类中:类。因此,如果我们能够用我们自己的对象替换它们,为了持久化对象,我们也可以检索对象。例如,当您调用 时,它将返回(因为只是 的别名),它将运行以下代码:Doctrine\ORM\Persisters\xxxPersister$entityRepository->findAll()$entityRepository->findBy(array())findAll()findBy(array())

$persister = $this->_em->getUnitOfWork()->getEntityPersister($this->_entityName);

return $persister->loadAll($criteria, $orderBy, $limit, $offset);

换句话说,一旦我们创建了权利和对象,我们将能够使用.EntityManagerUnitOfWorkxxxPersisterfindEntityRepository

更新 4

我发现为 Doctrine 开发了一个新功能:自定义持久化器(另请参阅此内容)。这应该使使用自定义持久化器类变得更加容易。我还不知道它是否能让我们创建一个非DB持久化器,但它看起来很有希望。但是,最后一次更新是在八月份,所以我不确定它是否仍在积极开发中。


答案 1

您可以使用 https://github.com/doctrine/rest 来构建与目标服务器通信的 REST 客户端。这里的基本部分是从实体(本地)到REST API(目标)的映射。

简而言之:Doctrine2(本地数据库)-> Rest客户端(实体到其余映射)->请求(目标服务器)

Doctrine/Rest还提供了相反的方法:Doctrine Rest Server,通过REST(对服务器的请求)公开本地实体。但这不是你要找的。


答案 2

DoctrineRestDriver正在做你正在寻找的事情。https://github.com/CircleOfNice/DoctrineRestDriver

配置原则:

doctrine: dbal: driver_class: "Circle\\DoctrineRestDriver\\Driver" host: "http://www.your-url.com/api" port: 80 user: "Circle" password: "CantRenember"

构建实体:

/**
 * This annotation marks the class as managed entity:
 *
 * @ORM\Entity
 *
 * You can either only use a resource name or the whole url of
 * the resource to define your target. In the first case the target 
 * url will consist of the host, configured in your options and the 
 * given name. In the second one your argument is used as it is.
 * Important: The resource name must begin with its protocol.
 *
 * @ORM\Table("products|http://www.yourSite.com/api/products")
 */
class Product {

    /**
     * @ORM\Column(type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=100)
     */
    private $name;

    public function getId() {
        return $this->id;
    }

    public function setName($name) {
        $this->name = $name;
        return $this;
    }

    public function getName() {
        return $this->name;
    }
}

假设我们已将值 http://www.yourSite.com/api/products 用于产品实体的@Table注释。

控制器:

<?php

namespace CircleBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\HttpFoundation\Response;

class UserController extends Controller {

    /**
     * Sends the following request to the API:
     * POST http://www.yourSite.com/api/products HTTP/1.1
     * {"name": "Circle"}
     *
     * Let's assume the API responded with:
     * HTTP/1.1 200 OK
     * {"id": 1, "name": "Circle"}
     *
     * Response body is "1"
     */
    public function createAction() {
        $em     = $this->getDoctrine()->getManager();
        $entity = new CircleBundle\Entity\Product();
        $entity->setName('Circle');
        $em->persist($entity);
        $em->flush();

        return new Response($entity->getId());
    }

    /**
     * Sends the following request to the API by default:
     * GET http://www.yourSite.com/api/products/1 HTTP/1.1
     *
     * which might respond with:
     * HTTP/1.1 200 OK
     * {"id": 1, "name": "Circle"}
     *
     * Response body is "Circle"
     */
    public function readAction($id = 1) {
        $em     = $this->getDoctrine()->getManager();
        $entity = $em->find('CircleBundle\Entity\Product', $id);

        return new Response($entity->getName());
    }

    /**
     * Sends the following request to the API:
     * GET http://www.yourSite.com/api/products HTTP/1.1
     *
     * Example response:
     * HTTP/1.1 200 OK
     * [{"id": 1, "name": "Circle"}]
     *
     * Response body is "Circle"
     */
    public function readAllAction() {
        $em       = $this->getDoctrine()->getManager();
        $entities = $em->getRepository('CircleBundle\Entity\Product')->findAll();

        return new Response($entities->first()->getName());
    }

    /**
     * After sending a GET request (readAction) it sends the following
     * request to the API by default:
     * PUT http://www.yourSite.com/api/products/1 HTTP/1.1
     * {"name": "myName"}
     *
     * Let's assume the API responded the GET request with:
     * HTTP/1.1 200 OK
     * {"id": 1, "name": "Circle"}
     *
     * and the PUT request with:
     * HTTP/1.1 200 OK
     * {"id": 1, "name": "myName"}
     *
     * Then the response body is "myName"
     */
    public function updateAction($id = 1) {
        $em     = $this->getDoctrine()->getManager();
        $entity = $em->find('CircleBundle\Entity\Product', $id);
        $entity->setName('myName');
        $em->flush();

        return new Response($entity->getName());
    }

    /**
     * After sending a GET request (readAction) it sends the following
     * request to the API by default:
     * DELETE http://www.yourSite.com/api/products/1 HTTP/1.1
     *
     * If the response is:
     * HTTP/1.1 204 No Content
     *
     * the response body is ""
     */
    public function deleteAction($id = 1) {
        $em     = $this->getDoctrine()->getManager();
        $entity = $em->find('CircleBundle\Entity\Product', $id);
        $em->remove($entity);
        $em->flush();

        return new Response();
    }
}

您甚至可以使用 DQL 或本机查询。


推荐