Documentação do CacheChan

Visão Geral

O CacheChan é uma biblioteca para cache distribuído e local em aplicações .NET. Com suporte a LRU, TTL e integração com dashboards analíticos, o CacheChan simplifica a implementação de estratégias de cache eficientes.

Além das operações de cache, o CacheChan registra automaticamente métricas de uso (como hits, misses, set e remove) caso você informe sua API Key. Essa integração permite que você visualize o desempenho e a eficiência do cache diretamente na sua dashboard.

Instalação

Instale o CacheChan utilizando o NuGet Package Manager:

Install-Package CacheChan

Ou com o .NET CLI:

dotnet add package CacheChan

Início Rápido

O uso do CacheChan é simples e direto. Ao criar a instância do cache, você pode optar por registrar métricas automaticamente. Basta informar sua API Key ao criá-lo – se a API Key for fornecida, todas as operações serão registradas; caso contrário, o cache funcionará de forma convencional.

// Exemplo de uso em uma aplicação .NET
using CacheChan.Utils;
using CacheChan.Interfaces;

class Program
{
    static void Main()
    {
        // Criar cache com métricas (informa a API Key)
        ICacheService cacheComMetricas = CacheFactory.CreateCache("minha-api-key-123");
        
        // Operações de cache com registro automático das métricas
        cacheComMetricas.Set("user:123", new { Nome = "Vinícius", Idade = 23 });
        var user = cacheComMetricas.Get<dynamic>("user:123");
        cacheComMetricas.Remove("user:123");
        
        // Criar cache sem métricas (não informa a API Key)
        ICacheService cacheSemMetricas = CacheFactory.CreateCache();
        cacheSemMetricas.Set("teste", 42);
        var valor = cacheSemMetricas.Get<int>("teste");
    }
}

Em resumo, o usuário só precisa chamar CacheFactory.CreateCache() e, opcionalmente, passar a sua API Key. Se a API Key for informada, todas as operações de cache serão registradas automaticamente para exibição na dashboard.