在Laravel应用程序如何减少代码重复编写

Laravel  /  管理员 发布于 2年前   318

代码重复是很多开发者最痛苦的事情, 你认为你已经解决了问题, 但同样的问题有几个实例.

在我作为Laravel开发者看到的许多代码库中, 控制台命令似乎总是被遗忘的地方, 或者是人们需要更加注意质量的部分.

下面介绍如何在编写代码时注重减少代码的重复。

首先，让我们提出一个假设。

我们有一个Laravel应用程序，它是一个电子商务商店，每天一次，我们想生成一个关于所有销售和运输状态的报告。

我们目前的方法是登录到管理面板，点击一个按钮来生成报告。

这可能是不现实的，因为这里的第一个例子是将其自动化。

但是，在我们冒险改进这个想法时，请跟我一起坚持一会儿。

我们的第一步将是创建一个或一组能够生成报告的工匠命令。

当我们开始研究报告时，为我们想要实现的目标明确地命名命令是有意义的。

因此，让我们从销售数字开始。

final class SalesFigures extends Command
{
    public $signature = 'reports:sales';
 
    public $description = 'Run a daily report on sales.';
 
    public function handle(): int
    {
        $date = now()->subDay();
 
        $sales = Order::query()
            ->where('status', Status::COMPLETE)
            ->whereBetween(
                'completed_at',
                $date->startOfDay(),
                $date->endOfDay(),
            )->latest()->get();
 
        // send information through to the report builder
    }
}

我们在这里有一个简单的命令，我们将能够运行并获得昨天被标记为完成的销售数字。

这个查询本身很简单。

它检查昨天的状态和日期，然后对它们进行排序，所以最新的在前面--以便让我们建立一个按时间顺序的报告。

但是，我们怎样才能改进这一点呢？

在应用程序的其他方面，我们是否需要以类似的顺序获得这些订单？

让我们开始重构过程。

首先，这个特定的查询是我们需要在几个不同的地方运行的。

所以我们可以把这个移到它自己的类中让我们运行。

final class ResultsForPeriod implements ResultsForPeriodContract
{
    public function handle(
        Builder $query,
        CarbonInterface $start,
        CarbonInterface $end,
    ): Builder {
        return $builder->whereBetween(
            'completed_at',
            $start,
            $end,
        );
    }
}

这将使我们能够在任何模型中获得一定时间范围内的结果--这对项目更有利。

final class SalesFigures extends Command
{
    public $signature = 'reports:sales';
 
    public $description = 'Run a daily report on sales.';
 
    public function handle(ResultsForPeriodContract $query): int
    {
        $date = now()->subDay();
 
        $sales = $query->handle(
            query: Order::query()
                ->where('status', Status::COMPLETE),
            start: $date->startOfDay(),
            end: $date->endOfDay()
        )->latest()->get();
 
        // send information through to the report builder
    }
}

我们已经实现了我们建立的基于时间范围的过滤的查询。

我们还能在哪里使它变得更干净、更有效？

我们是否可以创建一个特定的服务来处理这个报告方面？

这种服务在其他领域也有帮助吗？

我们的电子商务仪表板可能会有一些来自这些报告的信息，所以一些代码已经被重用了。

让我们把这个移到一个服务中。

final class ReportService implements ReportServiceContract
{
    public function __construct(
        private readonly ResultsForPeriodContract $periodFilter,
    ) {}
 
    public function dailySales(CarbonInterface $start, CarbonInterface $end): Collection
    {
        return $this->periodFilter->handle(
            query: Order::query()->where('status', Status::COMPLETE),
        )->latest()->get();
    }
}

我们现在可以将其移回artisan命令中。

final class SalesFigures extends Command
{
    public $signature = 'reports:sales';
 
    public $description = 'Run a daily report on sales.';
 
    public function handle(ReportServiceContract $service): int
    {
        $date = now()->subDay();
 
        $sales = $service->dailySales(
            query: Order::query(),
            start: $date->startOfDay(),
            end: $date->endOfDay()
        );
 
        // send information through to the report builder
    }
}

正如你所看到的，我们有一个新的干净的命令，

很好地利用了与我们应用程序的其他区域的共享代码。