l-1

PHP笔记

主页/PHP笔记/PHP问答/框架Laravel/如何在Laravel中安排任务：开发者指南

如何在Laravel中安排任务：开发者指南

Bug编译狮

Bug编译狮

在Laravel中安排任务是一个常见的需求，可以提高应用程序的性能和响应性。以下是如何使用Laravel来安排任务的基本指南。

1. 安装Laravel任务调度

首先，确保你已经安装了Laravel。如果没有安装，可以通过Composer来安装：

composer create-project --prefer-dist laravel/laravel my-laravel-app
cd my-laravel-app

然后，安装Laravel的任务调度包：

php artisan make:command SendEmail

这将创建一个名为SendEmail的命令文件。

2. 编辑任务命令

打开app/Console/Commands/SendEmail.php文件，并编辑它以实现你需要的任务逻辑。例如，你可以添加一个发送电子邮件的功能：

namespace AppConsoleCommands;

use IlluminateConsoleCommand;
use IlluminateSupportFacadesMail;

class SendEmail extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'send:email';

    /**
     * The description of the command.
     *
     * @var string
     */
    protected $description = 'Send an email to a user';

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        // 发送邮件到用户
        Mail::to('example@example.com')->send(new AppMailWelcomeMail());

        return 0;
    }
}

3. 配置任务调度

Laravel的默认任务调度器是通过crontab来执行任务的。你需要在你的服务器上设置cron任务，以便定期运行这些任务。

在Linux上配置cron

  1. 打开终端。

  2. 使用以下命令查看当前用户的cron作业：

    crontab -l

  3. 添加一个新的任务行，例如每天早上8点发送一封邮件。假设你的任务命令位于app/Console/Commands/SendEmail.php，并且它需要一个参数（例如用户ID），你可以这样做：

    0 8 * * * php /path/to/your/project/artisan send:email --user-id=1

  4. 保存并退出编辑器。

在Windows上配置cron

  1. 打开“控制面板” -> “系统和安全” -> “系统” -> “高级系统设置”。
  2. 点击“环境变量”按钮。
  3. 在“系统变量”部分，找到并选择“Path”，然后点击“编辑”。
  4. 添加Laravel项目的根目录到路径列表中。
  5. 关闭所有窗口并重新启动命令提示符或PowerShell。

4. 测试任务

现在，你可以测试任务是否按预期工作。运行以下命令来执行一次任务：

php artisan queue:work

如果一切正常，你应该会看到类似如下的输出：

[2023-04-01 12:34:56] Running [AppConsoleCommandsSendEmail]
Sending email to example@example.com

这样，你就成功地在Laravel中安排了一个任务。根据你的具体需求，你可能还需要调整任务的频率、队列类型等参数。

黑板Bug讲师

黑板Bug讲师

介绍

任务调度是现代Web应用程序开发中的一个重要方面。在Laravel，一个非常流行的PHP框架中，任务调度既强大又简单，允许开发者在应用中流畅且富有表现力地定义命令调度表。本教程将带你了解设置任务调度的过程，并提供一些常见的调度场景示例。

在我们深入探讨Laravel调度器之前，请确保您正在运行版本5.0或更高，因为此版本才引入了任务调度功能。调度器依赖于这个特性。cron一种基于时间的作业调度器在Unix-like操作系统上，因此您的服务器必须具备。cronRunning.

配置任务调度器

调度器的入口点是。app/Console/Kernel.php文件。这个文件包含的内容是：schedule方法，即您将定义所有定时任务的地方。


protected function schedule(Schedule $schedule)
{
  $schedule->command('inspire')->hourly();
}

一旦您定义了您的日程，就需要有一个单一的cron在您的服务器上运行Laravel命令调度器的入口脚本每分钟执行一次。

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

计划任务的类型

定时任务可以是命令、shell 命令或回调函数。以下是一些示例：

匠人命令

计划每日午夜运行一次手艺人命令：


$schedule->command('database:backup')->dailyAt('00:00');

排队命令

如果需要后台执行命令，可以使用队列功能。queue方法：


$schedule->command('email:send --force')->daily()->queue();

执行Shell命令

你可以定义定时运行的shell命令：


$schedule->exec('node /home/path-to-node-script.js')->everyFiveMinutes();

管理日程

Laravel 提供了多种方法来控制定时执行的频率以及决定何时执行的任务约束。

链式调用来执行频繁的任务

方法链可以用于特定频率：


$schedule->command('reports:generate')->weekly()->mondays()->at('15:00');

环境和维护模式约束

预定的任务可以仅在某些环境中运行，或者在您的应用程序不在维护模式时运行：

$schedule->command('email:customers')
         ->daily()
         ->when(fn () => ! app()->isDownForMaintenance());

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

防止任务重叠

Laravel 防止任务重叠默认情况下通过使用 Laravel 的机制实现。withoutOverlapping方法：


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

好的，请提供需要翻译的文本。

要将计划任务的结果输出到文件或通过电子邮件发送，请使用。sendOutputToand 是“并且”的意思。emailOutputTo方法分别：

$schedule->command('report:generate')
         ->daily()
         ->sendOutputTo($filePath);

$schedule->command('report:generate')
         ->daily()
         ->emailOutputTo('[email protected]');

处理失败的预定任务

你可以通过使用定时任务失败时的邮件通知来设置电子邮件通知。pingOnFailure方法，可以与 Laravel 自身的 Envoyer 服务集成。

$schedule->command('report:generate')
         ->daily()
         ->pingOnFailure('https://envoyer.com/heartbeat/url');

正在测试定时命令。

为了测试您的定时任务的执行，您可以手动使用Artisan执行它们：


php artisan schedule:run

在完成本指南后，你应该对如何在Laravel中安排任务有坚实的理解。Laravel的简单调度功能允许您将定时任务管理和定义保持在代码库内，从而实现更清晰和可维护的代码。

结论。

Laravel的任务调度提供了一种强大的解决方案，用于自动化后台任务，如发送电子邮件、数据库备份和甚至ping外部服务。凭借这种优雅且易于使用的功能，Laravel继续成为寻求全面功能但又便于访问的PHP框架的开发者的首选。

长工码奴1523

长工码奴1523

在 Laravel 中安排任务可以使用 Cron Job。Cron Job 是一种自动执行任务的机制，它可以在指定的时间和间隔内运行。以下是如何设置 cron job 的步骤：

  1. 首先，确保你已经安装了 Composer。如果没有，请通过命令行运行 composer global require composer/installers 来安装。

  2. 接下来，打开终端并导航到项目目录。如果还没有创建一个新的 Laravel 项目，你可以使用以下命令来启动一个新的项目：

    php artisan new my-project

  3. 在新的项目文件夹中，进入 Laravel 目录（通常是 vendor/laravel/framework/）。

  4. 运行以下命令来激活 Composer:

    cd vendor/laravel/framework/
composer install

  5. 创建一个新的 cron 命令文件。在 bin/cron.php 文件中添加以下内容:

<?php

namespace AppCommands;

use IlluminateConsoleCommand;
use IlluminateSupportFacadesClock;

class MyCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mycommand';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'A brief description of your command';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        // 添加你的cron task代码在这里
        $now = Clock::now()->format('Y-m-d H:i:s');
        echo "Cron job executed at: $nown";
    }
}

  1. 保存文件并关闭编辑器。现在你应该有一个名为 bin/cron.php 的文件，其中包含了一个简单的 cron 命令。

  2. 确保你具有执行 cron 命令所需的权限。可以通过在终端输入以下命令来验证权限：

    crontab -l

  3. 若要为cron job启用定时器，请按提示完成配置过程。完成后，返回终端并运行以下命令来重启 cron:

    sudo crontab -e

  4. 最后，测试 cron job是否正常运行。在终端中运行以下命令:

    php bin/cron.php

以上就是在 Laravel 中安排任务的基本步骤。请根据需要调整代码以满足您的需求。

最新更新