reallyli / laravel-repository
Laravel 仓库模式实现
1.0.6
2019-11-08 03:40 UTC
Requires
- php: ^7.0
- illuminate/database: ^5.7|^6.0
- illuminate/support: ^5.5|^6.0
README
Laravel Repository 是一个用于 Laravel 5.7 的包,用于抽象数据库层。这使得应用程序更容易维护。
本项目与其他项目的区别主要在于
- 使用 Eloquent 模型作为实体
- 将业务逻辑放入 Eloquent 模型
- 始终使用仓库来持久化 Eloquent 模型,
$repository->save($model)
; - 不要直接调用
$model->save, $model->update, $model->delete
等持久化方法,始终使用$repository->save($model)
安装
从您的终端运行以下命令
composer require tlikai/laravel-repository
或者将其添加到您的 composer.json 文件中的 require 部分
"tlikai/repository": "^1.0"
然后运行 composer update
用法
首先,创建您的仓库类。请注意,您的仓库类必须扩展 Uniqueway\Repositories\Eloquent\Repository
并实现 model() 方法
<?php namespace App\Repositories; use Uniqueway\Repositories\Contracts\RepositoryInterface; use Uniqueway\Repositories\Eloquent\Repository; class FilmsRepository extends Repository { public function model() { return 'App\Film'; } }
通过实现 model()
方法,您告诉仓库您想使用哪个模型类。现在,创建 App\Film
模型
<?php namespace App; use Illuminate\Database\Eloquent\Model; class Film extends Model { protected $primaryKey = 'film_id'; protected $table = 'film'; protected $casts = [ "rental_rate" => 'float' ]; }
最后,在控制器中使用仓库
<?php namespace App\Http\Controllers; use App\Repositories\FilmsRepository as Film; class FilmsController extends Controller { private $film; public function __construct(Film $film) { $this->film = $film; } public function index() { return \Response::json($this->film->all()); } }
可用方法
以下方法可用
Uniqueway\Repositories\Contracts\RepositoryInterface
public function all($columns = array('*')) public function lists($value, $key = null) public function paginate($perPage = 1, $columns = array('*')) public function save($model) public function delete($model) public function find($id, $columns = array('*')) public function findBy($field, $value, $columns = array('*')) public function findAllBy($field, $value, $columns = array('*')) public function findWhere($where, $columns = array('*')) public function findWhereIn($field, $values, $columns = ['*']) public function whereHas($relation, $closure)
Uniqueway\Repositories\Contracts\CriteriaInterface
public function apply($model, Repository $repository)
示例用法
按 ID 查找电影;
$this->film->find($id);
创建新的电影
$film = new Film; $film->fill($attributes); $this->film->save($film);
更新现有电影
$film = $this->film->find($id); $film->fill($attributes); $this->film->save($film);
删除电影
$film = $this->film->find($id); $this->film->delete($film);
Find one film by column
```php
$this->film->findBy('title', $title);
按列查找所有电影
$this->film->findAllBy('author_id', $author_id);
通过多个字段获取所有行
$this->film->findWhere([ 'author_id' => $author_id, ['year','>',$year] ]);
将领域逻辑放入模型,使用仓库持久化
<?php namespace App; use Illuminate\Database\Eloquent\Model; class Film extends Model { protected $primaryKey = 'film_id'; protected $table = 'film'; protected $casts = [ "rental_rate" => 'float' ]; public function publish() { $this->status = 'publish'; } } ?> <?php namespace App\Http\Controllers; use App\Repositories\FilmsRepository as Film; class FilmsController extends Controller { private $film; public function __construct(Film $film) { $this->film = $film; } public function markAsPublish(Request $request, $id) { $film = $this->film->find($id); $film->publish(); $this->film->save($film); return \Response::ok(); } } ?>
条件
条件是一个简单的方式来应用特定的条件,或将一组条件应用到仓库查询中。您的条件类必须扩展抽象类 Uniqueway\Repositories\Criteria\Criteria
。
这是一个简单的条件
<?php namespace App\Repositories\Criteria\Films; use Uniqueway\Repositories\Criteria\Criteria; use Uniqueway\Repositories\Contracts\RepositoryInterface as Repository; class LengthOverTwoHours extends Criteria { /** * @param $model * @param RepositoryInterface $repository * @return mixed */ public function apply($model, Repository $repository) { $model = $model->where('length', '>', 120); return $model; } }
现在,在您的控制器类中调用 pushCriteria 方法
<?php namespace App\Http\Controllers; use App\Repositories\Criteria\Films\LengthOverTwoHours; use App\Repositories\FilmsRepository as Film; class FilmsController extends Controller { /** * @var Film */ private $film; public function __construct(Film $film) { $this->film = $film; } public function index() { $this->film->pushCriteria(new LengthOverTwoHours()); return \Response::json($this->film->all()); } }