Laravel 创建自定义的 artisan make 命令

前言#

我们在 laravel 开发时经常用到 artisan make 等命令来新建 ControllerModelJobEvent 等类文件。 在 Laravel5.2artisan make 命令支持创建如下文件:

  make:auth           Scaffold basic login and registration views and routes
  make:console        Create a new Artisan command
  make:controller     Create a new controller class
  make:event          Create a new event class
  make:job            Create a new job class
  make:listener       Create a new event listener class
  make:middleware     Create a new middleware class
  make:migration      Create a new migration file
  make:model          Create a new Eloquent model class
  make:policy         Create a new policy class
  make:provider       Create a new service provider class
  make:request        Create a new form request class
  make:seeder         Create a new seeder class
  make:test           Create a new test class

不过,有时候默认的并不能够满足我们的需求, 比方我们在项目中使用的 Respository 模式来进一步封装了 Model 文件,就需要经常创建 Repository 类文件了,时间长了就会想能不能通过 artisan make:repository 命令自动创建类文件而不是都每次手动创建。

系统自带的 artisan make 命令对应的 PHP 程序放在 Illuminate\Foundation\Console 目录下,我们参照 Illuminate\Foundation\Console\ProviderMakeCommand 类来定义自己的 artisan make:repository 命令。

创建命令类#

app\Console\Commands 文件夹下创建 RepositoryMakeCommand.php 文件,具体程序如下:

namespace App\Console\Commands;

use Illuminate\Console\GeneratorCommand;

class RepositoryMakeCommand extends GeneratorCommand
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'make:repository';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create a new repository class';

    /**
     * The type of class being generated.
     *
     * @var string
     */
    protected $type = 'Repository';

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        return __DIR__.'/stubs/repository.stub';
    }

    /**
     * Get the default namespace for the class.
     *
     * @param  string  $rootNamespace
     * @return string
     */
    protected function getDefaultNamespace($rootNamespace)
    {
        return $rootNamespace.'\Repositories';
    }
}

创建命令类对应的模版文件#

app\Console\Commands\stubs 下创建模版文件 .stub 文件是 make 命令生成的类文件的模版,用来定义要生成的类文件的通用部分
创建 repository.stub 模版文件:

    namespace DummyNamespace;

    use App\Repositories\BaseRepository;

    class DummyClass extends BaseRepository
    {

        /**
         * Specify Model class name
         * 
         * @return string
         */
        public function model()
        {
            //set model name in here, this is necessary!
        }
    }

注册命令类#

将 RepositoryMakeCommand 添加到 App\Console\Kernel.php

    protected $commands = [
        Commands\RepositoryMakeCommand::class
    ];

使用命令#

好了, 现在就可以通过 make:repository 命令来创建 repository 类文件了

php artisan make:repository TestRepository

php artisan make:repository SubDirectory/TestRepository 
本作品采用《CC 协议》,转载必须注明作者和本文链接
公众号:网管叨 bi 叨 | Golang、Laravel、Docker、K8s 等学习经验分享
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
未填写
文章
113
粉丝
368
喜欢
487
收藏
317
排名:34
访问:20.4 万
私信
所有博文
社区赞助商