search
HomePHP FrameworkLaravelAnalysis 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.

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: <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>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: <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> The service is configured directly using the

withOptions()

method Guzzle option, but we can also use some convenience methods provided by the HTTP client: <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> 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([
    &#39;github.com/*&#39; => Http::response(&#39;ok&#39;),
]);

// Run test code
// If any other code triggers an HTTP call via Laravel&#39;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!

Statement
This article is reproduced at:learnku. If there is any infringement, please contact admin@php.cn delete
Laravel's Impact: Simplifying Web DevelopmentLaravel's Impact: Simplifying Web DevelopmentApr 21, 2025 am 12:18 AM

Laravel stands out by simplifying the web development process and delivering powerful features. Its advantages include: 1) concise syntax and powerful ORM system, 2) efficient routing and authentication system, 3) rich third-party library support, allowing developers to focus on writing elegant code and improve development efficiency.

Laravel: Frontend or Backend? Clarifying the Framework's RoleLaravel: Frontend or Backend? Clarifying the Framework's RoleApr 21, 2025 am 12:17 AM

Laravelispredominantlyabackendframework,designedforserver-sidelogic,databasemanagement,andAPIdevelopment,thoughitalsosupportsfrontenddevelopmentwithBladetemplates.

Laravel vs. Python: Exploring Performance and ScalabilityLaravel vs. Python: Exploring Performance and ScalabilityApr 21, 2025 am 12:16 AM

Laravel and Python have their own advantages and disadvantages in terms of performance and scalability. Laravel improves performance through asynchronous processing and queueing systems, but due to PHP limitations, there may be bottlenecks when high concurrency is present; Python performs well with the asynchronous framework and a powerful library ecosystem, but is affected by GIL in a multi-threaded environment.

Laravel vs. Python (with Frameworks): A Comparative AnalysisLaravel vs. Python (with Frameworks): A Comparative AnalysisApr 21, 2025 am 12:15 AM

Laravel is suitable for projects that teams are familiar with PHP and require rich features, while Python frameworks depend on project requirements. 1.Laravel provides elegant syntax and rich features, suitable for projects that require rapid development and flexibility. 2. Django is suitable for complex applications because of its "battery inclusion" concept. 3.Flask is suitable for fast prototypes and small projects, providing great flexibility.

Frontend with Laravel: Exploring the PossibilitiesFrontend with Laravel: Exploring the PossibilitiesApr 20, 2025 am 12:19 AM

Laravel can be used for front-end development. 1) Use the Blade template engine to generate HTML. 2) Integrate Vite to manage front-end resources. 3) Build SPA, PWA or static website. 4) Combine routing, middleware and EloquentORM to create a complete web application.

PHP and Laravel: Building Server-Side ApplicationsPHP and Laravel: Building Server-Side ApplicationsApr 20, 2025 am 12:17 AM

PHP and Laravel can be used to build efficient server-side applications. 1.PHP is an open source scripting language suitable for web development. 2.Laravel provides routing, controller, EloquentORM, Blade template engine and other functions to simplify development. 3. Improve application performance and security through caching, code optimization and security measures. 4. Test and deployment strategies to ensure stable operation of applications.

Laravel vs. Python: The Learning Curves and Ease of UseLaravel vs. Python: The Learning Curves and Ease of UseApr 20, 2025 am 12:17 AM

Laravel and Python have their own advantages and disadvantages in terms of learning curve and ease of use. Laravel is suitable for rapid development of web applications. The learning curve is relatively flat, but it takes time to master advanced functions. Python's grammar is concise and the learning curve is flat, but dynamic type systems need to be cautious.

Laravel's Strengths: Backend DevelopmentLaravel's Strengths: Backend DevelopmentApr 20, 2025 am 12:16 AM

Laravel's advantages in back-end development include: 1) elegant syntax and EloquentORM simplify the development process; 2) rich ecosystem and active community support; 3) improved development efficiency and code quality. Laravel's design allows developers to develop more efficiently and improve code quality through its powerful features and tools.

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

MantisBT

MantisBT

Mantis is an easy-to-deploy web-based defect tracking tool designed to aid in product defect tracking. It requires PHP, MySQL and a web server. Check out our demo and hosting services.

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Integrate Eclipse with SAP NetWeaver application server.

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

VSCode Windows 64-bit Download

VSCode Windows 64-bit Download

A free and powerful IDE editor launched by Microsoft

SublimeText3 Linux new version

SublimeText3 Linux new version

SublimeText3 Linux latest version