如何使用 Repository 模式?

最新推荐文章于 2024-05-03 14:36:14 发布
最新推荐文章于 2024-05-03 14:36:14 发布
阅读量2k 收藏 5
点赞数 1
分类专栏： laravel 文章标签：  中达型项目架构
原文链接：https://oomusou.io/laravel/repository
版权

如何使用 Repository 模式?

 使用 Repository 辅助 Model

Contents

  1. Version
  2. 资料库逻辑
  3. Model
  4. Repository
  5. Conclusion
  6. Sample Code

若将资料库逻辑都写在 model，会造成 model 的肥大而难以维护，基于SOLID原則，我们应该使用 Repository 模式辅助 model，将相关的资料库逻辑封装在不同的 repository，方便中大型项目的维护。

Version

Laravel 5.1.22

资料库逻辑

在 CRUD 中，CUD 比较稳定，但 R 的部分则千变万化，大部分的资料库逻辑都在描述 R 的部分，若将资料库逻辑写在 controller 或 model 都不适当，会造成 controller 与 model 肥大，造成日后难以维护。

Model

使用 repository 之后，model 仅当成Eloquent class 即可，不要包含资料库逻辑，仅保留以下部分 :

  • Property : 如$table，$fillable…等。
  • Mutator: 包括 mutator 与 accessor。
  • Method : relation 类的 method，如使用 hasMany() 与 belongsTo()。
  • 注解 : 因为 Eloquent 会根据资料库栏位动态产生 property 与 method，等。若使用 Laravel IDE Helper，会直接在 model 加上 @property 与 @method 描述 model 的动态 property 与 method。

User.php

app/User.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

namespace MyBlog;

use Illuminate\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;


/**
 * MyBlog\User
 *
 * @property integer $id
 * @property string $name
 * @property string $email
 * @property string $password
 * @property string $remember_token
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereName($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereEmail($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User wherePassword($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereRememberToken($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereCreatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereUpdatedAt($value)
 */
class User extends Model implements AuthenticatableContract,
                                    AuthorizableContract,
                                    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword;

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'users';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'email', 'password'];

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = ['password', 'remember_token'];
}

 

12行

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

/**
 * MyBlog\User
 *
 * @property integer $id
 * @property string $name
 * @property string $email
 * @property string $password
 * @property string $remember_token
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereName($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereEmail($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User wherePassword($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereRememberToken($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereCreatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\MyBlog\User whereUpdatedAt($value)
 */

 

IDE-Helper 帮我们替 model 加上注解，让我们可以在 PhpStorm 的语法提示使用 model 的 property 与 method。

Repository

初学者常会在 controller 直接调用 model 写资料库逻辑 :

1
2
3
4
5
6
7
8

public function index()
{
    $users = User::where('age', '>', 20)
                ->orderBy('age')
                ->get();

    return view('users.index', compact('users'));
}

资料库逻辑是要抓 20 岁以上的资料。

在中大型专案中，会有几个问题 :

  1. 将资料库逻辑写在 controller，造成 controller 的肥大难以维护。
  2. 违反 SOLID 的单一职责原則 : 资料库逻辑不应该写在 controller。
  3. controller 直接相依于model，使得我们无法对 controller 做单元测试。

比较好的方式是使用 repository :

  1. 将 model 依赖注入到 repository。
  2. 将资料库逻辑写在 repository。
  3. 将 repository 依赖注入到 service。

UserRepository.php

app/Repositories/UserRepository.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

namespace MyBlog\Repositories;

use Doctrine\Common\Collections\Collection;
use MyBlog\User;

class UserRepository
{
    /** @var User 注入的User model */
    protected $user;

    /**
     * UserRepository constructor.
     * @param User $user
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * 回传大于?年级的资料
     * @param integer $age
     * @return Collection
     */
    public function getAgeLargerThan($age)
    {
        return $this->user
            ->where('age', '>', $age)
            ->orderBy('age')
            ->get();
    }
}

 

第 8 行

1
2
3
4
5
6
7
8
9
10
11

/** @var User 注入的User model */
protected $user;

/**
 * UserRepository constructor.
 * @param User $user
 */
public function __construct(User $user)
{
    $this->user = $user;
}

 

将相依的 User model 依赖注入到 UserRepository。

21 行

1
2
3
4
5
6
7
8
9
10
11
12

/**
 * 回传大于?年级的资料
 * @param integer $age
 * @return Collection
 */
public function getAgeLargerThan($age)
{
    return $this->user
        ->where('age', '>', $age)
        ->orderBy('age')
        ->get();
}

 

将抓 20 岁以上的资料的资料库逻辑写在 getAgeLargerThan()。

不是使用User facade，而是使用注入的$this->user。33这里也可以使用User facade 的方式，并不会影响可测试性，因为在测试 repository 时，会真的去读写资料库，而不会去 mock User model，因此可以依可测试性決定要用依赖注入还是 Facade。

UserController.php

app/Http/Controllers/UserController.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

namespace App\Http\Controllers;

use App\Http\Requests;
use MyBlog\Repositories\UserRepository;

class UserController extends Controller
{
    /** @var  UserRepository 注入的UserRepository */
    protected $userRepository;

    /**
     * UserController constructor.
     *
     * @param UserRepository $userRepository
     */
    public function __construct(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $users = $this->userRepository
            ->getAgeLargerThan(20);

        return view('users.index', compact('users'));
    }
}

 

第8行

1
2
3
4
5
6
7
8
9
10
11
12

/** @var  UserRepository 注入的UserRepository */
protected $userRepository;

/**
 * UserController constructor.
 *
 * @param UserRepository $userRepository
 */
public function __construct(UserRepository $userRepository)
{
    $this->userRepository = $userRepository;
}

 

将相依的 UserRepository 依赖注入到 UserController。

26行

1
2
3
4
5
6
7
8
9
10
11
12

/**
 * Display a listing of the resource.
 *
 * @return \Illuminate\Http\Response
 */
public function index()
{
    $users = $this->userRepository
        ->getAgeLargerThan(20);

    return view('users.index', compact('users'));
}

 

从原本直接相依的 User model，改成依赖注入的 UserRepository。

 改用这种写法，有几个优点 :

  1. 将资料库逻辑料写在 repository，解决 controller 肥大问题。
  2. 符合 SOLID 的单一职责原則 : 资料库逻辑写在 repository，沒写在 controller。
  3. 符合 SOLID 的依賴反转原則 : controller 并非直接相依于 repository，而是将 repository 依赖注入进 controller。

 实际上建议 repository 仅依赖注入于 service，而不要直接注入在 controller，本范例因为还沒介绍到 servie 模式，为了简化起见，所以直接注入于 controller。

 是否该建立 Repository Interface?

理论上使用依赖注入时，应该使用 interface，不过 interface 目的在于抽象化方便抽换，让程式码达到开放封闭的要求，但是实际上要抽换 repository 的机会不高，除非你有抽换资料库的需求，如从 MySQL 抽换到 MongoDB，此时就该建立 repository interface。

不过由于我们使用了依赖注入，将来要从 class 改成 interface 也很方便，只要在 constructor 的 type hint 改成 interface 即可，维护成本很低，所以在此大可使用 repository class 即可，不一定得用 interface 而造成 over design，等真正需求来时再重构成 interface 即可。

 是否该使用 Query Scope？

Laravel 4.2 就有 query scope，到 5.1 都还留着，它让我们可以将商业逻辑写在 model，解決了维护与重复使用的问题。

User.php

app/User.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

namespace MyBlog;

use Illuminate\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;

/**
 * (注解:略)
 */
class User extends Model implements AuthenticatableContract,
                                    AuthorizableContract,
                                    CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword;

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'users';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'email', 'password'];

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = ['password', 'remember_token'];

    /**
     * 回传大于?年级的资料
     * @param Builder $query
     * @param integer $age
     * @return Builder
     */
    public function scopeGetAgerLargerThan($query, $age)
    {
        return $query->where('age', '>', $age)
            ->orderBy('age');
    }
}

 

42行

1
2
3
4
5
6
7
8
9
10
11

/**
 * 回传大于?年级的资料
 * @param Builder $query
 * @param integer $age
 * @return Builder
 */
public function scopeGetAgerLargerThan($query, $age)
{
    return $query->where('age', '>', $age)
        ->orderBy('age');
}

 

Query scope 必須以 scope 为 prefix，第 1 个参数为 query builder，一定要加，是 Laravel 要用的。

第2个参数以后为自己要传入的参数。

由于回传也必须是一个 query builder，因此不加上 get()。

UserController.php

app/Http/Controllers/UserController.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

namespace App\Http\Controllers;

use App\Http\Requests;
use MyBlog\User;

class UserController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $users = User::getAgerLargerThan(20)->get();

        return view('users.index', compact('users'));
    }
}

 

在 controller 呼叫 query scope 时，不要加上 prefix，由于其本质是 query builder，所以还要加上 get() 才能抓到Collection。

由于 query scope 是写在 model，不是写在 controller，所以基本上解決了 controller 肥大与违反 SOLID 的单一职责原则的问题，controller 也可以重复使用 query scope，已经比直接将资料库写在 controller 好很多了。

不过若在中大型项目，仍有以下问题 :

  1. Model 已经有原来的责任，若再加上 query scope，造成 model 过于肥大难以维护。
  2. 若资料库逻辑很多，可以拆成多 repository，可是却很难拆成多 model。
  3. 单元测试困难，必须面临 mock Eloquent 的问题。

Conclusion

  • 业务上可以一开始 1 个 repository 对应 1 个 model，但不用太执着于 1 个 repository 一定要对应 1 个 model，可将 repository 视为逻辑上的资料库逻辑类别即可，可以横跨多个 model 处理，也可以 1 个 model 拆成多个 repository，这看需求而定。
  • Repository 使得资料库逻辑从 controller 或 model中解放，不仅更容易维护、更容易扩展、更容易重复使用，且更容易测试。

文章来源：https://oomusou.io/laravel/repository

华尔街之猫
关注
  • 1
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
MVC中使用Repository模式vs2013
02-01
一、在MVC中开发的时候，避免在Controllers中直接访问数据,为了构建更加适应未来变化以及更加易于测试的MVC应用程序，应使用Repository模式。当你使用Repository模式时，你会创建一个独立的repository类，它包含了所有的数据访问逻辑。当你创建repository类时，创建了一个接口，该接口代表着所有由repository类所使用的方法。在你的控制器中，你针对接口编写代码，而不是针对repository。通过这种方式，你以后可以使用不同的数据访问技术来实现repository 二、数据访问使用EntityFramework,为了方便使用Northwind作为示例数据 三、在Models中,创建IEmployeeRepository接口 四、在Models中,创建EmployeeRepository类,该类实现IEmployeeRepository接口,并实现接口中的方法
Spring Boot学习笔记（三）Repository的使用
glenshappy的专栏
11-16 4676
在Spring中有Repository的概念，repository原意指的是仓库，即数据仓库的意思。Repository居于业务层和数据层之间，将两者隔离开来，在它的内部封装了数据查询和存储的逻辑。这样设计的好处有两个： 降低层级之间的耦合：更换、升级ORM引擎（Hibernate）并不会影响业务逻辑 提高测试效率：如果在测试时能用Mock数据对象代替实际的数据库操作，运行速度会快很多 Repository和DAO的区别 DAO是传统MVC中Model的关键角色，全称是Data Access Obje
【Android Gradle 插件】Android Studio 工程 Gradle 构建流程 ② ( settings(1)
最新发布
2401_84159839的博客
05-03 1081
dependencyResolutionManagement 脚本块 ,在 dependencyResolutionManagement 脚本块 中 定义的代码的含义是 解析依赖时 , 只能使用本脚本块中的 Maven 仓库 , 不能使用 Module 子项目中的依赖;参考之前的博客中的配置 ,
Spring Boot学习笔记--Repository的使用
qq_34075488的博客
12-20 2259
目录 一，信息库的概念 二，资源库和DAO的区别 三，库介绍 3.1 CrudRepository源码 3.2 PagingAndSortingRepository 3.3 JpaRepository 一，信息库的概念 库原意指的是仓库，即数据仓库的意思.Repository居于业务层和数据层之间，将两者隔离开来，在它的内部封装了数据查询和存储的逻辑。这样设计的好处有两个： 降低...
Laravel使用Repository模式
因为我很笨拙。
06-19 1899
设计模式是程序设计的技巧，在特殊场景中它能让我们更容易去解决问题。然而设计模式并不局限于一种语言，它是一种编程思想的体现。在开发过程中最主要的事情是需要理解它的原则，并知道怎样去使用它。Repository也是一种设计模式，在这篇文章中，我将会介绍怎样在Laravel中使用这种模式。 个人博客原文：http://www.muyesanren.com/2017/06/19/repository-p
如何在Laravel5.8中正确地应用Repository设计模式
10-15
主要介绍了如何在Laravel5.8中正确地应用Repository设计模式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Dapper结合Repository模式的应用
11-09
Dapper结合Repository模式的应用，包括如何在数据访问层（DAL）使用Dapper组件。
使用LINQtoSQL采用Repository模式实现三层架构.pdf
10-02
使用LINQtoSQL采用Repository模式实现三层架构.pdf
repository:Repository 分层实现组件
05-09
只要项目分层，都应当使用这个模式。这样做有几个好处：把数据处理逻辑分离使得代码更容易维护数据处理逻辑和业务逻辑分离，可以对这两个代码分别进行测试减少代码重复降低代码出错的几率让controller代码的可读性...
Repository模式
weixin_30394633的博客
03-16 80
http://www.cnblogs.com/carysun/archive/2009/03/20/repository.html 近来发现很多ASP.NET MVC的例子中都使用了Repository模式，比如Oxite，ScottGu最近发布的免费的ASP.NET MVC教程都使用了该模式。就简单看了下。 在《企业架构模式》中，译者将Repository翻译为资源库。给出如...
如何在laravel中使用Repository Pattern(仓库模式)
韩某的博客
02-25 564
来，这样做的好处有以下几点： 把数据处理逻辑分离使得代码更容易维护 数据处理逻辑和业务逻辑分离，可以对这两个代码分别进行测试 减少代码重复 降低代码出错的几率 让 controller 代码的可读性大大提高 如图所示 Repository 的分层关系 然而，要独立一个操作层出来，那就会增加大量代码，非常繁琐。如果你是小项目，未必需要使用这一模式。但如果是 4-5 年以上的复杂大型项目，这种模式的好处就比较明显了。 学习 Repository Pattern 的意义不只是为了使用它，更.
laravel进阶---repository仓库模式的使用
weixin_42265596的博客
07-06 1587
前言 在自学了一段时间的laravel之后，小编自认为对于laravel这个框架还是基本可以掌握的。但是最近看了一份实验室的项目源码之后，小编感触良多。首先别人的代码总体上给人一种既简洁明了又高大上的感觉，代码看着简单但仔细去看，有的地方小编也一时看不懂。再反过来看小编自己的代码 (写的那是啥，简直惨不忍睹）。后来小编仔细的想了一下，为啥别人的代码可以写的如此的华丽呢，比对了我们两者的代码，小编发...
model repository项目踩坑记录
NeverLate_gogogo的博客
06-29 965
一、model repository介绍 1、开发工具 python3.7 svn bash脚本 gunicorn fastapi sqlalchemy docker k8s git mysql 2、model repository是什么？ model repository是一个类似于github的模型版本管理网站，实现以项目为单位的现在协作的模型开发，主要实现的功能有： 模型版本管理（pygit2） 用户权限管理（涉及多种权限，pycasbin） 项目管理 模型管理 模型
使用@Param注解时注意org.springframework.data.repository.query.Param与org.apache.ibatis.annotations.Param的区别
qq_42945742的博客
02-15 3278
在mybatis的Map类中，方法参数为多个时，前面一般需要加上@Param注解，例如 User getUser(@Param(“userId”)String userId,@Param(“password”)String password); @Param注解分为spring的和mybatis的： org.springframework.data.repository.query.Param与o...
Laravel技巧集锦（27）：使用Repository分离model、controller
03-23 946
说明：实际开发时，如果控制器中写的代码太多会影响可读性，因此可以将控制器中的代码放入到Repository中，在控制器中调用就可以了。 1、创建Repositories目录，位于app目录下 2、创建ArticelRepository.php文件，目录为app\Repositories\ArticelRepository.php，定义CURD操作 namespace App\Reposit...
【spring data jpa】repository中使用@Query注解使用hql查询，使用@Param引用参数，报错：For queries with named parameters you ...
weixin_33754065的博客
04-12 7742
在spring boot中， repository中使用@Query注解使用hql查询，使用@Param引用参数 如题报错： For queries with named parameters you need to use provide names for method parameters. Use @Param for query method parameters, or when on...
mvc中repository和model有什么关系
m0_57236802的博客
11-22 88
Model代表应用程序的“数据”和“行为”，是业务逻辑和数据的直接表现。Repository作为数据访问层的一部分，处理与数据存储相关的操作，为Model层提供数据支持。在实际应用中，Repository从数据库或其他数据源获取数据，将其转换为Model对象，并将这些Model对象传递给业务逻辑层（Service层）。Service层处理业务逻辑，并使用Repository来持久化或查询Model数据。这种分离使得业务逻辑与数据存储机制之间保持了清晰的分界线，有助于代码的组织和维护。在这个例子中，
DDD领域驱动设计实战-DDD微服务代码结构
qianshanding0708的博客
02-21 924
更多内容关注微信公众号：fullstack888DDD并没有给出标准的代码模型，不同的人可能会有不同理解。按DDD分层架构的分层职责定义，在代码模型里分别为用户接口层、应用层、领域层和基础层，建立了 interfaces、application、domain 和 infrastructure 四个一级目录。1 Interfaces（用户接口层）存放用户接口层与前端交互、展现数据相关的代码。前端应用...
Repository怎么使用
06-09
Repository是一种设计模式，通常在数据访问层中使用，用于处理数据存储和检索。在Java中，Spring框架提供了一组数据访问工具，其中包括一种称为Repository的组件，它提供了一些常见的数据操作方法，例如保存、查询和删除等。 要使用Repository，首先需要定义一个接口，该接口继承自Spring提供的`org.springframework.data.repository.Repository`接口，并指定实体类型和主键类型。在这个接口中，可以定义一些抽象方法，这些方法将在实现该接口的类中实现。 接下来，需要创建一个实现该接口的类，并使用`@Repository`注解将其标记为Repository组件。Spring框架将自动为这个类创建实例，并将其注册到应用程序上下文中。 在使用Repository时，只需在需要访问数据的地方注入相应的Repository实例，然后调用其定义的方法即可。在调用这些方法时，Spring框架将自动处理与数据存储相关的细节，例如数据库连接、事务管理等等。这样可以大大简化代码，提高开发效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值