Laravel Artisan命令行工具：快速开发 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

Laravel Artisan：你的代码魔法棒，咻咻咻地加速开发！🚀

各位听众朋友们，大家好！我是你们的老朋友，代码界的段子手，今天咱们不聊风花雪月，聊点实在的——Laravel Artisan。

说到Laravel，那可是PHP界的一颗璀璨明星，以其优雅的语法、强大的功能和友好的开发者体验，俘获了无数程序员的心。而Artisan，就是Laravel为你精心准备的“代码魔法棒”，挥一挥，就能变出各种代码结构、数据库迁移、甚至还能帮你执行定时任务，简直就是开发效率的倍增器！

今天，咱们就来好好扒一扒Artisan的皮，看看这根魔法棒到底有多神奇，以及如何才能把它玩得溜到飞起！

一、Artisan：啥是Artisan？为啥我们需要它？

想象一下，你是一位辛勤的建筑工人，每天都要从头开始砌砖、和水泥，重复着枯燥乏味的工作。突然有一天，你得到了一台自动化砌砖机，只需要简单设置，就能高效地完成大部分重复性工作，你是不是要乐开花了？🎉

Artisan就相当于Laravel开发中的“自动化砌砖机”。它是一个基于Symfony Console组件构建的命令行工具，预置了大量的命令，可以帮你完成各种重复性、繁琐的任务，比如：

创建文件： 控制器、模型、迁移文件，一键生成，告别手动创建的痛苦。
数据库操作： 迁移、种子数据填充，轻松管理数据库结构和数据。
缓存管理： 清除缓存、生成缓存，让你的应用飞起来。
路由管理： 查看路由列表，了解应用的路由结构。
定时任务： 调度任务，让你的应用自动执行各种计划任务。
队列处理： 管理队列，让你的应用异步处理耗时任务。

总而言之，有了Artisan，你可以专注于核心业务逻辑的开发，而把那些重复性的工作交给它来处理，从而大大提高开发效率，节省宝贵的时间。

二、Artisan：基础入门，魔法棒怎么用？

要使用Artisan，首先你需要打开你的命令行终端，然后切换到你的Laravel项目根目录下。接下来，就可以使用php artisan命令来调用Artisan了。

php artisan list：查看所有可用的命令

这是Artisan最常用的命令之一，它可以列出所有可用的命令，并简要说明每个命令的功能。就像一个巨大的菜单，让你一览无遗地了解Artisan的能力。
```
php artisan list
```
php artisan help <command>：查看特定命令的帮助信息

如果你对某个命令的功能不太了解，可以使用help命令来查看该命令的详细帮助信息，包括命令的参数、选项和使用示例。就像一本使用说明书，告诉你如何正确地使用这根魔法棒。
```
php artisan help make:controller
```
php artisan --version：查看Laravel版本

这个命令可以查看你的Laravel版本号，确保你使用的Artisan命令与你的Laravel版本兼容。
```
php artisan --version
```

三、Artisan：常用命令详解，变出你的代码王国！

接下来，咱们就来详细了解一些常用的Artisan命令，看看它们是如何帮你变出代码王国的。

1. 代码生成类命令 (Make Commands)

这些命令可以帮你快速生成各种代码文件，例如控制器、模型、迁移文件等等。

命令	功能	示例
`make:controller`	创建一个新的控制器文件	`php artisan make:controller UserController`
`make:model`	创建一个新的模型文件	`php artisan make:model User`
`make:migration`	创建一个新的数据库迁移文件	`php artisan make:migration create_users_table`
`make:seeder`	创建一个新的数据库种子文件	`php artisan make:seeder UserSeeder`
`make:factory`	创建一个新的模型工厂文件	`php artisan make:factory UserFactory`
`make:request`	创建一个新的表单请求验证类文件	`php artisan make:request StoreUserRequest`
`make:command`	创建一个新的Artisan命令	`php artisan make:command SendEmails`
`make:event`	创建一个新的事件类文件	`php artisan make:event UserRegistered`
`make:listener`	创建一个新的事件监听器类文件	`php artisan make:listener SendWelcomeEmail --event=UserRegistered`
`make:policy`	创建一个新的授权策略类文件	`php artisan make:policy UserPolicy`
`make:resource`	创建一个新的资源控制器或资源集合类文件	`php artisan make:resource Photo`
`make:mail`	创建一个新的邮件类文件	`php artisan make:mail WelcomeEmail`
`make:notification`	创建一个新的通知类文件	`php artisan make:notification InvoicePaid`
`make:middleware`	创建一个新的中间件类文件	`php artisan make:middleware CheckAge`

举个例子：

你想创建一个用户控制器，只需要执行以下命令：

php artisan make:controller UserController

Artisan就会在app/Http/Controllers目录下生成一个名为UserController.php的文件，里面已经包含了基本的控制器结构。你只需要在里面添加你的业务逻辑即可，是不是很方便？

2. 数据库迁移类命令 (Migration Commands)

这些命令可以帮你管理数据库结构，包括创建表、修改表结构、删除表等等。

命令	功能	示例
`migrate`	运行所有未执行的迁移文件	`php artisan migrate`
`migrate:fresh`	删除所有表并重新运行所有迁移文件	`php artisan migrate:fresh`
`migrate:refresh`	回滚所有迁移并重新运行所有迁移文件	`php artisan migrate:refresh`
`migrate:rollback`	回滚最后一次迁移操作	`php artisan migrate:rollback`
`migrate:reset`	回滚所有迁移操作	`php artisan migrate:reset`
`migrate:status`	查看所有迁移文件的状态	`php artisan migrate:status`

举个例子：

你想创建一个users表，首先你需要使用make:migration命令创建一个迁移文件：

php artisan make:migration create_users_table

Artisan会在database/migrations目录下生成一个类似于2023_10_27_100000_create_users_table.php的文件。然后，你需要在该文件中定义up()方法和down()方法，分别用于创建表和删除表。

<?php

use IlluminateDatabaseMigrationsMigration;
use IlluminateDatabaseSchemaBlueprint;
use IlluminateSupportFacadesSchema;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

最后，执行migrate命令，就可以将users表创建到数据库中了：

php artisan migrate

3. 缓存管理类命令 (Cache Commands)

这些命令可以帮你管理应用的缓存，包括清除缓存、生成缓存等等。

命令	功能	示例
`cache:clear`	清除应用缓存	`php artisan cache:clear`
`cache:forget`	从缓存中移除指定项	`php artisan cache:forget key`
`config:cache`	为生产环境创建一个配置缓存文件	`php artisan config:cache`
`config:clear`	移除配置缓存文件	`php artisan config:clear`
`route:cache`	为生产环境创建一个路由缓存文件	`php artisan route:cache`
`route:clear`	移除路由缓存文件	`php artisan route:clear`
`view:cache`	预编译所有的 Blade 模板文件，提高视图渲染性能	`php artisan view:cache`
`view:clear`	清除编译的 Blade 模板文件	`php artisan view:clear`

4. 路由管理类命令 (Route Commands)

这些命令可以帮你管理应用的路由，包括查看路由列表、生成路由缓存等等。

命令	功能	示例
`route:list`	列出所有已注册的路由	`php artisan route:list`
`route:cache`	为生产环境创建一个路由缓存文件	`php artisan route:cache`
`route:clear`	移除路由缓存文件	`php artisan route:clear`

5. 队列管理类命令 (Queue Commands)

这些命令可以帮你管理应用的队列，包括启动队列监听器、重启队列监听器等等。

命令	功能	示例
`queue:work`	处理队列中的单个任务	`php artisan queue:work`
`queue:listen`	监听指定的队列，并在任务入队时自动处理任务	`php artisan queue:listen`
`queue:restart`	重启队列监听器	`php artisan queue:restart`
`queue:retry`	重新尝试失败的任务	`php artisan queue:retry {job_id}`
`queue:failed`	列出所有失败的任务	`php artisan queue:failed`
`queue:flush`	清除所有失败的任务	`php artisan queue:flush`
`queue:table`	创建队列迁移文件	`php artisan queue:table`

6. 定时任务管理类命令 (Schedule Commands)

这些命令可以帮你管理应用的定时任务，包括运行定时任务等等。

命令	功能	示例
`schedule:run`	运行所有到期的调度任务	`php artisan schedule:run`
`schedule:list`	列出所有定义的调度任务及其下次运行时间	`php artisan schedule:list`

7. 其他常用命令

命令	功能	示例
`db:seed`	填充数据库种子数据	`php artisan db:seed`
`optimize`	优化应用以获得更好的性能	`php artisan optimize`
`storage:link`	创建一个指向 `public/storage` 的符号链接	`php artisan storage:link`
`event:generate`	生成应用缺失的事件和监听器	`php artisan event:generate`

四、Artisan：自定义命令，打造专属魔法棒！

Artisan的强大之处不仅仅在于它预置的命令，更在于你可以自定义命令，打造属于你自己的专属魔法棒！

1. 创建自定义命令

使用make:command命令创建一个新的Artisan命令：

php artisan make:command MyCustomCommand

Artisan会在app/Console/Commands目录下生成一个名为MyCustomCommand.php的文件。

2. 定义命令的签名和描述

在MyCustomCommand.php文件中，你需要定义命令的$signature和$description属性。$signature属性用于定义命令的签名，包括命令的名称、参数和选项。$description属性用于定义命令的描述，用于在php artisan list命令中显示。

<?php

namespace AppConsoleCommands;

use IlluminateConsoleCommand;

class MyCustomCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'my:custom-command {name?} {--option=default}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'My custom command description';

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

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        $name = $this->argument('name');
        $option = $this->option('option');

        $this->info("Hello, {$name}! Option value: {$option}");

        return 0;
    }
}

3. 注册自定义命令

你需要将自定义命令注册到app/Console/Kernel.php文件的$commands数组中。

<?php

namespace AppConsole;

use IlluminateConsoleSchedulingSchedule;
use IlluminateFoundationConsoleKernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        AppConsoleCommandsMyCustomCommand::class, // 注册自定义命令
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  IlluminateConsoleSchedulingSchedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        //
    }

    /**
     * Register the commands for the application.
     *
     * @return void
     */
    protected function commands()
    {
        $this->load(__DIR__.'/Commands');

        require base_path('routes/console.php');
    }
}

4. 使用自定义命令

现在，你就可以使用自定义命令了：

php artisan my:custom-command John --option=value

五、Artisan：高级技巧，让魔法棒更强大！

使用选项 (Options) 和参数 (Arguments) 灵活控制命令的行为

在定义命令签名时，可以使用选项和参数来灵活控制命令的行为。选项使用--开头，参数使用{}包裹。
使用 $this->info(), $this->comment(), $this->error() 等方法输出不同类型的消息

这些方法可以让你在命令行中输出不同类型的消息，例如信息、注释、错误等等，方便用户了解命令的执行情况。
使用 $this->confirm() 方法进行确认操作

这个方法可以让你在执行敏感操作之前，先让用户确认是否继续执行，避免误操作。
使用 $this->choice() 方法让用户选择选项

这个方法可以让你在命令行中显示一个选项列表，让用户选择其中一个选项。

六、总结：Artisan，你的开发好伙伴！

Artisan是Laravel开发中不可或缺的一部分，它可以帮助你快速生成代码、管理数据库、执行定时任务等等，从而大大提高开发效率。掌握Artisan的使用技巧，就像拥有了一根神奇的魔法棒，可以让你咻咻咻地加速开发！

希望今天的分享对大家有所帮助，让我们一起利用Artisan，打造更高效、更优雅的Laravel应用！🚀

最后，祝大家编码愉快！下次再见！👋

Laravel Artisan：你的代码魔法棒，咻咻咻地加速开发！🚀

发表回复 取消回复

发表回复取消回复