LookupCache 政策

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

設定在執行階段擷取快取值的方式。

這項政策適用於一般用途的短期快取。這會與填入快取政策 (用於寫入項目) 和撤銷快取政策 (用於撤銷項目) 搭配使用。

如需快取後端資源的回應,請參閱回應快取政策

元素參照

以下列出可以在這項政策中設定的元素。

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

系統預設會納入共用快取。如要使用共用快取,請省略這項政策設定中的 <CacheResource> 元素。

如要進一步瞭解基礎資料儲存庫,請參閱「快取內部快取」。如要進一步瞭解如何設定快取,請參閱「建立及編輯環境快取」一文。

<LookupCache> 屬性

下表說明所有政策父項元素的通用屬性:

屬性 說明 預設 存在必要性
name

政策的內部名稱。name 屬性的值可以包含英文字母、數字、空格、連字號、底線和半形句號。這個值不得超過 255 個半形字元。

您也可以選擇使用 <DisplayName> 元素,在管理 UI Proxy 編輯器中使用不同的自然語言名稱為政策加上標籤。

不適用 需要
continueOnError

如果設為 false,即可在政策失敗時傳回錯誤。大部分政策都是預期中的行為。

設為 true,即可在政策失敗後繼續執行資料流。

false 選用
enabled

如要強制執行政策,請設為 true

設為 false 即可停用這項政策。即使政策仍附加在流程中,系統也不會強制執行政策。

true 選用
async

此屬性已淘汰。

false 已淘汰

<DisplayName> 元素

除了 name 屬性外,您還可以使用不同的自然語言名稱,在管理 UI Proxy 編輯器中為政策加上標籤。

<DisplayName>Policy Display Name</DisplayName>
預設

不適用

如果省略這個元素,系統會使用政策的 name 屬性值。

存在必要性 選用
類型 字串

<AssignTo> 元素

指定系統從快取中擷取快取項目之後,會為其指派快取項目的變數。變數必須可寫入。如果快取查詢未擷取值,系統就不會設定變數。

<AssignTo>variable_to_receive_cached_value</AssignTo>

預設:

不適用

所在地:

需要

類型:

字串

<CacheKey> 元素

針對儲存在快取中的資料設定專屬指標。

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

預設:

不適用

所在地:

需要

類型:

不適用

<CacheKey> 會為儲存在快取中的每張資料建構名稱。

在執行階段,<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>

預設:

30

所在地:

選用

類型:

整數

<CacheResource> 元素

指定訊息應儲存的快取。

如果這項政策 (以及相應的 PopulateCache 和 InvalidateCache 政策) 使用了隨附的共用快取,則完全省略此元素。

<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> 搭配使用。詳情請參閱「使用快取金鑰」。

<Scope> 元素

未在 <CacheKey> 元素中提供 <Prefix> 元素時,用來建構快取金鑰前置字串的列舉。

<Scope>scope_enumeration</Scope>

預設:

「獨家」

所在地:

選用

類型:

字串

<Scope> 設定會決定根據 <Scope> 值前面加上的快取金鑰。舉例來說,當範圍設為 Exclusive 時,快取金鑰會呈現以下形式:orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [serializedCacheKey]。

如果 <CacheKey> 中有 <Prefix> 元素,該元素會取代 <Scope> 元素值。有效值包含下列列舉。

請將 <Scope> 元素與 <CacheKey><Prefix> 搭配使用。詳情請參閱「使用快取金鑰」。

可接受的值

Global

快取金鑰會由環境部署的所有 API Proxy 共用。快取金鑰的前面會加上 orgName __ envName __ 的格式。

如果您使用 <KeyFragment> apiAccessToken 和 <Global> 範圍定義 <CacheKey> 項目,每個項目都會儲存為 orgName__envName__apiAccessToken,後面接著存取權杖的序列化值。如果 API Proxy 部署在名為「apifactory」的機構中,即部署在「test」的環境中,存取權杖會儲存在下列快取金鑰底下:apifactory__test__apiAccessToken

Application

系統會使用 API Proxy 名稱做為前置字串。

快取金鑰的前面會加上 orgName__envName__applicationName 格式。

Proxy

系統會使用 ProxyEndpoint 設定做為前置字串。

快取金鑰的前面會加上 orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName 格式。

Target

TargetEndpoint 設定會做為前置字串使用。

前置快取金鑰,格式為 orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName

Exclusive

預設。這是最具體的做法,因此在指定快取中會造成命名空間衝突的風險降到最低。

前置字串為下列其中一種格式:

  • 如果政策已附加至 ProxyEndpoint 資料流,前置字串的格式為 ApiProxyName_ProxyEndpointName
  • 如果附加在 TargetEndpoint 的政策,前置字串的格式為 ApiProxyName_TargetName

前方的快取金鑰,格式為 orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

例如,整個字串可能如下所示:

apifactory__test__weatherapi__16__default__apiAccessToken

使用須知

這項政策適用於一般用途快取。LookupCache 政策會在執行階段從快取中擷取值,並將值指派給您使用 AssignTo 元素指定的變數 (如未擷取任何值,系統就不會設定變數)。它會根據結合 CacheKey 和 Scope 元素的設定快取金鑰,尋找值。換句話說,如要擷取 PopulateCache 政策加入快取的特定值,您的 LookupCache 政策必須採用與 PopulateCache 政策相同的方式設定快取鍵相關元素。

依據填入快取政策、LookupCache 政策和 InvalidateCache 政策的一般用途快取,系統會使用您設定的快取,或是預設包含的共用快取。在大多數情況下,基本的共用快取應可滿足您的需求。如要使用預設快取,只要省略 <CacheResource> 元素即可。

如要進一步瞭解如何設定快取,請參閱「建立及編輯環境快取」一文。如要進一步瞭解基礎資料儲存庫,請參閱「快取內部快取」。

流程變數

您可以使用流程變數,根據 HTTP 標頭、訊息內容或流程中的可用結構定義,針對政策和流程設定動態執行階段行為。如要進一步瞭解流程變數,請參閱變數參考資料

自訂您在 LookupCache 政策中定義的快取行為後,即可使用下列預先定義的流程變數。

Variables 類型 權限 說明
lookupcache.{policy-name}.cachename 字串 唯讀 傳回政策中使用的快取名稱。
lookupcache.{policy-name}.cachekey 字串 唯讀 傳回使用的鍵。
lookupcache.{policy-name}.cachehit 布林值 唯讀 如果政策找到指定快取金鑰的值,則為「是」。
lookupcache.{policy-name}.assignto 字串 唯讀 傳回指派給快取的變數。

錯誤代碼

本節說明這項政策觸發錯誤時設定的錯誤訊息和流程變數。如果您正在開發 Proxy 的錯誤規則,請務必瞭解這項資訊。詳情請參閱「政策錯誤須知」和「處理錯誤」。

錯誤代碼前置字串

不適用

執行階段錯誤

這項政策不會擲回任何執行階段錯誤。

部署錯誤

若您部署包含這項政策的 Proxy,就可能會發生這些錯誤。

錯誤名稱 原因 修正
InvalidCacheResourceReference 如果 <CacheResource> 元素設定的名稱不在部署 API Proxy 的環境中,就會發生這個錯誤。
InvalidTimeout 如果 <CacheLookupTimeoutInSeconds> 元素設為負數,API Proxy 部署就會失敗。
CacheNotFound 如果尚未在特定的訊息處理器元件上建立錯誤訊息中提及的特定快取,就會發生這個錯誤。

錯誤變數

不適用

錯誤回應範例

不適用