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 arayüzüne dayanmaktadır. 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, bir Azure web uygulaması tüm istekleri aynı sunucuya yönlendirmek için Microsoft Uygulama İsteği Yönlendirme (ARR) kullanır.

Bir 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'i kullan"

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

• .NET Standart 2.0 veya üzeri
• .NET Standard 2.0 veya sonrası için hedeflenen herhangi bir .NET uygulaması (ASP.NET Core 3.1 veya üzeri gibi)
• .NET Framework 4.5 veya üzeri

Microsoft. Extensions.Caching.Memory/IMemoryCache (bu makalede açıklanmıştır) System.Runtime.Caching/MemoryCache ASP.NET Core ile daha iyi tümleştirme sunduğundan ö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 .

Bellek içi önbelleğe alma yönergelerini gözden geçirin

Aşağıdaki yönergeler bellek içi önbelleğe alma için geçerlidir:

• 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ılabilirliğine bağlı olmamalıdır .

• Önbellek yetersiz bir kaynak olan belleği kullanı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ı önbellek boyutunu bellek baskısına göre sınırlandırmaz. Önbellek boyutunu sınırlamak geliştiricinin sorumluluğundadır.

IMemoryCache örneği oluşturma

Bellek içi önbelleğe alma, bir uygulamanın bağımlılık enjeksiyonu kullanarak eriştiği bir hizmettir.

Warning

Aynı önbellek birden çok çerçeve veya kitaplık tarafından kullanılıyorsa, bu paylaşılan bir önbellektir. Bağımlılık enjeksiyonu ile bir paylaşılan bellek önbelleği kullanıyorsanız ve önbellek boyutunu sınırlamak için SetSize, Size ve SizeLimit kullanıyorsanız, uygulama çökmeye veya hata vermeye müsait olabilir.

Önbellekte boyut sınırı ayarlandığında, tüm girdiler eklendiğinde bir boyut belirtmelidir. Geliştiriciler paylaşılan önbelleği kullananlar üzerinde tam denetime sahip olmadığından bu yaklaşım sorunlara yol açabilir.

Önbellek boyutunu SetSize yöntemiyle, Size özelliğiyle veya SizeLimit özelliğiyle sınırlamak için, önbelleğe alma amacıyla bir önbellek tekil örneği oluşturun. Daha fazla bilgi ve örnek için bkz. Önbellek boyutunu sınırlamak için SetSize, Size ve SizeLimit kullanma.

Oluşturucudaki IMemoryCache örneği isteyin:

public class IndexModel : PageModel
{
    private readonly IMemoryCache _memoryCache;

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

    // ...

Aşağıdaki kod, önbellekte bir zamanın olup olmadığını denetlemek için TryGetValue metodunu kullanır. Zaman önbelleğe alınmadığında, yeni bir giriş oluşturulur ve Set yöntemiyle ö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;
}

Yukarıdaki kodda, önbellek girdisi 3 saniyelik kayan süre sonu ile yapılandırılır. Önbellek girdisine 3 saniyeden fazla erişilmezse, girdi ö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. Zaman aşımı süresi boyunca girdiye erişilmiş olsa bile önbellek girdisi bir gün sonra önbellekten çıkarılır.

Aşağıdaki kod, verileri önbelleğe almak için GetOrCreate ve GetOrCreateAsync yöntemlerini 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);
        });

    // ...
}

Aşağıdaki kod önbelleğe alınmış zamanı getirmek için yöntemini çağırır Get :

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. Kayan süre sonunu mutlak süre sonuyla birleştirmek, öğenin süresinin dolmasına garanti eder. Mutlak süre sonu, öğenin ne kadar süreyle önbelleğe alınabileceğine ilişkin bir üst sınır ayarlar. Kayan süre sonu aralığı içinde öğe istenmezse, yine de öğ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ınmadığından emin olur.

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

Bir giriş için MemoryCacheEntryOptions oluşturun

Aşağıdaki örnek, bir giriş için MemoryCacheEntryOptions nasıl oluşturulacağını göstermektedir. Kod aşağıdaki görevleri tamamlar:

• Önbellek önceliğini CacheItemPriority.NeverRemove olarak ayarlar.

• Öğe önbellekten silindikten sonra çağrılacak bir PostEvictionDelegate ayarlar. Geri çağırma, öğeyi önbellekten kaldıran koddan farklı bir iş parçacığı üzerinde çalışı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}.");
}

SetSize, Size ve SizeLimit ile önbellek boyutunu sınırlama

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ı öncelikli olarak dizeleri önbelleğe alırsa, 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 Özellik ayarlanmadıysa, önbellek bağlı olmadan 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.
• Compact Kullanılabilir bellek sınırlı olduğunda veya Remove yöntemini çağırın.

Aşağıdaki kodMemoryCache yoluyla erişilebilen bir birimsiz sabit boyutlu örnek oluşturur:

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

SizeLimit özelliğinin birimleri yok. Önbelleğe alınan girdilerin, önbellek boyutu sınırı ayarlandığında en uygun olarak değerlendirdikleri birimlerde boyutu 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 örneğini bağımlı enjeksiyonu kapsayıcısıyla 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 yöntemi, çağrılar new MemoryCacheOptions() üzerine zincirlenirken kolaylık sağlamak için sağlanır.

MemoryCache.Compact ile önbellek öğelerini kaldırma

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

• Süresi dolan tüm öğeler
• Önce en düşük öncelikli öğelerin kaldırıldığı önceliğe göre öğeler
• En son 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 yüzde 25'ini kaldırmak için Compact yöntemini çağırır.

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

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

Süresi dolan bağımlılıkları olan önbellek girdisini çıkartma

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 yöntemi CancellationTokenSource nesnesi üzerinde ç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 nesne kullandığınızda, birden çok önbellek girdisini grup olarak çıkarabilirsiniz. using Yukarıdaki koddaki desenle, kapsamın using içinde oluşturulan önbellek girdileri tetikleyicileri ve süre sonu ayarlarını devralır.

Bellek içi önbelleğe alma hakkındaki notları gözden geçirme

Aşağıdaki notlar bellek içi önbelleğe alma için geçerlidir:

• 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, TryGetValueveya SetaracılığıylaRemove) süresi dolan öğeler için arka plan taraması tetikleyebilir. Nesne üzerinde CancellationTokenSource ayarlanmış bir zamanlayıcı (CancelAfter yöntemini kullanarak) girişi kaldırır ve süresi dolan öğeler için taramayı tetikler.

  Aşağıdaki örnek, kayıtlı belirteç için CancellationTokenSource(TimeSpan) aşırı yüklenmiş oluşturucuyu kullanır. 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);
  }
  

• Bir önbellek öğesini yeniden doldurmaya yönelik bir geri çağırma kullandığınızda:

  • Geri çağırma tamamlanmadığından birden çok istek önbelleğe alınmış anahtar değerinin boş olduğunu bulabilir.
  • Bu yaklaşım, önbelleğe alınmış öğenin birkaç iş parçacığı tarafından güncellenmesiyle sonuçlanabilir.

• Bir önbellek girdisi (üst) başka bir giriş (alt) oluşturduğunda, alt öğe üst girişin süre sonu belirteçlerini ve zamana bağlı süre sonu ayarlarını kopyalar. Üst girdi el ile kaldırıldığında veya güncelleştirildiğinde alt öğe süresi dolmaz.

• Önbellek öğesi PostEvictionCallbacks önbellekten çıkarıldıktan sonra hangi geri çağırmaların tetikleneceğini belirtmek için bu özelliği kullanın.

• Çoğu uygulamada IMemoryCache etkindir. Örneğin, AddMvc, AddControllersWithViews, AddRazorPages, AddMvcCore().AddRazorViewEngine ve birçok başka Add{Service} yöntemini Program.cs dosyasında çağırmak IMemoryCache etkinleştirir.

  Belirtilen Add{Service} yöntemlerinden birini çağırmayan uygulamalar için, Program.cs dosyasında AddMemoryCache yöntemini çağırmanız gerekebilir.

Arka plan önbellek güncelleştirmesi kullanma

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

İlgili içerik

• Örnek kodu görüntüleme veya indirme (indirme)
• ASP.NET Core'da değişiklik belirteçleriyle değişiklikleri algılama
• ASP.NET Core'da yanıtı önbelleğe alma