Node.js'de önbelleğe erişme

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

Edge'de dağıtılan önbelleğe erişmek için apigee-access modülünü kullanabilirsiniz. Node.js uygulamasında kullanabilirsiniz. Modül, verileri girmek, verileri almak ve kaldırmak.

Apigee Edge dağıtılmış önbellek, dizeleri veya diğer verileri depolamanıza olanak tanır. Çoğu önbellek gibi maksimum boyuta sahip, en az kullanılan bir önbellektir. Apigee Edge'de önbellek dağıtılır Node.js uygulamanızın çalıştığı tüm düğümler arasında. Önbelleği yönetebilirsiniz. Apigee Edge API'si. API'yı kullanarak önbellek kaynaklarını manuel olarak oluşturabilir veya varsayılan kaynak. Apigee Edge'de önbelleğe alma özelliğine giriş için Edge'deki kalıcılık araçları bölümüne bakın. Daha fazla bilgi edinmek için hakkında daha fazla bilgi edinmek için bkz. Örnek: Genel amaçlı önbelleğe alma.

apigee-access modülü ve diğer özelliklerine giriş için bkz. Apigee-access modülünü kullanma.

Yöntemler


(1) getCache

var cache = apigee.getCache(cacheName);

Adlandırılmış bir önbellek arayın ve gerekirse bunu oluşturun. Ortaya çıkan önbellek, önceden tanımlanmış bir küme yapılandırma parametrelerini ifade eder.

Parametreler:

cacheName - Bir dize; önbellek. (Önbellek kaynağının adı değildir).

Şunu döndürür:

Önbellek nesnesi.

Ö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 önbellek kaynağına erişim. Nasıl iletişim kuracağınızla ilgili önbellek kaynağı oluşturmak için bkz. Ortam oluşturma ve düzenleme önbellek hakkında daha fazla bilgi edinin.

Parametreler:

cacheName - Bir dize; özel önbellek. (Önbellek kaynağının adı değildir)

options: Bir yapılandırma nesnesidir. İlgili içeriği oluşturmak için kullanılan nesne boş olabilir veya aşağıdaki isteğe bağlı parametreleri içerebilir:

  • resource: Bir Apigee "önbellek kaynağının" adı burada depolanan verileri gösterir. Önbellek kaynakları, bellek ayırmada ve diğer önbellekte ince ayar yapmak için kullanılır parametreleridir. Belirtilmezse varsayılan bir kaynak kullanılır. Önbellek kaynağı yöntem bir hata verir.

  • scope: Önbellek girişlerinin önüne kazaları önler. Geçerli değerler global, application ve exclusive.

    • global: Tüm önbellek girişleri, aynı Apigee "ortamı"dır.

    • application: Tüm önbellek girişleri, seçili olan tüm Node.js önbellekleri bir parçası olacak.

    • exclusive: (Varsayılan) Önbellek girişleri yalnızca aynı uygulamaya sahip olduğundan emin olun. Bu, varsayılan ayardır.

  • prefix: Önbellek anahtarı adı, Doldurma bölümünde açıklandığı Önbellek politikası ve Önbellek anahtarlarıyla çalışma, bu parametreyi kullanın. Edge, önek adı. "UserToken" önekiyle bir önbellek anahtarı oluşturulduysa, burada "UserToken__" var.

  • defaultTtl: Önbellek için varsayılan geçerlilik süresini belirtir giriş, saniye cinsinden. Belirtilmezse önbellek kaynağındaki varsayılan TTL şöyle olur: kullanılır.

  • timeout: birkaç saniye içinde dağıtıldı. Varsayılan 30 saniyedir. Gecikmeye duyarlı uygulamalar önbellek altyapısı uygunsa yanıt sürelerinin uzamasını önlemek için bunu azaltmayı isteyebilirsiniz. aşırı yüklü.

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

kon

cache.put('key', data, ttl, function(error));

Verileri bir önbelleğe alma.

Parametreler:

  • key: (Zorunlu) Benzersiz bir şekilde tanımlayan bir dize geri yükleyebilirsiniz. Önbellek anahtarları 2 KB boyutuyla sınırlıdır.

  • data: (Zorunlu) Bir dize, Arabellek veya nesne , önbelleğe alınacak verileri temsil eder. Diğer tüm veri türleri hatayla sonuçlanır. Kolaylık olması açısından nesneler "JSON.stringify" kullanılarak bir dizeye dönüştürülür.

  • ttl: (İsteğe bağlı) verileri önbellekte, saniyeler içinde saklar. Belirtilmezse varsayılan bir TTL kullanılır.

  • callback: (İsteğe bağlı) Belirtilmişse çağrılacaktır. Hata nesnesiyle çağrılacak varsa ilk parametre olarak ayarlanır, aksi takdirde parametre yok.

Ö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 al.

Parametreler:

  • key (gerekli): Benzersiz bir şekilde tanımlayan bir dize geri yükleyebilirsiniz.

    Apigee Edge politikasından (ör. Önbelleği Doldur politikası) önbelleğe alınan önbellek girişleri için: önbellek anahtarını, politikanın bu yapılandırmanın veri oluşturma yönteminden çıkarım yaparak tuşları vardır. Bunu yapmak için politikanın nasıl yapılandırıldığını bilmeniz gerekir. Bu sırada Önbellek anahtarlarıyla çalışma önbellek anahtarlarının politikalar tarafından nasıl oluşturulduğunu açıklasa da kapsamla ilgili dize değerleri; Node.js'den gelen çağrılarda kapsam zaten bağlam.

  • callback (gerekli): hazır olursunuz. Önbelleğe alınmış veri varsa bu veriler parametresinden sonra bir değer girin.

    • error - Hata nesnesi. Hata varsa alma işlemi tekrarlanırsa burada bir Hata nesnesi ayarlanır. Aksi halde bu parametresi "undefined" olarak ayarlanır.

    • data - Varsa alınan veriler. Bu şu dört değerden birini seçin:

      • Dize eklendiyse dize olur.
      • Arabellek eklendiyse bu bir Tampon olur.
      • Bir nesne eklendiyse bu, "JSON.stringify" tarafından üretildiği şekliyle nesne.
      • Hiçbir şey bulunamazsa "tanımlanmamış" olarak ayarlanır.

Ö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ınan bir öğeyi geçersiz kılar. Bir anahtar geçersiz kılındığında sonraki get() istekleri döndürülür "tanımsız" başka bir değer eklenmez.

Parametreler:

  • key (Zorunlu): Benzersiz bir şekilde tanımlayan bir dize önbellekteki öğeyi geçersiz kılmak için kullanılır.

    Apigee Edge politikasından (ör. Önbelleği Doldur politikası) önbelleğe alınan önbellek girişleri için: önbellek anahtarını, politikanın bu yapılandırmanın veri oluşturma yönteminden çıkarım yaparak tuşları vardır. Bunu yapmak için politikanın nasıl yapılandırıldığını bilmeniz gerekir. Bu sırada Önbellek anahtarlarıyla çalışma önbellek anahtarlarının politikalar tarafından nasıl oluşturulduğunu açıklasa da kapsamla ilgili dize değerleri; Node.js'den gelen çağrılarda kapsam zaten bağlam.

  • callback (Zorunlu): Şu işlemleri gerçekleştirecek bir geri çağırma işlevi: değeri ilk parametre olarak bir Hata nesnesiyle çağrılacaktır.

Örnek:

var apigee = require('apigee-access');
var cache = apigee.getCache();
cache.remove('key', function(error) {
});