README

webclient/ext-cache

PSR-18 HTTP 客户端缓存扩展。

安装

安装此包以及您喜欢的 psr-18 实现，psr-17 实现 和 缓存实现。

composer require webclient/ext-cache:^2.0

使用方法

<?php

use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Webclient\Cache\Contract\CacheInterface;
use Webclient\Extension\Cache\Client;
use Webclient\Extension\Cache\CacheKeyFactory\CacheKeyFactoryInterface;

/** 
 * @var ClientInterface $client Your PSR-18 HTTP Client
 * @var ResponseFactoryInterface $responseFactory Your PSR-17 response factory
 * @var StreamFactoryInterface $streamFactory Your PSR-17 stream factory
 * @var CacheInterface $cache Your cache adapter
 * @var CacheKeyFactoryInterface|null $cacheKeyFactory key factory for your cache
 */
$http = new CacheClientDecorator(
    $client, 
    $responseFactory, 
    $streamFactory, 
    $cache,
    $cacheKeyFactory,
    'X-Private-Cache-Key-Header', // name of the header in which the private cache key is contained
    4096, // Maximal response size (with header). null for unlimited.
    2147483648 // maximal TTL of cache items
);

/** @var RequestInterface $request */
$response = $http->sendRequest($request);

/** @var RequestInterface $request */
$response = $http->sendRequest($request);

/** 
 * For using private cache add header `X-Private-Cache-Key-Header` (or your configured) to request.
 * header `X-Private-Cache-Key-Header` (or your configured) do not be sent to original http-client.
 */
$response = $http->sendRequest($request->withHeader('X-Private-Cache-Key-Header', ['private-key-for-current-user']));
 

未处理的请求

如果请求包含 If-None-Match、If-Match、If-Modified-Since、If-Unmodified-Since 或 If-Range 标头，则将返回原始响应。

部分请求

不支持部分请求。