URL 生成

📝 此頁面為 Laravel 官方文檔的繁體中文翻譯。查看原始英文版本

URL 生成

簡介

Laravel 提供了多種輔助函數來協助您為應用程式生成 URL。這些輔助函數主要在範本和 API 回應中建立連結時，或在生成到應用程式另一部分的重定向上時很有用。

基礎知識

生成 URL

url 輔助函數可用於為您的應用程式生成任意 URL。生成的 URL 將自動使用當前請求的方案（HTTP 或 HTTPS）和主機：

$post = App\Models\Post::find(1);

echo url("/posts/{$post->id}");

// http://example.com/posts/1

要生成帶有查詢字串參數的 URL，可以使用 query 方法：

echo url()->query('/posts', ['search' => 'Laravel']);

// https://example.com/posts?search=Laravel

echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);

// http://example.com/posts?sort=latest&search=Laravel

提供路徑中已存在的查詢字串參數將覆蓋其現有值：

echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);

// http://example.com/posts?sort=oldest

值陣列也可以作為查詢參數傳遞。這些值將在生成的 URL 中被正確地鍵控和編碼：

echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);

// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body

echo urldecode($url);

// http://example.com/posts?columns[0]=title&columns[1]=body

存取當前 URL

如果未向 url 輔助函數提供路徑，將返回一個 Illuminate\Routing\UrlGenerator 實例，允許您存取有關當前 URL 的資訊：

// 獲取不帶查詢字串的當前 URL...
echo url()->current();

// 獲取包含查詢字串的當前 URL...
echo url()->full();

這些方法中的每一個也可以透過 URL外觀存取：

use Illuminate\Support\Facades\URL;

echo URL::current();

存取先前的 URL

有時了解使用者從哪裡訪問的先前 URL 很有幫助。您可以透過 url 輔助函數的 previous 和 previousPath 方法來存取先前的 URL：

// 獲取先前請求的完整 URL...
echo url()->previous();

// 獲取先前請求的路徑...
echo url()->previousPath();

或者，透過會話，您可以將先前的 URL 作為流暢 URI實例來存取：

use Illuminate\Http\Request;

Route::post('/users', function (Request $request) {
    $previousUri = $request->session()->previousUri();

    // ...
});

還可以透過會話檢索先前訪問的 URL 的路由名稱：

$previousRoute = $request->session()->previousRoute();

命名路由的 URL

route 輔助函數可用於為命名路由生成 URL。命名路由允許您生成 URL，而不必與路由上定義的實際 URL 耦合。因此，如果路由的 URL 更改，則無需更改對 route 函數的呼叫。例如，想像您的應用程式包含一個定義如下的路由：

Route::get('/post/{post}', function (Post $post) {
    // ...
})->name('post.show');

要生成此路由的 URL，您可以像這樣使用 route 輔助函數：

echo route('post.show', ['post' => 1]);

// http://example.com/post/1

當然，route 輔助函數也可以用於為具有多個參數的路由生成 URL：

Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
    // ...
})->name('comment.show');

echo route('comment.show', ['post' => 1, 'comment' => 3]);

// http://example.com/post/1/comment/3

任何與路由定義參數不對應的額外陣列元素都將添加到 URL 的查詢字串中：

echo route('post.show', ['post' => 1, 'search' => 'rocket']);

// http://example.com/post/1?search=rocket

Eloquent 模型

您通常會使用 Eloquent 模型的路由金鑰（通常是主鍵）來生成 URL。為此，您可以將 Eloquent 模型作為參數值傳遞。route 輔助函數將自動提取模型的路由金鑰：

echo route('post.show', ['post' => $post]);

簽名 URL

Laravel 允許您輕鬆地為命名路由建立「簽名」URL。這些 URL 在查詢字串中附加了一個「簽名」雜湊，允許 Laravel 驗證該 URL 自建立以來未被修改。簽名 URL 對於公開可存取但需要一層防護以防止 URL 操作的路由特別有用。

例如，您可以使用簽名 URL 來實現一個公開的「取消訂閱」連結，該連結將透過電子郵件發送給您的客戶。要為命名路由建立簽名 URL，請使用 URL 外觀的 signedRoute 方法：

use Illuminate\Support\Facades\URL;

return URL::signedRoute('unsubscribe', ['user' => 1]);

您可以透過向 signedRoute 方法提供 absolute 參數來從簽名 URL 雜湊中排除網域：

return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

如果您希望生成一個在指定時間後過期的臨時簽名路由 URL，可以使用 temporarySignedRoute 方法。當 Laravel 驗證臨時簽名路由 URL 時，它將確保編碼到簽名 URL 中的過期時間戳尚未過去：

use Illuminate\Support\Facades\URL;

return URL::temporarySignedRoute(
    'unsubscribe', now()->plus(minutes: 30), ['user' => 1]
);

驗證簽名路由請求

要驗證傳入請求是否具有有效簽名，應在傳入的 Illuminate\Http\Request 實例上呼叫 hasValidSignature 方法：

use Illuminate\Http\Request;

Route::get('/unsubscribe/{user}', function (Request $request) {
    if (! $request->hasValidSignature()) {
        abort(401);
    }

    // ...
})->name('unsubscribe');

有時，您可能需要允許應用程式的前端向簽名 URL 附加資料，例如執行客戶端分頁。因此，您可以使用 hasValidSignatureWhileIgnoring 方法指定在驗證簽名 URL 時應忽略的請求查詢參數。請記住，忽略參數允許任何人修改這些參數：

if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
    abort(401);
}

與其使用傳入的請求實例來驗證簽名 URL，您可以將 signed（Illuminate\Routing\Middleware\ValidateSignature）中介層分配給路由。如果傳入的請求沒有有效簽名，中介層將自動返回 403 HTTP 回應：

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed');

如果您的簽名 URL 未在 URL 雜湊中包含網域，則應向中介層提供 relative 參數：

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed:relative');

回應無效的簽名路由

當有人訪問已過期的簽名 URL 時，他們將收到 403 HTTP 狀態碼的通用錯誤頁面。但是，您可以透過在應用程式的 bootstrap/app.php 檔案中為 InvalidSignatureException 異常定義一個自訂「render」閉包來自訂此行為：

use Illuminate\Routing\Exceptions\InvalidSignatureException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (InvalidSignatureException $e) {
        return response()->view('errors.link-expired', status: 403);
    });
})

控制器動作的 URL

action 函數為給定的控制器動作生成一個 URL：

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

如果控制器方法接受路由參數，您可以將路由參數的關聯陣列作為函數的第二個參數傳遞：

$url = action([UserController::class, 'profile'], ['id' => 1]);

流暢 URI 物件

Laravel 的 Uri 類別提供了一個便利且流暢的介面，用於透過物件建立和操作 URI。此類別封裝了底層 League URI 套件提供的功能，並與 Laravel 的路由系統無縫整合。

您可以使用靜態方法輕鬆地建立 Uri 實例：

use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;

// 從給定的字串生成一個 URI 實例...
$uri = Uri::of('https://example.com/path');

// 從路徑、命名路由或控制器動作生成 URI 實例...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);

// 從當前請求 URL 生成一個 URI 實例...
$uri = $request->uri();

// 從先前的請求 URL 生成一個 URI 實例...
$uri = $request->session()->previousUri();

獲得 URI 實例後，您可以流暢地修改它：

$uri = Uri::of('https://example.com')
    ->withScheme('http')
    ->withHost('test.com')
    ->withPort(8000)
    ->withPath('/users')
    ->withQuery(['page' => 2])
    ->withFragment('section-1');

有關使用流暢 URI 物件的更多資訊，請查閱 URI 文檔。

預設值

對於某些應用程式，您可能希望為某些 URL 參數指定請求範圍的預設值。例如，想像您的許多路由定義了一個 {locale} 參數：

Route::get('/{locale}/posts', function () {
    // ...
})->name('post.index');

每次呼叫 route 輔助函數時都傳遞 locale 是很繁瑣的。因此，您可以使用 URL::defaults 方法來定義該參數的預設值，該預設值將始終在當前請求期間應用。您可能希望從路由中介層中呼叫此方法，以便存取當前請求：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;

class SetDefaultLocaleForUrls
{
    /**
     * 處理傳入的請求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        URL::defaults(['locale' => $request->user()->locale]);

        return $next($request);
    }
}

設定 locale 參數的預設值後，您在透過 route 輔助函數生成 URL 時不再需要傳遞其值。

URL 預設值和中介層優先級

設定 URL 預設值可能會干擾 Laravel 對隱式模型綁定的處理。因此，您應該優先處理您的中介層，這些中介層設定 URL 預設值，以便在 Laravel 自己的 SubstituteBindings 中介層之前執行。您可以使用應用程式 bootstrap/app.php 檔案中的 priority 中介層方法來實現這一點：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->prependToPriorityList(
        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        prepend: \App\Http\Middleware\SetDefaultLocaleForUrls::class,
    );
})