BlogDoFt.RedisToggler 1.0.0-alpha.24

BlogDoFt.RedisToggler.Lib

Português

Esta biblioteca é um wrapper para a Microsoft.Extensions.Caching.StackExchangeRedis, adicionando a capacidade de se auto-desligar quando perceber uma queda do servidor Redis conectado. Desta forma, as requisições não ficarão lentas, aguardando pelo time-out do request ao Redis.

Ainda, quando o Redis retornar on-line, a biblioteca irá se religar automaticamente, tornando as funcionalidades de cache disponíveis outra vez.

Outra funcionalidade que esta biblioteca adiciona é a padronização de chaves. Desta forma, quando necessitar de compartilhar o cache entre aplicações diferentes, o padrão poderá garantir que as aplicações acessem sempre o mesmo conteúdo.

Configurando o cache

Ao configurar as dependências da sua aplicação, adicione uma chamada a .AddCacheWrapper(). Este método configura a conexão e o tipo de cache a ser utilizado.

builder.Services
    .AddCacheWrapper(opt =>
    {
        opt.ConnectionString = "localhost:6379,asyncTimeout=1000,connectTimeout=1000,password=<your-redis-password>,abortConnect=false";
        opt.CacheType = CacheType.Redis;
    });

O método configura uma instância da classe RedisToggler.Lib.Configurations.CacheConfig, responsável por configurar o cache. Os tipos suportados são:

• NoCache: Nenhuma funcionalidade de cache estará ativa;
• Redis: A aplicação irá utilizar o Redis como repositório de cache;
• Memory: A aplicação irá utilizar a memória como repositório de cache;

Veja a documentação em: CacheType.cs.

Configurando a entidade para cache

Como as entidades cacheadas podem seguir padrões de storage diferentes, a biblioteca possui a capacidade de adicionar configurações para cada entidade cacheada.

Para isso, basta adicionar uma instância de CacheEntryConfiguration como Singleton como dependência da aplicação.

builder.Services
    .AddSingleton(opt =>
    {
        return new CacheEntryConfiguration();
    })

Caso você possua mais de uma entidade sendo recuperada do cache, basta que você crie uma classe, herdando de CacheEntryConfiguration, e também a adicione como Singleton nas dependências da aplicação.

Como utilizar?

Adicione ao construtor da classe que utilizará o cache, uma dependência para IDistributedTypedCache<CacheEntryConfiguration>. Neste caso, estamos utilizando uma referência para CacheEntryConfiguration, mas caso você possua outra configuração, basta substituir a referência de CacheEntryConfiguration pela classe de configuração desejada.

Você pode consultar a documentação de IDistributedTypedCache<TEntryConfig> para mais detalhes. Ou pode ver o projeto de exemplo no github do projeto.