Skip to content

Latest commit

 

History

History
827 lines (605 loc) · 27.5 KB

http-client.md

File metadata and controls

827 lines (605 loc) · 27.5 KB

HTTP 客戶端

簡介

Laravel 提供了一個表達性強、最小 API，圍繞著 Guzzle HTTP 客戶端，讓您可以快速發送外部 HTTP 請求，與其他網路應用程式進行通訊。Laravel 對 Guzzle 的封裝專注於其最常見的使用情境，提供了出色的開發者體驗。

發送請求

要發送請求，您可以使用 Http Facade 提供的 head、get、post、put、patch 和 delete 方法。首先，讓我們看一下如何對另一個 URL 發送基本的 GET 請求：

use Illuminate\Support\Facades\Http;

$response = Http::get('http://example.com');

get 方法會返回一個 Illuminate\Http\Client\Response 實例，該實例提供了多種方法，可用於檢視回應：

$response->body() : string;
$response->json($key = null, $default = null) : mixed;
$response->object() : object;
$response->collect($key = null) : Illuminate\Support\Collection;
$response->resource() : resource;
$response->status() : int;
$response->successful() : bool;
$response->redirect(): bool;
$response->failed() : bool;
$response->clientError() : bool;
$response->header($header) : string;
$response->headers() : array;

Illuminate\Http\Client\Response 物件還實作了 PHP 的 ArrayAccess 介面，讓您可以直接在回應上存取 JSON 回應資料：

return Http::get('http://example.com/users/1')['name'];

除了上述列出的回應方法外，還可以使用以下方法來確定回應是否具有特定狀態碼：

$response->ok() : bool;                  // 200 OK
$response->created() : bool;             // 201 Created
$response->accepted() : bool;            // 202 Accepted
$response->noContent() : bool;           // 204 No Content
$response->movedPermanently() : bool;    // 301 Moved Permanently
$response->found() : bool;               // 302 Found
$response->badRequest() : bool;          // 400 Bad Request
$response->unauthorized() : bool;        // 401 Unauthorized
$response->paymentRequired() : bool;     // 402 Payment Required
$response->forbidden() : bool;           // 403 Forbidden
$response->notFound() : bool;            // 404 Not Found
$response->requestTimeout() : bool;      // 408 Request Timeout
$response->conflict() : bool;            // 409 Conflict
$response->unprocessableEntity() : bool; // 422 Unprocessable Entity
$response->tooManyRequests() : bool;     // 429 Too Many Requests
$response->serverError() : bool;         // 500 Internal Server Error

URI 模板

HTTP 客戶端還允許您使用 URI 模板規範 構建請求 URL。要定義可以由您的 URI 模板擴展的 URL 參數，您可以使用 withUrlParameters 方法：

Http::withUrlParameters([
    'endpoint' => 'https://laravel.com',
    'page' => 'docs',
    'version' => '11.x',
    'topic' => 'validation',
])->get('{+endpoint}/{page}/{version}/{topic}');

輸出請求

如果您想在發送請求之前將輸出的請求實例輸出並終止腳本的執行，您可以將 dd 方法添加到您的請求定義的開頭：

return Http::dd()->get('http://example.com');

請求數據

當進行 POST、PUT 和 PATCH 請求時，通常會將額外的數據與您的請求一起發送，因此這些方法接受一個數據陣列作為它們的第二個引數。默認情況下，數據將使用 application/json 內容類型發送：

use Illuminate\Support\Facades\Http;

$response = Http::post('http://example.com/users', [
    'name' => 'Steve',
    'role' => 'Network Administrator',
]);

獲取請求查詢參數

在進行 GET 請求時，您可以直接將查詢字符串附加到 URL，或將鍵/值對的陣列作為 get 方法的第二個引數傳遞：

$response = Http::get('http://example.com/users', [
    'name' => 'Taylor',
    'page' => 1,
]);

或者，可以使用 withQueryParameters 方法：

Http::retry(3, 100)->withQueryParameters([
    'name' => 'Taylor',
    'page' => 1,
])->get('http://example.com/users')

發送表單 URL 編碼請求

如果您想使用 application/x-www-form-urlencoded 內容類型發送數據，應在發送請求之前調用 asForm 方法：

$response = Http::asForm()->post('http://example.com/users', [
    'name' => 'Sara',
    'role' => 'Privacy Consultant',
]);

發送原始請求主體

如果您想在發送請求時提供原始請求主體，可以使用 withBody 方法。內容類型可以通過該方法的第二個引數提供：

$response = Http::withBody(
    base64_encode($photo), 'image/jpeg'
)->post('http://example.com/photo');

多部分請求

如果您想將文件作為多部分請求發送，應在發送請求之前調用 attach 方法。該方法接受文件的名稱和內容。如果需要，可以提供第三個引數，該引數將被視為文件的文件名，同時第四個引數可用於提供與文件相關的標頭：

$response = Http::attach(
    'attachment', file_get_contents('photo.jpg'), 'photo.jpg', ['Content-Type' => 'image/jpeg']
)->post('http://example.com/attachments');

而不是傳遞檔案的原始內容，您可以傳遞一個串流資源：

$photo = fopen('photo.jpg', 'r');

$response = Http::attach(
    'attachment', $photo, 'photo.jpg'
)->post('http://example.com/attachments');

標頭

可以使用 withHeaders 方法向請求添加標頭。這個 withHeaders 方法接受一個鍵/值對的陣列：

$response = Http::withHeaders([
    'X-First' => 'foo',
    'X-Second' => 'bar'
])->post('http://example.com/users', [
    'name' => 'Taylor',
]);

您可以使用 accept 方法來指定應用程式期望在回應中收到的內容類型：

$response = Http::accept('application/json')->get('http://example.com/users');

為了方便起見，您可以使用 acceptJson 方法快速指定應用程式期望在回應中收到 application/json 內容類型：

$response = Http::acceptJson()->get('http://example.com/users');

withHeaders 方法將新的標頭合併到請求的現有標頭中。如果需要，您可以使用 replaceHeaders 方法完全替換所有標頭：

$response = Http::withHeaders([
    'X-Original' => 'foo',
])->replaceHeaders([
    'X-Replacement' => 'bar',
])->post('http://example.com/users', [
    'name' => 'Taylor',
]);

認證

您可以使用 withBasicAuth 和 withDigestAuth 方法來指定基本和摘要認證憑證：

// Basic authentication...
$response = Http::withBasicAuth('[email protected]', 'secret')->post(/* ... */);

// Digest authentication...
$response = Http::withDigestAuth('[email protected]', 'secret')->post(/* ... */);

持有者令牌

如果您想要快速將持有者令牌添加到請求的 Authorization 標頭中，可以使用 withToken 方法：

$response = Http::withToken('token')->post(/* ... */);

逾時

timeout 方法可用於指定等待回應的最大秒數。預設情況下，HTTP 客戶端在 30 秒後會逾時：

$response = Http::timeout(3)->get(/* ... */);

如果超過給定的逾時時間，將拋出 Illuminate\Http\Client\ConnectionException 的實例。

您可以使用 connectTimeout 方法指定在嘗試連接到伺服器時等待的最大秒數：

$response = Http::connectTimeout(3)->get(/* ... */);

重試

如果您希望HTTP客戶端在發生客戶端或伺服器錯誤時自動重試請求，您可以使用 retry 方法。retry 方法接受應嘗試請求的最大次數以及Laravel應在嘗試之間等待的毫秒數：

$response = Http::retry(3, 100)->post(/* ... */);

如果您希望手動計算嘗試之間要睡眠的毫秒數，您可以將閉包作為 retry 方法的第二個參數傳遞：

use Exception;

$response = Http::retry(3, function (int $attempt, Exception $exception) {
    return $attempt * 100;
})->post(/* ... */);

為了方便起見，您也可以將陣列作為 retry 方法的第一個參數。此陣列將用於確定連續嘗試之間要睡眠多少毫秒：

$response = Http::retry([100, 200])->post(/* ... */);

如果需要，您可以將第三個參數傳遞給 retry 方法。第三個參數應該是一個可調用函式，用於確定是否應該實際嘗試重試。例如，您可能希望僅在初始請求遇到 ConnectionException 時才重試請求：

use Exception;
use Illuminate\Http\Client\PendingRequest;

$response = Http::retry(3, 100, function (Exception $exception, PendingRequest $request) {
    return $exception instanceof ConnectionException;
})->post(/* ... */);

如果請求嘗試失敗，您可能希望在進行新嘗試之前對請求進行更改。您可以通過修改提供給 retry 方法的可調用函式的請求參數來實現這一點。例如，如果第一次嘗試返回身份驗證錯誤，您可能希望使用新的授權標記重試請求：

use Exception;
use Illuminate\Http\Client\PendingRequest;
use Illuminate\Http\Client\RequestException;

$response = Http::withToken($this->getToken())->retry(2, 0, function (Exception $exception, PendingRequest $request) {
    if (! $exception instanceof RequestException || $exception->response->status() !== 401) {
        return false;
    }

    $request->withToken($this->getNewToken());

    return true;
})->post(/* ... */);

如果所有請求都失敗，將拋出 Illuminate\Http\Client\RequestException 的實例。如果您希望禁用此行為，您可以提供一個具有值 false 的 throw 參數。禁用時，客戶端收到的最後一個回應將在所有嘗試之後返回：

$response = Http::retry(3, 100, throw: false)->post(/* ... */);

Warning

如果所有請求因連線問題而失敗，即使將 throw 參數設置為 false，仍將拋出 Illuminate\Http\Client\ConnectionException。

錯誤處理

與 Guzzle 的預設行為不同，Laravel 的 HTTP 客戶端包裝器在客戶端或伺服器錯誤（從伺服器返回的 400 和 500 級別的回應）時不會拋出異常。您可以使用 successful、clientError 或 serverError 方法來確定是否返回了其中一個錯誤：

// Determine if the status code is >= 200 and < 300...
$response->successful();

// Determine if the status code is >= 400...
$response->failed();

// Determine if the response has a 400 level status code...
$response->clientError();

// Determine if the response has a 500 level status code...
$response->serverError();

// Immediately execute the given callback if there was a client or server error...
$response->onError(callable $callback);

拋出異常

如果您有一個回應實例並且希望在回應狀態碼指示客戶端或伺服器錯誤時拋出 Illuminate\Http\Client\RequestException 實例，您可以使用 throw 或 throwIf 方法：

use Illuminate\Http\Client\Response;

$response = Http::post(/* ... */);

// Throw an exception if a client or server error occurred...
$response->throw();

// Throw an exception if an error occurred and the given condition is true...
$response->throwIf($condition);

// Throw an exception if an error occurred and the given closure resolves to true...
$response->throwIf(fn (Response $response) => true);

// Throw an exception if an error occurred and the given condition is false...
$response->throwUnless($condition);

// Throw an exception if an error occurred and the given closure resolves to false...
$response->throwUnless(fn (Response $response) => false);

// Throw an exception if the response has a specific status code...
$response->throwIfStatus(403);

// Throw an exception unless the response has a specific status code...
$response->throwUnlessStatus(200);

return $response['user']['id'];

Illuminate\Http\Client\RequestException 實例具有公共 $response 屬性，可讓您檢查返回的回應。

如果沒有發生錯誤，throw 方法將返回回應實例，使您可以將其他操作鏈接到 throw 方法上：

return Http::post(/* ... */)->throw()->json();

如果您希望在拋出異常之前執行一些額外邏輯，您可以將閉包傳遞給 throw 方法。在調用閉包後，異常將自動拋出，因此您無需在閉包內重新拋出異常：

use Illuminate\Http\Client\Response;
use Illuminate\Http\Client\RequestException;

return Http::post(/* ... */)->throw(function (Response $response, RequestException $e) {
    // ...
})->json();

預設情況下，當記錄或報告 RequestException 時，訊息會被截斷為 120 個字符。要自定義或停用此行為，您可以在配置應用程式的異常處理行為時使用 truncateRequestExceptionsAt 和 dontTruncateRequestExceptions 方法，在您的 bootstrap/app.php 檔案中：

->withExceptions(function (Exceptions $exceptions) {
    // Truncate request exception messages to 240 characters...
    $exceptions->truncateRequestExceptionsAt(240);

    // Disable request exception message truncation...
    $exceptions->dontTruncateRequestExceptions();
})

Guzzle 中介層

由於 Laravel 的 HTTP 客戶端由 Guzzle 提供支援，您可以利用 Guzzle 中介層 來操作發出的請求或檢查收到的回應。要操作發出的請求，請通過 withRequestMiddleware 方法註冊 Guzzle 中介層：

use Illuminate\Support\Facades\Http;
use Psr\Http\Message\RequestInterface;

$response = Http::withRequestMiddleware(
    function (RequestInterface $request) {
        return $request->withHeader('X-Example', 'Value');
    }
)->get('http://example.com');

同樣地，您可以通過 withResponseMiddleware 方法註冊一個中介層來檢查傳入的 HTTP 回應：

use Illuminate\Support\Facades\Http;
use Psr\Http\Message\ResponseInterface;

$response = Http::withResponseMiddleware(
    function (ResponseInterface $response) {
        $header = $response->getHeader('X-Example');

        // ...

        return $response;
    }
)->get('http://example.com');

全域中介層

有時，您可能希望註冊一個中介層，該中介層適用於每個傳出請求和傳入回應。為了實現這一點，您可以使用 globalRequestMiddleware 和 globalResponseMiddleware 方法。通常情況下，這些方法應該在應用程式的 AppServiceProvider 的 boot 方法中調用：

use Illuminate\Support\Facades\Http;

Http::globalRequestMiddleware(fn ($request) => $request->withHeader(
    'User-Agent', 'Example Application/1.0'
));

Http::globalResponseMiddleware(fn ($response) => $response->withHeader(
    'X-Finished-At', now()->toDateTimeString()
));

Guzzle 選項

您可以使用 withOptions 方法指定額外的 Guzzle 請求選項 來進行傳出請求。withOptions 方法接受一個鍵值對的陣列：

$response = Http::withOptions([
    'debug' => true,
])->get('http://example.com/users');

全域選項

為了為每個傳出請求配置默認選項，您可以使用 globalOptions 方法。通常情況下，這個方法應該在應用程式的 AppServiceProvider 的 boot 方法中調用：

use Illuminate\Support\Facades\Http;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Http::globalOptions([
        'allow_redirects' => false,
    ]);
}

並行請求

有時，您可能希望同時進行多個 HTTP 請求。換句話說，您希望多個請求同時發送，而不是按順序發送請求。這在與慢速 HTTP API 互動時可以帶來顯著的性能改進。

幸運的是，您可以使用 pool 方法來實現這一點。pool 方法接受一個閉包，該閉包接收一個 Illuminate\Http\Client\Pool 實例，讓您可以輕鬆地將請求添加到請求池中進行發送：

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$responses = Http::pool(fn (Pool $pool) => [
    $pool->get('http://localhost/first'),
    $pool->get('http://localhost/second'),
    $pool->get('http://localhost/third'),
]);

return $responses[0]->ok() &&
       $responses[1]->ok() &&
       $responses[2]->ok();

正如您所看到的，每個回應實例可以根據其添加到池中的順序進行訪問。如果您希望，您可以使用 as 方法為請求命名，這樣可以通過名稱訪問相應的回應：

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$responses = Http::pool(fn (Pool $pool) => [
    $pool->as('first')->get('http://localhost/first'),
    $pool->as('second')->get('http://localhost/second'),
    $pool->as('third')->get('http://localhost/third'),
]);

return $responses['first']->ok();

自訂並行請求

pool 方法無法與其他 HTTP 客戶端方法（如 withHeaders 或 middleware 方法）鏈接。如果您想要對池化請求應用自訂標頭或中介層，您應該在池中的每個請求上配置這些選項：

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;

$headers = [
    'X-Example' => 'example',
];

$responses = Http::pool(fn (Pool $pool) => [
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
    $pool->withHeaders($headers)->get('http://laravel.test/test'),
]);

宏

Laravel HTTP 客戶端允許您定義“宏”，這可以作為一種流暢、表達豐富的機制，用於在應用程序中與服務互動時配置常見的請求路徑和標頭。要開始，您可以在應用程序的 App\Providers\AppServiceProvider 類的 boot 方法中定義宏：

use Illuminate\Support\Facades\Http;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Http::macro('github', function () {
        return Http::withHeaders([
            'X-Example' => 'example',
        ])->baseUrl('https://github.com');
    });
}

一旦配置了您的宏，您可以在應用程序的任何地方調用它，以使用指定的配置創建一個待定請求：

$response = Http::github()->get('/');

測試

許多 Laravel 服務提供了功能，幫助您輕鬆且表達豐富地編寫測試，而 Laravel 的 HTTP 客戶端也不例外。Http 門面的 fake 方法允許您指示 HTTP 客戶端在進行請求時返回存根 / 虛擬響應。

虛擬響應

例如，要指示 HTTP 客戶端對每個請求返回空的 200 狀態碼響應，您可以調用 fake 方法而不帶任何參數：

use Illuminate\Support\Facades\Http;

Http::fake();

$response = Http::post(/* ... */);

虛擬特定 URL

或者，您可以將陣列傳遞給 fake 方法。陣列的鍵應該代表您希望虛擬的 URL 模式及其相關的響應。* 字元可用作萬用字元。對於未被虛擬的 URL 發出的任何請求將實際執行。您可以使用 Http 門面的 response 方法為這些端點構造存根 / 虛擬響應：

Http::fake([
    // Stub a JSON response for GitHub endpoints...
    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),

    // Stub a string response for Google endpoints...
    'google.com/*' => Http::response('Hello World', 200, $headers),
]);

如果您想要指定一個回退的 URL 樣式，以虛擬所有未匹配的 URL，您可以使用單個 * 字元：

Http::fake([
    // Stub a JSON response for GitHub endpoints...
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // Stub a string response for all other endpoints...
    '*' => Http::response('Hello World', 200, ['Headers']),
]);

為了方便起見，通過提供字符串、數組或整數作為回應，可以生成簡單的字符串、JSON 和空回應：

Http::fake([
    'google.com/*' => 'Hello World',
    'github.com/*' => ['foo' => 'bar'],
    'chatgpt.com/*' => 200,
]);

虛擬連接異常

有時候，當 HTTP 客戶端嘗試發送請求時遇到 Illuminate\Http\Client\ConnectionException 時，您可能需要測試應用程序的行為。您可以使用 failedConnection 方法指示 HTTP 客戶端拋出連接異常：

Http::fake([
    'github.com/*' => Http::failedConnection(),
]);

虛擬回應序列

有時候，您可能需要指定單個 URL 應按特定順序返回一系列虛擬回應。您可以使用 Http::sequence 方法來構建回應：

Http::fake([
    // Stub a series of responses for GitHub endpoints...
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->pushStatus(404),
]);

當回應序列中的所有回應都被使用後，任何進一步的請求將導致回應序列拋出異常。如果您想要指定一個當序列為空時應返回的默認回應，您可以使用 whenEmpty 方法：

Http::fake([
    // Stub a series of responses for GitHub endpoints...
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->whenEmpty(Http::response()),
]);

如果您想要虛擬一系列回應，但不需要指定應該虛擬的特定 URL 樣式，您可以使用 Http::fakeSequence 方法：

Http::fakeSequence()
    ->push('Hello World', 200)
    ->whenEmpty(Http::response());

虛擬回呼

如果您需要更複雜的邏輯來確定對於某些端點應返回什麼回應，您可以將閉包傳遞給 fake 方法。這個閉包將接收一個 Illuminate\Http\Client\Request 實例，並應返回一個回應實例。在您的閉包中，您可以執行必要的邏輯來確定應返回什麼類型的回應：

use Illuminate\Http\Client\Request;

Http::fake(function (Request $request) {
    return Http::response('Hello World', 200);
});

防止零散請求

如果您希望確保透過 HTTP 客戶端發送的所有請求在您的個別測試或完整測試套件中都已被偽造，您可以調用 preventStrayRequests 方法。調用此方法後，任何沒有相應偽造回應的請求將拋出異常，而不是進行實際的 HTTP 請求：

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

Http::fake([
    'github.com/*' => Http::response('ok'),
]);

// An "ok" response is returned...
Http::get('https://github.com/laravel/framework');

// An exception is thrown...
Http::get('https://laravel.com');

檢查請求

在偽造回應時，您可能偶爾希望檢查客戶端接收到的請求，以確保應用程序發送了正確的數據或標頭。您可以在調用 Http::fake 後調用 Http::assertSent 方法來實現這一點。

assertSent 方法接受一個閉包，該閉包將接收一個 Illuminate\Http\Client\Request 實例，並應返回一個布爾值，指示請求是否符合您的期望。為了通過測試，至少必須發出一個符合給定期望的請求：

use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;

Http::fake();

Http::withHeaders([
    'X-First' => 'foo',
])->post('http://example.com/users', [
    'name' => 'Taylor',
    'role' => 'Developer',
]);

Http::assertSent(function (Request $request) {
    return $request->hasHeader('X-First', 'foo') &&
           $request->url() == 'http://example.com/users' &&
           $request['name'] == 'Taylor' &&
           $request['role'] == 'Developer';
});

如果需要，您可以使用 assertNotSent 方法來斷言未發送特定請求：

use Illuminate\Http\Client\Request;
use Illuminate\Support\Facades\Http;

Http::fake();

Http::post('http://example.com/users', [
    'name' => 'Taylor',
    'role' => 'Developer',
]);

Http::assertNotSent(function (Request $request) {
    return $request->url() === 'http://example.com/posts';
});

您可以使用 assertSentCount 方法來斷言測試期間“發送”的請求數量：

Http::fake();

Http::assertSentCount(5);

或者，您可以使用 assertNothingSent 方法來斷言測試期間未發送任何請求：

Http::fake();

Http::assertNothingSent();

記錄請求 / 回應

您可以使用 recorded 方法來收集所有請求及其相應的回應。recorded 方法返回一個包含 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 實例的數組集合：

Http::fake([
    'https://laravel.com' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded();

[$request, $response] = $recorded[0];

此外，recorded 方法接受一個閉包，該閉包將接收一個 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 實例，並可用於根據您的期望篩選請求 / 回應對。

use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;

Http::fake([
    'https://laravel.com' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded(function (Request $request, Response $response) {
    return $request->url() !== 'https://laravel.com' &&
           $response->successful();
});

事件

在發送 HTTP 請求的過程中，Laravel 會觸發三個事件。RequestSending 事件在發送請求之前觸發，而 ResponseReceived 事件在接收到給定請求的回應後觸發。如果沒有收到給定請求的回應，則會觸發 ConnectionFailed 事件。

RequestSending 和 ConnectionFailed 事件都包含一個公共的 $request 屬性，您可以用來檢查 Illuminate\Http\Client\Request 實例。同樣地，ResponseReceived 事件也包含一個 $request 屬性以及一個 $response 屬性，可用於檢查 Illuminate\Http\Client\Response 實例。您可以在應用程式中為這些事件建立 事件監聽器：

use Illuminate\Http\Client\Events\RequestSending;

class LogRequest
{
    /**
     * Handle the given event.
     */
    public function handle(RequestSending $event): void
    {
        // $event->request ...
    }
}