php laravel框架自带命令的实现

Laravel通过Artisan创建自定义命令,使用php artisan make:command SendEmails生成命令类,位于app/Console/Commands目录;在Kernel.php的$commands数组中注册后,可通过php artisan send:emails运行;通过$signature定义参数(如{name}、{name?})和选项(如{–queue}),在handle()中用argument()和option()获取输入,并可用info()、error()输出信息,还可通过schedule()设置定时执行,适用于封装脚本、数据处理等后台任务。

php laravel框架自带命令的实现

在 Laravel 框架中,自定义命令是通过 Artisan 提供的强大功能实现的。Artisan 是 Laravel 自带的命令行工具,允许开发者创建、运行和管理各种命令,比如数据库迁移、队列处理、定时任务等。你也可以轻松创建自己的命令来执行特定的业务逻辑。

创建自定义命令

Laravel 使用 artisan make:command 命令来自动生成一个命令类:

  • 打开终端,进入项目根目录
  • 运行:php artisan make:command SendEmails
  • Laravel 会在 app/Console/Commands 目录下生成 SendEmails.php 文件

生成的类包含两个核心属性和方法:

立即学习PHP免费学习笔记(深入)”;

  • $signature:定义命令名称和参数(如:inspire {name})
  • $description:描述命令用途,用于 php artisan list 显示
  • handle():命令执行时调用的方法,写你的业务逻辑

注册命令

新创建的命令需要注册到 Laravel 的 Artisan 控制台。打开 app/Console/Kernel.php 文件,在 $commands 数组中添加你的命令类:


果酱小店开源电商系统源码

果酱小店开源电商系统源码

果酱小店开源电商系统源码是一个模块化的 B2C 社交电商系统,基于当下最热门的开源技术进行构建,后端基于 PHP 框架 Laravel,前端基于微信小程序,vue.js,实现完全的前后端分离。

果酱小店开源电商系统源码
0


查看详情
果酱小店开源电商系统源码

protected $commands = [
    /App/Console/Commands/SendEmails::class,
];
登录后复制

注册后,就可以在终端使用该命令了。

定义参数与选项

通过 $signature 属性可以灵活设置命令接收的参数和选项:

  • 必需参数inspire {name} —— 执行时必须提供 name 值
  • 可选参数inspire {name?} —— name 可有可无
  • 默认值inspire {name=John}
  • 选项(以 — 开头)inspire {--queue}{--queue=}
  • 获取参数/选项:在 handle() 中使用 $this->argument('name')$this->option('queue')

运行与调试

注册完成后,可通过以下方式运行:

  • php artisan list 查看所有可用命令
  • php artisan send:emails 执行你的命令
  • 可在 handle() 中使用 $this->info('Message')$this->error()$this->line() 输出信息

如果命令需要频繁执行,还可以在 Kernel.phpschedule() 方法中定义定时任务:

$schedule->command('send:emails')->daily();
登录后复制

基本上就这些。Laravel 的命令机制简洁实用,适合封装脚本、定时任务、数据处理等后台操作。

以上就是php laravel框架自带命令的实现的详细内容,更多请关注php中文网其它相关文章!

https://www.php.cn/faq/1812302.html

发表回复

Your email address will not be published. Required fields are marked *