侯体宗的博客
  • 首页
  • Hyperf版
  • beego仿版
  • 人生(杂谈)
  • 技术
  • 关于我
  • 更多分类
    • 文件下载
    • 文字修仙
    • 中国象棋ai
    • 群聊
    • 九宫格抽奖
    • 拼图
    • 消消乐
    • 相册

在laravel项目中创建Lifecycle hooks(生命周期钩子)及使用钩子的场景浅析

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

作为程序员, 必须特别善于把大型的, 复杂的问题分解成较小的, 易于管理的块. 

然而,有时会发现,我们为了减少重复(或其他需要)而提取的那些较小的、重复的代码片段,必须根据一些外部环境以不同的方式进行交互。


让我们来探索其中的一个场景,我将引导你和我一起完成这个过程。

为了设定场景,我们有一个半复杂的动作列表,将其串联起来执行一个整体的巨大任务。

我们把这个列表做成一系列的可调用类,内容并不重要。

我们将在我们的ActionRunner类中列出这些内容。

然后,我们在它们上面循环,从我们的run()方法中按顺序执行每一个。

namespace App;
 
use App\Actions;
 
class ActionRunner
{
    public array $actions = [
            Actions\FirstStepOfComplexThing::class,
            Actions\SecondStepOfComplexThing::class,
            Actions\ThirdStepOfComplexThing::class,
            Actions\FourthStepOfComplexThing::class,
            Actions\FifthStepOfComplexThing::class,
            Actions\SixthStepOfComplexThing::class,
    ];
 
    public function run(): void
    {
        foreach ($this->actions as $action) {
            // Resolving the action out of the
            // container will help with testing
            app($action)();
        }
    }
}

这很容易阅读。

而且我们可以在队列作业和artisan命令中使用这一个ActionRunner。

namespace App\Jobs;
 
use App\ActionRunner;
 
class RunActionsJob implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable;
 
    public function handle(): void
    {
        app(ActionRunner::class)->run();
    }
}
namespace App\Commands;
 
use App\ActionRunner;
 
class RunActionsCommand extends Command
{
    protected $signature = 'complicated-thing:run';
 
    protected $description = 'Runs the list of complicated actions.';
 
    public function handle(): int
    {
        app(ActionRunner::class)->run();
 
        $this->line('The list of complicated things was run successfully!');
 
        return Command::SUCCESS;
    }
}

不过,这也是我们可能遇到问题的地方。

比方说,这些是一些特别重要的行动,每一个行动都需要一分钟的时间。

这个工作流程要花5分钟,而且是零反馈。

现在我们说,当这些行动在队列中运行时,我们想在每个行动完成后向我们的Slack频道发送一条消息。

但是当运行命令时,我们想跳过这一点,把它输出到CLI。


你的本能可能会说,

"我们只需将run()方法复制到作业和命令中,然后在那里做循环,不管我们需要做什么"。

但是现在,我们不仅重复了代码(这并不总是坏事),而且这些类还承担了它们不应该承担的责任。

他们被要求掌握他们真正不应该掌握的知识,如果我们改变这个功能的工作方式,我们必须在多个地方进行修改。


我将向你们展示一种我绝对喜欢的方法。

我们要实现一个onProgress()钩子。

由于这个钩子很可能在这个假的应用程序的其他地方使用,我们将继续下去,只是把它变成一个特性。

namespace App\Traits;
 
use Closure;
 
trait UsesOnProgressHook
{
    public ?Closure $onProgressFn = null;
 
    public function onProgress(Closure $fn): self
    {
        $this->onProgressFn = $fn;
 
        return $this;
    }
 
    public function callOnProgressHook(...$args): void
    {
        if ($this->onProgressFn) {
            ($this->onProgressFn)(...$args);
        }
    }
}

在这个trait中,我们首先定义了一个nullable Closure。

这使得我们可以简单地调用 callOnProgressHook() 方法,并让 trait 担心我们是否要对它做什么。

如果我们没有用流畅的onProgress()方法设置一个函数,它就成了一个无用的东西。

现在我们的ActionRunner变成了这样:

namespace App
 
use App\Actions;
use App\Traits\UsesOnProgressHook;
 
class ActionRunner
{
    use UsesOnProgressHook;
 
    public array $actions = [
            Actions\FirstStepOfComplexThing::class,
            Actions\SecondStepOfComplexThing::class,
            Actions\ThirdStepOfComplexThing::class,
            Actions\FourthStepOfComplexThing::class,
            Actions\FifthStepOfComplexThing::class,
            Actions\SixthStepOfComplexThing::class,
    ];
 
    public function run(): void
    {
        foreach ($this->actions as $action) {
            app($action)();
            $this->callOnProgressHook("Ran {$action}.");
        }
    }
}

现在,由于我们的$onProgressFn被设置为null,所以就其本身而言,这不会有任何作用。

但这正是这个钩子的无限宇宙力量所在。


我们可以稍微改变我们的队列作业的handle()方法,让它向我们的Slack频道发送这个消息:

public function handle(): void
{
    app(ActionRunner::class)
        ->onProgress(fn (string $progress) => Log::channel('slack')->info($progress))
        ->run();
}

同样地,我们可以改变我们的命令的handle()方法,让它改成向控制台回音:

public function handle(): int
{
    app(ActionRunner::class)
        ->onProgress(fn (string $progress) => $this->info($progress))
        ->run();
 
    $this->line('The list of complicated things was run successfully!');
 
    return Command::SUCCESS;
}

在这一点上,我们可以在一个完全没有定义任何钩子的预定作业中做同样的事情,或者我们可以在排队的作业中添加更多的通知通道。

我们可以建立一个ActionContext类,它可以存储大量的数据并将其传递回来,

允许我们真正挑选我们想用的数据,如执行时间、模型数据、其他元信息等。

我们可以实现多个不同的钩子,在执行周期的不同时间被调用,比如onBeforeExternalApiCalls(),或者onCompleted()。


我认为这是一个非常强大的模式。


  • 上一条:
    基于go语言的高性能的数据库分表中间件介绍:Gorm Sharding
    下一条:
    微信支付商户证书生成流程步骤
  • 昵称:

    邮箱:

    0条评论 (评论内容有缓存机制,请悉知!)
    最新最热
    • 分类目录
    • 人生(杂谈)
    • 技术
    • linux
    • Java
    • php
    • 框架(架构)
    • 前端
    • ThinkPHP
    • 数据库
    • 微信(小程序)
    • Laravel
    • Redis
    • Docker
    • Go
    • swoole
    • Windows
    • Python
    • 苹果(mac/ios)
    • 相关文章
    • Laravel 11.15版本发布 - Eloquent Builder中添加的泛型(0个评论)
    • Laravel 11.14版本发布 - 新的字符串助手和ServeCommand改进(0个评论)
    • Laravel 11.12版本发布 - Artisan的`make`命令自动剪切`.php `扩展(0个评论)
    • Laravel的轻量型购物车扩展包:binafy/laravel-cart(0个评论)
    • Laravel 11.11版本发布 - 查看模型中的第三方关系:show(0个评论)
    • 近期文章
    • 智能合约Solidity学习CryptoZombie二课:让你的僵尸猎食(0个评论)
    • 智能合约Solidity学习CryptoZombie第一课:生成一只你的僵尸(0个评论)
    • 在go中实现一个常用的先进先出的缓存淘汰算法示例代码(0个评论)
    • 在go+gin中使用"github.com/skip2/go-qrcode"实现url转二维码功能(0个评论)
    • 在go语言中使用api.geonames.org接口实现根据国际邮政编码获取地址信息功能(1个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf分页文件功能(0个评论)
    • gmail发邮件报错:534 5.7.9 Application-specific password required...解决方案(0个评论)
    • 欧盟关于强迫劳动的规定的官方举报渠道及官方举报网站(0个评论)
    • 在go语言中使用github.com/signintech/gopdf实现生成pdf文件功能(0个评论)
    • Laravel从Accel获得5700万美元A轮融资(0个评论)
    • 近期评论
    • 122 在

      学历:一种延缓就业设计,生活需求下的权衡之选中评论 工作几年后,报名考研了,到现在还没认真学习备考,迷茫中。作为一名北漂互联网打工人..
    • 123 在

      Clash for Windows作者删库跑路了,github已404中评论 按理说只要你在国内,所有的流量进出都在监控范围内,不管你怎么隐藏也没用,想搞你分..
    • 原梓番博客 在

      在Laravel框架中使用模型Model分表最简单的方法中评论 好久好久都没看友情链接申请了,今天刚看,已经添加。..
    • 博主 在

      佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 @1111老铁这个不行了,可以看看近期评论的其他文章..
    • 1111 在

      佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 网站不能打开,博主百忙中能否发个APP下载链接,佛跳墙或极光..
    • 2016-10
    • 2016-11
    • 2017-07
    • 2017-08
    • 2020-03
    • 2020-04
    • 2020-05
    • 2020-06
    • 2020-07
    • 2020-08
    • 2020-09
    • 2020-10
    • 2020-11
    • 2021-01
    • 2021-02
    • 2021-03
    • 2021-04
    • 2021-05
    • 2021-06
    • 2021-07
    • 2021-08
    • 2021-09
    • 2021-10
    • 2021-11
    • 2021-12
    • 2022-01
    • 2022-02
    • 2022-03
    • 2022-04
    • 2022-05
    • 2022-06
    • 2022-07
    • 2022-08
    • 2022-09
    • 2022-10
    • 2022-11
    • 2022-12
    • 2023-01
    • 2023-02
    • 2023-03
    • 2023-04
    • 2023-05
    • 2023-06
    • 2023-07
    • 2023-08
    • 2023-09
    • 2023-10
    • 2023-11
    • 2023-12
    • 2024-01
    • 2024-02
    • 2024-03
    • 2024-04
    • 2024-05
    • 2024-06
    • 2024-07
    Top

    Copyright·© 2019 侯体宗版权所有· 粤ICP备20027696号 PHP交流群

    侯体宗的博客