您的 Laravel 应用程序与存储库没有任何意义

大家好，我们又见面了啊~本文《您的 Laravel 应用程序与存储库没有任何意义》的内容中将会涉及到等等。如果你正在学习文章相关知识，欢迎关注我，以后会给大家带来更多文章相关文章，希望我们能一起进步！下面就开始本文的正式内容~

多年来，我看到许多开发人员在 laravel 中使用存储库模式，试图将干净的架构概念应用于他们的应用程序，但经常误解使用 laravel 这样的框架的一般概念。

在我开始并必须躲避一些我知道你们可能会扔给我的石头之前，让我澄清一下：这是我作为一名软件工程师的观点，他曾使用过多种语言、框架，从头开始构建软件并维护旧版本遗留代码库。我的话不是最终的，一如既往，我相信对任何软件工程问题最容易接受的答案是：“这取决于你愿意牺牲什么来解决你的问题。”

那么，话不多说，让我们进入正题吧。

什么是清洁架构？

清洁架构是一种软件设计理念，旨在创建易于维护、测试和理解的系统。它强调关注点的分离以及系统不同部分之间边界的创建，以确保一个部分的更改不会对其他部分产生不利影响。这种架构由 robert c. martin（bob 叔叔）推广，通常用于指导代码组织，以适应业务规则或技术要求的变化。

简而言之，bob 的建议是，您的应用程序应该分为遵循关键原则的层，以允许您的业务逻辑与任何外部依赖项解耦，从而为它们提供移动性和单一职责上下文。但这不会是一篇干净的架构文章；我只是想让我们在这件事上达成共识。

laravel 和清洁架构怎么样？

说到框架，我们谈论的是依赖关系的紧耦合。您可能没有选择 laravel 来使用 doctrine；您可能选择使用 eloquent。这同样适用于您可能找到的任何框架功能 - 您选择框架是为了开发速度和便利性。

所以，我的问题是：为什么要在你选择简单的东西上添加额外的复杂层？

等等，不要因为我这么说而恨我。您仍然可以在 laravel 中适应甚至使用干净的架构，但任何架构决策中最重要的方面是清楚地了解您想要实现的目标以及这些选择的优缺点。

这是一个艰难的决定，您可以在实施过程中改变主意。软件不应该是一成不变的，对吧？我有一篇关于软件质量的整篇文章，我在其中举起了这个旗帜。

无论如何，回到 laravel 和干净的架构。以我的拙见，最烦人的方法之一是将存储库模式与 eloquent 结合使用，这就是我写这篇文章的动机。

存储库模式

存储库模式是一种在域和数据映射层之间进行调解的设计模式，充当域对象的内存集合。它的目的是解耦领域和数据映射层。

因此，repository 定义是一个领域实体。为什么？因为它与域交互并定义基础设施如何与域交互，充当域和我们应用程序的基础设施层之间的契约。

laravel 上的存储库模式

首先，让我向您展示我在 laravel 应用程序中经常看到的存储库模式的一个糟糕实现，然后为您修复它：

// app/repositories/userrepositoryinterface.php
<?php

namespace app\repositories;

interface userrepositoryinterface
{
  // ...methods definitions
}

// app/repositories/userrepository.php
<?php

namespace app\repositories;

class userrepository implements userrepositoryinterface
{
   // ...implementation
}

正如您在上面的代码中所看到的，域和基础设施的“契约”不是在域内部定义的，而是在基础设施本身内部定义的。是的，app命名空间是应用程序层的一部分，它包含所有非域的东西。

现在，让我们看看如何实现同样的事情：

// domain/repositories/userrepositoryinterface.php
<?php

namespace domain\repositories;

interface userrepositoryinterface
{
  // ...methods definitions
}

// app/repositories/userrepository.php
<?php

namespace app\repositories;

use domain\repositories\userrepositoryinterface;

class userrepository implements userrepositoryinterface
{
   // ...implementation
}

请注意，现在我们有了适当的领域层和应用程序层。是不是很简单就可以得到呢？

eloquent 的存储库模式

现在，让我们想一下。由于存储库接口现在是域的一部分，这意味着我们不能简单地将其他层的依赖项注入其中。这是一个不好的例子来解释它：

// app/repositories/userrepositoryinterface.php
<?php

namespace app\repositories;

use app\models\user;

interface userrepositoryinterface
{
  public function find(int $id): user|null;
  // ...other methods
}

还不清楚吗？让我把它移动到领域层：

// domain/repositories/userrepositoryinterface.php
<?php

namespace domain\repositories;

use app\models\user;

interface userrepositoryinterface
{
  public function find(int $id): user|null;
  // ...other methods
}

看到问题了吗？我们正在将作为基础设施层一部分的 eloquent 模型注入到我们的领域中。这将我们的领域与 eloquent 紧密耦合，这违背了存储库模式的目的。

但是我们该如何解决呢？嗯，这并不像您想象的那么难。您可能已经听说过实体，对吧？所以，让我们修复它：

// domain/repositories/userrepositoryinterface.php
<?php

namespace domain\repositories;

use domain\entities\user;

interface userrepositoryinterface
{
  public function find(int $id): user|null;
  // ...other methods
}

// domain/entities/user.php
<?php

namespace domain\entities;

class user
{
  public function __construct(
    public int $id;
    public string $name;
    public string $email;
  ) {}
  // ...other properties and methods
}

我们的域层现在已经摆脱了外部依赖，如果我们想将整个域移动到另一个框架，我们可以做到。

现在，我们如何在 laravel 应用程序中实现我们的存储库？让我告诉你：

// app/Repositories/EloquentUserRepository.php
<?php

namespace App\Repositories;

use Domain\Repositories\UserRepositoryInterface;
use Domain\Entities\User;
use App\Models\User as EloquentUser;

class EloquentUserRepository implements UserRepositoryInterface
{
    public function find(int $id): ?User {
        $eloquentUser = EloquentUser::find($id);
        return $eloquentUser ? $this->toDomain($eloquentUser): null;
    }

    private function toDomain(EloquentUser $eloquentUser): User
    {
        return new User(
          $eloquentUser->id, 
          $eloquentUser->name, 
          $eloquentUser->email
        );
    }
}

现在我们使用 eloquent 在 laravel 中正确实现了存储库模式。您可以创建任何其他存储库实现，例如 pdouserrepository.php、doctrineuserrepository.php 等，而无需向域层注入任何依赖项。

您真的需要使用存储库吗？

回到我在本文主题中所说的内容，我会补充一点，以我的拙见，在 laravel 中使用存储库模式只是过度设计，你需要一个非常好的理由才能这样做。

您正在为您的应用程序添加一个额外的复杂层，您可能根本不需要，或者更糟糕的是，它不能保证您的业务逻辑实际上被隔离到域层中。

你想在这里实现什么？想一想。您最终可能会错过 laravel 的许多优秀功能，或者至少使它们的使用过于复杂。

您不确定 laravel 是否是您应用程序的最佳框架，并且您将来可能会将您的应用程序迁移到 symfony？当然，请选择域和存储库。您稍后需要将 sql 数据库替换为 nosql 数据库吗？也许这是一个很好的理由。但你真的需要它，还是它只是魅力？

一个常见的论点是存储库有助于将一些业务逻辑放入单独的层中。这通常会让我感到毛骨悚然，因为有更好的方法来分割你的逻辑。存储库只是充当连接数据层和域的中间层，仅此而已。如果你想拆分你的业务逻辑，你应该使用其他东西 - 但这是另一个主题。

结论

总之，虽然存储库模式和干净的架构原则在可维护性和关注点分离方面提供了显着的好处，但它们在 laravel 上下文中的应用程序通常会引入不必要的复杂性。 laravel 的设计初衷是为了简单和快速开发，添加抽象层会使这个过程变得复杂。

在实现存储库模式之前，评估项目的具体需求至关重要。如果由于未来的迁移或灵活性的需要，将域逻辑与 laravel 基础设施解耦确实是必要的，那么复杂性可能是有必要的。然而，对于许多 laravel 应用程序来说，利用 eloquent 可以直接更好地发挥框架的优势，并使代码库更简单、更易于维护。

最终，决策应该基于对项目需求的清晰理解，并权衡所涉及的权衡。过度设计可能会导致比它解决的问题更多的问题，因此在实现设计目标的同时，尽量让您的解决方案尽可能简单。任何架构的主要目标都是解决问题，而不是创造新问题。

本篇关于《您的 Laravel 应用程序与存储库没有任何意义》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！