Skip to content

HTTP 請求

簡介

Laravel 的 Illuminate\Http\Request 類別提供了一種物件導向的方式,讓你與應用程式正在處理的當前 HTTP 請求進行互動,並取得隨請求一併提交的輸入、Cookie 與檔案。

與請求互動

存取請求

若要透過依賴注入取得當前 HTTP 請求的實例,您應該在路由閉包或控制器方法上對 Illuminate\Http\Request 類別進行型別提示 (Type-hint)。傳入的請求實例將由 Laravel 服務容器 自動注入:

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Store a new user.
     */
    public function store(Request $request): RedirectResponse
    {
        $name = $request->input('name');

        // Store the user...

        return redirect('/users');
    }
}

如前所述,您也可以在路由閉包上對 Illuminate\Http\Request 類別進行型別提示。服務容器在執行時會自動將傳入的請求注入到閉包中:

php
use Illuminate\Http\Request;

Route::get('/', function (Request $request) {
    // ...
});

依賴注入與路由參數

如果您的控制器方法也預期從路由參數中獲取輸入,您應該將路由參數列在其他依賴之後。例如,如果您的路由定義如下:

php
use App\Http\Controllers\UserController;

Route::put('/user/{id}', [UserController::class, 'update']);

您仍然可以對 Illuminate\Http\Request 進行型別提示,並藉由如下定義您的控制器方法來存取您的 id 路由參數:

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * Update the specified user.
     */
    public function update(Request $request, string $id): RedirectResponse
    {
        // Update the user...

        return redirect('/users');
    }
}

請求路徑、主機與方法

Illuminate\Http\Request 實例提供了多種方法來檢查傳入的 HTTP 請求,並擴充了 Symfony\Component\HttpFoundation\Request 類別。我們將在下方討論其中幾個最重要的方法。

取得請求路徑

path 方法會回傳請求的路徑資訊。因此,如果傳入的請求目標是 http://example.com/foo/bar,則 path 方法將回傳 foo/bar

php
$uri = $request->path();

檢查請求路徑與路由

is 方法允許您驗證傳入的請求路徑是否符合指定的模式。在使用此方法時,您可以使用 * 字元作為萬用字元:

php
if ($request->is('admin/*')) {
    // ...
}

使用 routeIs 方法,您可以判定傳入的請求是否符合某個 具名路由

php
if ($request->routeIs('admin.*')) {
    // ...
}

取得請求 URL

若要取得傳入請求的完整 URL,您可以使用 urlfullUrl 方法。url 方法會回傳不含查詢字串 (Query String) 的 URL,而 fullUrl 方法則包含查詢字串:

php
$url = $request->url();

$urlWithQueryString = $request->fullUrl();

如果您想在當前 URL 中附加查詢字串資料,您可以呼叫 fullUrlWithQuery 方法。此方法會將指定的查詢字串變數陣列與當前查詢字串合併:

php
$request->fullUrlWithQuery(['type' => 'phone']);

如果您想在不包含指定查詢字串參數的情況下取得當前 URL,可以使用 fullUrlWithoutQuery 方法:

php
$request->fullUrlWithoutQuery(['type']);

取得請求主機

您可以透過 hosthttpHostschemeAndHttpHost 方法取得傳入請求的「主機 (Host)」:

php
$request->host();
$request->httpHost();
$request->schemeAndHttpHost();

取得請求方法

method 方法會回傳請求的 HTTP 動詞。您可以使用 isMethod 方法來驗證 HTTP 動詞是否符合指定的字串:

php
$method = $request->method();

if ($request->isMethod('post')) {
    // ...
}

請求標頭

您可以使用 header 方法從 Illuminate\Http\Request 實例取得請求標頭。如果請求中不存在該標頭,則會回傳 null。不過,header 方法接受選用的第二個參數,若標頭不存在,則會回傳該值:

php
$value = $request->header('X-Header-Name');

$value = $request->header('X-Header-Name', 'default');

hasHeader 方法可用於判定請求是否包含指定的標頭:

php
if ($request->hasHeader('X-Header-Name')) {
    // ...
}

為了方便起見,可以使用 bearerToken 方法從 Authorization 標頭中取得 Bearer 權杖。如果沒有此標頭,則會回傳空字串:

php
$token = $request->bearerToken();

請求 IP 位址

ip 方法可用於取得向您的應用程式發出請求的客戶端 IP 位址:

php
$ipAddress = $request->ip();

如果您想取得 IP 位址陣列,包含所有由代理伺服器轉發的客戶端 IP 位址,您可以使用 ips 方法。「原始」客戶端 IP 位址會位於陣列的末尾:

php
$ipAddresses = $request->ips();

通常情況下, IP 位址應被視為不可信且受使用者控制的輸入,僅供資訊參考之用。

內容協商

Laravel 提供了多種方法,透過 Accept 標頭來檢查傳入請求所請求的內容類型。首先,getAcceptableContentTypes 方法將回傳一個包含請求所接受之所有內容類型的陣列:

php
$contentTypes = $request->getAcceptableContentTypes();

accepts 方法接受一個內容類型陣列,如果請求接受其中任何一種內容類型,則回傳 true。否則回傳 false

php
if ($request->accepts(['text/html', 'application/json'])) {
    // ...
}

您可以使用 prefers 方法,從指定的內容類型陣列中判定請求最偏好哪種內容類型。如果請求不接受任何提供的內容類型,則會回傳 null

php
$preferred = $request->prefers(['text/html', 'application/json']);

由於許多應用程式僅提供 HTML 或 JSON,您可以使用 expectsJson 方法快速判定傳入的請求是否預期 JSON 回應:

php
if ($request->expectsJson()) {
    // ...
}

PSR-7 請求

PSR-7 標準 定義了 HTTP 訊息的介面,包含請求與回應。若您想取得 PSR-7 請求實例而非 Laravel 請求,您需要先安裝一些程式庫。Laravel 使用 Symfony HTTP Message Bridge 元件將一般的 Laravel 請求與回應轉換為符合 PSR-7 的實作:

shell
composer require symfony/psr-http-message-bridge
composer require nyholm/psr7

安裝這些程式庫後,您就可以在路由閉包或控制器方法中,透過對請求介面進行型別提示來取得 PSR-7 請求:

php
use Psr\Http\Message\ServerRequestInterface;

Route::get('/', function (ServerRequestInterface $request) {
    // ...
});

📌 備註

若您從路由或控制器回傳 PSR-7 回應實例,它會自動被轉換回 Laravel 回應實例並由框架顯示。

輸入

取得輸入

取得所有輸入資料

您可以使用 all 方法以 array 形式取得所有傳入請求的輸入資料。不論傳入的請求是來自 HTML 表單還是 XHR 請求,都可以使用此方法:

php
$input = $request->all();

使用 collect 方法,您可以將所有傳入請求的輸入資料取得為一個 集合 (Collection)

php
$input = $request->collect();

collect 方法也允許您取得傳入請求輸入資料的子集作為集合:

php
$request->collect('users')->each(function (string $user) {
    // ...
});

取得單一輸入值

透過幾個簡單的方法,您可以從 Illuminate\Http\Request 實例存取所有使用者輸入,而無需擔心請求使用的是哪種 HTTP 動詞。不論 HTTP 動詞為何,都可以使用 input 方法來取得使用者輸入:

php
$name = $request->input('name');

您可以將預設值作為第二個參數傳遞給 input 方法。如果請求中不存在所要求的輸入值,則會回傳此預設值:

php
$name = $request->input('name', 'Sally');

當處理包含陣列輸入的表單時,請使用「點 (dot)」標記法來存取陣列:

php
$name = $request->input('products.0.name');

$names = $request->input('products.*.name');

您可以不帶任何參數呼叫 input 方法,以便以關聯陣列的形式取得所有輸入值:

php
$input = $request->input();

從查詢字串取得輸入

雖然 input 方法會從整個請求負載(包含查詢字串)中取得值,但 query 方法僅會從查詢字串中取得值:

php
$name = $request->query('name');

如果要求的查詢字串值不存在,則會回傳此方法的第二個參數:

php
$name = $request->query('name', 'Helen');

您可以不帶任何參數呼叫 query 方法,以便以關聯陣列的形式取得所有查詢字串值:

php
$query = $request->query();

取得 JSON 輸入值

向您的應用程式發送 JSON 請求時,只要請求的 Content-Type 標頭正確設置為 application/json,您就可以透過 input 方法存取 JSON 資料。您甚至可以使用「點」語法來取得嵌套在 JSON 陣列或物件中的值:

php
$name = $request->input('user.name');

取得可字串化 (Stringable) 的輸入值

除了將請求的輸入資料取得為原始 string 之外,您還可以使用 string 方法將請求資料取得為 Illuminate\Support\Stringable 的實例:

php
$name = $request->string('name')->trim();

取得整數輸入值

要以整數形式取得輸入值,您可以使用 integer 方法。此方法會嘗試將輸入值轉型為整數。如果輸入值不存在或轉型失敗,它將回傳您指定的預設值。這對於分頁或其他數值輸入特別有用:

php
$perPage = $request->integer('per_page');

取得布林輸入值

處理像核取方塊 (Checkbox) 這樣的 HTML 元素時,您的應用程式可能會收到實際上是字串的「真值 (truthy)」。例如 "true" 或 "on"。為了方便起見,您可以使用 boolean 方法將這些值取得為布林值。boolean 方法對 1, "1", true, "true", "on" 和 "yes" 回傳 true。所有其他值都將回傳 false

php
$archived = $request->boolean('archived');

取得陣列輸入值

包含陣列的輸入值可以使用 array 方法取得。此方法一律會將輸入值轉型為陣列。如果請求中不包含指定名稱的輸入值,則會回傳一個空陣列:

php
$versions = $request->array('versions');

取得日期輸入值

為了方便起見,包含日期/時間的輸入值可以使用 date 方法取得為 Carbon 實例。如果請求中不包含指定名稱的輸入值,則會回傳 null

php
$birthday = $request->date('birthday');

date 方法接受的第二個和第三個參數分別可用於指定日期的格式和時區:

php
$elapsed = $request->date('elapsed', '!H:i', 'Europe/Madrid');

如果輸入值存在但格式無效,則會拋出 InvalidArgumentException;因此,建議您在呼叫 date 方法之前先驗證輸入。

取得列舉 (Enum) 輸入值

對應於 PHP 列舉 (enums) 的輸入值也可以從請求中取得。如果請求不包含具有給定名稱的輸入值,或者列舉沒有與輸入值匹配的對應原始值,則會回傳 nullenum 方法的第一個和第二個參數分別接受輸入值的名稱和列舉類別:

php
use App\Enums\Status;

$status = $request->enum('status', Status::class);

您也可以提供一個預設值,如果該值缺失或無效,將會回傳該預設值:

php
$status = $request->enum('status', Status::class, Status::Pending);

如果輸入值是與 PHP 列舉相對應的值陣列,您可以使用 enums 方法將該陣列取得為列舉實例陣列:

php
use App\Enums\Product;

$products = $request->enums('products', Product::class);

透過動態屬性取得輸入

您還可以使用 Illuminate\Http\Request 實例上的動態屬性來存取使用者輸入。例如,如果您應用程式的表單之一包含 name 欄位,您可以像這樣存取該欄位的值:

php
$name = $request->name;

使用動態屬性時,Laravel 會首先在請求負載中尋找參數的值。如果不存在,Laravel 將在匹配路由的參數中搜尋該欄位。

取得部分輸入資料

如果您需要取得輸入資料的子集,可以使用 onlyexcept 方法。這兩個方法都接受單一 array 或動態參數列表:

php
$input = $request->only(['username', 'password']);

$input = $request->only('username', 'password');

$input = $request->except(['credit_card']);

$input = $request->except('credit_card');

⚠️ 警告

only 方法會回傳您要求的所有鍵值對;然而,它不會回傳請求中不存在的鍵值對。

確認輸入是否存在

您可以使用 has 方法來確定請求中是否存在某個值。has 方法在值存在於請求中時會回傳 true

php
if ($request->has('name')) {
    // ...
}

當傳入一個陣列時,has 方法將判斷是否所有指定的值都存在:

php
if ($request->has(['name', 'email'])) {
    // ...
}

hasAny 方法在任何指定的內容存在時回傳 true

php
if ($request->hasAny(['name', 'email'])) {
    // ...
}

如果請求中存在某個值,whenHas 方法將執行給定的 Closure:

php
$request->whenHas('name', function (string $input) {
    // ...
});

可以向 whenHas 方法傳遞第二個 Closure,若請求中不存在指定的值,則會執行該 Closure:

php
$request->whenHas('name', function (string $input) {
    // The "name" value is present...
}, function () {
    // The "name" value is not present...
});

如果您想確定請求中是否存在某個值且不為空字串,可以使用 filled 方法:

php
if ($request->filled('name')) {
    // ...
}

如果您想確定請求中是否缺少某個值或者是空字串,可以使用 isNotFilled 方法:

php
if ($request->isNotFilled('name')) {
    // ...
}

當傳入一個陣列時,isNotFilled 方法將判斷是否所有指定的值都缺失或為空:

php
if ($request->isNotFilled(['name', 'email'])) {
    // ...
}

如果指定的任何值不是空字串,anyFilled 方法會回傳 true

php
if ($request->anyFilled(['name', 'email'])) {
    // ...
}

如果請求中存在某個值且不為空字串,whenFilled 方法將執行給定的 Closure:

php
$request->whenFilled('name', function (string $input) {
    // ...
});

可以向 whenFilled 方法傳遞第二個 Closure,若指定的值不是「已填寫 (filled)」,則會執行該 Closure:

php
$request->whenFilled('name', function (string $input) {
    // The "name" value is filled...
}, function () {
    // The "name" value is not filled...
});

要確定請求中是否缺少給定的鍵值,您可以使用 missingwhenMissing 方法:

php
if ($request->missing('name')) {
    // ...
}

$request->whenMissing('name', function () {
    // The "name" value is missing...
}, function () {
    // The "name" value is present...
});

合併額外的輸入

有時您可能需要手動將額外的輸入合併到請求現有的輸入數據中。要實現這一點,您可以使用 merge 方法。如果請求中已存在給定的輸入鍵,它將被提供給 merge 方法的數據覆蓋:

php
$request->merge(['votes' => 0]);

mergeIfMissing 方法可用於在請求的輸入數據中尚不存在對應鍵時,將輸入合併到請求中:

php
$request->mergeIfMissing(['votes' => 0]);

先前輸入

Laravel 允許您在下一次請求期間保留本次請求的輸入。此功能對於在檢測到驗證錯誤後重新填充表單特別有用。然而,如果您使用 Laravel 內建的驗證功能,您可能不需要手動直接使用這些 Session 輸入快閃 (Flashing) 方法,因為 Laravel 的某些內建驗證設施會自動呼叫它們。

將輸入快閃至 Session

Illuminate\Http\Request 類別上的 flash 方法會將當前輸入快閃到 Session 中,以便在使用者下一次對應用程式發出請求時使用:

php
$request->flash();

您也可以使用 flashOnlyflashExcept 方法將請求數據的子集快閃到 Session。這些方法對於將密碼等敏感資訊排除在 Session 之外非常有用:

php
$request->flashOnly(['username', 'email']);

$request->flashExcept('password');

快閃輸入後重導向

由於您經常會想要將輸入快閃到 Session 然後重導向到前一個頁面,因此您可以使用 withInput 方法輕鬆地將輸入快閃鏈接到重導向上:

php
return redirect('/form')->withInput();

return redirect()->route('user.create')->withInput();

return redirect('/form')->withInput(
    $request->except('password')
);

取得先前輸入

要從上一次請求中取得快閃的輸入,請在 Illuminate\Http\Request 實例上呼叫 old 方法。old 方法將從 Session 中提取先前快閃的輸入數據:

php
$username = $request->old('username');

Laravel 還提供了一個全域的 old 輔助函式。如果您在 Blade 範本中顯示先前輸入,使用 old 輔助函式來重新填充表單會更方便。如果指定的欄位不存在先前輸入,則會回傳 null

blade
<input type="text" name="username" value="{{ old('username') }}">

所有由 Laravel 框架建立的 Cookie 都經過加密並附帶身份驗證代碼,這意味著如果用戶端更改了它們,它們將被視為無效。要從請求中取得 Cookie 值,請在 Illuminate\Http\Request 實例上使用 cookie 方法:

php
$value = $request->cookie('name');

輸入修整與正規化

預設情況下,Laravel 在應用程式的全域中介層堆疊中包含了 Illuminate\Foundation\Http\Middleware\TrimStringsIlluminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull 中介層。這些中介層會自動修整請求中所有傳入的字串欄位,並將任何空字串欄位轉換為 null。這讓您不必在路由與控制器中擔心這些正規化問題。

停用輸入正規化

如果您想為所有請求停用此行為,可以從應用程式的中介層堆疊中移除這兩個中介層,方法是在應用程式的 bootstrap/app.php 檔案中呼叫 $middleware->remove 方法:

php
use Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull;
use Illuminate\Foundation\Http\Middleware\TrimStrings;

->withMiddleware(function (Middleware $middleware): void {
    $middleware->remove([
        ConvertEmptyStringsToNull::class,
        TrimStrings::class,
    ]);
})

如果您想為應用程式的一部分請求停用字串修整與空字串轉換,可以在應用程式的 bootstrap/app.php 檔案中使用 trimStringsconvertEmptyStringsToNull 中介層方法。這兩個方法都接受一個閉包陣列,閉包應回傳 truefalse 以指示是否應跳過輸入正規化:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->convertEmptyStringsToNull(except: [
        fn (Request $request) => $request->is('admin/*'),
    ]);

    $middleware->trimStrings(except: [
        fn (Request $request) => $request->is('admin/*'),
    ]);
})

檔案

取得上傳檔案

您可以使用 file 方法或使用動態屬性從 Illuminate\Http\Request 實例中取得上傳的檔案。file 方法回傳 Illuminate\Http\UploadedFile 類別的實例,該類別繼承了 PHP 的 SplFileInfo 類別,並提供了多種與檔案互動的方法:

php
$file = $request->file('photo');

$file = $request->photo;

您可以使用 hasFile 方法來判斷請求中是否存在該檔案:

php
if ($request->hasFile('photo')) {
    // ...
}

驗證是否上傳成功

除了檢查檔案是否存在外,您還可以透過 isValid 方法驗證上傳檔案時是否沒有發生問題:

php
if ($request->file('photo')->isValid()) {
    // ...
}

檔案路徑與副檔名

UploadedFile 類別還包含存取檔案完整路徑及其副檔名的方法。extension 方法會嘗試根據檔案內容猜測其副檔名。此副檔名可能與客戶端提供的副檔名不同:

php
$path = $request->photo->path();

$extension = $request->photo->extension();

其他檔案方法

UploadedFile 實例還有許多其他可用的方法。請查看該類別的 API 文件 以了解有關這些方法的更多資訊。

儲存上傳檔案

要儲存上傳的檔案,您通常會使用已設定的 檔案系統 之一。UploadedFile 類別有一個 store 方法,會將上傳的檔案移動到您的其中一個磁碟,這可以是您本地檔案系統上的位置,也可以是像 Amazon S3 這樣的雲端儲存位置。

store 方法接受檔案應儲存的路徑,該路徑相對於檔案系統設定的根目錄。此路徑不應包含檔名,因為系統會自動產生一個唯一 ID 作為檔名。

store 方法還接受一個選用的第二個參數,用於指定儲存檔案的磁碟名稱。該方法將回傳相對於磁碟根目錄的檔案路徑:

php
$path = $request->photo->store('images');

$path = $request->photo->store('images', 's3');

如果您不希望自動產生檔名,可以使用 storeAs 方法,該方法接受路徑、檔名和磁碟名稱作為其參數:

php
$path = $request->photo->storeAs('images', 'filename.jpg');

$path = $request->photo->storeAs('images', 'filename.jpg', 's3');

📌 備註

有關 Laravel 檔案儲存的更多資訊,請查看完整的 檔案儲存文件

設定信任的代理伺服器 (Trusted Proxies)

當您的應用程式運行在終止 TLS / SSL 憑證的負載平衡器後方時,您可能會注意到應用程式在使用 url 輔助函式時有時不會產生 HTTPS 連結。這通常是因為您的應用程式是從負載平衡器的 80 連接埠轉發流量,且不知道應該產生安全連結。

要解決此問題,您可以啟用 Laravel 應用程式中包含的 Illuminate\Http\Middleware\TrustProxies 中介層,這讓您可以快速自訂應用程式應信任的負載平衡器或代理伺服器。您的信任代理伺服器應使用應用程式 bootstrap/app.php 檔案中的 trustProxies 中介層方法來指定:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(at: [
        '192.168.1.1',
        '10.0.0.0/8',
    ]);
})

除了設定信任的代理伺服器外,您還可以設定應信任的代理標頭:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(headers: Request::HEADER_X_FORWARDED_FOR |
        Request::HEADER_X_FORWARDED_HOST |
        Request::HEADER_X_FORWARDED_PORT |
        Request::HEADER_X_FORWARDED_PROTO |
        Request::HEADER_X_FORWARDED_AWS_ELB
    );
})

📌 備註

如果您使用的是 AWS Elastic Load Balancing,則 headers 的值應為 Request::HEADER_X_FORWARDED_AWS_ELB。如果您的負載平衡器使用來自 RFC 7239 的標準 Forwarded 標頭,則 headers 的值應為 Request::HEADER_FORWARDED。有關可用於 headers 值的常數的更多資訊,請查看 Symfony 關於 信任代理伺服器 的文件。

信任所有代理伺服器

如果您使用的是 Amazon AWS 或其他「雲端」負載平衡器供應商,您可能不知道實際平衡器的 IP 位址。在這種情況下,您可以使用 * 來信任所有代理伺服器:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(at: '*');
})

設定信任的主機 (Trusted Hosts)

預設情況下,Laravel 會回應其收到的所有請求,而不論 HTTP 請求的 Host 標頭內容為何。此外,在網頁請求期間產生指向應用程式的絕對 URL 時,會使用 Host 標頭的值。

通常情況下,您應該設定您的網頁伺服器(例如 Nginx 或 Apache),使其僅向您的應用程式發送與特定主機名稱相匹配的請求。但是,如果您無法直接自訂網頁伺服器,且需要指示 Laravel 僅回應特定的主機名稱,您可以透過為應用程式啟用 Illuminate\Http\Middleware\TrustHosts 中介層來達成此目的。

要啟用 TrustHosts 中介層,您應該在應用程式的 bootstrap/app.php 檔案中呼叫 trustHosts 中介層方法。使用此方法的 at 參數,您可以指定應用程式應回應的主機名稱。該主機名稱字串會被視為正規表示式。帶有其他 Host 標頭的傳入請求將會被拒絕:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: ['^laravel\.test$']);
})

預設情況下,來自應用程式 URL 子網域的請求也會被自動信任。如果您想停用此行為,可以使用 subdomains 參數:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: ['^laravel\.test$'], subdomains: false);
})

如果您需要存取應用程式的設定檔或資料庫來決定信任的主機,可以為 at 參數提供一個閉包 (Closure):

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: fn () => config('app.trusted_hosts'));
})