資料庫：分頁

• 簡介
• 基礎用法
  • 為 Query Builder 的結果分頁
  • 為 Eloquent 的結果分頁
  • Cursor Pagination
  • 手動建立 Paginator
  • 自訂 URL
• 顯示 Pagination 的結果
  • 調整 Pagination Link Window
  • 將結果轉為 JSON
• 自訂 Pagination 的 View
  • 使用 Bootstrap
• Paginator 與 LengthAwarePaginator 實體的方法
• Cursor Paginator 實體的方法

簡介

在其他框架中，要進行分頁非常麻煩。我們希望在 Laravel 中可以非常輕鬆地做出分頁功能。Laravel 的 Paginator(分頁程式)與 Query Builder 以及 Eloquent ORM 都進行了整合，不需要進行任何設定就能非常方便輕鬆地為資料庫內的資料進行分頁。

預設情況下，Paginator 產生的 HTML 相容於 Tailwind CSS。不過，Laravel 也有提供 Bootstrap Pagination 的支援。

Tailwind JIT

若要將 Laravel 的預設 Tailwind Pagination View 與 Tailwind JIT Engine 搭配使用，則請確保專案的 tailwind.config.js 中，content 索引鍵有參照到 Laravel 的 Pagination View，以避免 Pagination View 中的 Tailwind Class 被清除：

1content: [
2    './resources/**/*.blade.php',
3    './resources/**/*.js',
4    './resources/**/*.vue',
5    './vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
6],
1content: [
2    './resources/**/*.blade.php',
3    './resources/**/*.js',
4    './resources/**/*.vue',
5    './vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php',
6],

基礎用法

為 Query Builder 的結果進行分頁

要將資料進行分頁有許多方法。最簡單的方法就是在 Query Builder 或 Eloquent query 上使用 paginate 方法。paginate 方法會自動依照使用者額目前正在檢視的頁面來設定查詢的「LIMIT」與「OFFSET」。預設情況下，會使用 HTTP Request 上的 page Query String 引數來偵測目前的頁面。Laravel 會自動偵測這個值，並且在 Paginator 所產生的連結中也會自動插入這個值。

在這個範例中，傳給 paginate 方法的唯一一個引數為要「每頁(Per Page)」要顯示的項目數。在這個例子中，我們來指定每頁要顯示 15 筆資料：

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Support\Facades\DB;
 7use Illuminate\View\View;
 8 
 9class UserController extends Controller
10{
11    /**
12     * Show all application users.
13     */
14    public function index(): View
15    {
16        return view('user.index', [
17            'users' => DB::table('users')->paginate(15)
18        ]);
19    }
20}
 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Support\Facades\DB;
 7use Illuminate\View\View;
 8 
 9class UserController extends Controller
10{
11    /**
12     * Show all application users.
13     */
14    public function index(): View
15    {
16        return view('user.index', [
17            'users' => DB::table('users')->paginate(15)
18        ]);
19    }
20}

Simple Pagination

paginate 方法會在從資料庫中取得資料前，先計算該查詢所包含的資料數。要這麼做 Paginator 才知道這些資料總共有多少頁。不過，如果不打算在 UI 上顯示總頁數，那就不需要去計算資料數。

因此，如果我們只需要在網站 UI 上顯示「上一頁」與「下一頁」按鈕，則可以使用 simplePaginate 方法來執行單一、有效率的查詢：

1$users = DB::table('users')->simplePaginate(15);
1$users = DB::table('users')->simplePaginate(15);

為 Eloquent 查詢結果進行分頁

我們也可以為 Eloquent 的查詢結果進行分頁。在這個例子中，我們會為 App\Models\User Model 進行分頁，並在每頁中顯示 15 筆資料。在程式碼中可以看到，Eloquent 分頁的語法幾乎與 Query Builder 的語法相同：

1use App\Models\User;
2 
3$users = User::paginate(15);
1use App\Models\User;
2 
3$users = User::paginate(15);

當然，我們也可以在呼叫 paginate 方法前先在查詢上設定其他的查詢條件，如 where 子句：

1$users = User::where('votes', '>', 100)->paginate(15);
1$users = User::where('votes', '>', 100)->paginate(15);

我們也可以在 Eloquent Model 上使用 simplePaginate 方法進行分頁：

1$users = User::where('votes', '>', 100)->simplePaginate(15);
1$users = User::where('votes', '>', 100)->simplePaginate(15);

類似地，也可以使用 cursorPaginate 來以 Cursor 為 Eloquent Model 進行分頁：

1$users = User::where('votes', '>', 100)->cursorPaginate(15);
1$users = User::where('votes', '>', 100)->cursorPaginate(15);

在同一頁中包含多個 Paginator 實體

在網站中，有時候我們會需要在同一頁中顯示兩個不同的 Paginator。不過，如果這兩個 Paginator 實體都使用 page Query String 引數來保存目前頁碼的話，則這兩個 Paginator 會衝突。為了解決這樣的衝突，我們可以使用 paginate、simplePaginate、與 cursorPaginate 方法的第三個引數來指定用來保存該 Paginator 頁碼的 Query String 參數：

1use App\Models\User;
2 
3$users = User::where('votes', '>', 100)->paginate(
4    $perPage = 15, $columns = ['*'], $pageName = 'users'
5);
1use App\Models\User;
2 
3$users = User::where('votes', '>', 100)->paginate(
4    $perPage = 15, $columns = ['*'], $pageName = 'users'
5);

使用 Cursor 來分頁

paginate 與 simplePaginate 會使用 SQL 的「Offset」子句來建立查詢，而使用 Cursor 的分頁則會建立一個「Where」子句，該子句會在查詢中用來排序的欄位上進行比較。因此，在 Laravel 所有的分頁方法中，對於資料效能而言，使用 Cursor 的分頁是最有效率的。對於大量的資料、或是可以「無限」往下滑的 UI 來說，就特別適合使用這個方法。

與使用 Offset 的分頁方式不同。使用 Offset 時，Paginator 所產生的 URL 中，Query String 內會包含頁碼。而使用 Cursor 的分頁方式則會在 Query String 中包含一個「Cursor」字串。這個 Cursor 是一個經過編碼的字串，該字串用來表示下一頁的分頁查詢應從哪個地方開始分頁，以及分頁的方向為何：

1http://localhost/users?cursor=eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0
1http://localhost/users?cursor=eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0

我們可以使用 Query Builder 所提供的 cursorPaginate 方法來建立使用 Cursor 的 Paginator 實體。該方法會回傳一個 Illuminate\Pagination\CursorPaginator 的實體：

1$users = DB::table('users')->orderBy('id')->cursorPaginate(15);
1$users = DB::table('users')->orderBy('id')->cursorPaginate(15);

取得 Cursor Paginator 實體後，就可以像使用 paginate 與 simplePaginate 方法一樣顯示分頁結果。有關 Cursor Paginator 上所提供的實體方法之更多資訊，請參考 Cursor Paginator 實體方法的說明文件。

Cursor 與 Offset Pagination 的比較

為了說明使用 Offset 的 Pagination 與使用 Cursor 的 Pagination 間有何差異，讓我們先來看看一個範例的 SQL 查詢。不管使用下面這兩個查詢中的哪個查詢，都會顯示以 id 排列 users 資料表時，「第二頁」的資料：

1# 使用 Offset 的 Pagination...
2select * from users order by id asc limit 15 offset 15;
3 
4# 使用 Cursor 的 Pagination...
5select * from users where id > 15 order by id asc limit 15;
1# 使用 Offset 的 Pagination...
2select * from users order by id asc limit 15 offset 15;
3 
4# 使用 Cursor 的 Pagination...
5select * from users where id > 15 order by id asc limit 15;

比起使用 Offset 的 Pagination，使用 Cursor 的 Pagination 有下列優點：

• 當資料量龐大時，若「Order By」的欄位有索引，則使用 Cursor 的 Pagination 會比較有效率。這是因為，「Offset」子句會先掃描所有先前已經配對的資料。
• 如果這些資料很常寫入的話，當使用者在件事頁面時，若在這個頁面中有新增或刪除資料，使用 Offset 的 Pagination 可能會跳過或重複顯示某些資料。

不過，使用 Cursor 的 Pagination 也有下列限制：

• 與 simplePaginate 類似，使用 Cursor 的 Pagination 只能顯示「下一頁」與「上一頁」的連結，無法產生頁碼連結。
• 在使用 Cursor 的 Pagination 中，必須至少以 1 個不重複欄位排序，或是以多個組合起來不重複的欄位進行排序。不支援有 null 值的欄位。
• 若要在「Order By」子句中包含運算式，則必須先將這些運算式加到「Select」子句內，並設定別名(Alias)後以別名來在「Order By」中使用。
• 不支援有參數的查詢運算式。

手動建立 Paginator

有時候，我們會需要手動建立 Pagination 實體，並手動傳入記憶體中已有的值。若要手動建立 Pagination，則可依照需求手動建立 Illuminate\Pagination\Paginator、Illuminate\Pagination\LengthAwarePaginator、或 Illuminate\Pagination\CursorPaginator 的實體。

使用 Paginator 與 CursorPaginator 類別時，這兩個類別不需要知道資料的總數。因此，在這兩個類別上也沒有能取得最後一頁頁碼的方法。LengthAwarePaginator 接受的引數則幾乎與 Paginator 相同，不過，LengthAwarePaginator 必須要知道資料的總數。

換句話說，Paginator 對應 Query Builder 上的 simplePaginate 方法，而 CursorPaginator 則是對應 cursorPaginate 方法，LengthAwarePaginator 對應 paginate 方法。

自訂分頁的 URL

預設情況下，Paginator 會產生與目前 Request 網址相同的 URI。不過，只要使用 Paginator 的 withPath 方法，我們就能自訂 Paginator 在產生連結時要使用的 URI。舉例來說，若我們要產生像 http://example.com/admin/users?page=N 這樣的連結，則我們需要將 /admin/users 傳給 withPath 方法：

1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->withPath('/admin/users');
7 
8    // ...
9});
1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->withPath('/admin/users');
7 
8    // ...
9});

加上 Query String 值

可以使用 appends 方法來將 Query String 加到分頁連結的最後面。舉例來說，若要在每個分頁連結後方都加上 sort=votes，則應這樣呼叫 appends：

1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->appends(['sort' => 'votes']);
7 
8    // ...
9});
1use App\Models\User;
2 
3Route::get('/users', function () {
4    $users = User::paginate(15);
5 
6    $users->appends(['sort' => 'votes']);
7 
8    // ...
9});

若想將目前 Request 中所有的 Query String 值都加到分頁連結後，請使用 withQueryString 方法：

1$users = User::paginate(15)->withQueryString();
1$users = User::paginate(15)->withQueryString();

附加 Hash Fragment

若想在 Paginator 產生的網址後方加上「Hash Fragment」，請使用 fragment 方法。舉例來說，若要在每個分頁鏈接後方加上 #users，則請像這樣叫用 fragment 方法：

1$users = User::paginate(15)->fragment('users');
1$users = User::paginate(15)->fragment('users');

顯示分頁結果

呼叫 paginate 方法時，該方法會回傳 Illuminate\Pagination\LengthAwarePaginator 的實體，而呼叫 simplePaginate 方法時，則會回傳 Illuminate\Pagination\Paginator 的實體。最後，當呼叫 cursorPaginate 方法時，會回傳 Illuminate\Pagination\CursorPaginator 的實體。

這些物件都提供了各種用來描述分頁結果資料的方法。出了這些輔助方法外，Paginator 實體也是迭代器，所以可以像陣列一樣，以迴圈存取 Paginator 實體。因此，取得結果後，我們就可以使用 Blade 來顯示結果並轉譯出頁面的連結：

1<div class="container">
2    @foreach ($users as $user)
3        {{ $user->name }}
4    @endforeach
5</div>
6 
7{{ $users->links() }}
1<div class="container">
2    @foreach ($users as $user)
3        {{ $user->name }}
4    @endforeach
5</div>
6 
7{{ $users->links() }}

links 方法會將分頁結果中其他頁面的連結轉譯出來。轉譯出來的這些連結都會包含適當的 page Query String 變數。請記得，由 links 方法所產生的 HTML 連結相容於 Tailwind CSS 框架。

調整分頁連結的 Window

Paginator 在顯示分頁連結時，會顯示目前的頁碼以及該頁碼兩側各三頁的連結。只要使用 onEachSide 方法，就能控制 Paginator 在產生連結時目前頁碼的兩側各要顯示多少頁：

1{{ $users->onEachSide(5)->links() }}
1{{ $users->onEachSide(5)->links() }}

將分頁結果轉為 JSON

Laravel 的 Paginator 類別實作了 Illuminate\Contracts\Support\Jsonable 介面 Contract，並提供了一個 toJson 方法。因此，要將分頁結果轉為 JSON 非常簡單。我們也可以在 Route 或 Controller 動作中回傳 Paginator 實體來將 Paginator 實體轉為 JSON：

1use App\Models\User;
2 
3Route::get('/users', function () {
4    return User::paginate();
5});
1use App\Models\User;
2 
3Route::get('/users', function () {
4    return User::paginate();
5});

Paginator 轉換出來的 JSON 中會包含一些詮釋(Meta)資訊，如 total、current_page、last_page……等。在 JSON 陣列中，分頁結果的資料放在 data 索引鍵中。下列為從 Route 中回傳 Paginator 實體所產生的 JSON 範例：

 1{
 2   "total": 50,
 3   "per_page": 15,
 4   "current_page": 1,
 5   "last_page": 4,
 6   "first_page_url": "http://laravel.app?page=1",
 7   "last_page_url": "http://laravel.app?page=4",
 8   "next_page_url": "http://laravel.app?page=2",
 9   "prev_page_url": null,
10   "path": "http://laravel.app",
11   "from": 1,
12   "to": 15,
13   "data":[
14        {
15            // 資料...
16        },
17        {
18            // 資料...
19        }
20   ]
21}
 1{
 2   "total": 50,
 3   "per_page": 15,
 4   "current_page": 1,
 5   "last_page": 4,
 6   "first_page_url": "http://laravel.app?page=1",
 7   "last_page_url": "http://laravel.app?page=4",
 8   "next_page_url": "http://laravel.app?page=2",
 9   "prev_page_url": null,
10   "path": "http://laravel.app",
11   "from": 1,
12   "to": 15,
13   "data":[
14        {
15            // 資料...
16        },
17        {
18            // 資料...
19        }
20   ]
21}

自訂分頁的 View

預設情況下，轉譯出來顯示分頁連結的 View 是相容於 Tailwind CSS 框架的。不過，若不使用 Tailwind，則也可以自行定義自己的 View 來轉譯這些連結。在 Paginator 實體上呼叫 links 方法時，可傳入 View 的名稱作為該方法的第一個引數：

1{{ $paginator->links('view.name') }}
2 
3<!-- 傳入額外資料給 View... -->
4{{ $paginator->links('view.name', ['foo' => 'bar']) }}
1{{ $paginator->links('view.name') }}
2 
3<!-- 傳入額外資料給 View... -->
4{{ $paginator->links('view.name', ['foo' => 'bar']) }}

不過，要自訂分頁連結最簡單的方法是使用 vendor:publish 來將分頁 View 安裝到 resources/views/vendor 目錄下：

1php artisan vendor:publish --tag=laravel-pagination
1php artisan vendor:publish --tag=laravel-pagination

該指令會將分頁的 View 放到專案的 resources/views/vendor/pagination 目錄下。該目錄下的 tailwind.blade.php 為預設的分頁 View。我們可以編輯該檔案來修改分頁的 HTML。

若想指定用不同的檔案來作為預設的分頁 View，則可在 App\Providers\AppServiceProvider 類別的 boot 方法內叫用 Paginator 的 defaultView 與 defaultSimpleView 方法：

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Pagination\Paginator;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class AppServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     */
13    public function boot(): void
14    {
15        Paginator::defaultView('view-name');
16 
17        Paginator::defaultSimpleView('view-name');
18    }
19}
 1<?php
 2 
 3namespace App\Providers;
 4 
 5use Illuminate\Pagination\Paginator;
 6use Illuminate\Support\ServiceProvider;
 7 
 8class AppServiceProvider extends ServiceProvider
 9{
10    /**
11     * Bootstrap any application services.
12     */
13    public function boot(): void
14    {
15        Paginator::defaultView('view-name');
16 
17        Paginator::defaultSimpleView('view-name');
18    }
19}

使用 Bootstrap

Laravel 也提供了適用於 Bootstrap CSS 的分頁 View。若要使用這些 View 來替代預設的 Tailwind View，可以在 App\Providers\AppServiceProvider 內的 boot 方法中呼叫 Paginator 的 useBootstrapFour (用於 Bootstrap 第 4 版) 或 useBootstrapFive (用於 Bootstrap 第 5 版) 方法：

 1use Illuminate\Pagination\Paginator;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(): void
 7{
 8    Paginator::useBootstrapFive();
 9    Paginator::useBootstrapFour();
10}
 1use Illuminate\Pagination\Paginator;
 2 
 3/**
 4 * Bootstrap any application services.
 5 */
 6public function boot(): void
 7{
 8    Paginator::useBootstrapFive();
 9    Paginator::useBootstrapFour();
10}

Paginator / LengthAwarePaginator 實體方法

各個 Paginator 的實體都有提供下列方法，可用來存取額外的資訊：

Cursor Paginator 的實體方法

各個 Cursor Paginator 的實體都有提供下列方法，可用來存取額外的資訊：