使用 Laravel Horizon 优雅的终止进程(2)

发表于

小知识，大挑战！本文正在参与「程序员必备小知识」创作活动

本文已参与 「掘力星计划」 ，赢取创作大礼包，挑战创作激励金。

先看我

我是第一篇：使用 Laravel Horizon 优雅的终止进程(1)

抛出问题

我们发布新版本代码时，如果优雅的终止运行中的异步任务，规避异步任务运行到一半被kill掉的情况。

解决办法

通过调研之后发现，laravel 的 horizon 扩展可以解决这个问题，使用下面的命令可以优雅的结束进程：

  1. 确保进行中进程不会被kill掉，执行结束后才允许被kill；
  2. 非进行的任务等候，不会加入到队列中；

优雅的解决了这个问题，思路就是这么的朴实无华。

1
c复制代码php artisan horizon:terminate

下面继续介绍 Horizon 进阶知识点

基础知识点可以看这篇：使用 Laravel Horizon 优雅的终止进程(1)

运行 Horizon

当在 config/horizon.php 文件中配置好队列执行进程后，就可以使用 horizon Artisan 命令启动 Horizon。

只需要一条命令语句即可启动所有配置好的队列进程：

1
复制代码php artisan horizon

使用 horizon:pause 和 horizon:continue Artisan 命令来暂停或继续执行队列任务：

1
2
3
kotlin复制代码php artisan horizon:pause

php artisan horizon:continue

使用 horizon:terminate Artisan 命令优雅的终止 Horizon 主进程。

Horizon 会把正在执行的任务处理完毕后退出：

1
c复制代码php artisan horizon:terminate

部署 Horizon

将 Horizon 部署到线上服务器时，则需要配置一个进程监控器来检测 php artisan horizon 命令，在它意外退出时自动重启。

上线新代码时则需要该进程监控器终止 Horizon 进程并以修改后的代码重启 Horizon。

下面的内容比较重要，请集中注意力：

Supervisor 配置

如果使用 Supervisor 进程监控器管理 horizon 进程，那么以下配置文件则可满足需求：

1
2
3
4
5
6
7
8
ini复制代码[program:horizon]
process_name=%(program_name)s
command=php /home/forge/app.com/artisan horizon
autostart=true
autorestart=true
user=forge
redirect_stderr=true
stdout_logfile=/home/forge/app.com/horizon.log

标签

Horizon 允许你对任务分配「标签」，包括邮件，事件广播，通知和队列的事件监听器。

优雅如Laravel，Horizon 会智能并且自动根据任务携带 Eloquent 模型给大多数任务标记标签，如下任务示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
php复制代码<?php

namespace App\Jobs;

use App\Video;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;

class RenderVideo implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    /**
     * video 实例
     *
     * @var \App\Video
     */
    public $video;

    /**
     * 创建工作实例
     *
     * @param  \App\Video  $video
     * @return void
     */
    public function __construct(Video $video)
    {
        $this->video = $video;
    }

    /**
     * 执行任务
     *
     * @return void
     */
    public function handle()
    {
        //
    }
}

如果该队列任务是一个携带 id 为 1 的 App\Video 实例，那么它将自动被标记上 App\Video:1 标签。

因为 Horizon 会检查任务属性是否具有 Eloquent 模型，如果发现 Eloquent 模型，Horizon 将会智能的用该模型的类名和主键为任务标记上标签：

1
2
3
css复制代码$video = App\Video::find(1);

App\Jobs\RenderVideo::dispatch($video);

再一次发出感慨：真的优雅！

自定义标签

需要手动的为队列执行的对象定义标签，可以给这个类定义一个 tags 方法：

1
2
3
4
5
6
7
8
9
10
11
12
php复制代码class RenderVideo implements ShouldQueue
{
    /**
     * 获取分配给这个任务的标签
     *
     * @return array
     */
    public function tags()
    {
        return ['render', 'video:'.$this->video->id];
    }
}

通知

如果需要在队列等待时间过长时发起通知，可以在应用的 HorizonServiceProvider 中调用以下三种方法：

Horizon::routeMailNotificationsTo

Horizon::routeSlackNotificationsTo

Horizon::routeSmsNotificationsTo

1
2
3
4
5
6
css复制代码Horizon::routeMailNotificationsTo('example@example.com');

//这个不常用，起码我没用过。
Horizon::routeSlackNotificationsTo('slack-webhook-url', '#channel');

Horizon::routeSmsNotificationsTo('138xxxxxxxx');

题外话：Slack是什么？

百度百科的解释：Slack 是聊天群组 + 大规模工具集成 + 文件整合 + 统一搜索。截至2014年底，Slack 已经整合了电子邮件、短信、Google Drives、Twitter、Trello、Asana、GitHub 等 65 种工具和服务，可以把各种碎片化的企业沟通和协作集中到一起。

配置等待时间过长的阈值

可以在 config/horizon.php 配置文件中设置等待时间过长的具体秒数。

waits 配置项可以针对每一个 链接 / 队列 配置阈值：

1
2
3
dart复制代码'waits' => [
    'redis:default' => 60, //单位秒
],

Metrics

Horizon 包含一个 Metrics 仪表盘，它可以提供任务和队列等待时间和吞吐量信息。

为了填充此仪表盘，需要通过应用的任务调度器配置 Horizon 的 snapshot Artisan 命令每五分钟运行一次。

1
2
3
4
5
6
7
8
9
10
php复制代码/**
 * 定义应用程序的任务调度
 *
 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
 * @return void
 */
protected function schedule(Schedule $schedule)
{
    $schedule->command('horizon:snapshot')->everyFiveMinutes();
}

总结

文章开头抛出的问题是我开发过程中没考虑到的，

初识文档也没体会到 php artisan horizon:terminate 的妙处。

随着项目的不断成长，自己的技术水平和编程思想也在随之成长。

好了，Laravel Horizon的内容就总结到这里了，真的优雅~

感谢支持

文章看到这里就点赞关注之后再走呗，感谢❤️

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有

0%