Node.js의 캐시 액세스

Apigee Edge 문서입니다.
Go to the Apigee X documentation. info

apigee-access 모듈을 사용하여 Node.js 애플리케이션 내에서 Edge 분산 캐시에 액세스할 수 있습니다. 이 모듈에는 캐시를 가져오고 데이터를 넣고, 가져오고, 삭제하는 메서드가 포함되어 있습니다.

Apigee Edge 분산 캐시를 사용하면 문자열 또는 기타 데이터를 저장할 수 있습니다. 대부분의 캐시와 마찬가지로 최대 크기가 있는 최소 최근 사용 캐시입니다. Apigee Edge 내에서 캐시는 Node.js 애플리케이션이 실행되는 모든 노드에 분산됩니다. Apigee Edge API를 통해 캐시를 관리할 수 있습니다. API를 사용하여 캐시 리소스를 수동으로 만들거나 기본 리소스를 사용할 수 있습니다. Apigee Edge의 캐싱에 대한 소개는 Edge의 지속성 도구를 참조하세요. 분산 캐시에 대한 자세한 내용은 예시: 범용 캐싱을 참조하세요.

apigee-access 모듈 및 기타 기능에 대한 소개는 apigee-access 모듈 사용을 참조하세요.

메서드

(1) getCache

var cache = apigee.getCache(cacheName);

이름이 지정된 캐시를 조회하고 필요한 경우 캐시를 만듭니다. 결과 캐시는 대부분의 상황에 적합한 사전 정의된 구성 매개변수 집합 을 사용합니다.

매개변수:

cacheName - 문자열, 캐시의 이름입니다. (캐시 리소스의 이름이 아님)

반환:

캐시 객체입니다.

예:

var apigee = require('apigee-access');
var cache = apigee.getCache('cache');

(2) getCache

var customCache = apigee.getCache(cacheName, options );

구성 객체에 지정된 커스텀 캐시 리소스에 액세스합니다. 캐시 리소스를 만드는 방법에 대한 자세한 내용은 환경 캐시 만들기 및 수정을 참조하세요.

매개변수:

cacheName - 문자열, 커스텀 캐시의 이름입니다. (캐시 리소스의 이름이 아님)

options - 구성 객체입니다. 객체는 비어 있을 수도 있고 다음 선택적 매개변수를 포함할 수도 있습니다.

  • resource: 캐시 데이터가 저장되는 Apigee "캐시 리소스"의 이름입니다. 캐시 리소스는 메모리 할당 및 기타 캐시 매개변수를 미세 조정하는 데 사용됩니다. 지정하지 않으면 기본 리소스가 사용됩니다. 캐시 리소스가 없으면 메서드에서 오류가 발생합니다.

  • scope: 충돌을 방지하기 위해 캐시 항목에 프리픽스를 추가할지 여부를 지정합니다. 유효한 값은 global, application, and exclusive입니다.

    • global: 모든 캐시 항목은 동일한 Apigee "환경"의 모든 Node.js 애플리케이션에서 볼 수 있습니다.

    • application: 모든 캐시 항목은 동일한 Apigee Edge 애플리케이션에 속한 모든 Node.js 캐시에서 볼 수 있습니다.

    • exclusive: (기본값) 캐시 항목은 이름이 같은 동일한 애플리케이션의 Node.js 캐시에서만 볼 수 있습니다. 전역 window는 기본 설정이며,

  • prefix: 캐시 키 이름에 캐시 채우기 정책 및 캐시 키 작업에 설명된 대로 프리픽스가 포함되어 있는 경우 이 매개변수를 사용하여 지정합니다. Edge는 프리픽스 이름에 이중 밑줄 서픽스를 자동으로 추가합니다. 따라서 "UserToken" 프리픽스로 캐시 키가 생성된 경우 여기에 지정할 프리픽스는 "UserToken__"입니다.

  • defaultTtl: 캐시 항목의 기본 TTL(수명)을 초 단위로 지정합니다. 지정하지 않으면 캐시 리소스의 기본 TTL이 사용됩니다.

  • timeout: 분산 캐시에서 결과를 가져오기 위해 대기하는 시간(초)입니다. 기본값은 30초입니다. 지연 시간에 민감한 애플리케이션은 캐시 인프라가 과부하된 경우 응답 시간이 느려지는 것을 방지하기 위해 이 값을 줄일 수 있습니다.

반환:

커스텀 캐시 객체입니다.

예:

var apigee = require('apigee-access');
var customCache = apigee.getCache('doesNotMatter',
  { resource: 'MyCustomResource', scope: 'global', prefix: 'UserToken'} );
customCache.put("myCacheKey", "xyz");

이 메서드는 다음과 같이 구성된 LookupCache 정책과 함께 작동합니다.

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

캐시에 데이터를 넣습니다.

매개변수:

  • key: (필수) 캐시에서 항목을 고유하게 식별하는 문자열입니다. 캐시 키의 크기는 2KB로 제한됩니다.

  • data: (필수) 캐시할 데이터를 나타내는 문자열, 버퍼 또는 객체입니다. 다른 데이터 유형을 사용하면 오류가 발생합니다. 편의를 위해 객체는 'JSON.stringify'를 사용하여 문자열로 변환됩니다.

  • ttl: (선택사항) 캐시에서 데이터를 유지하는 최대 시간(초)입니다. 지정하지 않으면 기본 TTL이 사용됩니다.

  • callback: (선택사항) 지정된 경우 데이터가 캐시에 안전하게 저장되면 호출되는 함수입니다. 삽입 오류가 있는 경우 첫 번째 매개변수로 Error 객체가 전달되어 호출되고 그렇지 않으면 매개변수 없이 호출됩니다

예:

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

캐시에서 데이터를 검색합니다.

매개변수:

  • key (필수): 캐시에서 항목을 고유하게 식별하는 문자열입니다.

    Apigee Edge 정책 (예: 캐시 채우기 정책)에서 캐시에 저장된 캐시 항목의 경우 정책에서 항목의 키를 만드는 특정 방식을 추론하여 캐시 키를 구성해야 합니다. 이렇게 하려면 정책이 구성되는 방식을 알아야 합니다. 캐시 키 작업에서는 정책에서 캐시 키를 만드는 방법을 설명하지만 범위와 관련된 문자열 값을 지정해서는 안 됩니다. Node.js의 호출에서 범위는 이미 컨텍스트의 일부입니다.

  • callback (필수): 데이터가 사용 가능할 때 호출되는 함수입니다. 캐시된 데이터가 있으면 두 번째 매개변수로 반환됩니다.

    • error - Error 객체입니다. 캐시에서 검색하는 동안 오류가 발생하면 여기에 Error 객체가 설정됩니다. 그렇지 않으면 이 매개변수가 "undefined"로 설정됩니다.

    • data - 검색된 데이터(있는 경우)입니다. 次の四つの値のいずれかになります。

      • 문자열이 삽입된 경우 문자열입니다.
      • 버퍼가 삽입된 경우 버퍼입니다.
      • 객체가 삽입된 경우 'JSON.stringify'에서 생성된 객체의 JSON 버전을 포함하는 문자열입니다.
      • 아무것도 찾지 못한 경우 'undefined'입니다.

예:

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
});

remove

cache.remove('key', function(error));

캐시된 항목을 무효화합니다. 키가 무효화되면 다른 값이 삽입되지 않는 한 후속 get() 요청은 "undefined"를 반환합니다.

매개변수:

  • key (필수): 무효화할 캐시에서 항목을 고유하게 식별하는 문자열입니다.

    Apigee Edge 정책 (예: 캐시 채우기 정책)에서 캐시에 저장된 캐시 항목의 경우 정책에서 항목의 키를 만드는 특정 방식을 추론하여 캐시 키를 구성해야 합니다. 이렇게 하려면 정책이 구성되는 방식을 알아야 합니다. 캐시 키 작업에서는 정책에서 캐시 키를 만드는 방법을 설명하지만 범위와 관련된 문자열 값을 지정해서는 안 됩니다. Node.js의 호출에서 범위는 이미 컨텍스트의 일부입니다.

  • callback (필수): 오류가 있는 경우 첫 번째 매개변수로 Error 객체가 전달되어 호출되는 콜백 함수입니다.

예:

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