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&MYSQL服务器配置说明
Oct 09 PHP
COM in PHP (winows only)
Oct 09 PHP
php中用文本文件做数据库的实现方法
Mar 27 PHP
使用迭代器 遍历文件信息的详解
Jun 08 PHP
php对数组排序的简单实例
Dec 25 PHP
php日历制作代码分享
Jan 20 PHP
十幅图告诉你什么是PHP引用
Feb 22 PHP
PHP数组相关函数汇总
Mar 24 PHP
PHP简单检测网址是否能够正常打开的方法
Sep 04 PHP
PHP批量删除jQuery操作
Jul 23 PHP
分享8个Laravel模型时间戳使用技巧小结
Feb 12 PHP
基于PHP+Mysql简单实现了图书购物车系统的实例详解
Aug 06 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
杏林同学录(七)
2006/10/09 PHP
php在线代理转向代码
2012/05/05 PHP
php表单文件iframe异步上传实例讲解
2017/07/26 PHP
Laravel如何自定义command命令浅析
2019/03/23 PHP
js的alert弹出框出现乱码解决方案
2013/09/02 Javascript
css样式标签和js语法属性区别
2013/11/06 Javascript
多种方法实现load加载完成后把图片一次性显示出来
2014/02/19 Javascript
基于jquery实现的文字向上跑动类似跑马灯的效果
2014/06/17 Javascript
javascript实现的右下角弹窗实例
2015/04/24 Javascript
AngularJS基础 ng-href 指令用法
2016/08/01 Javascript
浅谈Angularjs link和compile的使用区别
2016/10/21 Javascript
jQuery实现扑克正反面翻牌效果
2017/03/10 Javascript
基于JavaScript实现数码时钟效果
2020/03/30 Javascript
基于ES6作用域和解构赋值详解
2017/11/03 Javascript
如何让你的JS代码更好看易读
2017/12/01 Javascript
JS设计模式之命令模式概念与用法分析
2018/02/06 Javascript
Vue.js实现数据响应的方法
2018/08/13 Javascript
[01:06:19]DOTA2-DPC中国联赛定级赛 LBZS vs SAG BO3第二场 1月8日
2021/03/11 DOTA
利用Python演示数型数据结构的教程
2015/04/03 Python
Python远程桌面协议RDPY安装使用介绍
2015/04/15 Python
python中引用与复制用法实例分析
2015/06/04 Python
Python读写文件方法总结
2015/06/09 Python
Python中属性和描述符的正确使用
2016/08/23 Python
基于python神经卷积网络的人脸识别
2018/05/24 Python
基于Python实现剪切板实时监控方法解析
2019/09/11 Python
Django 解决开发自定义抛出异常的问题
2020/05/21 Python
详解tf.device()指定tensorflow运行的GPU或CPU设备实现
2021/02/20 Python
韩国著名的在线综合购物网站:Akmall
2016/08/07 全球购物
美国香薰蜡烛品牌:PADDYWAX
2018/10/06 全球购物
重阳节登山活动方案
2014/02/03 职场文书
语文教学感言
2014/02/06 职场文书
学术会议主持词
2014/03/17 职场文书
学校党的群众路线教育实践活动领导班子对照检查材料
2014/09/25 职场文书
党的群众路线教育实践活动批评与自我批评发言稿
2014/10/16 职场文书
幼儿园六一儿童节演讲稿
2015/03/19 职场文书
详解Python为什么不用设计模式
2021/06/24 Python