如何编写适用于GuzzleHttp\Command\Guzzle\GuzzleClient的查询参数中间件

I’ve run into this exact issue before—when using the GuzzleHttp\Command\Guzzle\GuzzleClient, you’re restricted to only the query parameters defined in your API spec, so adding arbitrary params directly in the client call won’t work. The right approach is to hook into the request pipeline with a middleware that modifies the request right before it’s sent.

Here’s the complete, working middleware implementation, along with breakdowns of each part to help you understand why it works:

// Define your custom middleware
$myMiddleware = function (callable $handler) {
    // This inner function handles the actual request modification
    return function (\Psr\Http\Message\RequestInterface $request, array $options) use ($handler) {
        // Step 1: Parse the existing query parameters from the request URI
        $existingQuery = \GuzzleHttp\Psr7\Query::parse($request->getUri()->getQuery());
        
        // Step 2: Add your extra query parameter(s) here
        $existingQuery['your_extra_param'] = 'your_value';
        // If you need multiple params, just add more entries:
        // $existingQuery['another_param'] = 'another_value';
        
        // Step 3: Build the new query string and update the URI
        $newUri = $request->getUri()->withQuery(\GuzzleHttp\Psr7\Query::build($existingQuery));
        
        // Step 4: Update the request (PSR-7 objects are immutable, so we reassign)
        $request = $request->withUri($newUri);
        
        // Step 5: Pass the modified request to the next handler in the stack
        return $handler($request, $options);
    };
};

// Attach the middleware to your API client's handler stack
$apiClient->getHandlerStack()->push($myMiddleware);

Key Notes to Avoid Common Pitfalls: #

• Middleware Structure: Guzzle middleware uses a nested callable pattern—the outer function accepts the next handler in the stack, and the inner function processes the request/options before passing them along. This is probably where you ran into type errors earlier, so make sure you don’t mix up the function signatures.
• Immutable PSR-7 Objects: Remember that PSR-7 requests and URIs can’t be modified directly. You have to call methods like withUri() and reassign the result to the $request variable.
• Query Parsing/Building: Using GuzzleHttp\Psr7\Query ensures proper handling of URL-encoded parameters, so you don’t have to worry about manually encoding values or dealing with edge cases like empty params.
• Middleware Order: If you need this middleware to run before other existing middleware (like auth handlers), use unshift() instead of push(). For most cases where you’re adding query params, push() works fine since it runs right before the request is sent.

内容的提问来源于stack exchange，提问作者Szczepan Hołyszewski