Solution for executing long-term tasks in the background

Problems solved:

● It takes a long time

● Each end cannot retrieve the progress of relevant tasks for feedback

● Customization Feedback results after the task

● Please tell me, how does Laravel allow the program to execute code in the background for a long time?

Process Brief

● Use asynchronous queue to perform related tasks

● Use helper method to create task/progress

● Feedback related progress through the exposed interface

The source code of the assistant class is as follows

<?php
// +----------------------------------------------------------------------
// | Do what we can do
// +----------------------------------------------------------------------
// | Date  : 2019/9/11 - 9:25 AM
// +----------------------------------------------------------------------
// | Author: seebyyu <seebyyu@gmail.com> :)
// +----------------------------------------------------------------------
namespace App\Lib\Support;
trait MissionFrom
{
    /**
     * 标记前缀 模块名称#业务模块#板块标记
     *
     * @var string
     */
    public $prefix = &#39;school:task:default&#39;;
    /**
     * 任务详情
     * @var array
     */
    public $original = [];
    /**
     * Redis 链接
     *
     * The Redis factory implementation.
     *
     * @var \Illuminate\Redis\Connections\Connection
     */
    protected $redis;
    /**
     * 任务存在有效期
     *
     * @var int
     */
    protected $seconds = 600;
    /**
     * 创建任务
     *
     * @param string $sheet
     * @param int $len 总长度
     * @return string
     */
    public function createTask($sheet = &#39;&#39;, $len = 100)
    {
        $sheet = $sheet ?: $this->sheet();
        $detail = [
            //  开始时间
            &#39;begin&#39; => time(),
            //  标记号
            &#39;sheet&#39; => $sheet,
            //  总长度
            &#39;total_len&#39; => $len,
            //  当前长度
            &#39;schedule&#39; => 0
        ];
        //  主体信息
        $this->connect()->setex($this->prefix. &#39;:&#39;. $sheet, $this->seconds, serialize($detail));
        //  初始化任务进度
        $this->connect()->setex($this->prefix. &#39;:schedule:&#39;. $sheet, $this->seconds, 1);
        return $sheet;
    }
    /**
     * 设置任务内容
     *
     * @param $sheet
     * @param $value
     * @return MissionFrom
     */
    public function setTaskContent($sheet, $value)
    {
        if( $this->connect()->exists($this->prefix. &#39;:&#39;. $sheet)){
            $this->connect()->setex($this->prefix. &#39;:content:&#39;. $sheet, $this->seconds, serialize($value));
        }
        return $this;
    }
    /**
     * 获取任务内容
     *
     * @param $sheet
     * @return MissionFrom
     */
    public function getTaskContent($sheet)
    {
        return empty($data = $this->connect()->get($this->prefix. &#39;:content:&#39;. $sheet)) ? null : unserialize($data);
    }
    /**
     * 设置任务前缀
     *
     * @param string $prefix
     * @return $this
     */
    public function setPrefix($prefix = &#39;&#39;)
    {
        $this->prefix = &#39;school:task:&#39;. ($prefix ?: &#39;default&#39;);
        return $this;
    }
    /**
     * 任务详情
     *
     * @param string $sheet
     * @return array
     */
    public function taskDetail($sheet = &#39;&#39;)
    {
        $detail = $this->connect()->get($key = ($this->prefix. &#39;:&#39;. $sheet));
        if( !empty($detail)){
            $this->original = array_merge( unserialize($detail), [
                &#39;schedule&#39; => (int)$this->getSchedule($sheet),
                &#39;content&#39; => $this->getTaskContent($sheet)
            ]);
        }
        return (array) $this->original;
    }
    /**
     * 进度递增
     *
     * @param string $sheet
     * @return int
     */
    public function increments($sheet = &#39;&#39;)
    {
        $inc = 0;
        if( !empty($detail = $this->taskDetail($sheet)) &&
            $detail[&#39;schedule&#39;] < $detail[&#39;total_len&#39;]){
            $inc = $this->connect()->incr($this->prefix. &#39;:schedule:&#39;. $sheet);
        }
        return $detail[&#39;schedule&#39;] ?? $inc;
    }
    /**
     * 获取任务进度
     *
     * @param string $sheet
     * @return string
     */
    public function getSchedule($sheet = &#39;&#39;)
    {
        return $this->connect()->exists($key = ($this->prefix. &#39;:schedule:&#39;. $sheet)) ? $this->connect()->get($key) : 0;
    }
    /**
     * 生成任务单号
     */
    private static function sheet()
    {
        return md5(\Hash::make(date(&#39;YmdHis&#39;)));
    }
    /**
     * 所有任务进度
     *
     * @return array
     */
    public function taskAll()
    {
        $task_group_list = [];
        //  分组
        foreach( (array)$this->connect()->keys(&#39;school:task:*&#39;) as $task) {
            if( count($task_item = explode(&#39;:&#39;, $task)) == 4){
                list($model, $model_name, $business, $key) = $task_item;
                $task_group_list[$business][] = $this->setPrefix($business)->taskDetail($key);
            }
        }
        return $task_group_list;
    }
    /**
     * @return \Illuminate\Foundation\Application|mixed
     */
    public function connect()
    {
        return app(&#39;redis.connection&#39;);
    }
}

The calling process is as follows

<?php
namespace App\Jobs;
use App\Lib\Support\MissionFrom;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
/**
 * Excel 导入
 *
 * Class importExcel
 * @package App\Jobs
 */
class importExcel implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels, MissionFrom;
    /**
     * 任务运行的超时时间。
     *
     * @var int
     */
    public $timeout = 300;
    /**
     * @var string
     */
    public $sheet;
    /**
     * importExcel constructor.
     * @param $sheet
     */
    public function __construct($sheet = &#39;&#39;)
    {
        $this->sheet = $sheet;
    }
    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        //  自定义业务前缀
        $prefix = &#39;export_students&#39;;
        //  创建任务进度
        $this->sheet = $this->setPrefix($prefix)->createTask($this->sheet, 20);
        //  开始执行任务
        echo &#39;任务开始:&#39;. $this->sheet. "\n";
        for ($i = 1; $i <= 20; $i++){
            //  延时模拟长时间任务
            sleep(rand(1, 2));
            //  进度 +1
            echo &#39;任务进度:&#39;. ($this->setPrefix($prefix)->increments($this->sheet)). "\n";
        }
        //  追加结果 任何类型
        $this->setPrefix($prefix)->setTaskContent($this->sheet, [
            &#39;url&#39; => &#39;http://www.baidu.com&#39;
        ]);
    }
}

Controller Part

....
    /**
     * 学校pc端后台任务进度列表
     *
     * @return array
     */
    public function duties()
    {
        if( empty($key = request('key'))){
            $key = md5(\Hash::make(date('YmdHis')));
            //  创建任务
            $this->dispatch(new importExcel($key));
            return $key;
        }else{
            //  查询单条任务信息
            //  $this->setPrefix('export_students')->taskDetail($key);
            return success(['data' => array_merge([
                //  导出每餐记录列表
                'meal_records' => [],
                //  每日记录列表
                'daily_records' => [],
                //  其他记录列表
                'other_records' => [],
                //  照片库
                'photo_gallery' => [],
                //  采购计划
                'purchasing_plan' => [],
                //  凭证记录
                'voucher_records' => [],
                //  食材库
                'ingredient_records' => [],
                //  导入学生
                'import_students' => [],
                //  导出学生
                'export_students' => []
            ], $this->taskAll())]);
        }
    }
    ....

The effect achieved

Notes

QUEUE_DRIVER=sync changed to redis

It is strongly recommended to install horizon during the development stage. Laravel’s built-in error reporting exception is something I can’t complain about, and it is inconvenient for troubleshooting.

Queue troubleshooting reference:

Laravel Queue: How to view queue error information?

Finally

● The business above the code is completely written based on my own project, and copying it directly may cause incompatibility.

● Sharing is more of a solution idea, I hope it can help other friends in the future.

● If you have any optimization ideas or suggestions for the code, you can also discuss it.

For more Laravel related technical articles, please visit the Laravel Framework Getting Started Tutorial column to learn!

The above is the detailed content of Solution for executing long-term tasks in the background. For more information, please follow other related articles on the PHP Chinese website!