HTTP 請求
簡介
Laravel 的 Illuminate\Http\Request 類別提供了一種物件導向的方法,讓您能與應用程式正在處理的目前 HTTP 請求進行互動,並取得隨請求提交的輸入、Cookies 以及檔案。
與請求互動
存取請求
要透過依賴注入取得當前 HTTP 請求的實例,你應該在你的路由閉包或控制器方法上對 Illuminate\Http\Request 類別進行型別提示 (Type-hint)。傳入的請求實例將由 Laravel 服務容器 (Service Container) 自動注入:
<?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 類別進行型別提示。服務容器在執行閉包時會自動注入傳入的請求:
use Illuminate\Http\Request;
Route::get('/', function (Request $request) {
// ...
});依賴注入與路由參數
如果你的控制器方法也預期接收來自路由參數的輸入,你應該將路由參數列在其他依賴項目之後。例如,如果你的路由定義如下:
use App\Http\Controllers\UserController;
Route::put('/user/{id}', [UserController::class, 'update']);你仍然可以對 Illuminate\Http\Request 進行型別提示,並透過如下定義控制器方法來存取你的 id 路由參數:
<?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:
$uri = $request->path();檢查請求路徑 / 路由
is 方法允許你驗證傳入的請求路徑是否符合指定的模式。在使用此方法時,你可以使用 * 字元作為萬用字元 (Wildcard):
if ($request->is('admin/*')) {
// ...
}使用 routeIs 方法,你可以判斷傳入的請求是否匹配了某個 具名路由 (Named Route):
if ($request->routeIs('admin.*')) {
// ...
}取得請求 URL
若要取得傳入請求的完整 URL,你可以使用 url 或 fullUrl 方法。url 方法會回傳不含查詢字串 (Query String) 的 URL,而 fullUrl 方法則包含查詢字串:
$url = $request->url();
$urlWithQueryString = $request->fullUrl();如果你想要在當前 URL 中附加查詢字串資料,可以呼叫 fullUrlWithQuery 方法。此方法會將指定的查詢字串變數陣列與當前的查詢字串合併:
$request->fullUrlWithQuery(['type' => 'phone']);如果你想取得不含特定查詢字串參數的當前 URL,可以使用 fullUrlWithoutQuery 方法:
$request->fullUrlWithoutQuery(['type']);取得請求主機
你可以透過 host、httpHost 與 schemeAndHttpHost 方法取得傳入請求的「主機 (Host)」:
// http://localhost:8000
$request->host(); // localhost
$request->httpHost(); // localhost:8000
$request->schemeAndHttpHost(); // http://localhost:8000取得請求方法
method 方法會回傳請求的 HTTP 動詞。你可以使用 isMethod 方法來驗證 HTTP 動詞是否符合指定的字串:
$method = $request->method();
if ($request->isMethod('post')) {
// ...
}請求標頭
你可以使用 header 方法從 Illuminate\Http\Request 實例中取得請求標頭。如果請求中不存在該標頭,則會回傳 null。不過,header 方法接受選用的第二個引數,若標頭不存在,則會回傳該值:
$value = $request->header('X-Header-Name');
$value = $request->header('X-Header-Name', 'default');hasHeader 方法可用於判斷請求是否包含指定的標頭:
if ($request->hasHeader('X-Header-Name')) {
// ...
}為了方便起見,可以使用 bearerToken 方法從 Authorization 標頭中取得 Bearer 令牌 (Bearer Token)。如果不存在此標頭,則會回傳空字串:
$token = $request->bearerToken();請求 IP 位址
ip 方法可用於取得向你的應用程式發出請求的用戶端 IP 位址:
$ipAddress = $request->ip();如果你想取得 IP 位址陣列,包括由代理伺服器轉發的所有用戶端 IP 位址,可以使用 ips 方法。「原始」用戶端 IP 位址將位於陣列的末尾:
$ipAddresses = $request->ips();一般而言,IP 位址應被視為不可信且受使用者控制的輸入,僅供參考之用。
內容協商
Laravel 提供了幾種方法,可透過 Accept 標頭檢查傳入請求所要求的內容類型 (Content Type)。首先,getAcceptableContentTypes 方法將回傳一個包含請求所接受的所有內容類型的陣列:
$contentTypes = $request->getAcceptableContentTypes();accepts 方法接受一個內容類型陣列,如果請求接受其中的任何內容類型,則回傳 true。否則,將回傳 false:
if ($request->accepts(['text/html', 'application/json'])) {
// ...
}你可以使用 prefers 方法,從指定的內容類型陣列中判斷請求最偏好哪種內容類型。如果請求不接受任何提供的內容類型,則會回傳 null:
$preferred = $request->prefers(['text/html', 'application/json']);由於許多應用程式僅提供 HTML 或 JSON,因此你可以使用 expectsJson 方法快速判斷傳入的請求是否預期一個 JSON 回應:
if ($request->expectsJson()) {
// ...
}如果你需要判斷請求是否特別偏好 Markdown,或者是否在其他內容類型中接受 Markdown(例如在服務 AI 代理或其他取用 Markdown 回應的用戶端時),你可以使用 wantsMarkdown 與 acceptsMarkdown 方法:
if ($request->wantsMarkdown()) {
// The client's most preferred content type is text/markdown...
}
if ($request->acceptsMarkdown()) {
// The client accepts Markdown responses...
}PSR-7 請求
PSR-7 標準定義了 HTTP 訊息(包含請求與回應)的介面。如果你想取得 PSR-7 請求的實例而非 Laravel 請求,你需要先安裝幾個函式庫。Laravel 使用 Symfony HTTP Message Bridge 元件將一般的 Laravel 請求與回應轉換為符合 PSR-7 的實作:
composer require symfony/psr-http-message-bridge
composer require nyholm/psr7安裝這些函式庫後,你可以在路由閉包或控制器方法上藉由對請求介面進行型別提示來取得 PSR-7 請求:
use Psr\Http\Message\ServerRequestInterface;
Route::get('/', function (ServerRequestInterface $request) {
// ...
});📌 備註
若你從路由或控制器回傳一個 PSR-7 回應實例,它將自動轉換回 Laravel 回應實例並由框架顯示。
輸入
取得輸入
取得所有輸入資料
您可以使用 all 方法,以 array (陣列) 形式取得所有傳入請求的輸入資料。不論傳入的請求是來自 HTML 表單還是 XHR 請求,都可以使用此方法:
$input = $request->all();使用 collect 方法,您可以將所有傳入請求的輸入資料取得為 集合 (collection):
$input = $request->collect();collect 方法也允許您將傳入請求輸入的子集取得為集合:
$request->collect('users')->each(function (string $user) {
// ...
});取得單一輸入值
透過幾個簡單的方法,您可以從 Illuminate\Http\Request 實例存取所有的使用者輸入,而無需擔心請求使用的是哪種 HTTP 動詞。無論 HTTP 動詞為何,都可以使用 input 方法來取得使用者輸入:
$name = $request->input('name');您可以將預設值作為第二個引數傳遞給 input 方法。如果請求中不存在所請求的輸入值,則會返回此值:
$name = $request->input('name', 'Sally');在處理包含陣列輸入的表單時,請使用「點 (dot)」記法來存取陣列:
$name = $request->input('products.0.name');
$names = $request->input('products.*.name');您可以呼叫不帶任何引數的 input 方法,以便以關聯陣列的形式取得所有的輸入值:
$input = $request->input();從查詢字串取得輸入
雖然 input 方法會從整個請求酬載(包含查詢字串)中取得值,但 query 方法僅會從查詢字串中取得值:
$name = $request->query('name');如果所請求的查詢字串數值不存在,則會返回此方法的第二個引數:
$name = $request->query('name', 'Helen');您可以呼叫不帶任何引數的 query 方法,以便以關聯陣列的形式取得所有的查詢字串值:
$query = $request->query();取得 JSON 輸入值
當向您的應用程式發送 JSON 請求時,只要請求的 Content-Type 標頭正確設置為 application/json,您就可以透過 input 方法存取 JSON 資料。您甚至可以使用「點」語法來取得巢狀於 JSON 陣列或物件中的值:
$name = $request->input('user.name');取得 Stringable 輸入值
除了將請求的輸入資料取得為原始的 string (字串) 之外,您還可以使用 string 方法將請求資料取得為 Illuminate\Support\Stringable 的實例:
$name = $request->string('name')->trim();取得整數輸入值
若要將輸入值取得為整數,您可以使用 integer 方法。此方法會嘗試將輸入值轉換為整數。如果輸入不存在或轉換失敗,它將返回您指定的預設值。這對於分頁或其他數值輸入特別有用:
$perPage = $request->integer('per_page');取得布林輸入值
在處理像核取方塊 (checkboxes) 這樣的 HTML 元素時,您的應用程式可能會收到實際上是字串的「真值 (truthy)」。例如:"true" 或 "on"。為了方便起見,您可以使用 boolean 方法將這些值取得為布林值。對於 1、"1"、true、"true"、"on" 和 "yes",boolean 方法會返回 true。所有其他值都將返回 false:
$archived = $request->boolean('archived');取得陣列輸入值
包含陣列的輸入值可以使用 array 方法取得。此方法會始終將輸入值轉換為陣列。如果請求中不包含指定名稱的輸入值,則會返回一個空陣列:
$versions = $request->array('versions');取得日期輸入值
為了方便起見,包含日期或時間的輸入值可以使用 date 方法取得為 Carbon 實例。如果請求中不包含指定名稱的輸入值,則會返回 null:
$birthday = $request->date('birthday');date 方法接受的第二個和第三個引數可用於分別指定日期的格式和時區:
$elapsed = $request->date('elapsed', '!H:i', 'Europe/Madrid');如果輸入值存在但格式無效,則會拋出 InvalidArgumentException;因此,建議在呼叫 date 方法之前先對輸入進行驗證。
取得時間間隔輸入值
包含持續時間的輸入值可以使用 interval 方法取得為 CarbonInterval 實例。如果請求中不包含指定名稱的輸入值,則會返回 null:
$duration = $request->interval('duration');如果輸入值是數值,您可以提供單位作為第二個引數。單位可以是像 second、minute 或 day 這樣的字串,或者是 Carbon\Unit 的列舉 (enum) 實例:
use Carbon\Unit;
$timeout = $request->interval('timeout', 'second');
$delay = $request->interval('delay', Unit::Minute);如果輸入值存在但格式無效,則會拋出 InvalidArgumentException;因此,建議在呼叫 interval 方法之前先對輸入進行驗證。
取得 Enum 輸入值
對應於 PHP 列舉 (enums) 的輸入值也可以從請求中取得。如果請求不包含具有指定名稱的輸入值,或者列舉沒有與輸入值匹配的後端值 (backing value),則將返回 null。enum 方法接受輸入值的名稱和列舉類別作為其第一個和第二個引數:
use App\Enums\Status;
$status = $request->enum('status', Status::class);您還可以提供一個預設值,如果數值缺失或無效,將返回該預設值:
$status = $request->enum('status', Status::class, Status::Pending);如果輸入值是與 PHP 列舉相對應的值陣列,您可以使用 enums 方法將該值陣列取得為列舉實例:
use App\Enums\Product;
$products = $request->enums('products', Product::class);透過動態屬性取得輸入
您還可以使用 Illuminate\Http\Request 實例上的動態屬性來存取使用者輸入。例如,如果您的應用程式表單中包含一個 name 欄位,您可以像這樣存取該欄位的值:
$name = $request->name;使用動態屬性時,Laravel 會首先在請求酬載中尋找參數的值。如果不存在,Laravel 將在匹配的路由參數中搜尋該欄位。
取得部分輸入資料
如果您需要取得輸入資料的子集,可以使用 only 和 except 方法。這兩個方法都接受單一 array 或動態的引數列表:
$input = $request->only(['username', 'password']);
$input = $request->only('username', 'password');
$input = $request->except(['credit_card']);
$input = $request->except('credit_card');⚠️ 警告
only 方法會返回您請求的所有鍵值對 (key / value pairs);但是,它不會返回請求中不存在的鍵值對。
檢查輸入是否存在
您可以使用 has 方法來判斷請求中是否存在某個值。如果該值存在於請求中,has 方法將回傳 true:
if ($request->has('name')) {
// ...
}當傳入一個陣列時,has 方法將判斷是否所有指定的值都存在:
if ($request->has(['name', 'email'])) {
// ...
}hasAny 方法在任何一個指定的值存在時會回傳 true:
if ($request->hasAny(['name', 'email'])) {
// ...
}如果請求中存在某個值,whenHas 方法將執行給定的閉包:
$request->whenHas('name', function (string $input) {
// ...
});您可以向 whenHas 方法傳遞第二個閉包,該閉包將在請求中不存在指定值時執行:
$request->whenHas('name', function (string $input) {
// The "name" value is present...
}, function () {
// The "name" value is not present...
});如果您想判斷一個值是否存在於請求中且不為空字串,可以使用 filled 方法:
if ($request->filled('name')) {
// ...
}如果您想判斷請求中是否缺少某個值或者是空字串,可以使用 isNotFilled 方法:
if ($request->isNotFilled('name')) {
// ...
}當傳入陣列時,isNotFilled 方法將判斷是否所有指定的值都缺失或為空:
if ($request->isNotFilled(['name', 'email'])) {
// ...
}如果指定的任何一個值不是空字串,anyFilled 方法將回傳 true:
if ($request->anyFilled(['name', 'email'])) {
// ...
}如果請求中存在某個值且不是空字串,whenFilled 方法將執行給定的閉包:
$request->whenFilled('name', function (string $input) {
// ...
});您可以向 whenFilled 方法傳遞第二個閉包,該閉包將在指定值不為「已填寫 (filled)」時執行:
$request->whenFilled('name', function (string $input) {
// The "name" value is filled...
}, function () {
// The "name" value is not filled...
});要判斷請求中是否缺少指定的鍵,可以使用 missing 和 whenMissing 方法:
if ($request->missing('name')) {
// ...
}
$request->whenMissing('name', function () {
// The "name" value is missing...
}, function () {
// The "name" value is present...
});合併額外的輸入
有時您可能需要手動將額外的輸入合併到請求現有的輸入數據中。為此,您可以使用 merge 方法。如果請求中已存在指定的輸入鍵,它將被提供給 merge 方法的資料覆蓋:
$request->merge(['votes' => 0]);mergeIfMissing 方法可用於在請求的輸入資料中尚不存在對應鍵時,將輸入合併到請求中:
$request->mergeIfMissing(['votes' => 0]);舊輸入
Laravel 允許您在下一次請求中保留本次請求的輸入。這個功能在偵測到驗證錯誤後重新填寫表單時特別有用。但是,如果您使用的是 Laravel 內建的驗證功能,您可能不需要手動直接使用這些 Session 輸入快閃 (flashing) 方法,因為 Laravel 的某些內建驗證機制會自動呼叫它們。
將輸入快閃至 Session
Illuminate\Http\Request 類別上的 flash 方法會將目前的輸入快閃至 Session,以便在使用者下一次向應用程式發出請求時可以使用:
$request->flash();您也可以使用 flashOnly 和 flashExcept 方法將請求資料的子集快閃至 Session。這些方法對於將密碼等敏感資訊排除在 Session 之外非常有用:
$request->flashOnly(['username', 'email']);
$request->flashExcept('password');快閃輸入後進行重新導向
由於您通常會希望將輸入快閃至 Session,然後重新導向回上一頁,因此您可以使用 withInput 方法輕鬆地將輸入快閃鏈接到重新導向操作上:
return redirect('/form')->withInput();
return redirect()->route('user.create')->withInput();
return redirect('/form')->withInput(
$request->except('password')
);取得舊輸入
要從上一次請求中取得快閃的輸入,請在 Illuminate\Http\Request 實例上呼叫 old 方法。old 方法將從 Session 中取出先前快閃的輸入資料:
$username = $request->old('username');Laravel 還提供了一個全域的 old 輔助函式。如果您是在 Blade 模板 中顯示舊輸入,使用 old 輔助函式來重新填充表單會更方便。如果指定的欄位不存在舊輸入,則會回傳 null:
<input type="text" name="username" value="{{ old('username') }}">Cookies
從請求中取得 Cookies
Laravel 框架建立的所有 Cookies 都經過加密並附有身份驗證碼,這意味著如果客戶端修改了它們,它們將被視為無效。要從請求中取得 Cookie 值,請在 Illuminate\Http\Request 實例上使用 cookie 方法:
$value = $request->cookie('name');輸入修剪與正規化
預設情況下,Laravel 在應用程式的全域中介層堆疊中包含了 Illuminate\Foundation\Http\Middleware\TrimStrings 與 Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull 中介層。這些中介層會自動修剪請求中所有傳入的字串欄位,並將任何空字串欄位轉換為 null。這讓您不必在路由與控制器中擔心這些正規化的問題。
停用輸入正規化
如果您想要為所有請求停用此行為,可以透過在應用程式的 bootstrap/app.php 檔案中呼叫 $middleware->remove 方法,從應用程式的中介層堆疊中移除這兩個中介層:
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 檔案中使用 trimStrings 和 convertEmptyStringsToNull 中介層方法。這兩個方法都接受一個閉包 (Closure) 陣列,閉包應回傳 true 或 false 以指示是否應跳過輸入正規化:
->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 類別,並提供多種與檔案互動的方法:
$file = $request->file('photo');
$file = $request->photo;您可以使用 hasFile 方法來判斷請求中是否存在該檔案:
if ($request->hasFile('photo')) {
// ...
}驗證上傳是否成功
除了檢查檔案是否存在之外,您還可以透過 isValid 方法驗證上傳檔案時是否發生任何問題:
if ($request->file('photo')->isValid()) {
// ...
}檔案路徑與副檔名
UploadedFile 類別還包含存取檔案完整路徑與副檔名的方法。extension 方法會嘗試根據檔案內容推測檔案的副檔名。此副檔名可能與客戶端提供的副檔名不同:
$path = $request->photo->path();
$extension = $request->photo->extension();其他檔案方法
UploadedFile 實例還有許多其他可用的方法。請參閱該類別的 API 文件以取得關於這些方法的更多資訊。
儲存上傳檔案
要儲存上傳的檔案,您通常會使用其中一個已設定的檔案系統(Filesystems)。UploadedFile 類別有一個 store 方法,可以將上傳的檔案移到您的磁碟之一,該磁碟可以是您本機檔案系統上的位置,或者是像 Amazon S3 這樣的雲端儲存位置。
store 方法接受相對於檔案系統設定之根目錄的儲存路徑。此路徑不應包含檔名,因為系統會自動產生一個唯一的 ID 作為檔名。
store 方法也接受一個選用的第二引數,用來指定用於儲存檔案的磁碟名稱。該方法會回傳相對於該磁碟根目錄的檔案路徑:
$path = $request->photo->store('images');
$path = $request->photo->store('images', 's3');如果您不想自動產生檔名,可以使用 storeAs 方法,該方法接受路徑、檔名和磁碟名稱作為其引數:
$path = $request->photo->storeAs('images', 'filename.jpg');
$path = $request->photo->storeAs('images', 'filename.jpg', 's3');📌 備註
關於 Laravel 檔案儲存的更多資訊,請參閱完整的檔案儲存文件。
設定信任的代理伺服器
當您的應用程式運行在終止 TLS / SSL 憑證的負載平衡器後方時,您可能會注意到應用程式在使用 url 輔助函式時,有時不會產生 HTTPS 連結。這通常是因為您的應用程式是從負載平衡器的 80 連接埠轉發流量,且不知道應該產生安全的連結。
為了瞭解決這個問題,您可以啟用 Laravel 應用程式中包含的 Illuminate\Http\Middleware\TrustProxies 中介層,它讓您能快速自訂應用程式應信任的負載平衡器或代理伺服器。您應在應用程式的 bootstrap/app.php 檔案中使用 trustProxies 中介層方法來指定信任的代理伺服器:
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustProxies(at: [
'192.168.1.1',
'10.0.0.0/8',
]);
})除了設定信任的代理伺服器外,您還可以設定應信任的代理標頭:
->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 位址。在這種情況下,您可以使用 * 來信任所有代理伺服器:
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustProxies(at: '*');
})設定信任的主機
預設情況下,Laravel 會回應它收到的所有請求,而不考慮 HTTP 請求中 Host 標頭的內容。此外,在網頁請求期間產生指向您應用程式的絕對 URL 時,會使用 Host 標頭的值。
通常,您應該設定您的網頁伺服器(例如 Nginx 或 Apache),使其僅向您的應用程式發送與特定主機名稱匹配的請求。但是,如果您無法直接自訂網頁伺服器,且需要指示 Laravel 僅回應特定主機名稱,您可以為應用程式啟用 Illuminate\Http\Middleware\TrustHosts 中介層。
要啟用 TrustHosts 中介層,您應該在應用程式的 bootstrap/app.php 檔案中呼叫 trustHosts 中介層方法。透過該方法的 at 引數,您可以指定應用程式應回應的主機名稱。主機名稱字串被視為正規表示式。帶有其他 Host 標頭的傳入請求將被拒絕:
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustHosts(at: ['^laravel\.test$']);
})預設情況下,來自應用程式 URL 子網域的請求也會自動被信任。如果您想停用此行為,可以使用 subdomains 引數:
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustHosts(at: ['^laravel\.test$'], subdomains: false);
})如果您需要存取應用程式的設定檔或資料庫來決定信任的主機,可以為 at 引數提供一個閉包:
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustHosts(at: fn () => config('app.trusted_hosts'));
})