acdevelopers/l5-repository-slim

L5 - Repository Slim：andersao/l5-repository 的简化版本

维护者

详细信息

github.com/acdevelopers/l5-repository-slim

源代码

问题

安装次数: 5

依赖项: 0

建议者: 0

安全: 0

星星: 3

关注者: 3

分支: 0

公开问题: 0

v1.0 2019-03-25 11:11 UTC

Requires

MIT 5926e0e1aae9ea7f9cc6044e7e848705c09adae4

  • Anitche Chisom <anitchec.dev.woop@gmail.com>

cacherepositorymodellaraveleloquentlumen

This package is auto-updated.

Last update: 2024-09-16 22:02:38 UTC

README

Laravel 5 Repositories Slim 是 Anderson Andrade 的 andersao/l5-repository 的简化版本，用于抽象数据层。一直觉得原始包比我所需要的多了点，更不用说其中一些功能在 Laravel 的新版本中已经直接提供。所以一切还是一样，只是我移除了 Validator、Presenter 和 Transformer，认为它们可以用 Laravel 的 FormRequest 和 Resource 类来替代。

Latest Stable Version License Latest Unstable Version

想了解更多关于 Repository 模式的内容吗？请阅读这篇优秀的文章。

目录

安装

Composer

执行以下命令以获取软件包的最新版本

composer require acdevelopers/l5-repository-slim

Laravel

>= laravel5.5

ServiceProvider 将自动附加

其他

在你的 config/app.php 中，将 AcDevelopers\Repository\Providers\RepositoryServiceProvider::class 添加到 providers 数组的末尾

'providers' => [
    ...
    AcDevelopers\Repository\Providers\RepositoryServiceProvider::class,
],

如果使用 Lumen

$app->register(AcDevelopers\Repository\Providers\LumenRepositoryServiceProvider::class);

发布配置

php artisan vendor:publish --provider "AcDevelopers\Repository\Providers\RepositoryServiceProvider"

方法

AcDevelopers\Repository\Contracts\RepositoryInterface

  • all($columns = array('*'))
  • first($columns = array('*'))
  • firstOrNew(array $attributes = [])
  • firstOrCreate(array $attributes = [])
  • 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 = [*])
  • 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);

AcDevelopers\Repository\Contracts\RepositoryCriteriaInterface

  • pushCriteria($criteria)
  • popCriteria($criteria)
  • getCriteria()
  • getByCriteria(CriteriaInterface $criteria)
  • skipCriteria($status = true)
  • getFieldsSearchable()

AcDevelopers\Repository\Contracts\CacheableInterface

  • setCacheRepository(CacheRepository $repository)
  • getCacheRepository()
  • getCacheKey($method, $args = null)
  • getCacheMinutes()
  • skipCache($status = true)

AcDevelopers\Repository\Contracts\CriteriaInterface

  • apply($model, RepositoryInterface $repository);

使用方法

创建模型

正常创建您的模型，但重要的是要定义可以从输入表单数据填充的属性。

namespace App;

class Post extends Eloquent { // or Ardent, Or any other Model Class

    protected $fillable = [
        'title',
        'author',
        ...
     ];

     ...
}

创建仓库

namespace App;

use AcDevelopers\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',
            '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',
            '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" 文件夹。

完成了，刚刚您已经绑定了其实际存储库的接口，例如在您的自己的存储库服务提供者中。

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
    ['columnName','>','10']
]);

在一个字段中按多个值查找结果

$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 My

标准是按您的需求应用特定条件来更改查询的存储库的方式。您可以在您的存储库中添加多个标准。

use AcDevelopers\Repository\Contracts\RepositoryInterface;
use AcDevelopers\Repository\Contracts\CriteriaInterface;

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 AcDevelopers\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 AcDevelopers\Repository\Eloquent\BaseRepository;
use AcDevelopers\Repository\Criteria\RequestCriteria;


class PostRepository extends BaseRepository {

	/**
     * @var array
     */
    protected $fieldSearchable = [
        'name',
        'email'
    ];

    public function boot(){
        $this->pushCriteria(app('AcDevelopers\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('AcDevelopers\Repository\Criteria\RequestCriteria'));
        $posts = $this->repository->all();
		...
    }

标准示例

通过请求获取所有数据而不进行筛选

http://ac-developers.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://ac-developers.local/users?search=John%20Doe

或者

http://ac-developers.local/users?search=John%20Doe&searchFields=name:like

或者

http://ac-developers.local/users?search=john@gmail.com&searchFields=email:=

或者

http://ac-developers.local/users?search=name:John%20Doe;email:john@gmail.com

或者

http://ac-developers.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"
    }
]

默认情况下，RequestCriteria 使用每个查询参数的 OR 比较操作符进行查询。 http://ac-developers.local/users?search=age:17;email:john@gmail.com

上面的示例将执行以下查询

SELECT * FROM users WHERE age = 17 OR email = 'john@gmail.com';

若要使用 AND 进行查询，请按照以下方式传递 searchJoin 参数

http://ac-developers.local/users?search=age:17;email:john@gmail.com&searchJoin=and

过滤字段

http://ac-developers.local/users?filter=id;name

[
    {
        "id": 1,
        "name": "John Doe"
    },
    {
        "id": 2,
        "name": "Lorem Ipsum"
    },
    {
        "id": 3,
        "name": "Laravel"
    }
]

排序结果

http://ac-developers.local/users?filter=id;name&orderBy=id&sortedBy=desc

[
    {
        "id": 3,
        "name": "Laravel"
    },
    {
        "id": 2,
        "name": "Lorem Ipsum"
    },
    {
        "id": 1,
        "name": "John Doe"
    }
]

通过相关表排序

http://ac-developers.local/users?orderBy=posts|title&sortedBy=desc

查询将类似于以下内容

...
INNER JOIN posts ON users.post_id = posts.id
...
ORDER BY title
...

http://ac-developers.local/users?orderBy=posts:custom_id|posts.title&sortedBy=desc

查询将类似于以下内容

...
INNER JOIN posts ON users.custom_id = posts.id
...
ORDER BY posts.title
...

添加关系

http://ac-developers.local/users?with=groups

重写参数名称

您可以在配置文件 config/repository.php 中更改参数的名称

缓存

轻松为您的存储库添加一层缓存

缓存使用

实现 CacheableInterface 接口并使用 CacheableRepository 特性。

use AcDevelopers\Repository\Eloquent\BaseRepository;
use AcDevelopers\Repository\Contracts\CacheableInterface;
use AcDevelopers\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 AcDevelopers\Repository\Eloquent\BaseRepository;
use AcDevelopers\Repository\Contracts\CacheableInterface;
use AcDevelopers\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

鸣谢

许可

L5 Repository Slim 是开源软件，许可协议为 MIT 许可协议。