CleanArchitecture.Extensions.Caching 0.2.9

CleanArchitecture.Extensions.Caching

Simple setup for the JaysonTaylorCleanArchitectureBlank template.

Step 1 - Install the package

Install in both Application and Infrastructure projects:

dotnet add src/Application/Application.csproj package CleanArchitecture.Extensions.Caching
dotnet add src/Infrastructure/Infrastructure.csproj package CleanArchitecture.Extensions.Caching

Step 2 - Register caching services (Infrastructure layer)

File: src/Infrastructure/DependencyInjection.cs

Add the package and register caching:

using CleanArchitecture.Extensions.Caching;
using CleanArchitecture.Extensions.Caching.Options;

public static void AddInfrastructureServices(this IHostApplicationBuilder builder)
{
    // existing registrations...

    builder.Services.AddCleanArchitectureCaching(options =>
    {
        options.DefaultNamespace = "MyApp";
        options.MaxEntrySizeBytes = 256 * 1024;
        // Set Backend = CacheBackend.Distributed to force shared cache when IDistributedCache is configured.
    }, queryOptions =>
    {
        queryOptions.DefaultTtl = TimeSpan.FromMinutes(5);
    });
}

Step 3 - Register the caching behavior (Application layer)

File: src/Application/DependencyInjection.cs

Insert the caching behavior after Validation and before Performance:

using CleanArchitecture.Extensions.Caching.Behaviors;

builder.Services.AddMediatR(cfg =>
{
    cfg.RegisterServicesFromAssembly(Assembly.GetExecutingAssembly());
    cfg.AddOpenRequestPreProcessor(typeof(LoggingBehaviour<>));
    cfg.AddOpenBehavior(typeof(UnhandledExceptionBehaviour<,>));
    cfg.AddOpenBehavior(typeof(AuthorizationBehaviour<,>));
    cfg.AddOpenBehavior(typeof(ValidationBehaviour<,>));
    // Add caching behavior below this line ----
    cfg.AddOpenBehavior(typeof(QueryCachingBehavior<,>));
    // Add caching behavior above this line ----
    cfg.AddOpenBehavior(typeof(PerformanceBehaviour<,>));
});

Step 4 - Opt-in queries

Only queries that opt in are cached by default. Use the marker interface or attribute:

using CleanArchitecture.Extensions.Caching;
using CleanArchitecture.Extensions.Caching.Abstractions;

[CacheableQuery]
public record GetTodosQuery : IRequest<TodosVm>;

// or
public record GetUserQuery(int Id) : IRequest<UserDto>, ICacheableQuery;

// If your query cannot be serialized for hashing (e.g., contains delegates or HttpContext),
// implement ICacheKeyProvider to supply a deterministic hash:
public record GetReportQuery(Func<int> Factory) : IRequest<ReportDto>, ICacheableQuery, ICacheKeyProvider
{
    public string GetCacheHash(ICacheKeyFactory keyFactory) => keyFactory.CreateHash(new { Version = 1 });
}

Step 5 - What to expect

• Only queries marked with ICacheableQuery or [CacheableQuery] are cached by default.
• First request is a cache miss; the second identical request is a cache hit.
• Default TTL is 5 minutes; override with QueryCachingBehaviorOptions.DefaultTtl or TtlByRequestType.
• Debug logs show Cache hit and Cache miss messages when caching is active.