sostheblack / laravel-repository-pattern
Laravel 10+ - 数据库层仓库
Requires
- php: ^8.2
- illuminate/cache: ^10.0|^11.0
- illuminate/config: ^10.0|^11.0
- illuminate/console: ^10.0|^11.0
- illuminate/database: ^10.0|^11.0
- illuminate/filesystem: ^10.0|^11.0
- illuminate/http: ^10.0|^11.0
- illuminate/pagination: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
- illuminate/validation: ^10.0|^11.0
- league/fractal: ^0.20
- prettus/laravel-validation: ~1.4
Suggests
- league/fractal: Required to use the Fractal Presenter (0.12.*).
- robclancy/presenter: Required to use the Presenter Model (1.3.*)
This package is auto-updated.
Last update: 2024-09-05 14:26:43 UTC
README
Laravel Repositories用于抽象数据层,使我们的应用程序更容易维护。
您想了解更多关于Repository模式的信息吗?阅读这篇文章。
目录
安装
Composer
执行以下命令以获取软件包的最新版本:
composer require SOSTheBlack/laravel-repository-pattern
Laravel
> = laravel5.5
ServiceProvider将自动附加
其他
在您的config/app.php
中,将SOSTheBlack\Repository\Providers\RepositoryServiceProvider::class
添加到providers
数组末尾
'providers' => [ ... \SOSTheBlack\Repository\Providers\RepositoryServiceProvider::class, ],
如果是Lumen
$app->register(\SOSTheBlack\Repository\Providers\LumenRepositoryServiceProvider::class);
发布配置
php artisan vendor:publish --provider "SOSTheBlack\Repository\Providers\RepositoryServiceProvider"
方法
SOSTheBlack\Repository\Contracts\RepositoryInterface
- all($columns = array('*'))
- first($columns = array('*'))
- paginate($limit = null, $columns = ['*'])
- find($id, $columns = ['*'])
- findByField($field, $value, $columns = ['*'])
- findWhere(array $where, $columns = ['*'])
- findWhereIn($field, array $where, $columns = [*])
- findWhereNotIn($field, array $where, $columns = [*])
- findWhereBetween($field, array $where, $columns = [*])
- create(array $attributes)
- update(array $attributes, $id)
- updateOrCreate(array $attributes, array $values = [])
- delete($id)
- deleteWhere(array $where)
- orderBy($column, $direction = 'asc');
- with(array $relations);
- has(string $relation);
- whereHas(string $relation, closure $closure);
- hidden(array $fields);
- visible(array $fields);
- scopeQuery(Closure $scope);
- getFieldsSearchable();
- setPresenter($presenter);
- skipPresenter($status = true);
SOSTheBlack\Repository\Contracts\RepositoryCriteriaInterface
- pushCriteria($criteria)
- popCriteria($criteria)
- getCriteria()
- getByCriteria(CriteriaInterface $criteria)
- skipCriteria($status = true)
- getFieldsSearchable()
SOSTheBlack\Repository\Contracts\CacheableInterface
- setCacheRepository(CacheRepository $repository)
- getCacheRepository()
- getCacheKey($method, $args = null)
- getCacheTime()
- skipCache($status = true)
SOSTheBlack\Repository\Contracts\PresenterInterface
- present($data);
SOSTheBlack\Repository\Contracts\Presentable
- setPresenter(PresenterInterface $presenter);
- presenter();
SOSTheBlack\Repository\Contracts\CriteriaInterface
- apply($model, RepositoryInterface $repository);
SOSTheBlack\Repository\Contracts\Transformable
- transform();
使用
创建模型
创建您的模型,但重要的是要定义可以从输入表单数据中填充的属性。
namespace App; class Post extends Eloquent { // or Ardent, Or any other Model Class protected $fillable = [ 'title', 'author', ... ]; ... }
创建仓库
namespace App; use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { /** * Specify Model class name * * @return string */ function model() { return "App\\Post"; } }
生成器
通过生成器轻松创建您的仓库。
配置
您必须首先配置存储库文件的存储位置。默认情况下是“app”文件夹和命名空间“App”。请注意,paths
数组中的值实际上同时用作命名空间和文件路径。不过,在生成过程中会自动处理前后斜杠。
... 'generator'=>[ 'basePath'=>app()->path(), 'rootNamespace'=>'App\\', 'paths'=>[ 'models' => 'Entities', 'repositories' => 'Repositories', 'interfaces' => 'Repositories', 'transformers' => 'Transformers', 'presenters' => 'Presenters', 'validators' => 'Validators', 'controllers' => 'Http/Controllers', 'provider' => 'RepositoryServiceProvider', 'criteria' => 'Criteria', ] ]
您可能希望将项目文件夹的根目录放置在“app”之外,并添加另一个命名空间,例如
... 'generator'=>[ 'basePath' => base_path('src/Lorem'), 'rootNamespace' => 'Lorem\\' ]
此外,您可能希望自定义生成的类保存的位置。这可以通过编辑paths
节点来完成。例如
'generator'=>[ 'basePath'=>app()->path(), 'rootNamespace'=>'App\\', 'paths'=>[ 'models'=>'Models', 'repositories'=>'Repositories\\Eloquent', 'interfaces'=>'Contracts\\Repositories', 'transformers'=>'Transformers', 'presenters'=>'Presenters' 'validators' => 'Validators', 'controllers' => 'Http/Controllers', 'provider' => 'RepositoryServiceProvider', 'criteria' => 'Criteria', ] ]
命令
要生成您模型所需的所有内容,请运行以下命令
php artisan make:entity Post
这将创建控制器、验证器、模型、存储库、演示者和转换类。它还将创建一个新的服务提供者,用于将Eloquent存储库与其对应的存储库接口绑定。要加载它,只需将以下内容添加到您的AppServiceProvider的@register方法中
$this->app->register(RepositoryServiceProvider::class);
您也可以从repository
命令传递选项,因为该命令只是一个包装器。
要为您的Post模型生成存储库,请使用以下命令
php artisan make:repository Post
要为具有Blog命名空间的Post模型生成存储库,请使用以下命令
php artisan make:repository "Blog\Post"
添加可填充的字段
php artisan make:repository "Blog\Post" --fillable="title,content"
要直接与您的命令一起添加验证规则,您需要传递--rules
选项并创建迁移
php artisan make:entity Cat --fillable="title:string,content:text" --rules="title=>required|min:2, content=>sometimes|min:10"
该命令还会创建您的基本RESTful控制器,因此只需将此行添加到您的routes.php
文件中,您就可以拥有基本的CRUD操作
Route::resource('cats', CatsController::class);
在运行命令时,您将在您设置的默认文件夹内创建“Entities”文件夹和“Repositories”。
现在完成后,您仍然需要将其实际存储库的接口绑定,例如在您的自己的Repositories Service Provider中。
App::bind('{YOUR_NAMESPACE}Repositories\PostRepository', '{YOUR_NAMESPACE}Repositories\PostRepositoryEloquent');
然后使用
public function __construct({YOUR_NAMESPACE}Repositories\PostRepository $repository){ $this->repository = $repository; }
或者,您可以使用Artisan命令来自动绑定。
php artisan make:bindings Cats
使用方法
namespace App\Http\Controllers; use App\PostRepository; class PostsController extends BaseController { /** * @var PostRepository */ protected $repository; public function __construct(PostRepository $repository){ $this->repository = $repository; } .... }
在存储库中查找所有结果
$posts = $this->repository->all();
在存储库中带有分页的查找所有结果
$posts = $this->repository->paginate($limit = null, $columns = ['*']);
按id查找结果
$post = $this->repository->find($id);
隐藏模型属性
$post = $this->repository->hidden(['country_id'])->find($id);
仅显示模型的具体属性
$post = $this->repository->visible(['id', 'state_id'])->find($id);
加载模型关系
$post = $this->repository->with(['state'])->find($id);
按字段名查找结果
$posts = $this->repository->findByField('country_id','15');
按多个字段查找结果
$posts = $this->repository->findWhere([ //Default Condition = 'state_id'=>'10', 'country_id'=>'15', //Custom Condition ['columnName1','>','10'], //DATE, DAY, MONTH, YEAR ['columnName2','DATE','2021-07-02'], //whereDate ['columnName3','DATE >=','2021-07-02'], //whereDate with operator ['columnName4','IN',['value1','value2']], //whereIn ['columnName5','NOTIN',['value1','value2']], //whereNotIn ['columnName6','EXIST',''], //whereExists //HAS, HASMORPH, DOESNTHAVE, DOESNTHAVEMORPH ['columnName7','HAS',function($query){}], //whereHas //BETWEEN, BETWEENCOLUMNS, NOTBETWEEN, NOTBETWEENCOLUMNS ['columnName8','BETWEEN',[10, 100]], //whereBetween ]);
在一个字段中按多个值查找结果
$posts = $this->repository->findWhereIn('id', [1,2,3,4,5]);
在一个字段中按多个值排除查找结果
$posts = $this->repository->findWhereNotIn('id', [6,7,8,9,10]);
使用自定义范围查找所有结果
$posts = $this->repository->scopeQuery(function($query){ return $query->orderBy('sort_order','asc'); })->all();
在存储库中创建新条目
$post = $this->repository->create( Input::all() );
在存储库中更新条目
$post = $this->repository->update( Input::all(), $id );
在存储库中删除条目
$this->repository->delete($id)
按多个字段删除存储库中的条目
$this->repository->deleteWhere([ //Default Condition = 'state_id'=>'10', 'country_id'=>'15', ])
创建查询条件
使用命令
php artisan make:criteria MyCriteria
标准是按照您的需求应用特定条件来更改查询的存储库的方式。您可以在您的存储库中添加多个标准。
use SOSTheBlack\Repository\Contracts\CriteriaInterface;use SOSTheBlack\Repository\Contracts\RepositoryInterface; class MyCriteria implements CriteriaInterface { public function apply($model, RepositoryInterface $repository) { $model = $model->where('user_id','=', Auth::user()->id ); return $model; } }
在控制器中使用查询条件
namespace App\Http\Controllers; use App\PostRepository; class PostsController extends BaseController { /** * @var PostRepository */ protected $repository; public function __construct(PostRepository $repository){ $this->repository = $repository; } public function index() { $this->repository->pushCriteria(new MyCriteria1()); $this->repository->pushCriteria(MyCriteria2::class); $posts = $this->repository->all(); ... } }
从标准中获取结果
$posts = $this->repository->getByCriteria(new MyCriteria());
在存储库中设置默认标准
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { public function boot(){ $this->pushCriteria(new MyCriteria()); // or $this->pushCriteria(AnotherCriteria::class); ... } function model(){ return "App\\Post"; } }
跳过存储库中定义的标准
在任何其他链式方法之前使用skipCriteria
$posts = $this->repository->skipCriteria()->all();
弹出标准
使用popCriteria
来删除一个标准
$this->repository->popCriteria(new Criteria1()); // or $this->repository->popCriteria(Criteria1::class);
使用请求查询条件
RequestCriteria是标准的标准实现。它允许从请求发送的参数中执行过滤。
您可以执行动态搜索、过滤数据并自定义查询。
要在您的存储库中使用标准,您可以在存储库的boot方法中添加一个新的标准,或者直接在控制器中使用,以便过滤出只有少数请求。
在仓库中启用
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { /** * @var array */ protected $fieldSearchable = [ 'name', 'email' ]; public function boot(){ $this->pushCriteria(app('SOSTheBlack\Repository\Criteria\RequestCriteria')); ... } function model(){ return "App\\Post"; } }
记住,您需要定义模型中哪些字段可以搜索。
在您的存储库中,将$fieldSearchable
设置为可搜索的字段的名称或与字段的关系。
protected $fieldSearchable = [ 'name', 'email', 'product.name' ];
您可以为执行查询的查询设置条件类型,默认条件是“=”。
protected $fieldSearchable = [ 'name'=>'like', 'email', // Default Condition "=" 'your_field'=>'condition' ];
在控制器中启用
public function index() { $this->repository->pushCriteria(app('SOSTheBlack\Repository\Criteria\RequestCriteria')); $posts = $this->repository->all(); ... }
标准示例
按请求获取所有数据,不进行过滤
http://sostheblack.local/users
[ { "id": 1, "name": "John Doe", "email": "john@gmail.com", "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" }, { "id": 2, "name": "Lorem Ipsum", "email": "lorem@ipsum.com", "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" }, { "id": 3, "name": "Laravel", "email": "laravel@gmail.com", "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ]
在存储库中执行研究
http://sostheblack.local/users?search=John%20Doe
或者
http://sostheblack.local/users?search=John&searchFields=name:like
或者
http://sostheblack.local/users?search=john@gmail.com&searchFields=email:=
或者
http://sostheblack.local/users?search=name:John Doe;email:john@gmail.com
或者
http://sostheblack.local/users?search=name:John;email:john@gmail.com&searchFields=name:like;email:=
[ { "id": 1, "name": "John Doe", "email": "john@gmail.com", "created_at": "-0001-11-30 00:00:00", "updated_at": "-0001-11-30 00:00:00" } ]
您可以使用“search”参数而不必使用完整的“searchFields”参数。
http://sostheblack.local/users?search=id:2;age:17;email:john@gmail.com&searchFields='id':=
默认情况下,RequestCriteria使用每个查询参数的OR比较运算符进行查询。http://sostheblack.local/users?search=age:17;email:john@gmail.com
上述示例将执行以下查询
SELECT * FROM users WHERE age = 17 OR email = 'john@gmail.com';
要使用AND进行查询,请传递以下searchJoin参数
http://sostheblack.local/users?search=age:17;email:john@gmail.com&searchJoin=and
过滤字段
http://sostheblack.local/users?filter=id;name
[ { "id": 1, "name": "John Doe" }, { "id": 2, "name": "Lorem Ipsum" }, { "id": 3, "name": "Laravel" } ]
排序结果
http://sostheblack.local/users?filter=id;name&orderBy=id&sortedBy=desc
[ { "id": 3, "name": "Laravel" }, { "id": 2, "name": "Lorem Ipsum" }, { "id": 1, "name": "John Doe" } ]
通过相关表排序
http://sostheblack.local/users?orderBy=posts|title&sortedBy=desc
查询将类似于以下内容
... INNER JOIN posts ON users.post_id = posts.id ... ORDER BY title ...
http://sostheblack.local/users?orderBy=posts:custom_id|posts.title&sortedBy=desc
查询将类似于以下内容
... INNER JOIN posts ON users.custom_id = posts.id ... ORDER BY posts.title ...
http://sostheblack.local/users?orderBy=posts:custom_id,other_id|posts.title&sortedBy=desc
查询将类似于以下内容
... INNER JOIN posts ON users.custom_id = posts.other_id ... ORDER BY posts.title ...
多列相同排序
http://sostheblack.local/users?orderBy=name;created_at&sortedBy=desc
结果将类似于以下内容
[ { "id": 1, "name": "Laravel", "created_at": "-0001-11-29 00:00:00" }, { "id": 3, "name": "Laravel", "created_at": "-0001-11-28 00:00:00" }, { "id": 2, "name": "John Doe", "created_at": "-0001-11-30 00:00:00" } ]
多列不同排序
http://sostheblack.local/users?orderBy=name;created_at&sortedBy=desc;asc
结果将类似于以下内容
[ { "id": 3, "name": "Laravel", "created_at": "-0001-11-28 00:00:00" }, { "id": 1, "name": "Laravel", "created_at": "-0001-11-29 00:00:00" }, { "id": 2, "name": "John Doe", "created_at": "-0001-11-30 00:00:00" } ]
添加关系
http://sostheblack.local/users?with=groups
过滤条件之间
http://sostheblack.local/product?search=price:100,500&searchFields=price:between
结果将类似于以下内容
[ { "id": 3, "price": "150", "created_at": "-0001-11-28 00:00:00" }, { "id": 1, "price": "300", "created_at": "-0001-11-29 00:00:00" }, { "id": 2, "price": "450", "created_at": "-0001-11-30 00:00:00" } ]
WhereIn过滤
http://sostheblack.local/product?search=price:300,500&searchFields=price:in
结果将类似于以下内容
[ { "id": 1, "price": "300", "created_at": "-0001-11-29 00:00:00" } ]
覆盖参数名称
您可以在配置文件config/repository.php中更改参数的名称。
缓存
轻松为您的仓库添加一层缓存
缓存使用
实现CacheableInterface接口并使用CacheableRepository特性。
use SOSTheBlack\Repository\Contracts\CacheableInterface;use SOSTheBlack\Repository\Eloquent\BaseRepository;use SOSTheBlack\Repository\Traits\CacheableRepository; class PostRepository extends BaseRepository implements CacheableInterface { use CacheableRepository; ... }
完成,这样您的仓库就会被缓存,并且每当创建、修改或删除项目时,都会清除仓库缓存。
缓存配置
您可以在文件config/repository.php中更改缓存设置,也可以直接在您的仓库上更改。
config/repository.php
'cache'=>[ //Enable or disable cache repositories 'enabled' => true, //Lifetime of cache 'minutes' => 30, //Repository Cache, implementation Illuminate\Contracts\Cache\Repository 'repository'=> 'cache', //Sets clearing the cache 'clean' => [ //Enable, disable clearing the cache on changes 'enabled' => true, 'on' => [ //Enable, disable clearing the cache when you create an item 'create'=>true, //Enable, disable clearing the cache when upgrading an item 'update'=>true, //Enable, disable clearing the cache when you delete an item 'delete'=>true, ] ], 'params' => [ //Request parameter that will be used to bypass the cache repository 'skipCache'=>'skipCache' ], 'allowed'=>[ //Allow caching only for some methods 'only' =>null, //Allow caching for all available methods, except 'except'=>null ], ],
您可以直接在仓库中覆盖这些设置。
use SOSTheBlack\Repository\Contracts\CacheableInterface;use SOSTheBlack\Repository\Eloquent\BaseRepository;use SOSTheBlack\Repository\Traits\CacheableRepository; class PostRepository extends BaseRepository implements CacheableInterface { // Setting the lifetime of the cache to a repository specifically protected $cacheMinutes = 90; protected $cacheOnly = ['all', ...]; //or protected $cacheExcept = ['find', ...]; use CacheableRepository; ... }
可缓存的函数有:all、paginate、find、findByField、findWhere、getByCriteria
验证器
需要sostheblack/laravel-validator。 composer require sostheblack/laravel-validator
使用sostheblack/laravel-validator
进行简单的验证
使用验证器类
创建验证器
在下面的示例中,我们为创建和编辑定义了一些规则
use SOSTheBlack\Repository\Validators\LaravelValidator; class PostValidator extends LaravelValidator { protected $rules = [ 'title' => 'required', 'text' => 'min:3', 'author'=> 'required' ]; }
要定义特定规则,请按照以下步骤操作
use SOSTheBlack\Repository\Contracts\ValidatorInterface; use SOSTheBlack\Repository\Validators\LaravelValidator; class PostValidator extends LaravelValidator { protected $rules = [ ValidatorInterface::RULE_CREATE => [ 'title' => 'required', 'text' => 'min:3', 'author'=> 'required' ], ValidatorInterface::RULE_UPDATE => [ 'title' => 'required' ] ]; }
在仓库中启用验证器
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { /** * Specify Model class name * * @return mixed */ function model(){ return "App\\Post"; } /** * Specify Validator class name * * @return mixed */ public function validator() { return "App\\PostValidator"; } }
在仓库中定义规则
或者,您可以直接将规则设置到rules仓库属性中,而不是使用类来定义验证规则,这将与Validation类具有相同的效果。
use SOSTheBlack\Repository\Contracts\ValidatorInterface;use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { /** * Specify Validator Rules * @var array */ protected $rules = [ ValidatorInterface::RULE_CREATE => [ 'title' => 'required', 'text' => 'min:3', 'author'=> 'required' ], ValidatorInterface::RULE_UPDATE => [ 'title' => 'required' ] ]; /** * Specify Model class name * * @return mixed */ function model(){ return "App\\Post"; } }
验证现在已就绪。如果失败,将抛出类型为SOSTheBlack\Repository\Exceptions\ValidatorException的异常。
表示器
演示器作为对象的包装器和渲染器。
Fractal表示器
需要Fractal。 composer require league/fractal
实现演示器有两种方式,第一种是创建一个TransformerAbstract并使用您的演示器类,如创建Transformer类中所述。
第二种方式是使您的模型实现Transformable接口,并使用默认的演示器ModelFractarPresenter,这将产生相同的效果。
转换器类
使用以下命令创建转换器
php artisan make:transformer Post
这将生成以下类。
创建转换器类
use League\Fractal\TransformerAbstract; class PostTransformer extends TransformerAbstract { public function transform(\Post $post) { return [ 'id' => (int) $post->id, 'title' => $post->title, 'content' => $post->content ]; } }
使用以下命令创建演示器
php artisan make:presenter Post
如果您尚未创建转换器,命令将提示您创建转换器。
创建演示器
use SOSTheBlack\Repository\Presenter\FractalPresenter; class PostPresenter extends FractalPresenter { /** * Prepare data to present * * @return \League\Fractal\TransformerAbstract */ public function getTransformer() { return new PostTransformer(); } }
在仓库中启用
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { ... public function presenter() { return "App\\Presenter\\PostPresenter"; } }
或者,在您的控制器中启用它
$this->repository->setPresenter("App\\Presenter\\PostPresenter");
从模型使用演示器后
如果您记录了演讲者并且有时使用了 skipPresenter()
方法,或者您不想自动由演讲者更改结果。您可以在您的模型上实现 Presentable 接口,这样您就可以在任何时候展示您的模型。请看下面的示例。
在您的模型中实现接口 SOSTheBlack\Repository\Contracts\Presentable
和 SOSTheBlack\Repository\Traits\PresentableTrait
namespace App; use SOSTheBlack\Repository\Contracts\Presentable;use SOSTheBlack\Repository\Traits\PresentableTrait; class Post extends Eloquent implements Presentable { use PresentableTrait; protected $fillable = [ 'title', 'author', ... ]; ... }
现在,您可以单独提交您的模型,请看以下示例
$repository = app('App\PostRepository'); $repository->setPresenter("SOSTheBlack\\Repository\\Presenter\\ModelFractalPresenter"); //Getting the result transformed by the presenter directly in the search $post = $repository->find(1); print_r( $post ); //It produces an output as array ... //Skip presenter and bringing the original result of the Model $post = $repository->skipPresenter()->find(1); print_r( $post ); //It produces an output as a Model object print_r( $post->presenter() ); //It produces an output as array
您可以在每次访问时跳过演讲者,并直接在模型中使用它,为了实现这一点,在您的仓库中将 $skipPresenter
属性设置为 true
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { /** * @var bool */ protected $skipPresenter = true; public function presenter() { return "App\\Presenter\\PostPresenter"; } }
模型类
实现接口
namespace App; use SOSTheBlack\Repository\Contracts\Transformable; class Post extends Eloquent implements Transformable { ... /** * @return array */ public function transform() { return [ 'id' => (int) $this->id, 'title' => $this->title, 'content' => $this->content ]; } }
在仓库中启用
SOSTheBlack\Repository\Presenter\ModelFractalPresenter
是为实现了 Transformable 的模型提供的默认演讲者
use SOSTheBlack\Repository\Eloquent\BaseRepository; class PostRepository extends BaseRepository { ... public function presenter() { return "SOSTheBlack\\Repository\\Presenter\\ModelFractalPresenter"; } }
或者,在您的控制器中启用它
$this->repository->setPresenter("SOSTheBlack\\Repository\\Presenter\\ModelFractalPresenter");
在仓库中定义跳过演讲者
在任何其他链式方法之前使用 skipPresenter
$posts = $this->repository->skipPresenter()->all();
或者
$this->repository->skipPresenter(); $posts = $this->repository->all();