Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Bir Node.js uygulamasından Edge dağıtılmış önbelleğine erişmek için apigee-access modülünü kullanabilirsiniz. Modül, önbellek alma ve verileri yerleştirme, alma ve kaldırma yöntemlerini içerir.
Apigee Edge dağıtılmış önbelleği, dize veya başka verileri depolamanıza olanak tanır. Çoğu önbelleğe benzer şekilde, maksimum boyuta sahip en son kullanılmayan bir önbellektir. Apigee Edge'de önbellek, Node.js uygulamanızın çalıştığı tüm düğümler arasında dağıtılır. Önbelleği bir Apigee Edge API üzerinden yönetebilirsiniz. API'yi kullanarak önbelleğe alma kaynaklarını manuel olarak oluşturabilir veya varsayılan kaynağı kullanabilirsiniz. Apigee Edge'de önbelleğe alma hakkında bilgi edinmek için Edge'deki kalıcılık araçları başlıklı makaleyi inceleyin. Dağıtılmış önbellek hakkında daha fazla bilgi edinmek için Örnek: Genel amaçlı önbelleğe alma bölümüne bakın.
apigee-access modülü ve diğer özellikleri hakkında bilgi edinmek için apigee-access modülünü kullanma başlıklı makaleyi inceleyin.
Yöntemler
(1) getCache
var
cache = apigee.getCache(cacheName);Adlandırılmış bir önbellek arayın ve gerekirse bunu oluşturun. Elde edilen önbellekte, çoğu duruma uygun önceden tanımlanmış bir yapılandırma parametresi grubu kullanılır.
Parametreler:
cacheName: Önbelleğin adı olan bir dize. (Önbelleğe alma kaynağının adı değil).
İadeler:
Önbelleğe alınmış bir nesne.
Örnek:
var apigee = require('apigee-access');
var cache = apigee.getCache('cache');
(2) getCache
var
customCache = apigee.getCache(cacheName, options );Bir yapılandırma nesnesinde belirtilen özel önbelleğe erişme Önbelleğe alma kaynağı oluşturma hakkında bilgi edinmek için Ortam önbelleği oluşturma ve düzenleme başlıklı makaleyi inceleyin.
Parametreler:
cacheName - Bir dize, özel önbelleğin adı. (Önbellek kaynağının adı değil)
options: Yapılandırma nesnesi. Nesne boş olabilir veya aşağıdaki isteğe bağlı parametreleri içerebilir:
-
resource: Önbellek verilerinin depolandığı Apigee "önbellek kaynağının" adı. Önbellek kaynakları, bellek ayırmada ve diğer önbellek parametrelerinde ince ayar yapmak için kullanılır. Belirtilmemişse varsayılan bir kaynak kullanılır. Önbellek kaynağı mevcut değilse yöntem bir hata verir. -
scope: Çakışmaları önlemek için önbellek girişlerine önek eklenip eklenmeyeceğini belirtir. Geçerli değerlerglobal,applicationveexclusiveşeklindedir.-
global: Tüm önbellek girişleri, aynı Apigee "ortamındaki" tüm Node.js uygulamaları tarafından görülebilir. -
application: Tüm önbellek girişleri, aynı Apigee Edge uygulamasının parçası olan tüm Node.js önbellekleri tarafından görülebilir. -
exclusive: (Varsayılan) Önbellek girişleri yalnızca aynı uygulamadaki aynı ada sahip Node.js önbellekleri tarafından görülür. Bu, varsayılan seçenektir.
-
-
prefix: Önbellek anahtarı adı, Önbellek politikasını doldurma ve Önbellek anahtarlarıyla çalışma konularında açıklandığı gibi bir önek içeriyorsa bunu belirtmek için bu parametreyi kullanın. Edge, önek adına otomatik olarak iki alt çizgi eki ekler. Dolayısıyla, "UserToken" ön ekiyle bir önbelleğe alma anahtarı oluşturulduysa burada belirtilecek ön ek "UserToken__" olur. -
defaultTtl: Önbellek girişi için varsayılan geçerlilik süresini saniye cinsinden belirtir. Belirtilmezse önbellek kaynağındaki varsayılan TTL kullanılır. -
timeout: Dağıtılmış önbellekten sonuç almak için bekleme süresi (saniye cinsinden). Varsayılan 30 saniyedir. Gecikmeye duyarlı uygulamalar, önbellek altyapısı aşırı yüklü olduğunda yavaş yanıt sürelerini önlemek için bunu azaltmak isteyebilir.
Şunu döndürür:
Özel bir önbellek nesnesi.
Örnek:
var apigee = require('apigee-access');
var customCache = apigee.getCache('doesNotMatter',
{ resource: 'MyCustomResource', scope: 'global', prefix: 'UserToken'} );
customCache.put("myCacheKey", "xyz");
Bu işlem, şu şekilde yapılandırılmış bir LookupCache politikasıyla çalışır:
<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));Verileri bir önbelleğe alma.
Parametreler:
-
key: (Zorunlu) Önbelleğe alınan öğeyi benzersiz şekilde tanımlayan bir dize. Önbellek anahtarları 2 KB boyutuyla sınırlıdır. -
data: (Zorunlu) Önbelleğe alınacak verileri temsil eden bir dize, arabellek veya nesne. Diğer veri türleri hataya neden olur. Kolaylık sağlamak için nesneler, "JSON.stringify" kullanılarak dizeye dönüştürülür. -
ttl: (İsteğe bağlı) Verilerin önbellekte kalacağı maksimum süre (saniye cinsinden). Belirtilmemişse varsayılan TTL kullanılır. -
callback: (İsteğe bağlı) Belirtiliyse veriler güvenli bir şekilde önbelleğe alındıktan sonra çağrılacak bir işlev. Ekleme hatası varsa ilk parametre olarak Hata nesnesiyle çağrılır. Aksi takdirde parametre olmadan çağrılır.
Örnek:
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
});
al
cache.get('key',
function(error, data));Önbellekten veri alma.
Parametreler:
-
key(zorunlu): Öğeyi önbellekte benzersiz şekilde tanımlayan bir dize.Bir Apigee Edge politikasından (ör. Önbelleği Doldurma Politikası) önbelleğe eklenen önbellek girişleri için, politikanın girişler için anahtarları oluşturduğu belirli yöntemden yararlanarak önbellek anahtarını oluşturmanız gerekir. Bunun için politikanın nasıl yapılandırıldığını bilmeniz gerekir. Önbellek anahtarlarıyla çalışma bölümünde, önbellek anahtarlarının politikalar tarafından nasıl oluşturulduğu açıklanmaktadır. Ancak kapsamla ilgili dize değerleri belirtmeniz gerekmez. Node.js'den gelen çağrılarda kapsam zaten bağlamın bir parçasıdır.
-
callback(zorunlu): Veriler mevcut olduğunda çağrılacak bir işlev. Önbelleğe alınmış veriler varsa ikinci parametrede döndürülür.-
error: Hata nesnesi. Önbellekten alma sırasında bir hata oluşursa burada bir Hata nesnesi ayarlanır. Aksi takdirde bu parametre "undefined" olarak ayarlanır. -
data: Varsa alınan veriler. Bu, aşağıdaki dört değerden biri olmalıdır:- Bir dize eklendiyse dize olur.
- Tampon eklenmişse tampon olur.
- Bir nesne eklendiyse "JSON.stringify" tarafından oluşturulan nesnenin JSON sürümünü içeren bir dize olur.
- Hiçbir şey bulunamadıysa "undefined" olur.
-
Örnek:
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
});
kaldırma
cache.remove('key', function(error));Önbelleğe alınmış bir öğeyi geçersiz kılma. Bir anahtar geçersiz kılındıktan sonra, başka bir değer eklenmediği sürece sonraki get() istekleri "undefined" değerini döndürür.
Parametreler:
-
key(Zorunlu): Geçersiz kılınacak önbelleğe alınan öğeyi benzersiz şekilde tanımlayan bir dize.Bir Apigee Edge politikasından (ör. Önbelleği Doldurma Politikası) önbelleğe eklenen önbellek girişleri için, politikanın girişler için anahtarları oluşturduğu belirli yöntemden yararlanarak önbellek anahtarını oluşturmanız gerekir. Bunun için politikanın nasıl yapılandırıldığını bilmeniz gerekir. Önbellek anahtarlarıyla çalışma, önbellek anahtarlarının politikalar tarafından nasıl oluşturulduğunu açıklar ancak kapsamla ilgili dize değerleri belirtmemeniz gerektiğini unutmayın. Node.js'den yapılan çağrılarda kapsam zaten bağlamın bir parçasıdır.
-
callback(Zorunlu): Hata varsa ilk parametre olarak bir Hata nesnesi ile çağrılacak bir geri çağırma işlevi.
Örnek:
var apigee = require('apigee-access');
var cache = apigee.getCache();
cache.remove('key', function(error) {
});