2. 程式人生 > >Laravel框架中如何使用 Repository 模式

Laravel框架中如何使用 Repository 模式

阿新 • • 發佈：2018-12-26

源：http://www.sangeng.org/blog/index/detail/id/518.html

若將資料庫邏輯都寫在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
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行

    /**
* 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寫資料庫邏輯：

    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：
    4. 將model依賴注入到repository。
    5. 將資料庫邏輯寫在repository。

    6. 將repository依賴注入到service。
      UserRepository.php

      app/Repositories/UserRepository.php
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 行

      /** @var User 注入的User model */
protected $user;
/**
* UserRepository constructor.
* @param User $user
*/
public function __construct(User $user)
{
$this->user = $user;
}

      將相依的User model依賴注入到UserRepository。
      21 行

      /**
* 回傳大於？年紀的資料
* @param integer $age
* @return Collection
*/
public function getAgeLargerThan($age)
{
return $this->user
 ->where('age', '>', $age)
 ->orderBy('age')
 ->get();
}

      將抓20歲以上的資料的資料庫邏輯寫在getAgeLargerThan（）。
      不是使用User facade，而是使用注入的$this->user
      UserController.php
      app/Http/Controllers/UserController.php

      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行

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

      將相依的UserRepository依賴注入到UserController。
      26行

      /**
* 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。
      改用這種寫法，有幾個優點：

    • 將資料庫邏輯寫在repository，解決controller肥大問題。
    • 符合SOLID的單一職責原則：資料庫邏輯寫在repository，沒寫在controller。
    • 符合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

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行

/**
 * 回傳大於？年紀的資料
 * @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
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中解放，不僅更容易維護、更容易擴充套件、更容易重複使用，且更容易測試。
Sample Code
完整的示例可以在我的GitHub上找到。

相關推薦

Laravel框架中如何使用 Repository 模式

源：http://www.sangeng.org/blog/index/detail/id/518.html 若將資料庫邏輯都寫在model，會造成model的肥大而難以維護，基於SOLID原則，我們應該使用Repository模式輔助model，將相關的資料庫邏輯封裝在不同的repositor

Laravel框架中使用Service模式

若將商業邏輯都寫在controller，會造成controller肥大而難以維護，基於SOLID原則，我們應該使用Service模式輔助controller，將相關的商業邏輯封裝在不同的service，方便中大型專案的維護。 Version Laravel 5.1.22

Laravel框架中如何使用Service模式

源：http://www.sangeng.org/blog/index/detail/id/519.html   若將商業邏輯都寫在controller，會造成controller肥大而難以維護，基於SOLID原則，我們應該使用Service模式輔助controller，將相關的商

laravel框架中所蘊含的兩個重要的面向物件設計模式

1.1、IoC是什麼 　　Ioc—Inversionof Control，即“控制反轉”，不是什麼技術，而是一種設計思想。在Java開發中，Ioc意味著將你設計好的物件交給容器控制，而不是傳統的在你的物件內部直接控制。如何理解好Ioc呢？理解好Ioc的關鍵是要明確“誰控制誰

Laravel框架中的make方法詳解

option 節奏 構建 可能 特性 關系 翻譯 空數組 過程 為什麽網上已經有這麽多的介紹Laravel的執行流程了，Laravel的容器詳解了，Laravel的特性了，Laravel的啟動過程了之類的文章，我還要來再分享呢？ 因為，每個人的思維方式和方向是不一樣的，所以

Laravel框架中的event事件操作

clas smo php文件 cad ron div protect cache 框架 有時候當我們單純的看 Laravel 手冊的時候會有一些疑惑，比如說系統服務下的授權和事件，這些功能服務的應用場景是什麽，其實如果沒有經歷過一定的開發經驗有這些疑惑是很正常的事情，但是當

laravel框架中的MySQL事務處理

整了半天沒明白事務為什麼會失敗!最後還是解決掉了,記錄一下,以防忘記,可以參考參考!!! public function index() { $UserModel = new User(); DB::beginTransaction(); //開啟事務 $o = $Use

Laravel框架中常用PHP語法-匿名函式

Laravel框架之所以被稱為優雅的框架，是因為他在框架中使用大量的PHP新語法，包括名稱空間、匿名函式、反射機制、後期靜態繫結等，才使得Laravel框架顯得簡潔易擴充套件。 匿名函式 匿名函式（Anonymous functions）也叫閉包函式（Closure），

Laravel框架中縮小webpack打包vue js的體積

轉載，原文： Laravel框架中縮小Vue應用的體積 https://www.codercto.com/a/12720.html laravel中 webpack打包生成的app.js居然有3M，生成的production版也有1.4M，放到伺服器上，首頁開啟要十幾秒（1M

在laravel框架中：Error 1366: Incorrect string value: '\xF0\x9F\x91\xBD\xF0\x9F...' for column 'content'

可能的原因： 第一：檢查以下你的編輯器的編碼是否設定為UTF-8；這是最容易忽略的原因之一。 第二：檢查以下你資料庫的varchar/char等相關欄位是否已經設定為utf8 如果用的是navicat，需要檢查兩個地方; 是否都已經設定： 實在不行就

laravel框架中引入百度編輯器

第一步:先去這個https://ueditor.baidu.com/website/download.html 下載原始碼包   2.然後把他拉到laravel框架的public下  方便呼叫 3.開啟裡面的index頁面   把這

laravel框架中引入全域性錯誤碼以及相關報錯資訊

project\config\errorcode.php <?php /** * Created by PhpStorm. * User: DELL * Date: 2018/9/6 * Time: 10:28 */ return [ /*

Laravel框架中整合MongoDB和使用:

* 推薦元件composer require jenssegers/mongodb ^3.3 -vvv(本人的laravel版本是5.5)修改config/app.php* 註冊服務Jenssegers\Mongodb\MongodbServiceProvider::clas

在laravel框架中使用mongodb資料庫

在laravel框架中使用mongodb，前提是你已經安裝好了mongodb及mongodb的php擴充套件。 沒有安裝的，具體可以參照部落格http://blog.csdn.net/turtleo

Laravel框架中列印sql

 在使用Laravel框架的時候，除錯的時候，需要將查詢的SQL輸出校驗，這是需要將SQL打印出來。 一、方法 DB::connection()->enableQueryLog();  // 開啟查詢日誌 DB::table('my_table')->insert($da

Laravel框架中Blade模板的用法

1. 繼承、片段、佔位、元件、插槽 1.1 繼承 1、定義父模板 Laravel/resources/views/base.blade.php 2、子模板繼承 @extends('base') 1.2 片段 1、父模板定義片段 @section('part') // 中間內容即使是一個片段 @sh

在laravel框架中：Error 1366: Incorrect string value: '\xF0\x9F\x91\xBD\xF0\x9F...' for column 'content'

可能的原因： 第一：檢查以下你的編輯器的編碼是否設定為UTF-8；這是最容易忽略的原因之一。 第二：檢查以下你資料庫的varchar/char等相關欄位是否已經設定為utf8 如果用的是navicat，需要檢查兩個地方; 是否都已經設定： 實在不行就將utf8改成

在laravel框架中獲取路徑的函式

app_path() app_path函式返回app目錄的絕對路徑： $path = app_path(); 你還可以使用app_path函式為相對於app目錄的給定檔案生成絕對路徑： $path = app_path('Http/Controllers

Laravel框架中簡單使用中介軟體

簡介 HTTP 中介軟體提供一個方便的機制來過濾進入應用程式的 HTTP 請求，例如，Laravel 預設包含了一箇中間件來檢驗使用者身份驗證，如果使用者沒有經過身份驗證，中介軟體會將使用者導向登

laravel 框架中手寫rbac

<?php /** * Created by PhpStorm. * User: 青春已被放縱了 * Date: 2017/1/6 * Time: 16:30 */ namespace