下面由laravel教程栏目给大家介绍laravel自定义make命令生成service类,希望对需要的朋友有所帮助!
环境说明
我使用的环境是:Laravel Framework 8.40.0。
C:wwwwwwrootlaravel8>php artisan --version Laravel Framework 8.40.0
一、制作命令文件
前期知识的相关制作的教程,请参考我的另一篇博客Laravel自定义Make命令生成目标类。
-
运行如下命令
php artisan make:command MakeService
生成Console/Commands/MakeService.php命令文件。
-
修改继承类
把继承类修改成GeneratorCommand,该类的命名空间为IlluminateConsoleGeneratorCommand。
删除实例化方法,handle函数
实现一个方法getStub。 -
设置name属性。
修改$signature属性为name属性,并设置命令:protected $name = 'make:service';
-
设置type属性值
type类型设置,我们生成的是service,所以我们设置的属性就是Service。protected $type = 'Service';
type类型是自己去定义的,本身没有特殊含义,可以不用设置。
type属性值仅仅在创建错误的时候,给你一个友好的提示,如下所示:
C:wwwwwwrootlaravel8>php artisan make:service TestService already exists! C:wwwwwwrootlaravel8>php artisan make:service TestService Service already exists!
第一个是没有设置type属性的效果,第二个是设置了type属性的效果。
官方使用的type有:Controller,Middleware,Cast,Channel…
根据自己的需要修改其他的属性
-
设置Stub的位置和命令空间
Stub的位置是在根目录下Stubs/service.stub里面。
命名空间在app目录下Services里面。
实例代码如下:
<?php namespace AppConsoleCommands; use IlluminateConsoleGeneratorCommand; class MakeService extends GeneratorCommand{ /** * The console command name. * * @var string */ protected $name = 'make:service'; /** * The console command description. * * @var string */ protected $description = '生成service对象类'; /** * The type of class being generated. * * @var string */ protected $type = 'Service'; /** * Get the stub file for the generator. * * @return string */ protected function getStub() { // Implement getStub() method. return $this->laravel->basePath('/stubs/service.stub'); } /** * Get the default namespace for the class. * * @param string $rootNamespace * @return string */ protected function getDefaultNamespace($rootNamespace) { return $rootNamespace.'Services'; }}
二、制作Stub文件
我的service文件目前不需要继承或者依赖什么类。所以,相对的比较简单。如果你有特别的需要,可以进行扩展操作。
实例代码如下:
<?phpnamespace DummyNamespace;class DummyClass{ //}
DummyClass和DummyNamespace在继承的GeneratorCommand类内部会被自动替换成自动生成的类名和设置的命名空间。
建议这种写法,可以使用编辑器的语法提示,获得更友好的提示效果。
另外,你也可以使用Larave内置的{{ class }}和{{ namespace }}写法。
三、测试Service生成
执行以下命令
php artisan make:service IndexService
能正常生成成功
C:wwwwwwrootlaravel8>php artisan make:service IndexService Service created successfully.
生成的文件的目录是app/Services/IndexService.php,生成的文件如下:
<?php namespace AppServices; class IndexService{ //}
相关推荐:laravel