Laravel: Lập lịch tác vụ

• Giới thiệu
• Xác định lịch biểu
  • Lập lịch Lệnh cho Nghệ nhân
  • Lên lịch công việc đã xếp hàng
  • Lập lịch các lệnh Shell
  • Lên lịch tùy chọn tần suất
  • Múi giờ
  • Ngăn chặn việc chồng chéo nhiệm vụ
  • Chạy tác vụ trên một máy chủ
  • Nhiệm vụ nền
  • Chế độ bảo trì
• Chạy Trình lập lịch
  • Chạy bộ lập lịch cục bộ
• Đầu ra nhiệm vụ
• Móc nhiệm vụ

Giới thiệu

Trước đây, bạn có thể đã viết một mục cấu hình cron cho mỗi tác vụ bạn cần lập lịch trên máy chủ của mình. Tuy nhiên, điều này có thể nhanh chóng trở thành vấn đề vì lịch trình tác vụ của bạn không còn trong quyền kiểm soát nguồn và bạn phải SSH vào máy chủ của mình để xem các mục cron hiện có hoặc thêm các mục bổ sung.

Bộ lập lịch lệnh của Laravel cung cấp một cách tiếp cận mới để quản lý các tác vụ đã lên lịch trên máy chủ của bạn. Bộ lập lịch cho phép bạn xác định lịch biểu lệnh một cách trôi chảy và rõ ràng trong chính ứng dụng Laravel của bạn. Khi sử dụng bộ lập lịch, chỉ cần một mục nhập cron duy nhất trên máy chủ của bạn. Lịch trình tác vụ của bạn được xác định trong phương thức app/Console/Kernel.phpcủa tệp schedule. Để giúp bạn bắt đầu, một ví dụ đơn giản được xác định trong phương thức.

Xác định lịch biểu

Bạn có thể xác định tất cả các tác vụ đã lên lịch của mình trong schedulephương thức của App\Console\Kernellớp ứng dụng của bạn . Để bắt đầu, chúng ta hãy xem một ví dụ. Trong ví dụ này, chúng tôi sẽ lên lịch đóng cửa hàng ngày vào lúc nửa đêm. Trong phần đóng, chúng tôi sẽ thực hiện một truy vấn cơ sở dữ liệu để xóa một bảng:

<?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
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        //
    ];

    /**
     * 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 việc lập lịch sử dụng các bao đóng, bạn cũng có thể lập lịch cho các đối tượng bất khả xâm phạm . Các đối tượng có thể xâm nhập là các lớp PHP đơn giản có chứa một __invokephương thức:

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

Nếu bạn muốn xem tổng quan về các tác vụ đã lên lịch của mình và vào lần tiếp theo chúng được lên lịch chạy, bạn có thể sử dụng schedule:listlệnh Artisan:

php artisan schedule:list

Lập lịch Lệnh cho Nghệ nhân

Ngoài việc lên lịch đóng cửa, bạn cũng có thể lên lịch cho lệnh Artisan và lệnh hệ thống. Ví dụ, bạn có thể sử dụng commandphương thức để lập lịch một lệnh Artisan bằng cách sử dụng tên hoặc lớp của lệnh.

Khi lên lịch cho các lệnh Artisan bằng cách sử dụng tên lớp của lệnh, bạn có thể chuyển một mảng các đối số dòng lệnh bổ sung sẽ được cung cấp cho lệnh khi nó được gọi:

use App\Console\Commands\SendEmailsCommand;

$schedule->command('emails:send Taylor --force')->daily();

$schedule->command(SendEmailsCommand::class, ['Taylor', '--force'])->daily();

Lên lịch công việc đã xếp hàng

Các jobphương pháp có thể được sử dụng để sắp xếp một công việc xếp hàng đợi . Phương thức này cung cấp một cách thuận tiện để lập lịch các công việc đã được xếp hàng mà không cần sử dụng callphương thức để xác định các bao đóng để xếp hàng công việc:

use App\Jobs\Heartbeat;

$schedule->job(new Heartbeat)->everyFiveMinutes();

Đối số thứ hai và thứ ba tùy chọn có thể được cung cấp cho jobphương thức chỉ định tên hàng đợi và kết nối hàng đợi sẽ được sử dụng để xếp hàng công việc:

use App\Jobs\Heartbeat;

// Dispatch the job to the "heartbeats" queue on the "sqs" connection...
$schedule->job(new Heartbeat, 'heartbeats', 'sqs')->everyFiveMinutes();

Lập lịch các lệnh Shell

Các execphương pháp có thể được sử dụng để ra lệnh cho hệ điều hành:

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

Lên lịch tùy chọn tần suất

Chúng tôi đã thấy một vài ví dụ về cách bạn có thể định cấu hình một tác vụ để chạy trong các khoảng thời gian được chỉ định. Tuy nhiên, có nhiều tần suất lịch trình tác vụ khác mà bạn có thể chỉ định cho một tác vụ:

Các phương pháp này có thể được kết hợp với các ràng buộc bổ sung để tạo ra các lịch biểu được điều chỉnh tinh vi hơn chỉ chạy vào một số ngày nhất định trong tuần. Ví dụ: bạn có thể lập lịch chạy lệnh hàng tuần vào Thứ Hai:

// Run once per week on Monday at 1 PM...
$schedule->call(function () {
    //
})->weekly()->mondays()->at('13:00');

// Run hourly from 8 AM to 5 PM on weekdays...
$schedule->command('foo')
          ->weekdays()
          ->hourly()
          ->timezone('America/Chicago')
          ->between('8:00', '17:00');

Dưới đây là danh sách các ràng buộc lịch trình bổ sung:

Ràng buộc trong ngày

Các daysphương pháp có thể được sử dụng để hạn chế việc thực hiện một nhiệm vụ để ngày cụ thể trong tuần. Ví dụ: bạn có thể lập lịch để lệnh chạy hàng giờ vào Chủ Nhật và Thứ Tư:

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

Ngoài ra, bạn có thể sử dụng các hằng số có sẵn trên Illuminate\Console\Scheduling\Schedulelớp khi xác định ngày mà một tác vụ sẽ chạy:

use Illuminate\Console\Scheduling\Schedule;

$schedule->command('emails:send')
                ->hourly()
                ->days([Schedule::SUNDAY, Schedule::WEDNESDAY]);

Ràng buộc giữa thời gian

Các betweenphương pháp có thể được sử dụng để hạn chế việc thực hiện một nhiệm vụ căn cứ vào thời gian trong ngày:

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

Tương tự, unlessBetweenphương pháp này có thể được sử dụng để loại trừ việc thực thi một tác vụ trong một khoảng thời gian:

$schedule->command('emails:send')
                    ->hourly()
                    ->unlessBetween('23:00', '4:00');

Ràng buộc Kiểm tra Sự thật

Các whenphương pháp có thể được sử dụng để hạn chế việc thực hiện một nhiệm vụ dựa trên kết quả của một thử nghiệm thật nhất định. Nói cách khác, nếu bao đóng đã cho trả về true, tác vụ sẽ thực thi miễn là không có điều kiện ràng buộc nào khác ngăn tác vụ chạy:

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

Các skipphương pháp có thể được xem như là nghịch đảo của when. Nếu skipphương thức trả về true, tác vụ đã lên lịch sẽ không được thực thi:

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

Khi sử dụng whencác phương thức chuỗi , lệnh đã lên lịch sẽ chỉ thực thi nếu tất cả các whenđiều kiện trả về true.

Các ràng buộc về môi trường

Các environmentsphương pháp có thể được sử dụng để thực hiện nhiệm vụ duy nhất trên môi trường nhất định (theo quy định của APP_ENV biến môi trường ):

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

Múi giờ

Sử dụng timezonephương pháp này, bạn có thể chỉ định rằng thời gian của nhiệm vụ đã lên lịch sẽ được diễn giải trong một múi giờ nhất định:

$schedule->command('report:generate')
         ->timezone('America/New_York')
         ->at('2:00')

Nếu bạn liên tục chỉ định cùng một múi giờ cho tất cả các tác vụ đã lên lịch của mình, bạn có thể muốn xác định một scheduleTimezonephương thức trong App\Console\Kernellớp của mình . Phương thức này sẽ trả về múi giờ mặc định sẽ được chỉ định cho tất cả các tác vụ đã lên lịch:

/**
 * Get the timezone that should be used by default for scheduled events.
 *
 * @return \DateTimeZone|string|null
 */
protected function scheduleTimezone()
{
    return 'America/Chicago';
}

 

Hãy nhớ rằng một số múi giờ sử dụng thời gian tiết kiệm ánh sáng ban ngày. Khi các thay đổi về thời gian tiết kiệm ánh sáng ban ngày xảy ra, tác vụ đã lên lịch của bạn có thể chạy hai lần hoặc thậm chí hoàn toàn không chạy. Vì lý do này, chúng tôi khuyên bạn nên tránh lập lịch múi giờ khi có thể.

 

Ngăn chặn việc chồng chéo nhiệm vụ

Theo mặc định, các tác vụ đã lên lịch sẽ được chạy ngay cả khi phiên bản trước của tác vụ vẫn đang chạy. Để ngăn chặn điều này, bạn có thể sử dụng withoutOverlappingphương pháp:

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

Trong ví dụ này, emails:send lệnh Artisan sẽ được chạy mỗi phút nếu nó chưa chạy. Các withoutOverlappingphương pháp đặc biệt hữu ích nếu bạn có nhiệm vụ mà thay đổi đáng kể trong thời gian thực hiện của họ, ngăn cản bạn từ việc dự đoán một nhiệm vụ nhất định sẽ mất chính xác bao lâu.

Nếu cần, bạn có thể chỉ định bao nhiêu phút phải trôi qua trước khi khóa "không chồng chéo" hết hạn. Theo mặc định, khóa sẽ hết hạn sau 24 giờ:

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

Chạy tác vụ trên một máy chủ

 

Để sử dụng tính năng này, ứng dụng của bạn phải đang sử dụng database, memcached, dynamodb, hoặc redislái xe bộ nhớ cache như tài xế bộ nhớ cache mặc định của ứng dụng của bạn. Ngoài ra, tất cả các máy chủ phải được giao tiếp với cùng một máy chủ bộ đệm trung tâm.

 

Nếu bộ lập lịch của ứng dụng của bạn đang chạy trên nhiều máy chủ, bạn có thể giới hạn công việc đã lên lịch chỉ được thực thi trên một máy chủ. Ví dụ: giả sử bạn có một nhiệm vụ đã lên lịch tạo một báo cáo mới vào mỗi tối thứ Sáu. Nếu bộ lập lịch tác vụ đang chạy trên ba máy chủ công nhân, tác vụ đã lên lịch sẽ chạy trên cả ba máy chủ và tạo báo cáo ba lần. Không tốt!

Để chỉ ra rằng tác vụ chỉ nên chạy trên một máy chủ, hãy sử dụng onOneServerphương pháp khi xác định tác vụ đã lên lịch. Máy chủ đầu tiên nhận được nhiệm vụ sẽ bảo mật một khóa nguyên tử đối với công việc để ngăn các máy chủ khác chạy cùng một tác vụ cùng một lúc:

$schedule->command('report:generate')
                ->fridays()
                ->at('17:00')
                ->onOneServer();

Nhiệm vụ nền

Theo mặc định, nhiều tác vụ được lên lịch cùng lúc sẽ thực hiện tuần tự dựa trên thứ tự chúng được xác định trong schedulephương thức của bạn . Nếu bạn có các tác vụ đang chạy trong thời gian dài, điều này có thể khiến các tác vụ tiếp theo bắt đầu muộn hơn nhiều so với dự kiến. Nếu bạn muốn chạy các tác vụ trong nền để tất cả chúng có thể chạy đồng thời, bạn có thể sử dụng runInBackgroundphương pháp:

$schedule->command('analytics:report')
         ->daily()
         ->runInBackground();

 

Các runInBackgroundphương pháp duy nhất có thể được sử dụng khi lịch công việc thông qua commandvà execphương pháp.

 

Chế độ bảo trì

Các tác vụ đã lên lịch của ứng dụng của bạn sẽ không chạy khi ứng dụng đang ở chế độ bảo trì , vì chúng tôi không muốn các tác vụ của bạn ảnh hưởng đến bất kỳ công việc bảo trì chưa hoàn thành nào mà bạn có thể đang thực hiện trên máy chủ của mình. Tuy nhiên, nếu bạn muốn buộc một tác vụ chạy ngay cả trong chế độ bảo trì, bạn có thể gọi evenInMaintenanceModephương thức khi xác định tác vụ:

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

Chạy Trình lập lịch

Bây giờ chúng ta đã học cách xác định các tác vụ đã lên lịch, hãy thảo luận về cách thực sự chạy chúng trên máy chủ của chúng ta. Lệnh schedule:runArtisan sẽ đánh giá tất cả các tác vụ đã lên lịch của bạn và xác định xem chúng có cần chạy hay không dựa trên thời gian hiện tại của máy chủ.

Vì vậy, khi sử dụng bộ lập lịch của Laravel, chúng tôi chỉ cần thêm một mục nhập cấu hình cron duy nhất vào máy chủ của chúng tôi để chạy schedule:runlệnh mỗi phút. Nếu bạn không biết cách thêm các mục cron vào máy chủ của mình, hãy xem xét sử dụng một dịch vụ như Laravel Forge có thể quản lý các mục cron cho bạn:

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

Chạy bộ lập lịch cục bộ

Thông thường, bạn sẽ không thêm mục nhập cron của bộ lập lịch vào máy phát triển cục bộ của mình. Thay vào đó, bạn có thể sử dụng schedule:worklệnh Artisan. Lệnh này sẽ chạy ở chế độ nền trước và gọi bộ lập lịch mỗi phút cho đến khi bạn kết thúc lệnh:

php artisan schedule:work

Đầu ra nhiệm vụ

Bộ lập lịch Laravel cung cấp một số phương pháp thuận tiện để làm việc với đầu ra được tạo ra bởi các tác vụ đã lên lịch. Trước tiên, bằng cách sử dụng sendOutputTophương pháp này, bạn có thể gửi đầu ra tới một tệp để kiểm tra sau:

$schedule->command('emails:send')
         ->daily()
         ->sendOutputTo($filePath);

Nếu bạn muốn nối kết quả đầu ra vào một tệp nhất định, bạn có thể sử dụng appendOutputTophương pháp:

$schedule->command('emails:send')
         ->daily()
         ->appendOutputTo($filePath);

Sử dụng emailOutputTophương pháp này, bạn có thể gửi email đầu ra đến một địa chỉ email bạn chọn. Trước khi gửi email đầu ra của một nhiệm vụ, bạn nên cấu hình các dịch vụ email của Laravel :

$schedule->command('report:generate')
         ->daily()
         ->sendOutputTo($filePath)
         ->emailOutputTo('taylor@example.com');

Nếu bạn chỉ muốn gửi email đầu ra nếu lệnh Artisan hoặc hệ thống đã lên lịch kết thúc bằng mã thoát khác 0, hãy sử dụng emailOutputOnFailurephương pháp:

$schedule->command('report:generate')
         ->daily()
         ->emailOutputOnFailure('taylor@example.com');

 

Các emailOutputTo, emailOutputOnFailure, sendOutputTo, và appendOutputTophương pháp độc quyền cho commandvà execphương pháp.

 

Móc nhiệm vụ

Sử dụng các phương thức beforevà after, bạn có thể chỉ định mã sẽ được thực thi trước và sau khi tác vụ đã lên lịch được thực thi:

$schedule->command('emails:send')
         ->daily()
         ->before(function () {
             // The task is about to execute...
         })
         ->after(function () {
             // The task has executed...
         });

Các onSuccessvà onFailurephương thức cho phép bạn chỉ định mã sẽ được thực thi nếu tác vụ đã lên lịch thành công hay không thành công. Lỗi chỉ ra rằng lệnh Artisan hoặc hệ thống đã lên lịch đã kết thúc bằng mã thoát khác 0:

$schedule->command('emails:send')
         ->daily()
         ->onSuccess(function () {
             // The task succeeded...
         })
         ->onFailure(function () {
             // The task failed...
         });

Nếu sản lượng có sẵn từ lệnh của bạn, bạn có thể truy cập vào nó trong của bạn after, onSuccesshoặc onFailuremóc theo loại-gợi ý một Illuminate\Support\Stringableví dụ như $outputlập luận của định nghĩa đóng cửa của móc của bạn:

use Illuminate\Support\Stringable;

$schedule->command('emails:send')
         ->daily()
         ->onSuccess(function (Stringable $output) {
             // The task succeeded...
         })
         ->onFailure(function (Stringable $output) {
             // The task failed...
         });

Ping URL

Sử dụng các phương thức pingBeforevà thenPing, bộ lập lịch có thể tự động ping một URL nhất định trước hoặc sau khi một tác vụ được thực thi. Phương pháp này hữu ích để thông báo cho một dịch vụ bên ngoài, chẳng hạn như Envoyer , rằng tác vụ đã lên lịch của bạn đang bắt đầu hoặc đã kết thúc thực thi:

$schedule->command('emails:send')
         ->daily()
         ->pingBefore($url)
         ->thenPing($url);

Các phương thức pingBeforeIfvà chỉ thenPingIfcó thể được sử dụng để ping một URL nhất định nếu một điều kiện nhất định là true:

$schedule->command('emails:send')
         ->daily()
         ->pingBeforeIf($condition, $url)
         ->thenPingIf($condition, $url);

Các phương thức pingOnSuccessvà pingOnFailurecó thể được sử dụng để ping một URL nhất định chỉ khi tác vụ thành công hoặc không thành công. Lỗi chỉ ra rằng lệnh Artisan hoặc hệ thống đã lên lịch đã kết thúc bằng mã thoát khác 0:

$schedule->command('emails:send')
         ->daily()
         ->pingOnSuccess($successUrl)
         ->pingOnFailure($failureUrl);

Tất cả các phương thức ping đều yêu cầu thư viện Guzzle HTTP. Guzzle thường được cài đặt trong tất cả các dự án Laravel mới theo mặc định, nhưng bạn có thể cài đặt Guzzle vào dự án của mình theo cách thủ công bằng trình quản lý gói Composer nếu nó vô tình bị gỡ bỏ:

composer require guzzlehttp/guzzle