在使用第三方API并在Laravel中创建域时使用适配器模式

Posted 2021-04-07

在我的Laravel REST API项目中，我主要使用第三方API。为此，我有一个按服务（住宿，规划，折扣等）分组的“服务”文件夹，可以向API发送正确的参数并获取原始数据。

我觉得我需要在这里使用适配器模式，因为需要格式化第三方输出。

让我试着举个例子。

我有一个EventDao接口（数据访问对象）和一个或多个具体的EventDao类，如EventbriteDao。

我还为每个具体的DAO都有一个适配器。例如：EvenbriteAdapter

我会在某处有一些业务逻辑，所以我需要一个Event实体类。要将适配器的数据传递给实体，我需要一个EventDTO类（数据传输对象）

最后我可以调用eventDao（通过界面感谢Laravel的服务提供商）

我将其原始输出传递给适配器，然后将适配器的输出传递给实体。然后我可以调用实体类的方法之一。 （之后我需要将它转换为适当的json数据，但它很容易。）

我不知道在哪里放置其他CRUD逻辑，如updateEvent，deleteEvent，getAll等。我应该直接在控制器中调用它们还是创建存储库（存储库模式）？我很困惑。

这是一个好方法还是过度工程？因为我有5-6个类/接口而不是控制器。

另一个问题是直接在控制器中调用EventbriteAdapter。我应该有一个接口吗？在这种情况下，我需要将服务和适配器接口绑定到AppServiceProvider中的实现。

我的另一个问题是拥有实体块的集合。如果我调用getAll（）方法，我可以遍历数据并创建一个对象数组，但我对它不满意。 Laravel的集合很有用，但我想将应用层与域分开。什么是一个很好的解决方案呢？

这里我提到的一些文件的示例代码是：

interface EventAdapter
{
    public function getId();
    public function getName();
    public function getStartDate();
    public function getLocationName();
}



class EventbriteAdapter implements EventInterface
{
    private $raw;

    public function __construct(array $raw)
    {
        $this->raw = $raw;
    }

    public function getName()
    {
        return $this->raw['name'];
    }

    public function getStartDate()
    {
        return $this->raw['start'];
    }

    public function getLocation()
    {
        return $this->raw['venue']['name'].' '.$this->raw['venue']['address'];
    }
}


// Fetch event from Eventbrite (or other third-party)
$result = fetchEventFromEventbrite();

// Wrap event in adapter
$adapter = new EventbriteAdapter($result);

答案

我不知道在哪里放置其他CRUD逻辑，如updateEvent，deleteEvent，getAll等。我应该直接在控制器中调用它们还是创建存储库（存储库模式）？我很困惑。

您可以使用the Gateway pattern封装与第三方API交互的所有逻辑。网关可以包含获取数据和保存数据的方法。例如：

interface EventGatewayInterface
{
    /**
     * Get an event by id
     * 
     * @param mixed $id unique identifier of an event
     * @return Event the event
     */
    public function getById($id);

    /**
     * Get all events
     *
     * @return Event[] list of events
     */
    public function getAll();

    /** 
     * Add an event
     *
     * @param Event $event the event which will be added
     */
    public function add(Event $event);

    /**
     * Update an event
     *
     * @param Event $event the event which will be updated  
     */
    public function update(Event $event);

    /**
     * Delete an event
     *
     * @param Event $event the event which will be removed
     */
    public function delete();
}

这是一个好方法还是过度工程？因为我有5-6个类/接口而不是控制器。

实际上，您使用the Adapter pattern将一个表示（原始表示）转换为另一个（对象表示）。但适配器模式用于将一个程序接口转换为兼容的程序接口。要转换使用the Mapper pattern的表示法。您可以实现简单的映射器，例如：

class RawEventMapper
{
    /**
     * Map raw data to an event object
     * 
     * @param array $data raw data
     * @return Event the event object
     */
    public function map(array $data)
    {
        $event = new Event();
        $event->name = $data['name'];
        $event->startDate = $data['start'];
        $event->location = $data['venue']['name'].' '.$data['venue']['address'];
        return $event;
    }
}

并在Gateway中使用它将原始数据转换为对象。

class ConcreteEventGateway implement EventGatewayInterface
{
    /** @var RawEventMapper data mapper */
    protected $mapper;

    /**
     * Constructor
     *
     * @param RawEventMapper $mapper data mapper
     */ 
    public function __construct(RawEventMapper $mapper)
    {
        $this->mapper = $mapper;
    }

    /** @inheritdoc */
    public function getById($id)
    {
        // get raw data from 3rd party API
        return $this->mapper->map($raw);
    }
}

Laravel的集合很有用，但我想将应用层与域分开。什么是一个很好的解决方案呢？

如果您的目标是创建独立于框架的域层，则不应使用Laravel集合。