Task Scheduling trong Laravel

Giới thiệu

• Trước đây, có thể bạn đã từng tạo một Cron cho một tác vụ nào đó mà bạn muốn lập lịch để chạy trên server của bạn. Tuy nhiên, sẽ khá phiền phức nếu bạn muốn thay đổi hoặc thêm các schedules mới khi bạn phải SSH đến server của bạn để thực hiện việc này.
• Lệnh scheduler của Laravel cho phép bạn xác định lịch trình của mình một cách dễ dàng ngay trong chính Laravel. Khi sử dụng scheduler, bạn chỉ cần duy nhất một 1 lệnh Cron trên server của bạn. Lịch trình làm việc của bạn sẽ được định nghĩa trong phương thức schedule trên file app/Console/Kernel.php. Để giúp bạn bắt đầu, một ví dụ đơn giản được định nghĩa trong phương thức.
• VD : Với Task Scheduling, bạn có thể dễ dàng định lịch các tác vụ như gửi email hàng ngày, xóa các bản ghi cũ, cập nhật dữ liệu từ các nguồn bên ngoài và nhiều hơn nữa. Laravel cung cấp một cú pháp đơn giản để định nghĩa các tác vụ và lịch trình chúng, đảm bảo rằng các tác vụ được thực hiện đúng thời gian và đúng cách.

1.Khởi tạo Schedules

Bạn có thể khởi tạo các scheduled task trong method schedule trong class App\Console\Kernel. Ví dụ dưới đây là 1 schedule task chạy query xoá table vào mỗi ngày:

<?php
 
namespace App\Console;
 
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
use Illuminate\Support\Facades\DB;
 
class Kernel extends ConsoleKernel
{
    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        $schedule->call(function () {
            DB::table('recent_users')->delete();
        })->daily();
    }
}

Ngoài cách sử dụng Closure khi khai báo schedule, bạn cũng có thể gọi đến một PHP class bất kì mà có chưa __invoke() method:

$schedule->call(new DeleteRecentUsers)->daily();

Để xem tổng quan các Scheduled tasks và thời gian tiếp theo mà nó sẽ chạy bạn có thể sử dụng câu lệnh command sau:

php artisan schedule:list

2. Scheduling cho artisan command

Bạn cũng có thể lên lịch chạy cho các lệnh command bằng cách truyền trực tiếp câu lệnh command hoặc truyền class của command đó:

use App\Console\Commands\SendEmailsCommand;
 
$schedule->command('emails:send Taylor --force')->daily();
 
$schedule->command(SendEmailsCommand::class, ['Taylor', '--force'])->daily();

Khi sử dụng tên class thì các argument bạn muốn truyền vào sẽ phải dưới dạng array

3. Scheduling Queued Jobs

Để lên lịch đưa 1 job nào đó vào hàng đợi queue, bạn dùng tới job method. Ví dụ như sau:

use App\Jobs\Heartbeat;
 
$schedule->job(new Heartbeat)->everyFiveMinutes();

4. Scheduling Shell Commands

Ngoài ra bạn cũng có thể lên lịch cho 1 lệnh command bất kì:

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

5. Các tuỳ chọn custom thời gian Scheduling

Các tuỳ chọn về tần suất thực hiện:

Ngoài các tuỳ chọn trên bạn có thể kết hợp thêm các ràng buộc sau đây để tạo schedule chặt chẽ hơn :

Lên lịch vào các ngày trong tuần : Chạy hàng giờ vào CN và T4

$schedule->command('emails:send')
                ->hourly()
                ->days([0, 3]);

Giữa 1 khoảng thời gian : Chạy hàng giờ trong khoảng thời gian từ 7:00 đến 22:00

$schedule->command('emails:send')
                    ->hourly()
                    ->between('7:00', '22:00');

Dựa vào điều kiện : Khi điều kiện đúng thì thực thi

$schedule->command('emails:send')->daily()->when(function () {
    return true;
});

Dựa vào môi trường

$schedule->command('emails:send')
            ->daily()
            ->environments(['staging', 'production']);

6. Ngăn việc chồng chéo task

Theo mặc định các task đã được lên lịch sẽ chạy mà không cần đợi task trước đó đã chạy xong hay chưa. Nên để ngăn việc đó bạn có thể sử dụng đến method withoutOverlapping:

$schedule->command('emails:send')->withoutOverlapping();

Mặc định sẽ là sau 24h sau khi task trước đó kết thúc thì mới chạy đến task tiếp theo, nên bạn có thể khai báo thêm thời gian tuỳ chọn:

$schedule->command('emails:send')->withoutOverlapping(10);

• Thưc chất việc này sử dụng đến cache để lưu biến lock. Đại loại như khi 1 task được chạy 1 biến lock sẽ được lưu vào cache, sau khi hoàn thành thì biến đó sẽ bị xoá đi. Nếu task tiếp theo chạy sẽ cần check biến lock đó có tồn tại hay không thì mới được chạy tiếp.
• Nên nếu trường hợp có task nào đó bị kẹt thì bạn có thể xoá cache để khắc phục: schedule:clear-cache

Có thể vẫn chạy schedule cả khi ứng dụng trong maintenance mode : $schedule->command('emails:send')->evenInMaintenanceMode();

7. Chạy schedule

Môi trường server: để bắt đầu chạy schedule trên môi trường server bạn sử dụng lệnh với cú pháp như sau:

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

Môi trường local : Chỉ cần chạy câu lệnh artisan sau:

php artisan schedule:work