Laravel 调度、Laravel Console

在开发 Laravel 应用时，我们经常需要执行一些定时任务或后台任务，例如发送邮件、清理日志、更新数据库等。Laravel 提供了强大的调度功能和命令行工具，使得这些任务的管理和执行变得更加简单和高效。

解决方案

Laravel 的调度功能通过 IlluminateConsoleSchedulingSchedule 类来实现，可以方便地在 AppConsoleKernel 类中定义和管理定时任务。Laravel 还提供了自定义 Artisan 命令的功能，使得我们可以编写自己的命令行工具来执行特定的任务。

定义定时任务

1. 创建任务

我们需要创建一个定时任务。假设我们需要每天凌晨 1 点清理日志文件，可以使用以下步骤：

1. 创建 Artisan 命令：
   使用 Artisan 命令生成一个新的命令类：
   bash
php artisan make:command ClearLogs --command=clear:logs


2. 编写命令逻辑：
   在生成的命令类 app/Console/Commands/ClearLogs.php 中编写具体的逻辑：
   “`php
   namespace AppConsoleCommands;

   use IlluminateConsoleCommand;
   use IlluminateSupportFacadesStorage;

   class ClearLogs extends Command
   {
   protected $signature = ‘clear:logs’;
   protected $description = ‘Clear log files older than 7 days’;

   public function __construct()
   {
       parent::__construct();
   }
   
   public function handle()
   {
       $logFiles = Storage::files('logs');
       foreach ($logFiles as $file) {
           if (Storage::lastModified($file) < now()->subDays(7)) {
               Storage::delete($file);
           }
       }
   
       $this->info('Log files cleared successfully.');
   }
   

   }
   “`

2. 调度任务

接下来，我们需要在 AppConsoleKernel 类中调度这个任务：

1. 编辑 AppConsoleKernel 类：
   打开 app/Console/Kernel.php 文件，在 schedule 方法中添加任务调度：
   “`php
   namespace AppConsole;

   use IlluminateConsoleSchedulingSchedule;
   use IlluminateFoundationConsoleKernel as ConsoleKernel;

   class Kernel extends ConsoleKernel
   {
   protected $commands = [
   AppConsoleCommandsClearLogs::class,
   ];

   protected function schedule(Schedule $schedule)
   {
       $schedule->command('clear:logs')->dailyAt('1:00');
   }
   
   protected function commands()
   {
       $this->load(__DIR__.'/Commands');
   
       require base_path('routes/console.php');
   }
   

   }
   “`

2. 设置 Cron 任务：
   需要在服务器上设置一个 Cron 任务来运行 Laravel 的调度器。编辑 Crontab 文件：
   bash
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1


多种思路

1. 使用 Queue 队列

对于一些耗时较长的任务，可以考虑使用 Laravel 的队列系统。将任务推送到队列中，由队列工作进程异步处理，可以提高应用的响应速度和性能。

1. 创建队列任务：
   bash
php artisan make:job ProcessPodcast


2. 编写队列任务逻辑：
   “`php
   namespace AppJobs;

   use IlluminateBusQueueable;
   use IlluminateContractsQueueShouldQueue;
   use IlluminateFoundationBusDispatchable;
   use IlluminateQueueInteractsWithQueue;
   use IlluminateQueueSerializesModels;

   class ProcessPodcast implements ShouldQueue
   {
   use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

   protected $podcast;
   
   public function __construct($podcast)
   {
       $this->podcast = $podcast;
   }
   
   public function handle()
   {
       // 处理 podcast 的逻辑
   }
   

   }
   “`

3. 调度队列任务：
   php
protected function schedule(Schedule $schedule)
{
$schedule->job(new ProcessPodcast($podcast))->daily();
}


2. 使用 Event 和 Listener

对于一些事件驱动的任务，可以使用 Laravel 的事件系统。当某个事件发生时，触发相应的监听器来执行任务。

1. 创建事件：
   bash
php artisan make:event PodcastProcessed


2. 创建监听器：
   bash
php artisan make:listener SendPodcastNotification --event=PodcastProcessed


3. 编写监听器逻辑：
   “`php
   namespace AppListeners;

   use AppEventsPodcastProcessed;

   class SendPodcastNotification
   {
   public function handle(PodcastProcessed $event)
   {
   // 发送通知的逻辑
   }
   }
   “`

4. 注册事件和监听器：
   在 app/Providers/EventServiceProvider.php 中注册事件和监听器：
   php
protected $listen = [
PodcastProcessed::class => [
SendPodcastNotification::class,
],
];


通过以上方法，我们可以灵活地管理和执行各种定时任务和后台任务，提升 Laravel 应用的效率和可维护性。