Add distributed cache redis and sql server

aimenux · aimenux · commit 82f2d669b391 · 2025-08-17T23:13:19.000+02:00
diff --git a/Api/Api.csproj b/Api/Api.csproj
@@ -5,6 +5,8 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Caching.SqlServer" Version="9.0.8" />
+    <PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="9.0.8" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="9.0.8" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.8" />
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.8" />
diff --git a/Api/Startup.Ioc.cs b/Api/Startup.Ioc.cs
@@ -1,8 +1,10 @@
+using System;
 using Domain.Abstractions;
 using Domain.Configuration;
 using Domain.Services;
 using Infrastructure.DistributedCaches;
 using Infrastructure.HttpClients;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Api;
@@ -19,12 +21,35 @@ private void ConfigureIoc(IServiceCollection services)
             .AddHttpClient<IDummyClient, DummyClient>()
             .AddHttpMessageHandler<DummyMessageHandler>();
 
-        services.AddDistributedMemoryCache();
-
+        services.Configure<Settings>(Configuration.GetSection(Settings.SectionName));
+        
         services.AddSingleton<IDistributedCacheProvider, DistributedCacheProvider>();
-
-        services.Configure<Settings>(Configuration.GetSection(nameof(Settings)));
-
-        services.Configure<DistributedCacheOptions>(Configuration.GetSection(nameof(DistributedCacheOptions)));
+        
+        var settings = Configuration
+            .GetSection(Settings.SectionName)
+            .Get<Settings>();
+
+        switch (settings.CacheSettings.Source)
+        {
+            case nameof(CacheSource.Memory):
+                services.AddDistributedMemoryCache();
+                break;
+            case nameof(CacheSource.Redis):
+                services.AddStackExchangeRedisCache(options =>
+                {
+                    options.Configuration = settings.CacheSettings.Redis.ConnectionString;
+                });
+                break;
+            case nameof(CacheSource.SqlServer):
+                services.AddDistributedSqlServerCache(options =>
+                {
+                    options.ConnectionString = settings.CacheSettings.SqlServer.ConnectionString;
+                    options.SchemaName = settings.CacheSettings.SqlServer.SchemaName;
+                    options.TableName = settings.CacheSettings.SqlServer.TableName;
+                });
+                break;
+            default:
+                throw new NotSupportedException($"Distributed cache source '{settings.CacheSettings.Source}' is not supported.");
+        }
     }
 }
diff --git a/Api/Startup.cs b/Api/Startup.cs
@@ -21,7 +21,7 @@ public void ConfigureServices(IServiceCollection services)
     {
         services.AddControllers(options =>
         {
-            options.Filters.Add(typeof(ApiExceptionFilter));
+            options.Filters.Add<ApiExceptionFilter>();
         });
 
         ConfigureSwagger(services);
diff --git a/Api/appsettings.json b/Api/appsettings.json
@@ -41,9 +41,18 @@
       "https://twitter.com/",
       "https://www.snapchat.com/",
       "https://www.facebook.com/"
-    ]
-  },
-  "DistributedCacheOptions": {
-    "ExpirationInMinutes": 2
+    ],
+    "CacheSettings": {
+      "ExpirationInMinutes": 2,
+      "Source": "Memory",
+      "Redis": {
+        "ConnectionString": "localhost:6379"
+      },
+      "SqlServer": {
+        "ConnectionString": "Server=localhost,1433;Database=CacheDatabase;User Id=sa;Password=@Pa5sw0rd!;TrustServerCertificate=True;",
+        "SchemaName": "dbo",
+        "TableName": "CacheTable"
+      }
+    }
   }
 }
diff --git a/CreateDatabase.sql b/CreateDatabase.sql
@@ -0,0 +1,2 @@
+CREATE DATABASE CacheDatabase;
+GO
diff --git a/DistributedCacheDemo.sln b/DistributedCacheDemo.sln
@@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\ci.yml = .github\workflows\ci.yml
 		README.md = README.md
+		CreateDatabase.sql = CreateDatabase.sql
 	EndProjectSection
 EndProject
 Global
diff --git a/Domain/Configuration/CacheSettings.cs b/Domain/Configuration/CacheSettings.cs
@@ -0,0 +1,10 @@
+﻿namespace Domain.Configuration;
+
+public sealed record CacheSettings
+{
+    public int ExpirationInMinutes { get; init; } = 2;
+    public string Source { get; init; } = nameof(CacheSource.Memory);
+    public RedisSettings Redis { get; init; }
+    
+    public SqlServerSettings SqlServer { get; init; }
+}
diff --git a/Domain/Configuration/CacheSource.cs b/Domain/Configuration/CacheSource.cs
@@ -0,0 +1,8 @@
+﻿namespace Domain.Configuration;
+
+public enum CacheSource
+{
+    Memory,
+    Redis,
+    SqlServer
+}
diff --git a/Domain/Configuration/RedisSettings.cs b/Domain/Configuration/RedisSettings.cs
@@ -0,0 +1,6 @@
+﻿namespace Domain.Configuration;
+
+public sealed record RedisSettings
+{
+    public string ConnectionString { get; init; }
+}
diff --git a/Domain/Configuration/Settings.cs b/Domain/Configuration/Settings.cs
@@ -2,7 +2,11 @@
 
 namespace Domain.Configuration;
 
-public class Settings
+public sealed record Settings
 {
-    public ICollection<string> BlacklistUrls { get; set; }
+    public const string SectionName = "Settings";
+    
+    public ICollection<string> BlacklistUrls { get; init; }
+
+    public CacheSettings CacheSettings { get; init; }
 }
diff --git a/Domain/Configuration/SqlServerSettings.cs b/Domain/Configuration/SqlServerSettings.cs
@@ -0,0 +1,8 @@
+﻿namespace Domain.Configuration;
+
+public sealed record SqlServerSettings
+{
+    public string ConnectionString { get; init; }
+    public string SchemaName { get; init; }
+    public string TableName { get; init; }
+}
diff --git a/Infrastructure/DistributedCaches/DistributedCacheOptions.cs b/Infrastructure/DistributedCaches/DistributedCacheOptions.cs
diff --git a/Infrastructure/DistributedCaches/DistributedCacheProvider.cs b/Infrastructure/DistributedCaches/DistributedCacheProvider.cs
@@ -3,6 +3,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Domain.Abstractions;
+using Domain.Configuration;
 using Microsoft.Extensions.Caching.Distributed;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
@@ -12,10 +13,10 @@ namespace Infrastructure.DistributedCaches;
 public class DistributedCacheProvider : IDistributedCacheProvider
 {
     private readonly IDistributedCache _cache;
-    private readonly IOptions<DistributedCacheOptions> _options;
+    private readonly IOptions<CacheSettings> _options;
     private readonly ILogger<DistributedCacheProvider> _logger;
 
-    public DistributedCacheProvider(IDistributedCache cache, IOptions<DistributedCacheOptions> options, ILogger<DistributedCacheProvider> logger)
+    public DistributedCacheProvider(IDistributedCache cache, IOptions<CacheSettings> options, ILogger<DistributedCacheProvider> logger)
     {
         _cache = cache;
         _logger = logger;
diff --git a/README.md b/README.md
@@ -1,17 +1,36 @@
 [![.NET](https://github.com/aimenux/DistributedMemoryCacheDemo/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/aimenux/DistributedMemoryCacheDemo/actions/workflows/ci.yml)
 
-# DistributedMemoryCacheDemo
+# DistributedCacheDemo
 ```
-Using distributed memory cache in web api applications
+Using distributed cache in web api applications
 ```
 
-> In this repo, i m using a [distributed memory cache](https://docs.microsoft.com/en-us/aspnet/core/performance/caching/distributed?view=aspnetcore-5.0#distributed-memory-cache) in order to improve web api responsiveness.
->
-> 📢 Distributed memory cache is useful for development and testing scenarios and is not intended for production environements. 📢
+> In this repo, i m using a [distributed cache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/distributed) in order to improve web api responsiveness.
 >
+> Distributed cache source can be configured to use :
+> - [memory cache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/distributed#distributed-memory-cache)
+> - [redis cache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/distributed#distributed-redis-cache)
+> - [sql server cache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/distributed#distributed-sql-server-cache)
+
+> For redis cache, you can use docker to run redis server.
+> ```bash
+> docker run -d --name local-redis -p 6379:6379 redis/redis-stack-server:latest
+> ```
+
+> For sql server cache, you can use docker to run sql server.
+> ```bash
+> docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=@Pa5sw0rd!" -p 1433:1433 --name local-sqlserver -d mcr.microsoft.com/mssql/server:2022-latest
+> ```
+> Use the sql script `CreateDatabase.sql` in order to create the database `CacheDatabase`.
+> 
+> Use the global tool `dotnet-sql-cache` in order to create the table `CacheTable`.
+> ```bash
+> dotnet sql-cache create "Server=localhost,1433;Database=CacheDatabase;User Id=sa;Password=@Pa5sw0rd!;TrustServerCertificate=True;" dbo CacheTable
+> ```
+
 > The web api sample provided in this repo is based on :
 >
-> - a distributed memory cache in order to save/load cached websites
+> - a distributed cache in order to save/load cached websites
 >
 > - a service to compute content length for a white listed website
 >
@@ -20,4 +39,6 @@ Using distributed memory cache in web api applications
 > - a validation attribute to validate route parameters
 >
 
-**`Tools`** : net 9.0, distributed memory cache, serilog
+> 📢 Distributed memory cache is useful for development and testing scenarios and is not intended for production environements. 📢
+
+**`Tools`** : net 9.0, distributed cache, serilog

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public void ConfigureServices(IServiceCollection services)`
`21`	`21`	`{`
`22`	`22`	`services.AddControllers(options =>`
`23`	`23`	`{`
`24`		`- options.Filters.Add(typeof(ApiExceptionFilter));`
	`24`	`+ options.Filters.Add<ApiExceptionFilter>();`
`25`	`25`	`});`
`26`	`26`
`27`	`27`	`ConfigureSwagger(services);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+CREATE DATABASE CacheDatabase;`
	`2`	`+GO`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,11 @@`
`2`	`2`
`3`	`3`	`namespace Domain.Configuration;`
`4`	`4`
`5`		`-public class Settings`
	`5`	`+public sealed record Settings`
`6`	`6`	`{`
`7`		`- public ICollection<string> BlacklistUrls { get; set; }`
	`7`	`+ public const string SectionName = "Settings";`
	`8`	`+`
	`9`	`+ public ICollection<string> BlacklistUrls { get; init; }`
	`10`	`+`
	`11`	`+ public CacheSettings CacheSettings { get; init; }`
`8`	`12`	`}`