ASP.NET Core 메모리 내 캐시

작성자: Rick Anderson, John Luo 및 Steve Smith

캐싱은 콘텐츠를 생성하는 데 필요한 작업을 줄여 앱의 성능과 확장성을 크게 향상시킬 수 있습니다. 캐싱은 자주 변경되지 않는 데이터, 그리고 생성하는 데 비용이 많이 드는 데이터에서 가장 잘 작동합니다. 캐싱은 원본에서 더 훨씬 빠르게 반환될 수 있는 데이터 복사본을 만듭니다. 캐시된 데이터에 종속되지 않도록 앱을 작성하고 테스트해야 합니다.

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

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

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

System.Runtime.Caching/MemoryCache

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에 권장됩니다. 예를 들어 IMemoryCache는 ASP.NET Core 종속성 주입을 기본적으로 사용합니다.

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

캐시 지침

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

IMemoryCache 사용

Warning

종속성 주입에서 공유 메모리 캐시를 사용하고, 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일이 지나면 캐시에서 제거됩니다.

다음 코드는 데이터를 사용하고 GetOrCreateGetOrCreateAsync 캐시합니다.

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

이전 코드에서 강조 표시된 두 줄은 캐시 항목의 크기를 설정하는 것과 동일한 결과를 가져옵니다. 호출을 new MemoryCacheOptions()에 편리하게 연결할 수 있도록 SetSize가 제공됩니다.

MemoryCache.Compact

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

• 만료된 모든 항목.
• 우선 순위별 항목. 우선 순위가 가장 낮은 항목이 먼저 제거됩니다.
• 가장 최근에 사용한 개체.
• 절대 만료가 가장 빠른 항목.
• 상대 만료가 가장 빠른 항목.

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

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

자세한 내용은 GitHub의 Compact 소스를 참조하세요.

캐시 종속성

다음 샘플에서는 종속 항목이 만료될 경우 캐시 항목을 만료하는 방법을 보여 줍니다. 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, Set, Remove)에 대한 모든 활동은 만료된 항목에 대한 백그라운드 검색을 트리거할 수 있습니다. 또한 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 및 Program.cs의 다른 많은 Add{Service} 메서드를 호출하면 IMemoryCache가 활성화됩니다. 이전 Add{Service} 메서드 중 하나를 호출하지 않는 앱의 경우 Program.cs에서 AddMemoryCache를 호출해야 할 수도 있습니다.

백그라운드 캐시 업데이트

IHostedService와 같은 백그라운드 서비스를 사용하여 캐시를 업데이트합니다. 백그라운드 서비스는 항목을 다시 컴파일한 다음, 준비가 된 경우에만 캐시에 할당할 수 있습니다.

추가 리소스

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