• Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS
  • Docs
  • Comparisons
  • Blogs
  • Try NCache
  • Contact Us
Try NCache
Show / Hide Table of Contents

Using IDistributedCache in ASP.NET Core

Using IDistributedCache in ASP.NET Core with NCache improves application scalability and efficiency by allowing cached data to be shared across multiple application servers. With the implementation of the IDistributedCache interface in NCache, it becomes possible to have high-performance caching along with data integrity across multiple application servers.

Prerequisites

Before using this, ensure that the following prerequisites are fulfilled:

  • .NET
  • Install the following NuGet packages in your application based on your NCache edition:
    • NCache: NCache.Microsoft.Extensions.Caching
    • NCache Open Source: NCache.Microsoft.Extensions.Caching.OpenSource
  • The cache must be running.
  • The application must be connected to cache before performing the operation.
  • For API details, refer to: IDistributedCache, AddNCacheDistributedCache.
  • Make sure that the data being added is serializable.

How to Configure NCache as a Distributed Cache Provider

To use NCache through the IDistributedCache API, you need to add the cache configurations in the appsettings.json of your application. The following IDistributedCache example adds a section NCacheSettings which configures the cache name. You may change the name according to your registered cache.

Important

Make sure that the specified cache is running.

. . .
"NCacheSettings": {
    "CacheName": "defaultCache",
    "EnableLogs": "True",
    "ExceptionsEnabled": "True"
}
. . .
Note

To ensure the operation is fail-safe, it is recommended to handle any potential exceptions within your application, as explained in Handling Failures.

Once the cache configuration has been specified, use the NCache-provided AddNCacheDistributedCache method in Startup.cs to set NCache as the default cache for storing objects.

public void ConfigureServices(IServiceCollection services)
{
    services.AddNCacheDistributedCache(Configuration.GetSection("NCacheSettings"));
}

NCache is now the underlying cache for IDistributedCache. Let’s suppose our database contains information for a music store, including album information, genre, artist, order details, and so on. We proceed to fetch the details for an album, which is stored as an object of the Album class. The following code snippet attempts to get the album details based on the cache key. If the specified item is not found in the cache, it is fetched from the database and stored in the cache with an expiration of 10 minutes. If no operation is performed on this object within the next 10 minutes, it expires from the cache. Meanwhile, if it is fetched from the cache, it is returned as an object of Album.

public async Task<IActionResult> Details(
             [FromServices] IDistributedCache cache,
             int id)
{
            var cacheKey = string.Format("album1", id);
            Album album;
            object value;

            if (!cache.TryGetValue(cacheKey, out value)){
                album = await DbContext.Albums
                                .Where(a => a.AlbumId == id)
                                .Include(a => a.Artist)
                                .Include(a => a.Genre)
                                .FirstOrDefaultAsync();

                if (album != null)
                {
                    if (_appSettings.CacheDbResults)
                    {
                        // Remove it from cache if not retrieved in last 10 minutes
                        cache.SetObject(cacheKey, album, new DistributedCacheEntryOptions().SetSlidingExpiration(TimeSpan.FromMinutes(10)));
                    }
                }
            }
            else
            {
                album = value as Album;
            }
            if (album == null)
            {
                return NotFound();
            }
            return View(album);
   }

See Also

.NET: Alachisoft.NCache.Caching.Distributed namespace.

Contact Us

PHONE

+1 214-619-2601   (US)

+44 20 7993 8327   (UK)

 
EMAIL

sales@alachisoft.com

support@alachisoft.com

NCache
  • Edition Comparison
  • NCache Architecture
  • Benchmarks
Try NCache
Pricing
NCache Playground

Deployments
  • Cloud
  • Docker
  • Kubernetes
  • On-Premises
Technical Use Cases
  • ASP.NET Sessions
  • ASP.NET Core Sessions
  • Pub/Sub Messaging
  • SignalR Backplane
  • Internet of Things (IoT)
  • NoSQL Database
  • Stream Processing
  • Microservices
Resources
  • Blogs
  • Foundations
  • Videos
  • Comparisons
  • Shows
  • Whitepapers
  • Articles
  • Tech Talks
  • Magazine Articles
  • Third-Party Articles
Customer Case Studies
  • Testimonials
  • Customers
Support
  • Docs
  • Schedule a Demo
  • Tips
Company
  • Leadership
  • Partners
  • News
  • Events
  • Careers
Contact Us

  • EnglishChinese (Simplified)FrenchGermanItalianJapaneseKoreanPortugueseSpanish

  • Terms of Use
  •  
  • Privacy Policy
  •  
  • Cookie Policy
© Copyright Alachisoft 2002 - . All rights reserved. NCache is a registered trademark of Diyatech Corp.
  • Facebook
  • Twitter
  • Youtube
  • LinkedIn
  • RSS