Laravel/Lumen 任务调度简易入门说明

news/2024/4/19 4:55:31

前提

Laravel 中任务调度简化了服务器系统中 Cron 的操作,使得 计划任务 的实现更为简便。

这里主要以 Laravel 自带的消息队列进行说明,了解其间运行关系可以让我们更清晰的进行代码实现。

下方代码以 Lumen 9.x 框架进行举例,与 Laravel 应无二致。

中文参考文档:任务调度 - Laravel 9.x

定义任务调度

我们称之为 计划任务周期性任务 均可。因为他的目的即是如此。

首先编辑 App\Console\Kernel 类,默认内容如下:

<?phpnamespace App\Console;use Illuminate\Console\Scheduling\Schedule;
use Laravel\Lumen\Console\Kernel as ConsoleKernel;class Kernel extends ConsoleKernel {/*** The Artisan commands provided by your application.** @var array*/protected $commands = [];/*** Define the application's command schedule.** @param Schedule $schedule** @return void*/protected function schedule(Schedule $schedule): void {// TODO:}
}

例如我们需要在 每周一凌晨时段 执行业务统计任务(假设统计上一周订单量、销售额)

周期定义可参阅:任务调度 - 调度频率选项

schedule 方法中先写上如下代码:

protected function schedule(Schedule $schedule): void {$schedule->job()                // 到达指定周期执行的目标任务,此处我们的目的是生产一条消息队列->withoutOverlapping()      // 避免任务重复->timezone('Asia/Shanghai') // 指定时区->weeklyOn([1], '03:00');   // 定义时间:每周一 03:00 AM 执行。如果周一、周三、周六皆需要运行则可将第一参数修改为 [1, 3, 6]
}

IDE 会对 job 方法报出警告,因为我们还未添加其对应的消息队列

添加消息队列

Laravel/Lumen 框架中支持多种消息队列驱动:sqsdatabaseredisbeanstalkd,我们以 redis 为例。此处假设你已做好 redis 队列相关环境以及配置。

我们在 App\Jobs 中编写一个 WeeklyStatisticsJob 类:

<?phpnamespace App\Jobs;class WeeklyStatisticsJob extends Job {public function __construct() {}/*** Execute the job.** @return void*/public function handle(): void {// TODO:echo "done\n";$this->delete();}
}

如需传递自定义参数至该 Job 类,只需在 __construct 方法中添加形参相应,并传递至成员变量,例如:

<?phpnamespace App\Jobs;class WeeklyStatisticsJob extends Job {private int $supplierId;private string $beginDate;private string $endDate;public function __construct(int $supplier_id, string $begin_date, string $end_date) {$this->supplierId = $supplier_id;$this->beginDate = $begin_date;$this->endDate= $end_date;}
}

TODO: 部分为实际业务代码,例如调用服务类实现统计并存储于数据库中。

应用消息队列

回到 App\Console\Kernel 类,将消息队列类实例化进 job 方法即可:

protected function schedule(Schedule $schedule): void {$schedule->job(new WeeklyStatisticsJob(1, '2023-11-13', '2023-11-19'))->withoutOverlapping()->timezone('Asia/Shanghai')->weeklyOn([1], '03:00');
}

注意,我们为了将其与已有消息队列进行区分,应对其指定单独的队列名称。同样,如果需要单独指定消息队列的连接(使用 databasesqs 等),还需指定连接名。

所以我们应当修改为:

protected function schedule(Schedule $schedule): void {$schedule->job(new WeeklyStatisticsJob(1, '2023-11-13', '2023-11-19'),'weekly_calc_statistics',  // 建议指定队列名称,如未指定,默认为 'default''redis'                    // 默认使用 redis 时,此处可忽略)->withoutOverlapping()->timezone('Asia/Shanghai')->weeklyOn([1], '03:00');
}

至此,我们的周期任务就已编写完成,但对于测试来说,周期过于漫长,我们可以将 每周一凌晨三点 修改为每分钟,或者每 5-10 分钟进行测试。

即,将 weeklyOn([1], '03:00') 修改为 everyMinute()everyFiveMinute() 等方法。

运行测试

我们首先应当运行上方编写的队列监听:weekly_calc_statistics

在项目根目录中执行下方命令:

# 如未指定队列名,可忽略 queue 参数
php artisan queue:work --queue=weekly_calc_statistics

随后在 另一 命令窗口中执行:

php artisan schedule:work

稍等片刻,周期任务将生产一条消息队列放入 redis 中,随后可在消息队列命令窗口中看到该队列被消费提示。


https://dhexx.cn/news/show-5160641.html

相关文章

第二十章,多线程

创建线程 有两种方式&#xff0c;分别为继承Java.lang.Thread类与实现Java.lang.Runnable接口 继承Thread类 Thread常用的两个构造方法语法 public Thread&#xff08;&#xff09;&#xff1b; public Thread&#xff08;String threadName&#xff09;&#xff1b; 继承…

【蓝桥杯 LCA 差分】 砍树

题目分析&#xff1a; 这道题还是比较裸的一道书上差分的题目了 对于每一对标记点(x,y) 他们之间的路径就是 x − > L C A ( x , y ) − > y x->LCA(x,y)->y x−>LCA(x,y)−>y 这条路径上的每一条边都要经过。 那么对于一条边&#xff0c;什么时候砍掉这条…

qt实现一个安卓测试小工具

qt实现一个安卓测试小工具 最终效果&#xff1a;目录结构源码gui.py 主要是按钮&#xff0c;文本控制代码main.py 主要是逻辑代码gui.spec 是打包使用的adb.ui 最终效果&#xff1a; 目录结构 上面2个是打包的生成的不用管 源码 gui.py 主要是按钮&#xff0c;文本控制代码…

数据结构(超详细讲解!!)第二十五节 树与森林

1.树的存储结构 和线性表一样&#xff0c;树可以用顺序和链式两种存储结构。 树的顺序存储结构适合树中结点比较“满”的情况。根据树的非线性结构特点&#xff0c;常用链式存储方式来表示树。树常用的存储方法有&#xff1a;双亲表示法、孩子表示法和孩子兄弟表…

Python(八十九)函数的参数的内存分析

❤️ 专栏简介&#xff1a;本专栏记录了我个人从零开始学习Python编程的过程。在这个专栏中&#xff0c;我将分享我在学习Python的过程中的学习笔记、学习路线以及各个知识点。 ☀️ 专栏适用人群 &#xff1a;本专栏适用于希望学习Python编程的初学者和有一定编程基础的人。无…

ZKP15.2 Formal Methods in ZK (Part I)

ZKP学习笔记 ZK-Learning MOOC课程笔记 Lecture 15: Secure ZK Circuits via Formal Methods (Guest Lecturer: Yu Feng (UCSB & Veridise)) 15.2 Formal Methods in ZK (Part I) Circuits Workflow Source Code: Witness Generation and ConstraintsWitness Generatio…

kubenetes-kubelet组件

一、kubelet架构 每个节点都运行一个kubelet进程&#xff0c;默认监听10250端口&#xff0c;kubelet作用非常重要&#xff0c;是节点的守护神。 接收并执行 master发来的指令。管理Pod及Pod中的容器。每个kubelet进程会在API Server 上注册节点自身信息&#xff0c;定期向mast…

JavaScript 的 DOM 知识点有哪些?

文档对象模型&#xff08;Document Object Model&#xff0c;简称 DOM&#xff09;&#xff0c;是一种与平台和语言无关的模型&#xff0c;用来表示 HTML 或 XML 文档。文档对象模型中定义了文档的逻辑结构&#xff0c;以及程序访问和操作文档的方式。 当网页加载时&#xff0…

每日一练【移动零】

一、题目描述 283. 移动零 - 力扣&#xff08;LeetCode&#xff09; 给定一个数组 nums&#xff0c;编写一个函数将所有 0 移动到数组的末尾&#xff0c;同时保持非零元素的相对顺序。 请注意 &#xff0c;必须在不复制数组的情况下原地对数组进行操作。 二、题目解析 可以…

基于SSM的旅游管理系统设计与实现

末尾获取源码 开发语言&#xff1a;Java Java开发工具&#xff1a;JDK1.8 后端框架&#xff1a;SSM 前端&#xff1a;采用JSP技术开发 数据库&#xff1a;MySQL5.7和Navicat管理工具结合 服务器&#xff1a;Tomcat8.5 开发软件&#xff1a;IDEA / Eclipse 是否Maven项目&#x…