PabloCache.Abstractions 0.1.0-alpha

PabloCache Component

The PabloCache component provides an abstraction layer for a versatile caching mechanism in a .NET application. It is designed to be easily integrated into your project using the Microsoft.Extensions.DependencyInjection framework.

ICacheService Interface

The ICacheService interface, found in the PabloCache.Abstractions.Api.Services namespace, defines methods for interacting with the cache. It includes the following methods:

• GetCachedValue<T>: Retrieves a cached value by providing a cache key, a resolver function to generate the value if not found, and an optional time-to-live (TTL) in minutes.

    Task<T> GetCachedValue<T>(string cacheKey, Func<Task<T>> resolver, int ttlMinutes = 5) where T : class;
  

• TryGetCachedValue<T>: Attempts to retrieve a cached value by providing a cache key, a resolver function to generate the value if not found, and an optional time-to-live (TTL) in minutes. Unlike GetCachedValue, this method returns a nullable result.

    Task<T?> TryGetCachedValue<T>(string cacheKey, Func<Task<T?>> resolver, int ttlMinutes = 5) where T : class;
  

IPabloCacheComponent Interface

The IPabloCacheComponent interface, found in the PabloCache.Abstractions.Configuration namespace, defines a method for configuring the caching component within the Dependency Injection framework.

• SetCacheService<T>: Sets the cache service implementation type, allowing customization of the caching behavior. The ServiceLifetime parameter specifies the lifetime of the service in the DI container.

    IPabloCacheComponent SetCacheService<T>(ServiceLifetime lifetime = ServiceLifetime.Scoped) where T : ICacheService;
  

ServiceCollectionExtensions

The ServiceCollectionExtensions class, found in the PabloCache.Abstractions.Configuration namespace, provides an extension method for IServiceCollection to simplify the registration of the PabloCache component.

• AddPabloCaching: Adds the PabloCache component to the service collection. It accepts an optional configuration delegate for customizing the component before registration.

    public static IServiceCollection AddPabloCaching(this IServiceCollection services, Action<IPabloCacheComponent>? componentConfig = null);
  

Usage Example:

services.AddPabloCaching(component => 
{
    // Set your own implementation of the cache service
    component.SetCacheService<CustomCacheService>(ServiceLifetime.Singleton);
});