说明:本文主要讲述Laravel的Artisan命令来实现自定义模板,就如经常输入的php artisan make:controller ShopController就会自动生成一个ShopController.php模板文件一样,通过命令生成模板也会提高开发效率。同时,作者会将开发过程中的一些截图和代码黏上去,提高阅读效率。
备注:个人平时在写Repository代码时会这样写,如先写上ShopRepositoryInterface并定义好接口方法如all()、create()、update()、delete()、findBy()等等,然后再写上接口对应的实现ShopRepository并注入对应的Model即Shop。别的PostRepository、TagRepository也会是这么写(当然,对于很多重用的Repository方法可以集体拿到AbstractRepository抽象类里供子类继承,实现代码复用)。那能不能直接命令行生成模板文件呢,就不用自己一个个的写了,就像输入php artisan make:controller PostController给我一个Controller模板来。
关于使用Repository模式来封装下Model逻辑,不让Controller里塞满了很多Model逻辑,这样做是有很多好处的,最主要的就是好测试和代码架构清晰,也符合SOLID原则。如果使用PHPUnit来做测试就知道了为啥说好测试了。SegmentFault上也有相关的文章描述。作者也打算最近新开一篇文章聊一聊这个,PHPUnit也打算过段时间聊一聊。
个人研究了下Artisan命令行,是可以的。经过开发后,结果是输入自定义指令php artisan make:repository PostRepository --model=Post(这个option可要可不要),就会帮我生成一个PostRepositoryInterface和对应的接口实现PostRepository。
模板文件Stub
由于个人需要生成一个RepositoryInterface和对应接口实现Repository,那就需要两个模板文件了。在resources/stubs新建两个模板文件,以下是个人经常需要的两个模板文件(你可以自定义):
/** * @param array $columns * @return \Illuminate\Database\Eloquent\Collection|static[] */ public function all($columns = array('*')) { return $this->$model_var_name->all($columns); } /** * @param int $perPage * @param array $columns * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator */ public function paginate($perPage = 15, $columns = array('*')) { return $this->$model_var_name->paginate($perPage, $columns); } /** * Create a new $model_var_name * @param array $data * @return \$model_namespace */ public function create(array $data) { return $this->$model_var_name->create($data); } /** * Update a $model_var_name * @param array $data * @param $id * @return \$model_namespace */ public function update($data = [], $id) { return $this->$model_var_name->whereId($id)->update($data); } /** * Store a $model_var_name * @param array $data * @return \$model_namespace */ public function store($data = []) { $this->$model_var_name->id = $data['id']; //... $this->$model_var_name->save(); } /** * Delete a $model_var_name * @param array $data * @param $id * @return \$model_namespace */ public function delete($data = [], $id) { $this->$model_var_name->whereId($id)->delete(); } /** * @param $id * @param array $columns * @return array|\Illuminate\Database\Eloquent\Collection|static[] */ public function find($id, $columns = array('*')) { $$model_name = $this->$model_var_name->whereId($id)->get($columns); return $$model_name; } /** * @param $field * @param $value * @param array $columns * @return \Illuminate\Database\Eloquent\Collection|static[] */ public function findBy($field, $value, $columns = array('*')) { $$model_name = $this->$model_var_name->where($field, '=', $value)->get($columns); return $$model_name; } }
模板文件里包括参数,这些参数将会根据命令行中输入的参数和选项被相应替换:
复制代码 代码如下:
['$repository_namespace', '$model_namespace', '$repository_interface_namespace', '$repository_interface', '$class_name', '$model_name', '$model_var_name']
Artisan命令生成Repository模板文件
生成Artisan命令并注册
Laravel提供了Artisan命令自定义,输入指令:
php artisan make:console MakeRepositoryCommand
然后改下签名和描述:
// app/Console/Commands/MakeRepositoryCommand /** * The name and signature of the console command. * * @var string */ protected $signature = 'make:repository {repository} {--model=}'; /** * The console command description. * * @var string */ protected $description = 'Make a repository and interface';
这里{repository}是必填参数并指明(选填参数加个?,就和路由参数一样),将会被$this->argument('repository')方法捕捉到,{--model=}是选项,可填可不填,将会被$this->option('model')方法捕捉到。填上这个命令的描述,最后在Console的Kernel里注册下命令: