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 相关文章推荐
Smarty安装配置方法
Apr 10 PHP
php将数据库中的电话号码读取出来并生成图片
Aug 31 PHP
利用ThinkPHP内置的ThinkAjax实现异步传输技术的实现方法
Dec 19 PHP
探讨PHP使用eAccelerator的API开发详解
Jun 09 PHP
深入Apache与Nginx的优缺点比较详解
Jun 17 PHP
php实现微信公众平台账号自定义菜单类
Dec 02 PHP
php实现的IMEI限制的短信验证码发送类
May 05 PHP
PHP实现的构造sql语句类实例
Feb 03 PHP
PHP判断FORM表单或URL参数来的数据是否为整数的方法
Mar 25 PHP
修改Laravel5.3中的路由文件与路径
Aug 10 PHP
php+redis实现商城秒杀功能
Nov 19 PHP
php使用curl获取header检测开启GZip压缩的方法
Aug 15 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的一些小问题
2010/07/03 PHP
php实现文件下载更能介绍
2012/11/23 PHP
PHP获取QQ达人QQ信息的方法
2015/03/05 PHP
php实现SAE上使用storage上传与下载文件的方法
2015/06/29 PHP
php生成二维码
2015/08/10 PHP
基于jquery的一个浮动框(扩展性比较好 )
2010/08/27 Javascript
读jQuery之十一 添加事件核心方法
2011/07/31 Javascript
JS Jquery 遍历,筛选页面元素 自动完成(实现代码)
2013/07/08 Javascript
js判断上传文件类型判断FileUpload文件类型代码
2014/05/20 Javascript
js获取当前日期前七天的方法
2015/02/28 Javascript
JS生成不重复的随机数组的简单实例
2016/07/10 Javascript
使用jQuery操作DOM的方法小结
2017/02/27 Javascript
vue登录路由验证的实现
2017/12/13 Javascript
讲解vue-router之什么是编程式路由
2018/05/28 Javascript
nodejs同步调用获取mysql数据时遇到的大坑
2019/03/02 NodeJs
ES6知识点整理之对象解构赋值应用示例
2019/04/17 Javascript
原生js实现瀑布流效果
2020/03/09 Javascript
如何使用JS console.log()技巧提高工作效率
2020/10/14 Javascript
JS如何操作DOM基于表格动态展示数据
2020/10/15 Javascript
Python卸载模块的方法汇总
2016/06/07 Python
一些常用的Python爬虫技巧汇总
2016/09/28 Python
Python 获得命令行参数的方法(推荐)
2018/01/24 Python
python 字符串和整数的转换方法
2018/06/25 Python
python3格式化字符串 f-string的高级用法(推荐)
2020/03/04 Python
Ramy Brook官网:美国现代女装品牌
2019/06/18 全球购物
什么是封装
2013/03/26 面试题
在校生汽车维修实习自我鉴定
2013/09/19 职场文书
销售经理工作职责范文
2013/12/03 职场文书
致长跑运动员广播稿
2014/01/31 职场文书
中文教师求职信
2014/02/22 职场文书
校园学雷锋活动月总结
2014/03/09 职场文书
雏鹰争章活动总结
2014/05/09 职场文书
交通志愿者活动总结
2014/06/27 职场文书
规范化管理年活动总结
2014/08/29 职场文书
小学毕业典礼演讲稿
2014/09/09 职场文书
公证书
2019/04/17 职场文书