ASP.NET Core'da bellek içi önbellek

Rick Anderson, John Luo ve Steve Smith tarafından

Önbelleğe alma, içerik oluşturmak için gereken çalışmayı azaltarak uygulamanın performansını ve ölçeklenebilirliğini önemli ölçüde artırabilir. Önbelleğe alma, seyrek değişen ve oluşturulması pahalı olan verilerle en iyi şekilde çalışır. Önbelleğe alma, kaynaktan çok daha hızlı döndürülebilen verilerin bir kopyasını oluşturur. Uygulamalar hiçbir zaman önbelleğe alınmış verilere bağımlı olmayacak şekilde yazılmalı ve test edilmelidir.

ASP.NET Core birkaç farklı önbelleği destekler. En basit önbellek IMemoryCache üzerine kuruludur. IMemoryCache , web sunucusunun belleğinde depolanan bir önbelleği temsil eder. Bir sunucu grubunda (birden çok sunucu) çalışan uygulamalar, bellek içi önbelleği kullanırken oturumların yapışkan olmasını sağlamalıdır. Yapışkan oturumlar, bir istemciden gelen isteklerin tümünün aynı sunucuya gitmesini sağlar. Örneğin, Azure Web uygulamaları tüm istekleri aynı sunucuya yönlendirmek için Uygulama İsteği Yönlendirmesi'ni (ARR) kullanır.

Web grubundaki yapışkan olmayan oturumlar, önbellek tutarlılığı sorunlarını önlemek için dağıtılmış bir önbellek gerektirir. Bazı uygulamalarda, dağıtılmış önbellek bellek içi önbellekten daha yüksek ölçeği genişletmeyi destekleyebilir. Dağıtılmış önbellek kullanmak, önbellek belleğini bir dış işleme boşaltır.

Bellek içi önbellek herhangi bir nesneyi depolayabilir. Dağıtılmış önbellek arabirimi byte[] ile sınırlıdır. Bellek içi ve dağıtılmış önbellek deposu önbellek öğelerini anahtar-değer çiftleri olarak depolar.

System.Runtime.Caching/MemoryCache

System.Runtime.Caching / MemoryCache (NuGet paketi) ile kullanılabilir:

• .NET Standard 2.0 veya üzeri.
• .NET Standard 2.0 veya üstünü hedefleyen herhangi bir .NET uygulaması. Örneğin, ASP.NET Core 3.1 veya daha yeni bir sürümü.
• .NET Framework 4.5 veya üzeri.

Microsoft.Extensions.Caching.Memory/IMemoryCache (bu makalede açıklanmıştır), ASP.NET Core ile daha iyi tümleştirildiğinden System.Runtime.Caching/MemoryCache önerilir. Örneğin, IMemoryCache ASP.NET Core bağımlılık enjeksiyonu ile doğal olarak çalışır.

kodu ASP.NET 4.x'ten ASP.NET Core'a aktarırken uyumluluk köprüsü olarak kullanın System.Runtime.Caching/MemoryCache .

Önbellek yönergeleri

• Kod her zaman verileri getirmek için bir geri dönüş seçeneğine sahip olmalı ve önbelleğe alınmış bir değerin kullanılabilir olmasına bağlı olmamalıdır .
• Önbellekte az miktarda kaynak ve bellek kullanılır. Önbellek büyümesini sınırla:
  • Önbelleğe dış giriş eklemeyin . Örneğin, kullanıcı tarafından sağlanan rastgele girişin önbellek anahtarı olarak kullanılması önerilmez çünkü giriş öngörülemeyen miktarda bellek tüketebilir.
  • Önbellek büyümesini sınırlamak için süre sonu kullanma.
  • Önbellek boyutunu sınırlamak için SetSize, Size ve SizeLimit kullanın. ASP.NET Core çalışma zamanı, bellek baskısına göre önbellek boyutunu sınırlamaz . Önbellek boyutunu sınırlamak geliştiriciye bağlı.

IMemoryCache kullanma

Uyarı

Paylaşılan bir bellek önbelleğini Bağımlılık Enjeksiyonu ile kullanmak ve önbellek boyutunu sınırlamak için SetSize, Size veya SizeLimit çağrısı yapmak uygulamanın başarısız olmasına neden olabilir. Önbellekte boyut sınırı ayarlandığında, tüm girdiler eklenirken bir boyut belirtmelidir. Geliştiriciler paylaşılan önbelleği kullananlar üzerinde tam denetime sahip olmadığından bu sorunlara yol açabilir. Önbelleği sınırlamak için SetSize, Size veya SizeLimit kullanırken, önbelleğe alma için bir önbellek singletonu oluşturun. Daha fazla bilgi ve örnek için bkz. Önbellek boyutunu sınırlamak için SetSize, Size ve SizeLimit kullanma. Paylaşılan önbellek, diğer çerçeveler veya kitaplıklar tarafından paylaşılan önbellektir.

Bellek içi önbelleğe alma, Bağımlılık Enjeksiyonu kullanılarak bir uygulamadan referans verilen bir hizmettir. Oluşturucudaki IMemoryCache örneği isteyin:

public class IndexModel : PageModel
{
    private readonly IMemoryCache _memoryCache;

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

    // ...

Aşağıdaki kod, bir saatin önbellekte olup olmadığını denetlemek için kullanır TryGetValue . Eğer bir zaman önbelleğe alınmamışsa, yeni bir giriş oluşturulur ve Set ile önbelleğe eklenir.

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

Önceki kodda, önbellek girişi üç saniyelik kayan süre sonu ile yapılandırılır. Önbellek girdisine üç saniyeden fazla erişilmezse önbellekten çıkarılır. Önbellek girdisine her erişildiğinde, önbellekte 3 saniye daha kalır. CacheKeys sınıfı, indirme örneğinin bir parçasıdır.

Geçerli saat ve önbelleğe alınan süre görüntülenir:

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

Aşağıdaki kod, Set uzantı yöntemini kullanarak MemoryCacheEntryOptions olmadan, verileri göreli bir süre için önbelleğe alır:

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

Önceki kodda, önbellek girdisi bir günlük göreli süre sonuyla yapılandırılır. Önbellek girdisi, bu zaman aşımı süresi içinde erişilmiş olsa bile bir gün sonra önbellekten çıkarılır.

Aşağıdaki kod, verileri önbelleğe almak için GetOrCreate ve GetOrCreateAsync kullanır.

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

    // ...
}

Önbelleğe alınmış zamanı getirmek için aşağıdaki kod Get'yi çağırır:

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

Aşağıdaki kod, mutlak süre sonuyla önbelleğe alınmış bir öğe alır veya oluşturur:

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

Yalnızca kayan süre sonu olan önbelleğe alınmış bir öğe kümesinin süresi hiç dolmama riski altındadır. Önbelleğe alınan öğeye kayan süre sonu aralığı içinde tekrar tekrar erişilirse, öğenin süresi hiçbir zaman dolmaz. Öğenin süresinin dolduğundan emin olmak için kayan süre sonunu mutlak süre sonuyla birleştirin. Mutlak süre sonu, öğenin ne kadar süre önbelleğe alınabileceğine ilişkin bir üst sınır ayarlar ve kayan süre sonu aralığı içinde istenmezse öğenin süresinin daha erken dolmasına izin verir. Kayan süre sonu aralığı veya mutlak süre sonu süresi geçerse, öğe önbellekten çıkarılır.

Aşağıdaki kod, hem kayan hem de mutlak süre sonu olan önbelleğe alınmış bir öğeyi alır ve oluşturur.

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

Yukarıdaki kod, verilerin mutlak süreden daha uzun süre önbelleğe alınmayacağını garanti eder.

GetOrCreate, GetOrCreateAsyncve Get sınıfındaki CacheExtensions uzantı yöntemleridir. Bu yöntemler, IMemoryCache'ün yeteneğini genişletir.

MemoryCacheEntryOptions

Aşağıdaki örnek:

• Önbellek önceliğini CacheItemPriority.NeverRemove olarak ayarlar.
• Girdi önbellekten çıkarıldıktan sonra çağrılan bir PostEvictionDelegate ayarlar. Geri çağırma, öğeyi önbellekten kaldıran koddan farklı bir iş parçacığında çalıştırılır.

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

Önbellek boyutunu sınırlamak için SetSize, Size ve SizeLimit kullanma

Bir MemoryCache örnek isteğe bağlı olarak bir boyut sınırı belirtebilir ve zorunlu kılabilir. Önbellekte girdilerin boyutunu ölçen bir mekanizma olmadığından önbellek boyutu sınırı tanımlı bir ölçü birimine sahip değildir. Önbellek boyutu sınırı ayarlanırsa, tüm girdilerin boyutu belirtmesi gerekir. ASP.NET Core çalışma zamanı, bellek baskısına bağlı olarak önbellek boyutunu sınırlamaz. Önbellek boyutunu sınırlamak geliştiriciye bağlı. Belirtilen boyut, geliştiricinin seçtiği birim cinsindendir.

Örneğin:

• Web uygulaması birincil olarak dizeleri önbelleğe almaksa, her önbellek girdisi boyutu dize uzunluğu olabilir.
• Uygulama tüm girişlerin boyutunu 1 olarak belirtebilir ve boyut sınırı girdi sayısıdır.

SizeLimit ayarlanmadıysa, önbellek sınırsız büyür. ASP.NET Core çalışma zamanı, sistem belleği düşük olduğunda önbelleği kırpmaz. Uygulamaların mimarisinin şu şekilde tasarlanması gerekir:

• Önbellek büyümesini sınırlayın.
• Kullanılabilir bellek sınırlı olduğunda Compact veya Remove çağır.

Aşağıdaki kodMemoryCache ile erişilebilen bir birimsiz sabit boyut oluşturur:

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

SizeLimit birimleri yoktur. Önbellek boyutu sınırı ayarlandıysa, önbelleğe alınan girdilerin boyutu en uygun olarak değerlendirdikleri birimlerde belirtmesi gerekir. Önbellek örneğinin tüm kullanıcıları aynı birim sistemini kullanmalıdır. Önbelleğe alınan girdi boyutlarının toplamı tarafından SizeLimitbelirtilen değeri aşarsa bir girdi önbelleğe alınmaz. Önbellek boyutu sınırı ayarlı değilse, girdide ayarlanan önbellek boyutu yoksayılır.

Aşağıdaki kod MyMemoryCache'yi bağımlılık ekleme kapsayıcısına kaydeder:

var builder = WebApplication.CreateBuilder(args);

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

MyMemoryCache , bu boyut sınırlı önbelleğin farkında olan ve önbellek giriş boyutunu uygun şekilde ayarlamayı bilen bileşenler için bağımsız bir bellek önbelleği olarak oluşturulur.

Önbellek girdisinin boyutu, uzantı yöntemi veya SetSize özelliği kullanılarak Size ayarlanabilir:

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

Yukarıdaki kodda vurgulanan iki satır, önbellek girdisinin boyutunun ayarlanmasıyla aynı sonucu elde ediyor. SetSize , çağrıların new MemoryCacheOptions() ile zincirleme şekilde yapılabilmesi için kolaylık sağlar.

MemoryCache.Compact

MemoryCache.Compact önbelleğin belirtilen yüzdesini aşağıdaki sırayla kaldırmaya çalışır:

• Süresi dolan tüm öğeler.
• Önceliğe göre öğeler. En düşük öncelikli öğeler önce kaldırılır.
• En az yakın zamanda kullanılan nesneler.
• En erken mutlak süre sonu olan öğeler.
• En erken kayan süre sonu olan öğeler.

Önceliğe NeverRemove sahip sabitlenmiş öğeler hiçbir zaman kaldırılmaz. Aşağıdaki kod bir önbellek öğesini kaldırır ve önbelleğe alınmış girdilerin 25% kaldırmayı çağırır Compact :

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

Daha fazla bilgi için GitHub'daki Compact kaynağına bakın.

Önbellek bağımlılıkları

Aşağıdaki örnek, bağımlı bir girişin süresi dolduğunda önbellek girişinin nasıl sona erdirileceğini gösterir. Önbelleğe alınan öğeye bir CancellationChangeToken eklenir. Cancel üzerinde CancellationTokenSource çağrıldığında, her iki önbellek girdisi de çıkarılır.

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

Bir CancellationTokenSource kullanarak birden çok önbellek girdisi grup olarak kaldırılabilir. using Yukarıdaki koddaki desenle, using kapsamı içinde oluşturulan önbellek girdileri tetikleyicileri ve süre sonu ayarlarını devralır.

Ek notlar

• Süresinin dolması arka planda gerçekleşmez. Süresi dolan öğeler için önbelleği etkin bir şekilde tarayan zamanlayıcı yoktur. Önbellekteki herhangi bir etkinlik (Get, TryGetValue, Set, Remove) süresi dolan öğeler için arka plan taraması tetikleyebilir. CancellationTokenSource (CancelAfter) üzerindeki bir zamanlayıcı, aynı zamanda girdiyi kaldırır ve süresi dolan öğeler için bir tarama tetikler. Aşağıdaki örnekte kayıtlı belirteç için kullanılır CancellationTokenSource(TimeSpan) . Bu jeton tetiklendiğinde, kaydı hemen kaldırır ve geriye çağırma işlevlerini çalıştırır.

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

• Önbellek öğesini yeniden doldurmaya yönelik bir geri çağırma kullanılırken:

  • Geri çağırma tamamlanmadığından birden çok istek önbelleğe alınmış anahtar değerini boş bulabilir.
  • Bu, önbelleğe alınmış öğeyi birkaç iş parçacığının yeniden doldurmasıyla sonuçlanabilir.

• Bir önbellek girdisi başka bir önbellek girişi oluşturmak için kullanıldığında, alt öğe üst girdinin süre sonu belirteçlerini ve zamana bağlı süre sonu ayarlarını kopyalar. Ebeveyn girişinin el ile kaldırılması veya güncellenmesiyle çocuğun süresi dolmaz.

• Önbellek girdisi önbellekten çıkarıldıktan sonra tetiklenecek geri çağırmaları ayarlamak için kullanın PostEvictionCallbacks .

• Çoğu uygulamada IMemoryCache etkindir. Örneğin, AddMvc, AddControllersWithViews, AddRazorPages, AddMvcCore().AddRazorViewEngine ve birçok başka Add{Service} yönteminin Program.cs içinde çağrılması IMemoryCache öğesini etkinleştirir. Önceki Add{Service} yöntemlerinden birini çağırmayan uygulamalar için, AddMemoryCache içinde Program.cs çağrısı yapılması gerekebilir.

Arka plan önbelleği güncelleştirmesi

Önbelleği güncelleştirmek için gibi bir IHostedService kullanın. Arka plan hizmeti girdileri yeniden derleyebilir ve sonra bunları yalnızca hazır olduklarında önbelleğe atayabilir.

Ek kaynaklar

• Örnek kodu görüntüleme veya indirme (indirme)
• ASP.NET Core'da dağıtılmış önbelleğe alma
• ASP.NET Core'da değişiklik belirteçleriyle değişiklikleri algılama
• ASP.NET Core'da yanıtı önbelleğe alma
• ASP.NET Core'da Yanıt Önbelleğe Alma Ara Yazılımı
• ASP.NET Core MVC'de Önbellek Etiketi Yardımcısı
• ASP.NET Core'da Dağıtılmış Önbellek Etiketi Yardımcısı