Analysis and summary of 5 Laravel HTTP Client tips

This article brings you relevant knowledge about Laravel. It mainly shares with you 5 tips of Laravel HTTP Client. Friends who are interested can take a look at it. I hope it will be helpful to everyone.

As web developers, we often need to interact with api from Laravel applications. A convenient and intuitive Guzzle HTTP library wrapper is provided in Laravel HTTP client version 7. In this article, we'll explore five valuable tips for using Laravel HTTP Client that can make your development experience more efficient and enjoyable. These techniques include using

HTTP

macros, configuring HTTP clients for container services, portable basic URL configuration, preventing Miscellaneous requests and listening for HTTP events. By mastering these techniques, you can simplify API interactions and create more robust and maintainable Laravel applications. HTTP Macros

Many of Laravel's services have a

Macro

feature that allows you to define custom methods for your application. You can add these macros to the service provider's boot() method instead of extending the core class from the Laravel framework. The HTTP documentation shows an

example

of a macro you can use to define common settings:

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

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

The macro can define anything you want to define in your application and convenient methods for reuse. The macro example in the documentation involves another tip for configuring an HTTP client for use with other services.

In the next section, we will revisit the method of combining macros with passing clients to other container services.

Configuring the HTTP Client for the Container ServiceWhen interacting with the API in your Laravel application, you may want to configure various configurable settings for the client. For example, if your API has multiple environments, you need to configure the base URL, tokens, timeout settings, etc.

We can use macros to define the client, represent the client as its own service, and then inject it into other services, or both.

First, let's see how to define client settings in the service provider's

register()

method: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">public function register(): void {     $this-&gt;app-&gt;singleton(ExampleService::class, function (Application $app) {         $client = Http::withOptions([             'base_uri' =&gt; config('services.example.base_url'),             'timeout' =&gt; config('services.example.timeout', 10),             'connect_timeout' =&gt; config('services.example.connect_timeout', 2),         ])-&gt;withToken(config('services.example.token'));         return new ExampleService($client);     }); }</pre><div class="contentsignin">Copy after login</div></div>In the singleton service definition, we chain A few calls are made to configure the client. The result is a

PendingRequest

instance, which we can pass to our service constructor like this: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">class ExampleService {     public function __construct(         private PendingRequest $client     ) {}     public function getWidget(string $uid)     {         $response = $this-&gt;client             -&gt;withUrlParameters(['uid' =&gt; $uid])             -&gt;get('widget/{uid}');         return new Widget($response-&gt;json());     } }</pre><div class="contentsignin">Copy after login</div></div> The service is configured directly using the

withOptions()

method Guzzle option, but we can also use some convenience methods provided by the HTTP client: <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false">$this-&gt;app-&gt;singleton(ExampleService::class, function (Application $app) {     $client = Http::baseUrl(config('services.example.base_url'))         -&gt;timeout(config('services.example.timeout', 10))         -&gt;connectTimeout(config('services.example.connect_timeout', 2))         -&gt;withToken(config('services.example.token'));     return new ExampleService($client); });</pre><div class="contentsignin">Copy after login</div></div> Alternatively, if you want to combine a macro with a service, you can do so in the ## of your

AppServiceProvider

#boot() Use the macro you defined in the method:

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

Portable base URL configurationYou may have seen that the default base URL contains a trailing

/

, which provides maximum portability according to

RFC3986. Take the following service configuration as an example (note the default base_url):

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),
    ],
];

If our API has a path prefix

/v1/

in production and test environments , maybe it's just

https://stg-api.example.com/; Using a trailing slash makes the URL work as expected without changing the code. While configuring the trailing /, please note that all API calls in my code use relative paths:

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

See Guzzle's Creating a Client documentation , learn how different base_uri styles affect URI parsing.

Prevent Stray Requests in Tests

Laravel’s HTTP client provides excellent testing tools that make writing tests a breeze. When I write code that interacts with the API, I feel uneasy that my tests somehow have actual network requests happening. Enter

Preventing Stray Requests

with Laravel HTTP Client:

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.

In my opinion, the best way to use preventStrayRequests()

is where you expect with the API Define a

setUp() method in the interactive test class. Maybe you could also add this to your application's base TestCase class.

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();
    }
}

Doing this will ensure that every HTTP client call fired in your test suite is backed by a fake request. Using this approach gives me a lot of confidence that I've covered all my outbound requests with an equivalent fake request in my tests.

Log handler for HTTP events

Laravel's HTTP client has many valuable events that you can use to quickly dig into important stages of the request/response life cycle. At the time of writing this article, three events were triggered:

• 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

The above is the detailed content of Analysis and summary of 5 Laravel HTTP Client tips. For more information, please follow other related articles on the PHP Chinese website!