Laravel自定义模板命令详解

本文详解了如何在 Laravel 中通过 Artisan 命令行工具创建高度可定制的模板命令（如 `make:service`），帮助开发者一键生成符合团队编码规范的服务类等代码结构；从命令创建、签名与描述定义，到模板文件编写、占位符替换及目录自动创建，全程覆盖实战关键步骤，大幅提升重复性代码的开发效率与项目一致性。

创建自定义 Artisan 命令

使用内置命令生成一个命令类：

php artisan make:command MakeServiceCommand

该命令会在 app/Console/Commands 目录下创建 MakeServiceCommand.php 文件。

定义命令签名与描述

打开刚创建的命令文件，设置 signature 和 description：

protected $signature = 'make:service {name}';
protected $description = 'Create a new service class';

这里 {name} 是参数，表示服务类名称。

编写模板逻辑

在 handle() 方法中实现文件生成逻辑：

• 读取自定义模板文件内容
• 替换占位符（如类名）
• 写入目标文件

示例代码：

public function handle()
{
    $name = $this->argument('name');
    $path = app_path("Services/{$name}.php");

    if (file_exists($path)) {
        $this->error("Service {$name} already exists!");
        return false;
    }

    $this->makeDirectory($path);

    file_put_contents($path, $this->buildClass($name));

    $this->info("Service {$name} created successfully.");
}

protected function buildClass($name)
{
    $stub = file_get_contents(app_path('Console/Stubs/service.stub'));
    return str_replace(['{{class}}'], [$name], $stub);
}

protected function makeDirectory($path)
{
    if (! is_dir(dirname($path))) {
        mkdir(dirname($path), 0755, true);
    }
}

准备模板文件

在 app/Console/Stubs/ 创建 service.stub 模板文件：

<?php

namespace App\Services;

class {{class}}
{
    // Your service logic here
}

运行命令时，{{class}} 会被实际类名替换。

注册命令

将命令添加到 app/Console/Kernel.php 的 $commands 数组中：

protected $commands = [
    \App\Console\Commands\MakeServiceCommand::class,
];

执行自定义命令：

php artisan make:service UserService

将在 app/Services/UserService.php 生成对应类。

到这里，我们也就讲完了《Laravel自定义模板命令详解》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于php,Laravel的知识点！