DevelopmentHelpers.AzureDistributedCache 10.0.0

DevelopmentHelpers.AzureDistributedCache

Overview

**DevelopmentHelpers.AzureDistributedCache is a library that simplifies access to Azure Redis Cache in .NET applications.

Installation

1. Add Configuration Settings to your appsettings.json file:

   {
     "DevelopmentHelpers" : {
      "AzureDistributedCacheConfiguration": {
     "DnsName": "--DNS--NAME",
     "ConnectionString": "-- Connection String --- "
     }
    }
   }  
   

2. Add the Development Helper Service

        builder.Services.AddAzureRedisCache(builder.Configuration);
   

Code Example

 public class IndexModel : PageModel
 {
     private readonly IDistributedCache cache;
     private const string cacheItem = "CacheTime";
     private readonly ILogger<IndexModel> _logger;

     public IndexModel(ILogger<IndexModel> logger, IDistributedCache cache)
     {

         this.cache = cache;
         _logger = logger;
     }

     public async Task OnGetAsync()
     {
         string value = await cache.GetStringAsync(cacheItem);
         if (value == null)
         {
             value = DateTime.Now.ToString();
             var options = new DistributedCacheEntryOptions();
             options.SetSlidingExpiration(TimeSpan.FromMinutes(10));
             await this.cache.SetStringAsync(cacheItem, value, options);
         }

         ViewData[cacheItem] = value;

         ViewData["CurrentTime"] = DateTime.Now.ToString();
     }
 }

Motivation

I needed a consistent and easy to use library in .net application.

API Reference (common IDistributedCache methods)

The library exposes/uses the platform IDistributedCache. Common methods:

• Task<string?> GetStringAsync(string key, CancellationToken token = default)
• Task SetStringAsync(string key, string value, DistributedCacheEntryOptions options, CancellationToken token = default)
• Task RemoveAsync(string key, CancellationToken token = default)
• Task<byte[]?> GetAsync(string key, CancellationToken token = default)
• Task SetAsync(string key, byte[] value, DistributedCacheEntryOptions options, CancellationToken token = default)
• Task RefreshAsync(string key, CancellationToken token = default)

Synchronous counterparts also exist on IDistributedCache (e.g., GetString, SetString, Get, Set, Remove), but prefer the async APIs.

Tests

Unit/integration tests in this project assume a configured IDistributedCache is available via your test DI setup. Run tests from the solution directory with:

• dotnet test

Example tests included in this repo show usage patterns for string and byte[] caching and removal.

Troubleshooting

• Ensure your Redis instance allows connections from your host (network rules/firewall).
• Use the correct TLS/SSL settings in your connection string if required by your Redis SKU.
• Check logs for connection or serialization errors.

Contributing & Standards

This project targets .NET 10 and follows the repository's contribution and formatting standards. See CONTRIBUTING.md and .editorconfig for coding style, naming conventions, and test requirements. Keep secrets out of source control — use environment variables or Azure Key Vault for connection strings in CI/CD.

License

Refer to the repository root for license information.