ASP.NET Core에서 메모리에 저장된 캐시

릭 앤더슨, 존 루오, 스티브 스미스

캐싱은 콘텐츠를 생성하는 데 필요한 작업을 줄여 앱의 성능과 확장성을 크게 향상시킬 수 있습니다. 캐싱은 자주 변경되지 않고 생성 비용이 많이 드는 데이터에 가장 적합합니다. 캐싱을 사용하면 원본보다 훨씬 빠르게 반환할 수 있는 데이터 복사본이 만들어집니다. 캐시된 데이터에 의존 하지 않도록 앱을 작성하고 테스트해야 합니다.

ASP.NET Core는 여러 다른 캐시를 지원합니다. 가장 간단한 캐시는 .를 기반으로 합니다 IMemoryCache. IMemoryCache 는 웹 서버의 메모리에 저장된 캐시를 나타냅니다. 서버 팜(여러 서버)에서 실행되는 앱은 메모리 내 캐시를 사용할 때 세션이 고정되도록 해야 합니다. 고정 세션은 클라이언트의 요청이 모두 동일한 서버로 이동하도록 합니다. 예를 들어 Azure 웹앱은 ARR( 애플리케이션 요청 라우팅)을 사용하여 모든 요청을 동일한 서버로 라우팅합니다.

웹 팜의 고정되지 않은 세션에는 캐시 일관성 문제를 방지하기 위해 분산 캐시 가 필요합니다. 일부 앱의 경우 분산 캐시는 메모리 내 캐시보다 더 높은 스케일 아웃을 지원할 수 있습니다. 분산 캐시를 사용하면 캐시 메모리가 외부 프로세스로 오프로드됩니다.

메모리 내 캐시는 모든 개체를 저장할 수 있습니다. 분산 캐시 인터페이스는 .로 byte[]제한됩니다. 메모리 내 및 분산 캐시 저장소는 키-값 쌍으로 항목을 캐시합니다.

System.Runtime.Caching/메모리 캐시

System.Runtime.Caching / MemoryCache (NuGet 패키지)는 다음과 함께 사용할 수 있습니다.

• .NET Standard 2.0 이상.
• .NET Standard 2.0 이상을 대상으로 하는 모든 .NET 구현입니다. 예를 들어 ASP.NET Core 3.1 이상입니다.
• .NET Framework 4.5 이상.

Microsoft.Extensions.Caching.Memory/IMemoryCache(이 문서에서 설명)는 ASP.NET Core에 더 잘 통합되므로 권장System.Runtime.Caching/MemoryCache됩니다. 예를 들어 ASP.NET IMemoryCache Core 종속성 주입에서 기본적으로 작동합니다.

ASP.NET 4.x에서 ASP.NET Core로 코드를 포팅할 때 호환성 브리지로 사용합니다 System.Runtime.Caching/MemoryCache .

캐시 지침

• 코드에는 항상 데이터를 가져오는 대체 옵션이 있어야 하며 사용 가능한 캐시된 값에 의존 하지 않아야 합니다.
• 캐시는 부족한 리소스, 메모리를 사용합니다. 캐시 증가 제한:
  • 캐시에 외부 입력을 삽입 하지 마세요. 예를 들어 입력에서 예측할 수 없는 양의 메모리를 사용할 수 있으므로 임의의 사용자 제공 입력을 캐시 키로 사용하지 않는 것이 좋습니다.
  • 만료를 사용하여 캐시 증가를 제한합니다.
  • SetSize, Size 및 SizeLimit를 사용하여 캐시 크기를 제한합니다. ASP.NET Core 런타임은 메모리 압력에 따라 캐시 크기를 제한 하지 않습니다. 캐시 크기를 제한하는 것은 개발자의 책임입니다.

IMemoryCache 사용

경고

공유 메모리 캐시를 종속성 주입에서 사용하거나 SetSize 또는 Size, SizeLimit를 호출하여 캐시 크기를 제한하면 앱이 실패할 수 있습니다. 캐시에 크기 제한이 설정되면 모든 항목이 추가될 때 크기를 지정해야 합니다. 이로 인해 개발자가 공유 캐시를 사용하는 것을 완전히 제어할 수 없으므로 문제가 발생할 수 있습니다. "SetSize, Size, 또는 SizeLimit를 사용하여 캐시를 제한하는 경우, 캐싱을 위한 캐시 싱글톤을 만듭니다." 자세한 내용 및 예제는 SetSize, Size 및 SizeLimit를 사용하여 캐시 크기를 제한합니다. 공유 캐시는 다른 프레임워크 또는 라이브러리에서 공유하는 캐시입니다.

메모리 내 캐싱은 종속성 주입을 사용하여 앱에서 참조되는 서비스입니다. 생성자 IMemoryCache 에서 인스턴스를 요청합니다.

public class IndexModel : PageModel
{
    private readonly IMemoryCache _memoryCache;

    public IndexModel(IMemoryCache memoryCache) =>
        _memoryCache = memoryCache;

    // ...

다음 코드는 시간이 캐시에 있는지 확인하는 데 사용합니다 TryGetValue . 시간이 캐시되지 않으면 새 항목이 생성되어 Set와 함께 캐시에 추가됩니다.

public void OnGet()
{
    CurrentDateTime = DateTime.Now;

    if (!_memoryCache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue))
    {
        cacheValue = CurrentDateTime;

        var cacheEntryOptions = new MemoryCacheEntryOptions()
            .SetSlidingExpiration(TimeSpan.FromSeconds(3));

        _memoryCache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions);
    }

    CacheCurrentDateTime = cacheValue;
}

위의 코드에서 캐시 항목은 3초 동안 슬라이딩 만료가 적용되도록 설정됩니다. 캐시 항목이 3초 이상 액세스되지 않으면 캐시에서 제거됩니다. 캐시 항목에 액세스할 때마다 3초 동안 캐시에 유지됩니다. 클래스는 CacheKeys 다운로드 샘플의 일부입니다.

현재 시간 및 캐시된 시간이 표시됩니다.

<ul>
    <li>Current Time: @Model.CurrentDateTime</li>
    <li>Cached Time: @Model.CacheCurrentDateTime</li>
</ul>

다음 코드는 Set 확장 메서드를 사용하여 MemoryCacheEntryOptions 없이 상대적인 시간 동안 데이터를 캐시합니다.

_memoryCache.Set(CacheKeys.Entry, DateTime.Now, TimeSpan.FromDays(1));

위의 코드에서 캐시 항목은 1일의 상대 만료로 구성됩니다. 이 시간 제한 기간 내에 액세스하더라도 캐시 항목은 1일 후에 캐시에서 제거됩니다.

다음 코드는 GetOrCreate와 GetOrCreateAsync를 사용하여 데이터를 캐시합니다.

public void OnGetCacheGetOrCreate()
{
    var cachedValue = _memoryCache.GetOrCreate(
        CacheKeys.Entry,
        cacheEntry =>
        {
            cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
            return DateTime.Now;
        });

    // ...
}

public async Task OnGetCacheGetOrCreateAsync()
{
    var cachedValue = await _memoryCache.GetOrCreateAsync(
        CacheKeys.Entry,
        cacheEntry =>
        {
            cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
            return Task.FromResult(DateTime.Now);
        });

    // ...
}

다음 코드는 캐시된 시간을 가져오기 위해 호출 Get 합니다.

var cacheEntry = _memoryCache.Get<DateTime?>(CacheKeys.Entry);

다음 코드는 절대 만료가 있는 캐시된 항목을 가져오거나 만듭니다.

var cachedValue = _memoryCache.GetOrCreate(
    CacheKeys.Entry,
    cacheEntry =>
    {
        cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(20);
        return DateTime.Now;
    });

슬라이딩 만료만 있는 캐시된 항목 집합은 만료되지 않을 위험이 있습니다. 캐시된 항목이 슬라이딩 만료 간격 내에 반복적으로 액세스되는 경우 항목은 만료되지 않습니다. 절대 만료와 슬라이딩 만료를 결합하여 항목이 만료되도록 합니다. 절대 만료는 항목이 슬라이딩 만료 간격 내에 요청되지 않은 경우 항목이 더 일찍 만료되도록 허용하면서 항목을 캐시할 수 있는 기간에 대한 상한을 설정합니다. 슬라이딩 만료 간격 또는 절대 만료 시간이 지나면 항목이 캐시에서 제거됩니다.

다음 코드는 슬라이딩 및 절대 만료를 모두 사용하여 캐시된 항목을 가져오거나 만듭니다.

var cachedValue = _memoryCache.GetOrCreate(
    CacheKeys.CallbackEntry,
    cacheEntry =>
    {
        cacheEntry.SlidingExpiration = TimeSpan.FromSeconds(3);
        cacheEntry.AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(20);
        return DateTime.Now;
    });

위의 코드는 데이터가 절대 시간보다 오래 캐시되지 않도록 보장합니다.

GetOrCreate, GetOrCreateAsync및 Get 클래스의 확장 메서드입니다 CacheExtensions . 이러한 메서드는 IMemoryCache의 기능을 확장합니다.

MemoryCacheEntryOptions

다음 예제는 다음과 같습니다.

• 캐시 우선 순위를 .로 CacheItemPriority.NeverRemove설정합니다.
• PostEvictionDelegate 항목이 캐시에서 제거된 후 호출되는 값을 설정합니다. 콜백은 캐시에서 항목을 제거하는 코드와 다른 스레드에서 실행됩니다.

public void OnGetCacheRegisterPostEvictionCallback()
{
    var memoryCacheEntryOptions = new MemoryCacheEntryOptions()
        .SetPriority(CacheItemPriority.NeverRemove)
        .RegisterPostEvictionCallback(PostEvictionCallback, _memoryCache);

    _memoryCache.Set(CacheKeys.CallbackEntry, DateTime.Now, memoryCacheEntryOptions);
}

private static void PostEvictionCallback(
    object cacheKey, object cacheValue, EvictionReason evictionReason, object state)
{
    var memoryCache = (IMemoryCache)state;

    memoryCache.Set(
        CacheKeys.CallbackMessage,
        $"Entry {cacheKey} was evicted: {evictionReason}.");
}

SetSize, Size 및 SizeLimit를 사용하여 캐시 크기 제한

인스턴스는 MemoryCache 필요에 따라 크기 제한을 지정하고 적용할 수 있습니다. 캐시에는 항목 크기를 측정하는 메커니즘이 없기 때문에 캐시 크기 제한에 정의된 측정 단위가 없습니다. 캐시 크기 제한이 설정되면 모든 항목에서 크기를 지정해야 합니다. ASP.NET Core 런타임은 메모리 압력에 따라 캐시 크기를 제한하지 않습니다. 캐시 크기를 제한하는 것은 개발자의 책임입니다. 지정된 크기는 개발자가 선택하는 단위입니다.

다음은 그 예입니다.

• 웹앱이 주로 문자열을 캐싱하는 경우 각 캐시 항목 크기는 문자열 길이일 수 있습니다.
• 앱은 모든 항목의 크기를 1로 지정할 수 있으며 크기 제한은 항목 수입니다.

설정되지 않은 경우 SizeLimit 캐시는 바인딩되지 않고 증가합니다. ASP.NET Core 런타임은 시스템 메모리가 부족할 때 캐시를 트리밍하지 않습니다. 앱은 다음으로 설계되어야 합니다.

• 캐시 증가를 제한합니다.
• 호출 Compact 또는 Remove 사용 가능한 메모리가 제한된 경우

다음 코드는 MemoryCache을 통해 액세스할 수 있는 단위 없는 고정 크기를 만듭니다.

public class MyMemoryCache
{
    public MemoryCache Cache { get; } = new MemoryCache(
        new MemoryCacheOptions
        {
            SizeLimit = 1024
        });
}

SizeLimit 에 단위가 없습니다. 캐시된 항목은 캐시 크기 제한이 설정된 경우 가장 적합한 단위로 크기를 지정해야 합니다. 캐시 인스턴스의 모든 사용자는 동일한 단위 시스템을 사용해야 합니다. 캐시된 항목 크기의 합계가 지정된 SizeLimit값을 초과하면 항목이 캐시되지 않습니다. 캐시 크기 제한이 설정되지 않은 경우 항목에 설정된 캐시 크기는 무시됩니다.

다음 코드는 MyMemoryCache 컨테이너에 등록됩니다.

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddSingleton<MyMemoryCache>();

MyMemoryCache 는 이 크기 제한 캐시를 인식하고 캐시 항목 크기를 적절하게 설정하는 방법을 알고 있는 구성 요소에 대한 독립 메모리 캐시로 만들어집니다.

확장 메서드 또는 SetSize 속성을 사용하여 캐시 항목의 Size 크기를 설정할 수 있습니다.

if (!_myMemoryCache.Cache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue))
{
    var cacheEntryOptions = new MemoryCacheEntryOptions()
        .SetSize(1);

    // cacheEntryOptions.Size = 1;

    _myMemoryCache.Cache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions);
}

앞의 코드에서 강조 표시된 두 줄은 캐시 항목의 크기를 설정하는 것과 동일한 결과를 가져옵니다. SetSize는 new MemoryCacheOptions()에 대한 호출을 체인으로 연결할 때 편의를 위해 제공됩니다.

MemoryCache.컴팩트

MemoryCache.Compact 는 다음 순서대로 캐시의 지정된 백분율을 제거하려고 시도합니다.

• 만료된 모든 항목입니다.
• 우선 순위별 항목입니다. 우선 순위가 가장 낮은 항목이 먼저 제거됩니다.
• 오래 사용하지 않은 개체.
• 절대 만료가 가장 빠른 항목입니다.
• 가장 빠른 슬라이딩 만료가 있는 항목입니다.

우선 순위가 지정된 NeverRemove 고정된 항목은 제거되지 않습니다. 다음 코드는 캐시 항목을 제거하고 25개% 캐시된 항목을 제거하도록 호출 Compact 합니다.

_myMemoryCache.Cache.Remove(CacheKeys.Entry);
_myMemoryCache.Cache.Compact(.25);

자세한 내용은 GitHub의 Compact 원본을 참조하세요.

캐시 종속성

다음 샘플에서는 종속 항목이 만료되는 경우 캐시 항목을 만료하는 방법을 보여 줍니다. A CancellationChangeToken 가 캐시된 항목에 추가됩니다. Cancel 호출 시 CancellationTokenSource두 캐시 항목이 모두 제거됩니다.

public void OnGetCacheCreateDependent()
{
    var cancellationTokenSource = new CancellationTokenSource();

    _memoryCache.Set(
        CacheKeys.DependentCancellationTokenSource,
        cancellationTokenSource);

    using var parentCacheEntry = _memoryCache.CreateEntry(CacheKeys.Parent);

    parentCacheEntry.Value = DateTime.Now;

    _memoryCache.Set(
        CacheKeys.Child,
        DateTime.Now,
        new CancellationChangeToken(cancellationTokenSource.Token));
}

public void OnGetCacheRemoveDependent()
{
    var cancellationTokenSource = _memoryCache.Get<CancellationTokenSource>(
        CacheKeys.DependentCancellationTokenSource);

    cancellationTokenSource.Cancel();
}

사용하면 CancellationTokenSource를 통해 여러 캐시 항목을 하나의 그룹으로 제거할 수 있습니다. using 위의 코드에서 패턴을 사용하면 범위 내에서 만든 캐시 항목이 using 트리거 및 만료 설정을 상속합니다.

추가적인 참고 사항

• 만료는 백그라운드에서 발생하지 않습니다. 캐시에서 만료된 항목을 적극적으로 검색하는 타이머는 없습니다. 캐시(Get, TryGetValue, ,SetRemove)에 대한 모든 활동은 만료된 항목에 대한 백그라운드 검사를 트리거할 수 있습니다. CancellationTokenSource의 타이머 (CancelAfter)는 항목을 제거하고 만료된 항목에 대한 검사를 트리거합니다. 다음 예제에서는 등록된 토큰에 사용합니다 CancellationTokenSource(TimeSpan) . 이 토큰이 실행되면 즉시 항목을 제거하고 제거 콜백을 실행합니다.

  if (!_memoryCache.TryGetValue(CacheKeys.Entry, out DateTime cacheValue))
  {
      cacheValue = DateTime.Now;
  
      var cancellationTokenSource = new CancellationTokenSource(
          TimeSpan.FromSeconds(10));
  
      var cacheEntryOptions = new MemoryCacheEntryOptions()
          .AddExpirationToken(
              new CancellationChangeToken(cancellationTokenSource.Token))
          .RegisterPostEvictionCallback((key, value, reason, state) =>
          {
              ((CancellationTokenSource)state).Dispose();
          }, cancellationTokenSource);
  
      _memoryCache.Set(CacheKeys.Entry, cacheValue, cacheEntryOptions);
  }
  

• 콜백을 사용하여 캐시 항목을 다시 입력하는 경우:

  • 콜백이 완료되지 않았기 때문에 여러 요청에서 캐시된 키 값이 비어 있는 것을 찾을 수 있습니다.
  • 이로 인해 여러 스레드가 캐시된 항목을 다시 채우게 될 수 있습니다.

• 한 캐시 항목을 사용하여 다른 항목을 만들면 자식은 부모 항목의 만료 토큰 및 시간 기반 만료 설정을 복사합니다. 자식은 부모 항목을 수동으로 제거하거나 업데이트하여 만료되지 않습니다.

• 캐시 항목이 캐시에서 제거된 후 발생하는 콜백을 설정하는 데 사용합니다 PostEvictionCallbacks .

• 대부분의 앱에서 IMemoryCache 사용하도록 설정됩니다. 예를 들어, AddMvc, AddControllersWithViews, AddRazorPages, AddMvcCore().AddRazorViewEngine 및 많은 다른 Add{Service} 메서드를 Program.cs에서 호출하면 IMemoryCache을 가능하게 합니다. 이전 Add{Service} 방법 중 하나를 호출하지 않는 앱의 경우, AddMemoryCache에서 Program.cs을 호출해야 할 수도 있습니다.

백그라운드 캐시 업데이트

캐시를 업데이트하는 등의 IHostedService 사용합니다. 백그라운드 서비스는 항목을 다시 계산한 다음 준비가 된 경우에만 캐시에 할당할 수 있습니다.

추가 리소스

• 샘플 코드 보기 및 다운로드(다운로드 방법)
• ASP.NET Core 분산 캐싱
• ASP.NET Core에서 변경 토큰을 사용하여 변경 내용 검색
• ASP.NET Core의 응답 캐싱
• ASP.NET Core의 응답 캐싱 미들웨어
• ASP.NET Core MVC의 캐시 태그 도우미
• ASP.NET Core의 분산 캐시 태그 도우미