Analisis dan ringkasan 5 petua Pelanggan HTTP Laravel

Artikel ini membawakan anda pengetahuan yang berkaitan tentang Laravel. Ia terutamanya berkongsi dengan anda 5 petua Pelanggan HTTP Laravel yang berminat boleh lihat di bawah.

Sebagai web pembangun, kami selalunya perlu berinteraksi dengan Laravel daripada api aplikasi. Laravel HTTP pembalut perpustakaan yang mudah dan intuitif disediakan dalam 7versi klienGuzzle HTTP. Dalam artikel ini, kami akan meneroka lima petua berharga untuk menggunakan Laravel HTTP Client yang boleh menjadikan pengalaman pembangunan anda lebih cekap dan menyeronokkan.

Petua ini termasuk menggunakan HTTP makro, mengkonfigurasi HTTP klien untuk perkhidmatan kontena, konfigurasi asas mudah alih URL, mencegah permintaan palsu dalam ujian dan mendengar acara HTTP. Dengan menguasai teknik ini, anda boleh memudahkan API interaksi dan mencipta aplikasi Laravel yang lebih mantap dan boleh diselenggara.

Makro HTTP

Banyak perkhidmatan Laravel mempunyai ciri 宏 yang membolehkan anda menentukan kaedah tersuai untuk aplikasi anda. Anda boleh menambahkan makro ini pada kaedah boot() pembekal perkhidmatan dan bukannya melanjutkan kelas teras daripada rangka kerja Laravel.

Dokumentasi HTTP menunjukkan contoh makro yang anda boleh gunakan untuk mentakrifkan tetapan biasa:

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

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

Makro boleh mentakrifkan apa sahaja yang anda mahukan dalam aplikasi anda Kaedah mudah ditakrifkan dan digunakan semula dalam . Contoh makro dalam dokumentasi melibatkan petua lain untuk mengkonfigurasi klien HTTP untuk digunakan dengan perkhidmatan lain.

Dalam bahagian seterusnya kami akan menyemak semula kaedah menggabungkan makro dengan menghantar pelanggan kepada perkhidmatan kontena lain.

Mengkonfigurasi klien HTTP untuk perkhidmatan kontena

Apabila berinteraksi dengan API dalam aplikasi Laravel anda, anda mungkin mahu mengkonfigurasi pelbagai tetapan boleh dikonfigurasikan untuk klien. Contohnya, jika API anda mempunyai berbilang persekitaran, anda perlu mengkonfigurasi URL asas, token, tetapan tamat masa, dsb.

Kami boleh menggunakan makro untuk mentakrifkan pelanggan, mewakili pelanggan sebagai perkhidmatannya sendiri dan kemudian menyuntiknya ke dalam perkhidmatan lain atau kedua-duanya.

Mula-mula, mari lihat cara mentakrifkan tetapan klien dalam kaedah register() pembekal perkhidmatan:

public function register(): void
{
    $this->app->singleton(ExampleService::class, function (Application $app) {
        $client = Http::withOptions([
            'base_uri' => config('services.example.base_url'),
            'timeout' => config('services.example.timeout', 10),
            'connect_timeout' => config('services.example.connect_timeout', 2),
        ])->withToken(config('services.example.token'));

        return new ExampleService($client);
    });
}

Dalam definisi perkhidmatan tunggal, kami merangkai beberapa Dipanggil untuk mengkonfigurasi klien. Hasilnya ialah contoh PendingRequest yang boleh kami hantar kepada pembina perkhidmatan kami seperti ini:

class ExampleService
{
    public function __construct(
        private PendingRequest $client
    ) {}

    public function getWidget(string $uid)
    {
        $response = $this->client
            ->withUrlParameters(['uid' => $uid])
            ->get('widget/{uid}');

        return new Widget($response->json());
    }
}

Perkhidmatan menggunakan kaedah withOptions() untuk mengkonfigurasi pilihan Guzzle secara langsung, tetapi kami juga boleh menggunakan Beberapa kaedah kemudahan disediakan oleh pelanggan HTTP:

$this->app->singleton(ExampleService::class, function (Application $app) {
    $client = Http::baseUrl(config('services.example.base_url'))
        ->timeout(config('services.example.timeout', 10))
        ->connectTimeout(config('services.example.connect_timeout', 2))
        ->withToken(config('services.example.token'));

    return new ExampleService($client);
});

Sebagai alternatif, jika anda ingin menggabungkan makro dengan perkhidmatan anda, anda boleh menggunakan makro yang anda tentukan dalam kaedah AppServiceProvider boot() anda:

$this->app->singleton(ExampleService::class, function (Application $app) {
    return new ExampleService(Http::github());
});

Konfigurasi URL Pangkalan Mudah Alih

Anda mungkin telah melihat bahawa URL asas lalai mengandungi / pengekoran, yang memberikan kemudahalihan maksimum. Ambil konfigurasi perkhidmatan berikut sebagai contoh (perhatikan base_url lalai):

Jika API kami mempunyai awalan laluan

return [
    'example' => [
        'base_url' => env('EXAMPLE_BASE_URI', 'https://api.example.com/v1/'),
        'token' => env('EXAMPLE_SERVICE_TOKEN'),
        'timeout' => env('EXAMPLE_SERVICE_TIMEOUT', 10),
        'connect_timeout' => env('EXAMPLE_SERVICE_TIMEOUT', 2),
    ],
];

dalam persekitaran pengeluaran dan ujian, mungkin hanya

; Menggunakan garis miring mengekor menjadikan URL berfungsi seperti yang diharapkan tanpa mengubah kod. Semasa mengkonfigurasi jejak /v1/, sila ambil perhatian bahawa semua panggilan API dalam kod saya menggunakan laluan relatif: https://stg-api.example.com//

Lihat dokumentasi

$this->client
    ->withUrlParameters(['uid' => $uid])
    // 例子：
    // 测试环境 - https://stg-api.example.com/widget/123
    // 生产环境 - https://api.example.com/v1/widget/123
    ->get('widget/{uid}');

Mencipta Pelanggan

Guzzle untuk mengetahui lebih lanjut Bagaimana gaya base_uri yang berbeza mempengaruhi Penghuraian URI. Halang permintaan sesat dalam ujian

Klien HTTP Laravel menyediakan alat ujian yang sangat baik yang menjadikan ujian penulisan mudah. Apabila saya menulis kod yang berinteraksi dengan API, saya berasa tidak senang bahawa dalam beberapa cara ujian saya mempunyai permintaan rangkaian sebenar berlaku. Masukkan

untuk mengelakkan permintaan sesat

dengan klien HTTP Laravel:

Pada pendapat saya, cara terbaik untuk menggunakan

Http::preventStrayRequests();

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

// Run test code
// If any other code triggers an HTTP call via Laravel's client
// an exception is thrown.

ialah dalam kelas ujian yang anda harapkan untuk berinteraksi dengan API Define kaedah

dalam . Mungkin anda juga boleh menambahkan ini pada kelas preventStrayRequests() asas apl anda. setUp()TestCase

Melakukan ini akan memastikan bahawa setiap panggilan klien HTTP yang dicetuskan dalam suite ujian anda disokong oleh permintaan palsu. Menggunakan pendekatan ini memberi saya banyak keyakinan bahawa saya telah merangkumi semua permintaan keluar saya dengan permintaan palsu yang setara dalam ujian saya.

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Illuminate\Support\Facades\Http;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    public function setUp(): void
    {
        parent::setUp();

        Http::preventStrayRequests();
    }
}

Pengendali log untuk acara HTTP

Pelanggan HTTP Laravel mempunyai banyak peristiwa berharga yang boleh anda gunakan untuk menyelidiki peringkat penting dalam kitaran hayat permintaan/tindak balas. Semasa artikel ini ditulis, tiga peristiwa telah dicetuskan:

• Illuminate\HttpClient\Events\RequestSending
• IlluminateHttpClient\Events\ResponseReceived
• IlluminateHttpClient\EventsConnectionFailed

比方说，你想把你的应用程序发出请求的每个 URL 都可视化。我们可以很容易地接入 RequestSending 事件，并记录出每个请求。

namespoace App/Listeners;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Log;

class LogRequestSending
{
    public function handle(object $event): void
    {
        Log::debug('HTTP请求正在发送。', ['url' => $event->request->url()
            'url' => $event->request->url(),
        ]);
    }
}

为了使事件处理程序工作，在 EventServiceProvider 类中添加以下内容。

use App\Listeners\LogRequestSending;
use Illuminate\Http\Client\Events\RequestSending;
// ...
protected $listen = [
    Registered::class => [
        SendEmailVerificationNotification::class,
    ],
    RequestSending::class => [
        LogRequestSending::class,
    ],
];

一旦它被连接起来，你就会在你的日志中看到类似于 HTTP 客户端尝试的每个请求的内容。

[2023-03-17 04:06:03] local.DEBUG: HTTP请求正在被发送。{"url": "https://api.example.com/v1/widget/123"}

了解更多

官方的Laravel HTTP 文档有你需要的一切，可以开始了。我希望这个教程能给你一些灵感和技巧，你可以在你的 Laravel 应用程序中使用。

原文地址：https://laravel-news.com/laravel-http-cl...

译文地址：https://www.php.cn/link/bac346f4c260a59fde0b1546e8a025aa

Atas ialah kandungan terperinci Analisis dan ringkasan 5 petua Pelanggan HTTP Laravel. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!