Chính sách LookupCache

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X.
thông tin

Định cấu hình cách truy xuất các giá trị đã lưu vào bộ nhớ đệm trong thời gian chạy.

Chính sách này dùng cho mục đích lưu vào bộ nhớ đệm trong thời gian ngắn nói chung. Ngôn ngữ này được dùng trong kết hợp với tham số Điền Chính sách bộ nhớ đệm (để viết mục nhập) và Chính sách vô hiệu hoá bộ nhớ đệm (đối với các mục nhập không hợp lệ).

Để lưu phản hồi của các tài nguyên phụ trợ vào bộ nhớ đệm, hãy xem Chính sách về bộ nhớ đệm của phản hồi.

Tham chiếu phần tử

Dưới đây là danh sách các thành phần mà bạn có thể thiết lập theo chính sách này.

<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>

Bộ nhớ đệm dùng chung được bao gồm theo mặc định. Để sử dụng bộ nhớ đệm dùng chung, hãy bỏ qua Phần tử <CacheResource> trong cấu hình chính sách này.

Để biết thêm thông tin về kho dữ liệu cơ bản, hãy xem phần Bộ nhớ đệm nội bộ. Để biết thêm thông tin về cách định cấu hình bộ nhớ đệm, hãy xem Tạo và chỉnh sửa bộ nhớ đệm của môi trường.

&lt;LookupCache&gt; thuộc tính

Bảng sau đây mô tả những thuộc tính chung cho tất cả phần tử mẹ của chính sách:

Thuộc tính Mô tả Mặc định Sự hiện diện
name

Tên nội bộ của chính sách. Giá trị của thuộc tính name có thể chứa chữ cái, số, dấu cách, dấu gạch nối, dấu gạch dưới và dấu chấm. Giá trị này không được vượt quá 255 ký tự.

(Không bắt buộc) Bạn có thể dùng phần tử <DisplayName> để gắn nhãn chính sách trong trình chỉnh sửa proxy giao diện người dùng quản lý bằng tên ngôn ngữ tự nhiên khác.

Không áp dụng Bắt buộc
continueOnError

Đặt thành false để trả về lỗi khi chính sách không thành công. Điều này là dự kiến đối với hầu hết các chính sách.

Đặt thành true để tiếp tục thực thi luồng ngay cả sau khi có chính sách không thành công.

false Không bắt buộc
enabled

Hãy đặt thành true để thực thi chính sách này.

Đặt thành false để tắt chính sách này. Chính sách này sẽ không được thực thi ngay cả khi luồng đó vẫn được liên kết với một luồng.

đúng Không bắt buộc
async

Thuộc tính này không được dùng nữa.

false Không được dùng nữa

&lt;DisplayName&gt; phần tử

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý có tên ngôn ngữ tự nhiên khác.

<DisplayName>Policy Display Name</DisplayName>
Mặc định

Không áp dụng

Nếu bạn bỏ qua phần tử này, giá trị của thuộc tính name của chính sách sẽ là đã sử dụng.

Sự hiện diện Không bắt buộc
Loại Chuỗi

&lt;AssignTo&gt; phần tử

Chỉ định biến mà mục nhập bộ nhớ đệm được chỉ định sau khi mục này được truy xuất từ bộ nhớ đệm. Biến phải có thể ghi. Nếu quá trình tra cứu bộ nhớ đệm không truy xuất một giá trị, biến sẽ không được thiết lập.

<AssignTo>variable_to_receive_cached_value</AssignTo>

Mặc định:

Không áp dụng

Sự hiện diện:

Bắt buộc

Loại:

Chuỗi

&lt;CacheKey&gt; phần tử

Định cấu hình một con trỏ duy nhất đến một phần dữ liệu được lưu trữ trong bộ nhớ đệm.

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

Mặc định:

Không áp dụng

Sự hiện diện:

Bắt buộc

Loại:

Không áp dụng

<CacheKey> tạo tên của từng phần dữ liệu được lưu trữ trong bộ nhớ đệm.

Trong thời gian chạy, các giá trị <KeyFragment> được thêm vào trước Giá trị phần tử <Scope> hoặc giá trị <Prefix>. Ví dụ: các kết quả sau trong khoá bộ nhớ đệm của UserToken__apiAccessToken__&lt;value_of_client_id&gt;:

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

Bạn sử dụng phần tử <CacheKey> cùng với <Prefix><Scope>. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.

&lt;CacheLookupTimeoutInSeconds&gt; phần tử

Chỉ định số giây mà sau đó một lần tra cứu bộ nhớ đệm không thành công sẽ được coi là một thiếu bộ nhớ đệm. Nếu điều này xảy ra, luồng sẽ tiếp tục dọc theo đường dẫn bỏ lỡ bộ nhớ đệm.

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

Mặc định:

30

Sự hiện diện:

Không bắt buộc

Loại:

Số nguyên

&lt;CacheResource&gt; phần tử

Chỉ định bộ nhớ đệm nơi lưu trữ thông báo.

Hãy bỏ qua hoàn toàn phần tử này nếu chính sách này (và ĐiềnCache và Chính sách InvalidateCache) đang dùng bộ nhớ đệm dùng chung đi kèm.

<CacheResource>cache_to_use</CacheResource>

Mặc định:

Không áp dụng

Sự hiện diện:

Không bắt buộc

Loại:

Chuỗi

Để biết thêm thông tin về cách định cấu hình bộ nhớ đệm, hãy xem Tạo và chỉnh sửa môi trường lưu vào bộ nhớ đệm.

&lt;CacheKey&gt;/&lt;KeyFragment&gt; phần tử

Chỉ định một giá trị sẽ được đưa vào khoá bộ nhớ đệm, tạo không gian tên để so khớp đối với các phản hồi được lưu vào bộ nhớ đệm.

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

Mặc định:

Không áp dụng

Sự hiện diện:

Không bắt buộc

Loại:

Không áp dụng

Đây có thể là một khoá (tên tĩnh mà bạn cung cấp) hoặc một giá trị (một mục nhập động được đặt bởi tham chiếu đến một biến). Tất cả các mảnh được chỉ định kết hợp (cùng với tiền tố) đều được nối với tạo khoá bộ nhớ đệm.

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

Bạn sử dụng phần tử <KeyFragment> cùng với <Prefix><Scope>. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.

Thuộc tính

Thuộc tính Loại Mặc định Bắt buộc Mô tả
tham chiếu string Không

Biến để nhận giá trị. Không nên sử dụng nếu phần tử này chứa một giá trị cố định.

&lt;CacheKey&gt;/&lt;Prefix&gt; phần tử

Chỉ định một giá trị dùng làm tiền tố khoá bộ nhớ đệm.

<Prefix>prefix_string</Prefix>

Mặc định:

Không áp dụng

Sự hiện diện:

Không bắt buộc

Loại:

Chuỗi

Sử dụng giá trị này thay vì <Scope> khi bạn muốn chỉ định giá trị của riêng mình thay vì giá trị được liệt kê là <Scope>. Nếu được xác định, <Prefix> thêm giá trị khoá bộ nhớ đệm cho các mục nhập được ghi vào bộ nhớ đệm. Đáp Giá trị phần tử <Prefix> ghi đè phần tử <Scope> giá trị.

Bạn sử dụng phần tử <Prefix> cùng với <CacheKey><Scope>. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.

&lt;Scope&gt; phần tử

Phương thức liệt kê dùng để tạo tiền tố cho khoá bộ nhớ đệm khi <Prefix> không được cung cấp trong phần tử <CacheKey>.

<Scope>scope_enumeration</Scope>

Mặc định:

"Độc quyền"

Sự hiện diện:

Không bắt buộc

Loại:

Chuỗi

Chế độ cài đặt <Scope> xác định khoá bộ nhớ đệm được thêm vào trước theo giá trị <Scope>. Ví dụ: khoá bộ nhớ đệm sẽ có dạng như sau khi phạm vi được đặt thành Exclusive : orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Nếu có một phần tử <Prefix> trong <CacheKey>, thì phần tử này thay thế giá trị phần tử <Scope>. Các giá trị hợp lệ bao gồm giá trị enum bên dưới.

Bạn sử dụng phần tử <Scope> cùng với <CacheKey><Prefix>. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.

Giá trị được chấp nhận

Global

Khoá bộ nhớ đệm được dùng chung trên tất cả proxy API được triển khai trong môi trường. Khoá bộ nhớ đệm là thêm vào trước ở dạng orgName __ envName __.

Nếu bạn xác định một mục nhập <CacheKey> bằng phương thức <KeyFragment> apiAccessToken và một phạm vi <Global>, mỗi mục nhập được lưu trữ dưới dạng orgName__envName__apiAccessToken, theo sau là giá trị tuần tự của mã truy cập. Đối với proxy API được triển khai trong môi trường được gọi là "test" [kiểm thử] trong tổ chức có tên là 'apifactory', mã thông báo truy cập sẽ được lưu trữ trong khoá bộ nhớ đệm sau: apifactory__test__apiAccessToken.

Application

Tên proxy API được dùng làm tiền tố.

Khoá bộ nhớ đệm được thêm vào đầu biểu mẫu orgName__envName__applicationName.

Proxy

Cấu hình ProxyEndpoint được dùng làm tiền tố.

Khoá bộ nhớ đệm được thêm vào đầu biểu mẫu orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName của Google.

Target

Cấu hình TargetEndpoint được dùng làm tiền tố.

Khoá bộ nhớ đệm đã được thêm vào đầu biểu mẫu orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName của Google.

Exclusive

Mặc định. Đây là yếu tố cụ thể nhất và do đó thể hiện rủi ro tối thiểu về không gian tên các xung đột trong một bộ nhớ đệm nhất định.

Tiền tố là một trong hai dạng:

  • Nếu chính sách này được đính kèm vào quy trình ProxyEndpoint, thì tiền tố sẽ là biểu mẫu ApiProxyName_ProxyEndpointName.
  • Nếu bạn đính kèm chính sách này tại TargetEndpoint thì tiền tố sẽ nằm trong biểu mẫu ApiProxyName_TargetName.

Khoá bộ nhớ đệm đã được thêm vào đầu biểu mẫu orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

Ví dụ: toàn bộ chuỗi có thể có dạng như sau:

apifactory__test__weatherapi__16__default__apiAccessToken
.

Lưu ý về cách sử dụng

Sử dụng chính sách này cho việc lưu vào bộ nhớ đệm cho mục đích chung. Trong thời gian chạy, chính sách LookupCache sẽ truy xuất một từ bộ nhớ đệm, gán giá trị cho biến mà bạn chỉ định bằng phần tử AttributionTo (nếu không có giá trị nào được truy xuất, biến sẽ không được đặt). Phương thức này tìm giá trị dựa trên bộ nhớ đệm khoá được tạo thông qua cấu hình kết hợp phần tử CacheKey và Scope. Nói cách khác, để truy xuất một giá trị cụ thể được thêm vào bộ nhớ đệm theo chính sách SpecifyCache, trong đó là LookupCache phải có các phần tử liên quan đến khoá bộ nhớ đệm được định cấu hình theo cách giống với FillCache .

Lưu vào bộ nhớ đệm cho mục đích chung theo chính sách Điền bộ nhớ đệm, Chính sách LookupCache và InvalidateCache sử dụng có thể là bộ nhớ đệm bạn định cấu hình hoặc bộ nhớ đệm dùng chung có sẵn theo mặc định. Trong hầu hết các trường hợp, bộ nhớ đệm dùng chung cơ bản có thể đáp ứng nhu cầu của bạn. Để sử dụng bộ nhớ đệm mặc định, chỉ cần bỏ phần tử <CacheResource>.

Để biết thêm thông tin về cách định cấu hình bộ nhớ đệm, hãy xem Tạo và chỉnh sửa môi trường lưu vào bộ nhớ đệm. Để biết thêm thông tin về kho dữ liệu cơ bản, hãy xem phần Bộ nhớ đệm nội bộ.

Biến luồng

Biến luồng có thể được dùng để định cấu hình hành vi động cho các chính sách và luồng, dựa trên trên tiêu đề HTTP hoặc nội dung thông báo hoặc ngữ cảnh có sẵn trong Luồng. Thông tin khác về biến luồng, hãy xem Biến tham khảo.

Các biến Flow được xác định trước sau đây sẽ có sẵn sau khi bạn tuỳ chỉnh hành vi của mà bạn xác định trong chính sách LookupCache.

Biến Loại Quyền Mô tả
Tra cứu bộ nhớ đệm.{policy-name}.tên bộ nhớ đệm Chuỗi Chỉ có thể đọc Trả về tên bộ nhớ đệm dùng trong chính sách.
tra cứucache.{policy-name}.cachekey Chuỗi Chỉ có thể đọc Trả về khoá đã sử dụng.
tra cứucache.{policy-name}.cachehit Boolean Chỉ có thể đọc Đúng nếu chính sách tìm thấy giá trị cho khoá bộ nhớ đệm đã chỉ định.
lookupcache.{policy-name}.assignto Chuỗi Chỉ có thể đọc Trả về biến được gán bộ nhớ đệm.

Mã lỗi

Phần này mô tả các thông báo lỗi và biến luồng được thiết lập khi chính sách này kích hoạt lỗi. Thông tin này rất quan trọng mà bạn cần biết nếu đang phát triển các quy tắc lỗi cho một proxy. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sáchXử lý lỗi.

Tiền tố mã lỗi

Không áp dụng

Lỗi thời gian chạy

Chính sách này không gửi bất kỳ lỗi thời gian chạy nào.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.

Tên lỗi Nguyên nhân Khắc phục
InvalidCacheResourceReference Lỗi này xảy ra nếu phần tử <CacheResource> được đặt thành một tên không tồn tại trong môi trường nơi proxy API đang được triển khai.
InvalidTimeout Nếu bạn đặt phần tử <CacheLookupTimeoutInSeconds> thành số âm, thì proxy API sẽ không triển khai được.
CacheNotFound Lỗi này xảy ra nếu bộ nhớ đệm cụ thể được đề cập trong thông báo lỗi chưa được tạo trên một thành phần cụ thể của Trình xử lý thông báo.

Biến lỗi

Không áp dụng

Ví dụ về phản hồi lỗi

Không áp dụng