Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
Aby uzyskać dostęp do rozproszonej pamięci podręcznej Edge z aplikacji Node.js, możesz użyć modułu apigee-access
. Moduł ten obejmuje metody uzyskiwania pamięci podręcznej oraz umieszczania, pobierania i usuwania danych.
Dystrybuowana pamięć podręczna Apigee Edge umożliwia przechowywanie ciągów znaków i innych danych. Podobnie jak większość pamięci podręcznej, jest to pamięć podręczna o najmniejszym rozmiarze, która była używana najrzadziej. W ramach Apigee Edge pamięć podręczna jest rozprowadzana do wszystkich węzłów, na których działa aplikacja Node.js. Pamięcią podręczną możesz zarządzać za pomocą interfejsu API Apigee Edge. Za pomocą interfejsu API możesz ręcznie tworzyć zasoby pamięci podręcznej lub użyć zasobu domyślnego. Więcej informacji o używaniu pamięci podręcznej w usłudze Apigee Edge znajdziesz w artykule Narzędzia trwałości w usłudze Edge. Więcej informacji o rozproszonej pamięci podręcznej znajdziesz w artykule Przykład: pamięć podręczna ogólnego przeznaczenia.
Więcej informacji o module apigee-access
i jego innych funkcjach znajdziesz w artykule Korzystanie z modułu apigee-access (w języku angielskim).
Metody
(1) getCache
var
cache = apigee.getCache(cacheName);
Sprawdź nazwany bufor i w razie potrzeby utwórz go. Powstały bufor używa wstępnie zdefiniowanego zestawu parametrów konfiguracji, który jest odpowiedni w większości sytuacji.
Parametry:
cacheName – ciąg znaków zawierający nazwę pamięci podręcznej. (nie jest to nazwa zasobu pamięci podręcznej).
Zwroty:
Obiekt pamięci podręcznej.
Przykład:
var apigee = require('apigee-access'); var cache = apigee.getCache('cache');
(2) getCache
var
customCache = apigee.getCache(cacheName, options );
Dostęp do zasobu niestandardowej pamięci podręcznej określonego w obiekcie konfiguracji. Informacje o tworzeniu zasobu pamięci podręcznej znajdziesz w artykule Tworzenie i edytowanie zasobów pamięci podręcznej środowiska.
Parametry:
cacheName – ciąg znaków zawierający nazwę niestandardowej pamięci podręcznej. (nie jest to nazwa zasobu pamięci podręcznej)
options – obiekt konfiguracji. Obiekt może być pusty lub może zawierać te opcjonalne parametry:
-
resource
: nazwa „zasobu pamięci podręcznej” Apigee, w którym są przechowywane dane pamięci podręcznej. Zasoby pamięci podręcznej służą do dokładnego dostosowania alokacji pamięci i innych parametrów pamięci podręcznej. Jeśli go nie podasz, używany będzie zasób domyślny. Jeśli zasób pamięci podręcznej nie istnieje, metoda zwraca błąd. -
scope
: określa, czy wpisy w pamięci podręcznej mają mieć prefiks, aby zapobiec kolizjom. Prawidłowe wartości toglobal
,application
iexclusive
.-
global
: wszystkie wpisy w pamięci podręcznej są widoczne dla wszystkich aplikacji Node.js w tym samym „środowisku” Apigee. -
application
: wszystkie wpisy w pamięci podręcznej mogą być widoczne dla wszystkich pamięci podręcznych Node.js, które są częścią tej samej aplikacji Apigee Edge. -
exclusive
: (domyślnie) Wpisy w pamięci podręcznej są widoczne tylko dla pamięci podręcznej Node.js w tej samej aplikacji, która ma tę samą nazwę. Jest to ustawienie domyślne.
-
-
prefix
: jeśli nazwa klucza pamięci podręcznej zawiera prefiks, jak to opisano w artykułach Wypełnianie zasad dotyczących pamięci podręcznej i Praca z kluczami pamięci podręcznej, użyj tego parametru, aby go określić. Edge automatycznie dodaje przyrostek z podwójnym podkreślnikiem do nazwy prefiksu. Jeśli klucz pamięci podręcznej został utworzony z preiksem „UserToken”, prefiks, który należy podać, to „UserToken__”. -
defaultTtl
: określa domyślny czas życia wpisu w pamięci podręcznej (w sekundach). Jeśli nie zostanie określony, użyty zostanie domyślny czas życia w zasobie pamięci podręcznej. -
timeout
: czas oczekiwania na pobranie wyniku z rozproszonej pamięci podręcznej (w sekundach). Domyślnie 30 sekund. Aplikacje wrażliwe na opóźnienia mogą chcieć zmniejszyć ten czas, aby zapobiec długiemu czasowi odpowiedzi w przypadku przeciążenia infrastruktury pamięci podręcznej.
Zwroty:
Obiekt pamięci podręcznej niestandardowej.
Przykład:
var apigee = require('apigee-access'); var customCache = apigee.getCache('doesNotMatter', { resource: 'MyCustomResource', scope: 'global', prefix: 'UserToken'} ); customCache.put("myCacheKey", "xyz");
Ta metoda działa z zasadami LookupCache skonfigurowanymi w ten sposób:
<LookupCache name="Lookup-Cache-1"> <CacheKey> <Prefix>UserToken</prefix> <KeyFragment>myCacheKey</KeyFragment> </CacheKey> <CacheResource>MyCustomResource</CacheResource> <Scope>Global</Scope> <AssignTo>contextVariable</AssignTo> </LookupCache>
put
cache.put('key',
data, ttl, function(error));
umieszczać dane w pamięci podręcznej.
Parametry:
-
key
: (wymagany) ciąg znaków jednoznacznie identyfikujący element w pamięci podręcznej. Klucze pamięci podręcznej mają ograniczony rozmiar do 2 KB. -
data
: (wymagany): ciąg znaków, bufor lub obiekt reprezentujący dane do pamięci podręcznej. W przypadku innych typów danych wystąpi błąd. Dla wygody obiekty zostaną przekonwertowane na ciąg znaków za pomocą funkcji „JSON.stringify”. -
ttl
: (opcjonalny) maksymalny czas przechowywania danych w pamięci podręcznej (w sekundach). Jeśli nie zostanie określony, zostanie użyty domyślny czas życia. -
callback
: (opcjonalnie) funkcja, która zostanie wywołana, gdy dane zostaną bezpiecznie w pamięci podręcznej, jeśli jest określona. Jeśli wystąpi błąd wstawiania, zostanie wywołana z obiektem Error jako pierwszym parametrem, w przeciwnym razie bez parametrów.
Przykład:
var apigee = require('apigee-access'); var cache = apigee.getCache(); // Insert a string into cache using the default TTL cache.put('key1', 'Buenos dias, Mundo!'); // Insert a string into cache using a TTL of 120 seconds cache.put('key2', 'Hello, World!', 120); // Insert a string with the default TTL, and get notified when the insert is complete cache.put('key3', 'Ciao, Mondo!', function(error) { // "error" will be falsy unless there was an error on insert }); // Insert a string with a TTL of 600 seconds, and get notified when the insert is complete cache.put('key4', 'Hallo Wereld!', 600, function(error) { // "error" will be falsy unless there was an error on insert });
get
cache.get('key',
function(error, data));
Pobieranie danych z pamięci podręcznej.
Parametry:
-
key
(wymagane): ciąg znaków jednoznacznie identyfikujący element w pamięci podręcznej.W przypadku wpisów w pamięci podręcznej umieszczanych w pamięci podręcznej z zasad Apigee Edge (np. Zasady wypełniania pamięci podręcznej) musisz utworzyć klucz pamięci podręcznej, wnioskując na podstawie sposobu tworzenia przez zasady kluczy dla wpisów. Aby to zrobić, musisz wiedzieć, jak skonfigurować tę zasadę. Opis w sekcji Praca z kluczami pamięci podręcznej opisuje sposób tworzenia kluczy pamięci podręcznej przez zasady, ale pamiętaj, że nie należy określać wartości ciągów znaków związanych z zakresem, ponieważ w wywołaniach z Node.js zakres jest już częścią kontekstu.
-
callback
(wymagana): funkcja, która zostanie wywołana, gdy dane będą dostępne. Jeśli dane są w pamięci podręcznej, są one zwracane w drugim parametrze.-
error
– obiekt Error. Jeśli podczas pobierania z pamięci podręcznej wystąpi błąd, zostanie tu ustawiony obiekt Error. W przeciwnym razie parametr ten będzie miał wartość „nieokreślony”. -
data
– pobrane dane (jeśli występują). Może to być jedna z 4 wartości:- Jeśli został wstawiony ciąg znaków, będzie to ciąg znaków.
- Jeśli został wstawiony bufor, będzie to bufor.
- Jeśli został wstawiony obiekt, będzie to ciąg znaków zawierający wersję obiektu w formacie JSON, wygenerowaną przez funkcję „JSON.stringify”.
- Jeśli nic nie zostanie znalezione, wartość będzie „nieokreślona”.
-
Przykład:
var apigee = require('apigee-access'); var cache = apigee.getCache(); cache.get('key', function(error, data) { // If there was an error, then "error" will be set. // If error is falsy, "data" is the item that was retrieved: // - undefined, in the case of cache miss, or // - a Buffer, or // - a String });
usuń
cache.remove('key', function(error));
Unieważnianie zawartości pamięci podręcznej Gdy klucz zostanie unieważniony, kolejne żądania get() będą zwracać wartość „undefined”, chyba że zostanie wstawiona inna wartość.
Parametry:
-
key
(wymagany): ciąg znaków jednoznacznie identyfikujący element w pamięci podręcznej, który ma zostać unieważniony.W przypadku wpisów w pamięci podręcznej umieszczanych w pamięci podręcznej z zasad Apigee Edge (np. Zasady wypełniania pamięci podręcznej) musisz utworzyć klucz pamięci podręcznej, wnioskując na podstawie sposobu tworzenia kluczy dla wpisów przez tę zasadę. Aby to zrobić, musisz wiedzieć, jak skonfigurować tę zasadę. Opis w sekcji Praca z kluczami pamięci podręcznej opisuje sposób tworzenia kluczy pamięci podręcznej przez zasady, ale pamiętaj, że nie należy określać wartości ciągów znaków związanych z zakresem, ponieważ w wywołaniach z Node.js zakres jest już częścią kontekstu.
-
callback
(wymagany): funkcja wywołania zwrotnego, która zostanie wywołana z obiektem Error jako pierwszym parametrem, jeśli wystąpi błąd.
Przykład:
var apigee = require('apigee-access'); var cache = apigee.getCache(); cache.remove('key', function(error) { });