Laravel中使用Queue的最基本操作教程


Posted in PHP onDecember 27, 2017

前言

laravel中的队列服务跟其他队列服务也没有什么不同,都是最符合人类思维的最简单最普遍的流程:有一个地方存放队列信息,一个PHP进程在运行时将任务写入,另外一个PHP守护进程轮询队列信息,将达到执行要求的任务执行并删除。由于PHP是url驱动的同步语言,本身是阻塞的,所以laravel提供一个守护进程工具来查询并执行队列信息也就不足为奇了。

这两天初次接触 Laravel 的队列,也是搞了好一会。。。一番折腾下来还是感慨对 Laravel 不得其门,文档写的相对简单和概括,看源码又有些力不从心(不过看源码慢慢调试验证还是最可靠的)。

下面是我的一个简单 Demo,仅仅使用了队列的最基本操作,偏高级的操作需要再去好好时间一番 :)

和我一样入门 Laravel 的队列有些困难的同学可以交流一下。

配置

添加 Redis 包

在 composer.json 中 require 部分加入 "predis/predis": "~1.0",,然后 composer up 更新一下即可。

database.php

在 database.php 配置文件中对 redis 数据库部分进行配置,默认有一个 default 连接,就用这个好了:)

根据这个默认连接中需要的配置项,编辑 .env 配置文件,将其中的 REDIS_HOST、REDIS_PASSWORD、REDIS_PORT 填写成自己服务器中 Redis 的相应值。

queue.php

首先需要去 .env 中配置 QUEUE_DRIVER,因为现在打算用 Redis,所以配置成 redis。

接着配置 queue.php 里 connections 部分的 redis 连接,其中 connection 对应的值就是 database.php 中 redis 的那个 default 连接。

任务类

接下来就是写实际的操作类了,Laravel 提供了 artisan 命令简化创建任务类:

php artisan make:job Demo

在 app 目录下会生成 Jobs 目录,里面已经有了 Demo.php 任务类。

Lumen 可没有这个 artisan 命令,不过也很方便,默认会有一个 ExampleJob.php 已经写好了,拷贝一份改个名字即可。
先写个简单的日志输出测试一下好了,在 handle 方法中:

Log::info('Hello, queue');

发放任务

现在写个入口函数,推送任务到队列中。使用辅助函数 dispatch():

Laravel 中使用如下方式:

Demo::dispatch();

Lumen 中使用如下方式:

dispatch(new Demo);

开启队列

顺利的话,这是最后一步了。命令行中执行:

php artisan queue:listen --queue=default

它会监听队列,并输出简单的执行情况,比如:

[2017-11-07 02:12:47] Processing: App\Jobs\Demo
[2017-11-07 02:12:47] Processed: App\Jobs\Demo

没啥问题后就可以让这个队列脚本执行在后台:

php artisan queue:work --daemon --quiet --queue=default 1>> /dev/null 2>&1

进阶一下 :)

推送到队列中时,一般会有传参的需求,那这里怎么传呢?

参数传递

传入

在入口函数中传入参数方式如下:

Laravel 中使用如下方式:

$param = 'Stephen';
Demo::dispatch($param);

Lumen 中使用如下方式:

$param = 'Stephen';
dispatch(new Demo($param));

接收

在任务类中接收参数方式如下:

protected $param;
/**
 * Create a new job instance.
 *
 * @return void
 */
public function __construct($param)
{
  $this->param = $param;
}
/**
 * Execute the job.
 *
 * @return void
 */
public function handle()
{
  Log::info('Hello, ' . $this->param);
}

初次尝试到此为止,还有许多高级用法,比如延迟分发、错误处理、优先级、失败处理等,后续会继续写 :)

多队列

这是一个必然需要考虑到的问题,我不可能将所有任务都放在一个叫 default 的队列中,这样不容易对队列进行管理。

要指定不同的队列,非常简单,在 dispatch() 后紧接着跟上 onQueue() 方法即可:

Demo::dispatch()->onQueue('emails');

不对啊,我好像没有定义过这个叫 emails 的 queue。嗯,自然需要做出一点改动,在 queue.php 配置文件中的 redis 配置 queue 从 default 改为 {default},这样做的效果就是队列的名称可以从运行的时候动态拿到,而不是写死的。

如果使用 Lumen 框架,那么直接这么写会报错:Call to a member function onQueue() on string。

原因在于 Lumen 的 Job 基类中并没有使用 Illuminate\Foundation\Bus\Dispatchable 这个 trait,而是直接使用 Illuminate\Bus\Queueable 中的 onQueue() 方法。

那么现在就很清楚了,我们的 Job 类使用了 Illuminate\Bus\Queueable 这个 trait,所以需要在 Job 类上调用这个 onQueue() 方法。

$job = new XXXJob();
dispatch($job->onQueue('queue-name'));

当我们在开启队列的时候:

php artisan queue:work --queue=emails

这里指定的队列名 emails 和 dispatch 时指定的队列名保持一致即可。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

参考链接

Laravel 官方文档

PHP 相关文章推荐
php你的验证码安全码?
Jan 02 PHP
php数据库密码的找回的步骤
Jan 12 PHP
基于PHP的简单采集数据入库程序
Jul 30 PHP
PHP的Yii框架的基本使用示例
Aug 21 PHP
PHP比较运算符的详细介绍
Sep 29 PHP
PHP中调用C/C++制作的动态链接库的教程
Mar 10 PHP
php生成带logo二维码方法小结
Apr 08 PHP
php阳历转农历优化版
Aug 08 PHP
php版微信数据统计接口用法示例
Oct 12 PHP
PHP+Ajax无刷新带进度条图片上传示例
Feb 08 PHP
PHP经典实用正则表达式小结
May 04 PHP
php中各种定义变量的方法小结
Oct 18 PHP
php获取ajax的headers方法与内容实例
Dec 27 #PHP
PHP实现求连续子数组最大和问题2种解决方法
Dec 26 #PHP
PHP基于双向链表与排序操作实现的会员排名功能示例
Dec 26 #PHP
thinkphp5 URL和路由的功能详解与实例
Dec 26 #PHP
php-msf源码详解
Dec 25 #PHP
关于 Laravel Redis 多个进程同时取队列问题详解
Dec 25 #PHP
源码分析 Laravel 重复执行同一个队列任务的原因
Dec 25 #PHP
You might like
php 显示指定路径下的图片
2009/10/29 PHP
浅谈php的优缺点
2015/07/14 PHP
PHP实现linux命令tail -f
2016/02/22 PHP
php打包压缩文件之ZipArchive方法用法分析
2016/04/30 PHP
PHP基于IMAP收取邮件的方法示例
2017/08/07 PHP
PHP实现的mysql读写分离操作示例
2018/05/22 PHP
JavaScript对象学习经验整理
2013/10/12 Javascript
jQuery 鼠标经过(hover)事件的延时处理示例
2014/04/14 Javascript
Egret引擎开发指南之运行项目
2014/09/03 Javascript
JQuery判断checkbox是否选中及其它复选框操作方法合集
2015/06/01 Javascript
JavaScript获取对象在页面中位置坐标的方法
2016/02/03 Javascript
浅析jQuery Ajax请求参数和返回数据的处理
2016/02/24 Javascript
Angular外部使用js调用Angular控制器中的函数方法或变量用法示例
2016/08/05 Javascript
原生态js,鼠标按下后,经过了那些单元格的简单实例
2016/08/11 Javascript
详解vue.js组件化开发实践
2016/12/14 Javascript
jQuery EasyUI Draggable拖动组件
2017/03/01 Javascript
ES6 Symbol在对象中的作用实例分析
2020/06/06 Javascript
使用Python的Django框架实现事务交易管理的教程
2015/04/20 Python
python绘图方法实例入门
2015/05/19 Python
Python 记录日志的灵活性和可配置性介绍
2018/02/27 Python
Python聊天室程序(基础版)
2018/04/01 Python
pyqt5对用qt designer设计的窗体实现弹出子窗口的示例
2019/06/19 Python
Python OpenCV调用摄像头检测人脸并截图
2020/08/20 Python
python tkinter实现屏保程序
2019/07/30 Python
python range实例用法分享
2020/02/06 Python
Python chardet库识别编码原理解析
2020/02/18 Python
Django认证系统user对象实现过程解析
2020/03/02 Python
如何基于Python爬取隐秘的角落评论
2020/07/02 Python
Python venv虚拟环境配置过程解析
2020/07/08 Python
HTML5 Canvas旋转动画的2个代码例子(一个旋转的太极图效果)
2014/04/10 HTML / CSS
美国性感女装网站:bebe
2017/03/04 全球购物
Made in Design德国:设计师家具、灯具和装饰
2019/10/31 全球购物
高中军训感言1000字
2014/03/01 职场文书
安全教育月活动总结
2014/05/05 职场文书
车辆工程专业求职信
2014/06/14 职场文书
应届毕业生求职信范文
2014/07/07 职场文书