Laravel 创建命令教程 - PHP

本教程将介绍如何在 Laravel 中创建自定义的 Artisan 命令。

1. 创建命令

在 Laravel 中，你可以通过 Artisan 命令来创建自定义命令。

要创建命令，你需要使用 make:command Artisan 命令。该命令将在 app/Console/Commands 目录下生成一个命令文件。

php artisan make:command YourCommandName

上面的命令将创建一个名为 YourCommandName 的命令文件。你需要将 handle 方法中的命令逻辑放入该文件中。

2. 添加代码逻辑

在该命令文件中，你需要定义命令名称、描述和处理逻辑。

以下是一个简单命令的示例：

namespace App\Console\Commands;

use Illuminate\Console\Command;

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

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

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        // Your command code logic here
        $this->info('Your command executed successfully!');
    }
}

在上面的示例中，我们定义了一个名为 YourCommandName 的命令。我们通过 $signature 属性来定义了命令的名称，即 yourcommandname。我们还通过 $description 属性来定义了命令的描述。在 handle 方法中我们添加了命令的逻辑代码，并通过 $this->info 方法输出了一条消息，表示命令执行成功。

3. 注册命令

在 Laravel 中，你需要将创建的命令注册到 Artisan 命令列表中，以便于它们可以被 Artisan 知道并且执行。

你可以在 app/Console/Kernel.php 文件中注册命令。在 commands 数组中添加你的命令类名即可完成注册：

protected $commands = [
    // YourCommandName::class,
];

完整的 app/Console/Kernel.php 文件示例：

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        // YourCommandName::class,
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // $schedule->command('inspire')->hourly();
    }

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

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

4. 执行命令

现在我们已经成功创建了一个自定义的 Artisan 命令，并注册到了 Artisan 命令列表中。现在我们只需执行以下命令：

php artisan yourcommandname

该命令将执行我们在 handle 方法中添加的逻辑。在本例中，我们向命令行输出了一条消息，表示代码逻辑已执行成功。

5. 结论

在本教程中，我们学习了如何在 Laravel 应用程序中创建自定义的 Artisan 命令。我们了解了如何使用 make:command Artisan 命令来生成命令文件，如何添加命令的逻辑，并如何注册命令到 Artisan 命令列表中。我们还学习了如何执行我们自己创建的 Artisan 命令。