本文主要講述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裡註冊下命令:
// app/Console/Kernel
protected
$commands
= [
// Commands\Inspire::class,
// Commands\RedisSubscribe::class,
// Commands\RedisPublish::class,
// Commands\MakeTestRepositoryCommand::class,
Commands\MakeRepositoryCommand::
class
,
];
然後輸入php artisan命令後就能看到這個make:repository命令了。
自動化生成RepositoryInterface和Repository檔案
在MakeRepositoryCommand.php命令執行檔案裡寫上模板自動生成邏輯,程式碼也不長,有些邏輯也有註釋,可看:
use
Config;
use
Illuminate\Console\Command;
use
Illuminate\Filesystem\Filesystem;
use
Illuminate\Support\Composer;
class
MakeRepositoryCommand
extends
Command
{
/**
* 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'
;
/**
* @var
*/
protected
$repository
;
/**
* @var
*/
protected
$model
;
/**
* Create a new command instance.
*
* @param Filesystem $filesystem
* @param Composer $composer
*/
public
function
__construct(Filesystem
$filesystem
, Composer
$composer
)
{
parent::__construct();
$this
->files =
$filesystem
;
$this
->composer =
$composer
;
}
/**
* Execute the console command.
*
* @return mixed
*/
public
function
handle()
{
//獲取repository和model兩個引數值
$argument
=
$this
->argument(
'repository'
);
$option
=
$this
->option(
'model'
);
//自動生成RepositoryInterface和Repository檔案
$this
->writeRepositoryAndInterface(
$argument
,
$option
);
//重新生成autoload.php檔案
$this
->composer->dumpAutoloads();
}
private
function
writeRepositoryAndInterface(
$repository
,
$model
)
{
if
(
$this
->createRepository(
$repository
,
$model
)){
//若生成成功,則輸出資訊
$this
->info(
'Success to make a '
.ucfirst(
$repository
).
' Repository and a '
.ucfirst(
$repository
).
'Interface Interface'
);
}
}
private
function
createRepository(
$repository
,
$model
)
{
// getter/setter 賦予成員變數值
$this
->setRepository(
$repository
);
$this
->setModel(
$model
);
// 建立檔案存放路徑, RepositoryInterface放在app/Repositories,Repository個人一般放在app/Repositories/Eloquent裡
$this
->createDirectory();
// 生成兩個檔案
return
$this
->createClass();
}
private
function
createDirectory()
{
$directory
=
$this
->getDirectory();
//檢查路徑是否存在,不存在建立一個,並賦予775許可權
if
(!
$this
->files->isDirectory(
$directory
)){
return
$this
->files->makeDirectory(
$directory
, 0755, true);
}
}
private
function
getDirectory()
{
return
Config::get(
'repository.directory_eloquent_path'
);
}
private
function
createClass()
{
//渲染模板檔案,替換模板檔案中變數值
$templates
=
$this
->templateStub();
$class
= null;
foreach
(
$templates
as
$key
=>
$template
) {
//根據不同路徑,渲染對應的模板檔案
$class
=
$this
->files->put(
$this
->getPath(
$key
),
$template
);
}
return
$class
;
}
private
function
getPath(
$class
)
{
// 兩個模板檔案,對應的兩個路徑
$path
= null;
switch
(
$class
){
case
'Eloquent'
:
$path
=
$this
->getDirectory().DIRECTORY_SEPARATOR.
$this
->getRepositoryName().
'.php'
;
break
;
case
'Interface'
:
$path
=
$this
->getInterfaceDirectory().DIRECTORY_SEPARATOR.
$this
->getInterfaceName().
'.php'
;
break
;
}
return
$path
;
}
private
function
getInterfaceDirectory()
{
return
Config::get(
'repository.directory_path'
);
}
private
function
getRepositoryName()
{
// 根據輸入的repository變數引數,是否需要加上'Repository'
$repositoryName
=
$this
->getRepository();
if
((
strlen
(
$repositoryName
) <
strlen
(
'Repository'
)) ||
strrpos
(
$repositoryName
,
'Repository'
, -11)){
$repositoryName
.=
'Repository'
;
}
return
$repositoryName
;
}
private
function
getInterfaceName()
{
return
$this
->getRepositoryName().
'Interface'
;
}
/**
* @return mixed
*/
public
function
getRepository()
{
return
$this
->repository;
}
/**
* @param mixed $repository
*/
public
function
setRepository(
$repository
)
{
$this
->repository =
$repository
;
}
/**
* @return mixed
*/
public
function
getModel()
{
return
$this
->model;
}
/**
* @param mixed $model
*/
public
function
setModel(
$model
)
{
$this
->model =
$model
;
}
private
function
templateStub()
{
// 獲取兩個模板檔案
$stubs
=
$this
->getStub();
// 獲取需要替換的模板檔案中變數
$templateData
=
$this
->getTemplateData();
$renderStubs
= [];
foreach
(
$stubs
as
$key
=>
$stub
) {
// 進行模板渲染
$renderStubs
[
$key
] =
$this
->getRenderStub(
$templateData
,
$stub
);
}
return
$renderStubs
;
}
private
function
getStub()
{
$stubs
= [
'Eloquent'
=>
$this
->files->get(resource_path(
'stubs/Repository'
).DIRECTORY_SEPARATOR.
'Eloquent'
.DIRECTORY_SEPARATOR.
'repository.stub'
),
'Interface'
=>
$this
->files->get(resource_path(
'stubs/Repository'
).DIRECTORY_SEPARATOR.
'repository_interface.stub'
),
];
return
$stubs
;
}
private
function
getTemplateData()
{
$repositoryNamespace
= Config::get(
'repository.repository_namespace'
);
$modelNamespace
=
'App\\'
.
$this
->getModelName();
$repositoryInterfaceNamespace
= Config::get(
'repository.repository_interface_namespace'
);
$repositoryInterface
=
$this
->getInterfaceName();
$className
=
$this
->getRepositoryName();
$modelName
=
$this
->getModelName();
$templateVar
= [
'repository_namespace'
=>
$repositoryNamespace
,
'model_namespace'
=>
$modelNamespace
,
'repository_interface_namespace'
=>
$repositoryInterfaceNamespace
,
'repository_interface'
=>
$repositoryInterface
,
'class_name'
=>
$className
,
'model_name'
=>
$modelName
,
'model_var_name'
=>
strtolower
(
$modelName
),
];
return
$templateVar
;
}
private
function
getRenderStub(
$templateData
,
$stub
)
{
foreach
(
$templateData
as
$search
=>
$replace
) {
$stub
=
str_replace
(
'$'
.
$search
,
$replace
,
$stub
);
}
return
$stub
;
}
private
function
getModelName()
{
$modelName
=
$this
->getModel();
if
(isset(
$modelName
) && !
empty
(
$modelName
)){
$modelName
= ucfirst(
$modelName
);
}
else
{
// 若option選項沒寫,則根據repository來生成Model Name
$modelName
=
$this
->getModelFromRepository();
}
return
$modelName
;
}
private
function
getModelFromRepository()
{
$repository
=
strtolower
(
$this
->getRepository());
$repository
=
str_replace
(
'repository'
,
''
,
$repository
);
return
ucfirst(
$repository
);
}
}
這裡把一些常量值放在config/repository.php配置檔案裡了:
<?php
/**
* Created by PhpStorm.
* User: liuxiang
* Date: 16/6/22
* Time: 17:06
*/
return
[
'directory_path'
=>
'App'
.DIRECTORY_SEPARATOR.
'Repositories'
,
'directory_eloquent_path'
=>
'App'
.DIRECTORY_SEPARATOR.
'Repositories'
.DIRECTORY_SEPARATOR.
'Eloquent'
,
'repository_namespace'
=>
'App\Repositories\Eloquent'
,
'repository_interface_namespace'
=>
'App\Repositories'
,
];
執行一下看可不可以吧,這裡截個圖:
It is working!!!
是可以生成RepositoryInterface和對應的介面實現檔案,這裡一個是加了--model選項一個沒加的,沒加的話這裡第一個指令就預設Model的名稱是Shop。
生成的檔案內容不截圖了,看下新生成的ShopRepository.php檔案,的確是我想要的模板檔案:
總結:本文主要用Laravel的Artisan命令來自動生成個人需要的模板,減少平時開發中重複勞動。就像Laravel自帶了很多模板生成命令,用起來會節省很多時間。這是作者在平時開發中遇到的問題,透過利用Laravel Artisan命令解決了,所以Laravel還是挺好玩的。有興趣的可以把程式碼扒下來玩一玩,並根據你自己想要的模板做修改。這兩天想就Repository模式封裝Model邏輯的方法和好處聊一聊,到時見。希望對大家的學習有所幫助
<?php
/**
* Created by PhpStorm.
* User: liuxiang
*/
namespace
App\Repositories\Eloquent;
use
App\Shop;
use
App\Repositories\ShopRepositoryInterface;
class
ShopRepository
implements
ShopRepositoryInterface
{
/**
* @var \App\Shop
*/
public
$shop
;
public
function
__construct(Shop
$shop
)
{
$this
->shop =
$shop
;
}
/**
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public
function
all(
$columns
=
array
(
'*'
))
{
return
$this
->shop->all(
$columns
);
}
/**
* @param int $perPage
* @param array $columns
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
public
function
paginate(
$perPage
= 15,
$columns
=
array
(
'*'
))
{
return
$this
->shop->paginate(
$perPage
,
$columns
);
}
/**
* Create a new shop
* @param array $data
* @return \App\Shop
*/
public
function
create(
array
$data
)
{
return
$this
->shop->create(
$data
);
}
/**
* Update a shop
* @param array $data
* @param $id
* @return \App\Shop
*/
public
function
update(
$data
= [],
$id
)
{
return
$this
->shop->whereId(
$id
)->update(
$data
);
}
/**
* Store a shop
* @param array $data
* @return \App\Shop
*/
public
function
store(
$data
= [])
{
$this
->shop->id =
$data
[
'id'
];
//...
$this
->shop->save();
}
/**
* Delete a shop
* @param array $data
* @param $id
* @return \App\Shop
*/
public
function
delete
(
$data
= [],
$id
)
{
$this
->shop->whereId(
$id
)->
delete
();
}
/**
* @param $id
* @param array $columns
* @return array|\Illuminate\Database\Eloquent\Collection|static[]
*/
public
function
find(
$id
,
$columns
=
array
(
'*'
))
{
$Shop
=
$this
->shop->whereId(
$id
)->get(
$columns
);
return
$Shop
;
}
/**
* @param $field
* @param $value
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public
function
findBy(
$field
,
$value
,
$columns
=
array
(
'*'
))
{
$Shop
=
$this
->shop->where(
$field
,
'='
,
$value
)->get(
$columns
);
return
$Shop
;
}
}