源码解读[ GeneratorCommand ]，创建文件命令

熟练使用 artisan 命令如 php artisan make:model 等来创建文件的 laravel 盆友们，肯定不习惯点击右键新建文件，尤其是大量重复这样的操作真的很繁琐有没有！

所以想着折腾自定义一条 artisan 命令，实现新建文件功能。网上查了查，发现 laravel 已经把轮子造好了，只要继承基类 GeneratorCommand，便可简单实现功能。题外话：习惯不好，很多时候宁愿 Google 教程做伸手党，也不愿意带着问题通读代码。在此共勉！

源码解读

 public function fire()
    {
        //获取拼接命名空间后的全称
        $name = $this->qualifyClass($this->getNameInput());

        //获取文件的实际存储路径
        $path = $this->getPath($name);

        //若文件已存在，直接给出错误提示而不会覆盖原来的文件
        if ($this->alreadyExists($this->getNameInput())) {
            $this->error($this->type.' already exists!');
            return false;
        }

        //生成文件
        $this->makeDirectory($path);

        //适当地替换模版文件中的数据，如命名空间和类名
        $this->files->put($path, $this->buildClass($name));

       //控制台提示
        $this->info($this->type.' created successfully.');
    }

由上述代码可以看出，轮子已经造的很完备了。其他部分都比较简单，具体看下模版文件替换部分的代码，从而按需求编辑模版文件。

*编辑模版文件

protected function buildClass($name)
    {
        //获取模版文件
        $stub = $this->files->get($this->getStub());
        //替换命名空间和类名
        return $this->replaceNamespace($stub, $name)->replaceClass($stub, $name);
    }

*DummyNamespace=命名空间

 protected function replaceNamespace(&$stub, $name)
    {
        $stub = str_replace(
            ['DummyNamespace', 'DummyRootNamespace'],
            [$this->getNamespace($name), $this->rootNamespace()],
            $stub
        );

        return $this;
    }

根据自定义的命名空间替换模版文件中的命名空间，所以模版文件中的命名空间用 DummyNamespace 来代替。这点在读源码之前看 migrate 的 create.stub 代码时，真心一脸懵逼啊。

*DummyClass=类名

protected function replaceClass($stub, $name)
    {
        $class = str_replace($this->getNamespace($name).'\\', '', $name);

        return str_replace('DummyClass', $class, $stub);
    }

同理可得，模版文件中的类名用 DummyClass 代替。

实现

很明确分成两步：

1. 创建模版文件 xxx.stub
2. 创建命令——生成文件

*模版

简单例子 public/stubs/repo.stub，可根据需要添加构造函数等共性代码：

<?php

namespace DummyNamespace;

class DummyClass
{

}

*command 命令

class MakeRepo extends GeneratorCommand
{
    //执行命令
    protected $signature = 'make:repo {name}';

   //命令说明
    protected $description = 'Create a new repo';

   //模版文件存储路径
    public function getStub()
    {
        return public_path('stub/repo.stub');
    }

    //为生成文件指定命名空间
    public function getDefaultNamespace($rootNamespace)
    {
        return $rootNamespace.'\Repos';
    }
}

看起来有没有很简单，若对 artisan 命令不熟的小伙伴先移步 artisan 命令行看看文档了解下。希望能养成记笔记的好习惯，供以后自己阅读吧。