ResponseCache 政策

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

缓存来自后端资源的数据，从而减少对资源的请求数量。当应用向同一 URI 发出请求时，可以使用此政策返回缓存的响应，而不是将这些请求转发到后端服务器。ResponseCache 政策可通过降低延迟和减少网络流量来提高 API 的性能。

如果您的 API 使用的后端数据仅会定期更新时，您就很可能会发现 ResponseCache 最为有用。例如，假设您用于公布天气报告数据的 API 仅会每 10 分钟刷新一次时。通过使用 ResponseCache 在刷新之间返回缓存的响应，您可以减少到达后端的请求数量。这也减少了网络跃点的数量。

对于通用短期缓存，请考虑使用填充缓存政策。该政策与查找缓存政策（用于读取条目）和让缓存失效政策（用于使条目失效）结合使用。

示例

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

'http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778' -H "bypass-cache:true"

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <!-- Explicitly refresh the cached response -->
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

元素参考

元素参考介绍了政策的元素和属性。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" />
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSeconds ref="flow.variable.here">300</TimeoutInSeconds>
    </ExpirySettings>
    <CacheResource>cache_to_use</CacheResource>
    <CacheLookupTimeoutInSeconds/>
    <ExcludeErrorResponse/>
    <SkipCacheLookup/>
    <SkipCachePopulation/>
    <UseAcceptHeader/>
    <UseResponseCacheHeaders/>
</ResponseCache>

<ResponseCache> 属性

<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">

下表介绍了所有政策父元素通用的特性：

<DisplayName> 元素

除了用于 name 属性之外，还可以用于在管理界面代理编辑器中给政策添加不同的自然语言名称标签。

<DisplayName>Policy Display Name</DisplayName>

<CacheKey> 元素

配置存储在缓存中的数据块的唯一指针。

缓存键的大小限制为 2 KB。

<CacheKey>
    <Prefix>string</Prefix>
    <KeyFragment ref="variable_name" />
    <KeyFragment>literal_string</KeyFragment>
</CacheKey>

<CacheKey> 构造缓存中存储的每个数据块的名称。键通常使用实体标头或查询参数中的值进行设置。在这些情况下，您可以让元素的 ref 属性指定一个包含键值的变量。

在运行时，<KeyFragment> 值前面会附加 <Scope> 元素值或 <Prefix> 值。例如，以下命令会产生 UserToken__apiAccessToken__<value_of_client_id> 的缓存键：

<CacheKey>
    <Prefix>UserToken</Prefix>
    <KeyFragment>apiAccessToken</KeyFragment>
    <KeyFragment ref="request.queryparam.client_id" />
</CacheKey>

您可将 <CacheKey> 元素与 <Prefix> 和 <Scope> 搭配使用。如需了解详情，请参阅使用缓存键。

<CacheLookupTimeoutInSeconds> 元素

指定缓存查找失败后的秒数，经过此时间之后将视为缓存未命中。如果发生这种情况，流会沿着缓存未命中的路径继续执行。

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

<CacheResource> 元素

指定存储消息的缓存。 省略此元素可使用所包括的共享缓存。如果您希望能够管理性清理缓存中包含的条目，则应该按名称指定 CacheResource。如需了解详情，请参阅缓存。

<CacheResource>cache_to_use</CacheResource>

如需详细了解如何配置缓存，请参阅创建和修改环境缓存。

<CacheKey>/<KeyFragment> 元素

指定应在缓存键中包含的值，从而创建用于将请求与缓存响应匹配的命名空间。

<KeyFragment ref="variable_name"/>
<KeyFragment>literal_string</KeyFragment>

这可以是键（您提供的静态名称）或值（通过引用变量设置的动态条目）。组合的所有指定片段（加上前缀）都串联在一起以创建缓存键。

<KeyFragment>apiAccessToken</KeyFragment>
<KeyFragment ref="request.queryparam.client_id" />

您可将 <KeyFragment> 元素与 <Prefix> 和 <Scope> 搭配使用。如需了解详情，请参阅使用缓存键。

属性

<CacheKey>/<Prefix> 元素

指定要用作缓存键前缀的值。

<Prefix>prefix_string</Prefix>

如果您想指定自己的值，而不是 <Scope> 枚举值，请使用此值，而不是 <Scope>。如果已定义，<Prefix> 将在写入缓存的条目的缓存键值前面。<Prefix> 元素值会替换 <Scope> 元素值。

您可将 <Prefix> 元素与 <CacheKey> 和 <Scope> 搭配使用。如需了解详情，请参阅使用缓存键。

<ExcludeErrorResponse> 元素

目前，默认情况下，此政策会缓存 HTTP 响应以及任何可能状态代码。这意味着成功响应和错误响应都会缓存。例如，默认情况下，会缓存具有 2xx 和 3xx 状态码的响应。

如果您不想缓存具有 HTTP 错误状态代码的目标响应，请将此元素设为 true；如果此元素为 true，则只缓存具有从 200 到 205 的状态代码的响应。只有这些 HTTP 状态代码会被 Edge 统计 “成功”代码，且无法更改此关联。

如需查看关于此元素发挥作用的响应缓存模式的讨论，请参阅此社区帖子。

注意：在将来的版本中（待定），此元素的默认设置将更改为 true。如需了解详情，请参阅 Apigee 版本说明。

<ExcludeErrorResponse>true</ExcludeErrorResponse>

<ExpirySettings> 元素

指定缓存条目何时失效。如果存在，<TimeoutInSeconds> 将同时替换 <TimeOfDay> 和 <ExpiryDate>。

<ExpirySettings>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
</ExpirySettings>

<ExpirySettings>/<ExpiryDate> 元素

指定缓存条目应失效的日期。使用格式 mm-dd-yyyy。 如果存在，该元素的同级 <TimeoutInSeconds> 将替换 <ExpiryDate>。

<ExpirySettings>
    <ExpiryDate ref="{date_variable}">expiration_date</ExpiryDate>
</ExpirySettings>

特性

<ExpiryDate ref="" />

<ExpirySettings>/<TimeOfDay> 元素

缓存条目应失效的时间。使用格式 hh:mm:ss。如果存在，该元素的同级 <TimeoutInSeconds> 将替换 <TimeOfDay>。

以 HH:mm:ss 格式输入时间，其中 HH 表示 24 小时制的小时。例如，14:30:00 表示下午 2:30。

对于时间，默认语言区域和时区将因代码运行位置而异（在配置政策时尚不知）。 如需了解如何配置语言区域，请参阅创建和修改环境缓存。

<ExpirySettings>
    <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

特性

<ExpirySettings>/<TimeoutInSec> 元素

之后缓存条目应失效的秒数。