使用 php artisan make:command User:sync 生成命令骨架,Laravel 自动注册并设置签名;在 handle() 中用 $this->argument() 和 $this->option() 安全读参,注意判空与退出码返回。

怎么生成一个可运行的 Artisan 命令
直接用 php artisan make:command 生成骨架,这是最稳妥的起点。Laravel 会自动注册命令、设置签名、注入依赖,省得手动改 app/Console/Commands/ 和 app/Console/Kernel.php。
- 命令名带冒号更规范,比如
php artisan make:command User:sync,生成的类名是UserSyncCommand,签名默认为user:sync - 别手写类文件后忘了在
app/Console/Kernel.php的$commands数组里加引用——Laravel 9+ 默认用自动发现(commands目录下所有类自动加载),但如果你把命令放错目录(比如丢进app/根目录),它就根本不会被识别 - 生成后立刻跑
php artisan list确认是否出现在命令列表里;没出现,八成是命名空间错、类没继承Illuminate\Console\Command,或 PHP 文件末尾多了不可见字符
handle() 里怎么安全读取参数和选项
别直接用 $argv 或全局变量,全靠 Artisan 自带的 $this->argument() 和 $this->option()——它们已做类型校验、必填提示、默认值填充。
- 定义参数时,在
protected $signature里写清楚:比如user:sync {user_id? : 用户 ID} {--force : 强制同步},其中{user_id?}表示可选参数,{--force}是布尔开关选项 - 读取时别漏判空:
$userId = $this->argument('user_id');返回null而不是空字符串,如果后续要查数据库,得先if (!$userId) { $this->error('请提供 user_id'); return 1; } - 选项值不传就是
false,传了--force就是true,传--force=1会变成字符串"1"——除非你显式声明{--force=},否则不要依赖等号赋值
命令里调用模型或服务为什么报错 Class not found
常见于在 handle() 里直接 new 一个没引入命名空间的类,或用了未加载的 Facade。Artisan 命令运行在 console 环境,但 autoloading 和 service container 并不因此失效——问题出在写法上。
Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。
- 确保顶部有
use App\Models\User;,而不是靠 IDE 自动补全漏掉——控制台命令不走 Web 请求栈,不会触发某些自动加载钩子 - 别在
__construct()里做重操作(如 DB 查询),因为 Artisan 在解析命令签名阶段就会实例化类;想延迟执行,把逻辑全挪到handle() - 要用门面(如
Cache、Log)没问题,但别用request()或session()——console 环境没 request 对象,调用会抛RuntimeException
怎么让命令支持进度条和交互式确认
Artisan 内置了 ProgressBar 和 ask()/confirm(),不用额外装包,但得注意使用时机和上下文。
- 进度条必须在
handle()中创建:$bar = $this->output->createProgressBar($total);,然后循环中调$bar->advance();,最后$bar->finish();;提前 finish 或漏 finish 都会导致终端显示错乱 -
$this->confirm('确定要删除?')返回布尔值,但用户按 Ctrl+C 会中断并抛异常,建议包一层try/catch捕获Symfony\Component\Console\Exception\RuntimeException - 批量操作前加
--dry-run选项是好习惯:if ($this->option('dry-run')) { $this->info('跳过实际执行'); return 0; },避免误删数据
最常被忽略的是命令退出码:成功返回 0,失败返回非 0(如 1)。别只靠 $this->error() 打印就完事,记得在出错分支末尾写 return 1;,否则 CI 流水线可能误判任务成功。










