為什麼 Laravel 會重複執行同一個佇列任務？

紙牌屋弗蘭克發表於2017-12-24
Laravel佇列

（原文連結：https://blog.tanteng.me/2017/12/laravel-qu...）

在 Laravel 中使用 Redis 處理佇列任務，框架提供的功能非常強大，但是最近遇到一個問題，就是發現一個任務被多次執行，這是為什麼呢？

先說原因：因為在 Laravel 中如果一個佇列（任務）執行時間大於 60 秒，就會被認為執行失敗並重新加入佇列中，這樣就會導致重複執行同一個任務。

這個任務的邏輯就是給使用者推送內容，需要根據佇列內容取出使用者並遍歷，透過請求後端 HTTP 介面傳送。比如有 10000 個使用者，在使用者數量多或介面處理速度沒那麼快的情況下，執行時間肯定會大於 60 秒，於是這個任務就被重新加入佇列。情況更糟糕一點，前面的任務如果都沒有在 60 秒執行完，就都會重新加入佇列，這樣同一個任務就不止重複執行一次了，而是多次。

下面從 Laravel 原始碼找一下罪魁禍首。

原始碼檔案：vendor/laravel/framework/src/Illuminate/Queue/RedisQueue.php

/**
 * The expiration time of a job.
 *
 * @var int|null
 */
protected $expire = 60;

這個 $expire 成員變數是一個固定的值，Laravel 認為一個佇列再怎麼 60 秒也該執行完了吧。取佇列方法：

public function pop($queue = null)
{
    $original = $queue ?: $this->default;

    $queue = $this->getQueue($queue);

    $this->migrateExpiredJobs($queue.':delayed', $queue);

    if (! is_null($this->expire)) {
        $this->migrateExpiredJobs($queue.':reserved', $queue);
    }

    list($job, $reserved) = $this->getConnection()->eval(
        LuaScripts::pop(), 2, $queue, $queue.':reserved', $this->getTime() + $this->expire
    );

    if ($reserved) {
        return new RedisJob($this->container, $this, $job, $reserved, $original);
    }
}

取佇列有幾步操作，因為佇列執行失敗，或執行超時等都會放入另外的集合儲存起來，以便重試，過程如下：

1.把因執行失敗的佇列從 delayed 集合重新 rpush 到當前執行的佇列中。

2.把因執行超時的佇列從 reserved 集合重新 rpush 到當前執行的佇列中。

3.然後才是從佇列中取任務開始執行，同時把佇列放入 reserved 的有序集合。

這裡使用了 eval 命令執行這個過程，用到了幾個 lua 指令碼。

從要執行的佇列中取任務：

local job = redis.call('lpop', KEYS[1])
local reserved = false
if(job ~= false) then
    reserved = cjson.decode(job)
    reserved['attempts'] = reserved['attempts'] + 1
    reserved = cjson.encode(reserved)
    redis.call('zadd', KEYS[2], ARGV[1], reserved)
end
return {job, reserved}

可以看到 Laravel 在取 Redis 要執行的佇列的時候，同時會放一份到一個有序集合中，並使用過期時間戳作為分值。

只有當這個任務完成後，再把有序集合中這個任務移除。從這個有序集合移除佇列的程式碼就省略，我們看一下 Laravel 如何處理執行時間大於 60 秒的佇列。

也就是這段 lua 指令碼執行的操作：

local val = redis.call('zrangebyscore', KEYS[1], '-inf', ARGV[1])
if(next(val) ~= nil) then
    redis.call('zremrangebyrank', KEYS[1], 0, #val - 1)
    for i = 1, #val, 100 do
        redis.call('rpush', KEYS[2], unpack(val, i, math.min(i+99, #val)))
    end
end
return true

這裡 zrangebyscore 找出分值從無限小到當前時間戳的元素，也就是 60 秒之前加入到集合的任務，然後透過 zremrangebyrank 從集合移除這些元素並 rpush 到佇列中。

看到這裡應該就恍然大悟了。

如果一個佇列 60 秒沒執行完，那麼程式在取佇列的時候從 reserved 集合中把這些任務又重新 rpush 到佇列中。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章