laravel定時任務用法及原理詳解

【相關推薦：】

應用場景

一個網站系統往往會有很多定時任務要執行。例如推播訂閱訊息，統計相關資料等，Linux一般採用crontab對定時任務進行設定和管理，但是隨著任務的增多，管理定時任務就比較麻煩，容易管理混亂。laravel 對此的解決方案是隻設定一條定時任務，業務中所有的定時任務在這條定時任務進行處理和判斷，實現了在程式碼層面對定時任務的管理。

基本用法

首先設定crontab:

* * * * * php artisan schedule:run >> /dev/null 2>&1

上面的意思是設定定時任務每分鐘執行一次，具體的業務設定，放在了App\Console\Kernel 的 schedule 方法中：

class Kernel extends ConsoleKernel{
    Protected function schedule(Schedule $schedule)
    {
                //綜合資料統計
        $schedule->command('complex_data_log')
        ->everyMinute() //每分鐘執行一次（除此之外還有，每五、十、十五、三十...，不同方法設定的預設時間不同）
        ->withoutOverlapping() //防止重複執行
        ->onOneServer() //在單臺伺服器上跑
        ->runInBackground() //任務後臺執行
        //->appendOutputTo('log_path')//紀錄檔輸出，預設追加
        ->sendOutputTo('log_path'); //紀錄檔輸出，預設覆蓋先前紀錄檔
    }}

原理解析：

基本原理：
schedule:run 這個指定是在vendor\illuminate\console\Scheduling\ScheduleRunCommand 類裡面進行定義的，定義的形式和一般的定時任務相同：

/**
 * The console command name.
 *
 * @var string
 */protected $name = 'schedule:run';

在laravel 解析命令的時候，ScheduleRunCommand 這個類與 Kernel 類裡面的 commands 陣列進行了合併：

	/**
     * Get the commands to add to the application.
     *
     * @return array
     */
    protected function getCommands()
    {
        return array_merge($this->commands, [
            'Illuminate\Console\Scheduling\ScheduleRunCommand',
        ]);
    }

所以 php artisan schedule:run 命令就是框架內建的一個命令。
在命令啟動的時候，會預設找類中的handle 方法進行執行：

/** vendor\illuminate\console\Command.php
 * Execute the console command.
 * 
 * @param  \Symfony\Component\Console\Input\InputInterface  $input
 * @param  \Symfony\Component\Console\Output\OutputInterface  $output
 * @return mixed
 */protected function execute(InputInterface $input, OutputInterface $output){
    return $this->laravel->call([$this, 'handle']);}

php artisan schedule:run 指令會每分鐘掃描Kernel::schedule裡面註冊的所有指令，並判斷該指令是否已經到達執行週期，如果到達，就推入待執行佇列：

    /**
     * Schedule the event to run every minute.
     * 程式碼每分鐘執行一次
     * @return $this
     */
    public function everyMinute()
    {
        return $this->spliceIntoPosition(1, '*');
    }
    
    /**
     * Splice the given value into the given position of the expression.
     * 拼接定時任務表示式
     * @param  int  $position
     * @param  string  $value
     * @return $this
     */
    protected function spliceIntoPosition($position, $value)
    {
        $segments = explode(' ', $this->expression);

        $segments[$position - 1] = $value;

        return $this->cron(implode(' ', $segments));
    }

ScheduleRunCommand::handle函數：

/**
     * Execute the console command.
     * 
     * @return void
     */
    public function handle()
    {
        foreach ($this->schedule->dueEvents($this->laravel) as $event) {
            if (! $event->filtersPass($this->laravel)) {
                continue;
            }
            $this->runEvent($event);
        }
    }

避免任務重疊：
有時候單個定時任務執行時間過長，到了下一個執行時間後，上一次的執行任務還沒有跑完，這個時候，我們可以採用withoutOverlapping（）方法，避免任務重疊。在 withoutOverlapping方法中，給對應的任務加鎖（onOneServer 方法同理）：

public function create(Event $event){
    return $this->cache->store($this->store)->add(
        $event->mutexName(), true, $event->expiresAt
    );}

只有拿到對應的任務鎖，才能執行任務：

/**
     * Run the given event.
     * 執行任務
     * @param  \Illuminate\Contracts\Container\Container  $container
     * @return void
     */
    public function run(Container $container)
    {
        if ($this->withoutOverlapping &&
            ! $this->mutex->create($this)) {
            return;
        }
        
        //判斷是否是後臺執行
        $this->runInBackground
                    ? $this->runCommandInBackground($container)
                    : $this->runCommandInForeground($container);
    }

任務後臺執行：
由於定時任務是依次執行的，上一個任務執行時間過長，會影響下一個任務的執行時間，所以我們可以採用runInBackground方法，將任務放到後臺執行，有點類似於shell 中 & 的作用：

/**
     * Build the command for running the event in the background.
     * 構建定時任務後臺執行語句
     * @param  \Illuminate\Console\Scheduling\Event  $event
     * @return string
     */
    protected function buildBackgroundCommand(Event $event)
    {
        $output = ProcessUtils::escapeArgument($event->output);

        $redirect = $event->shouldAppendOutput ? ' >> ' : ' > ';

        $finished = Application::formatCommandString('schedule:finish').' "'.$event->mutexName().'"';

        return $this->ensureCorrectUser($event,
            '('.$event->command.$redirect.$output.' 2>&1 '.(windows_os() ? '&' : ';').' '.$finished.') > '
            .ProcessUtils::escapeArgument($event->getDefaultOutput()).' 2>&1 &'
        );
    }

其他用法：

除了上面的方法，我們還可以用laravel 的定時任務去呼叫Shell 命令：

$schedule->exec('node /home/forge/script.js')->daily();

也可以使用閉包進行排程：

$schedule->call(function () {
    DB::table('recent_users')->delete();})->daily();

想了解更多使用方法的話，可以檢視laravel 的檔案：

https://laravelacademy.org/post/19517.html

【相關推薦：】

以上就是laravel定時任務用法及原理詳解的詳細內容，更多請關注TW511.COM其它相關文章！