带你走进redis的封装及注入使用
Redis（Remote Dictionary Server )，即远程字典服务，是一个开源的使用ANSI C语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库，并提供多种语言的API。
本内容对Redis进行简单的封装。使用框架为StackExchange.Redis
定于redis的配置选项，主要用来读取配置
public class RedisOption
{
public const string sectionName = "RedisConfig";
public string ConnectionString { get; set; }
}
定义缓存接口 IRedisOperationRepository ，在代码中使用接口，减少依赖，可以进行扩展，假如有一天我使用的这个框架停用了，
我可以使用其他框架比如ServiceStack.Redis，或者用自带的memory, 或者mongodb。主要是在替换的时候减少代码的修改量
using StackExchange.Redis;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace WebApplication2
{
/// <summary>
/// Redis缓存接口
/// </summary>
public interface IRedisOperationRepository
{
//获取 Reids 缓存值
Task<string> Get(string key);
//获取值，并序列化
Task<TEntity> Get<TEntity>(string key);
//保存
Task Set(string key, object value, TimeSpan cacheTime);
//判断是否存在
Task<bool> Exist(string key);
//移除某一个缓存值
Task Remove(string key);
//全部清除
Task Clear();
/// <summary>
/// 根据key获取RedisValue
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<RedisValue[]> ListRangeAsync(string redisKey);
/// <summary>
/// 在列表头部插入值。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
Task<long> ListLeftPushAsync(string redisKey, string redisValue);
/// <summary>
/// 在列表尾部插入值。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
Task<long> ListRightPushAsync(string redisKey, string redisValue);
/// <summary>
/// 在列表尾部插入数组集合。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
Task<long> ListRightPushAsync(string redisKey, IEnumerable<string> redisValue);
/// <summary>
/// 移除并返回存储在该键列表的第一个元素 反序列化
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<T> ListLeftPopAsync<T>(string redisKey) where T : class;
/// <summary>
/// 移除并返回存储在该键列表的最后一个元素 反序列化
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<T> ListRightPopAsync<T>(string redisKey) where T : class;
/// <summary>
/// 移除并返回存储在该键列表的第一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<string> ListLeftPopAsync(string redisKey);
/// <summary>
/// 移除并返回存储在该键列表的最后一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<string> ListRightPopAsync(string redisKey);
/// <summary>
/// 列表长度
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
Task<long> ListLengthAsync(string redisKey);
/// <summary>
/// 返回在该列表上键所对应的元素
/// </summary>
/// <param name="redisKey"></param>
/// <param name="db"></param>
/// <returns></returns>
Task<IEnumerable<string>> ListRangeAsync(string redisKey, int db = -1);
/// <summary>
/// 根据索引获取指定位置数据
/// </summary>
/// <param name="redisKey"></param>
/// <param name="start"></param>
/// <param name="stop"></param>
/// <returns></returns>
Task<IEnumerable<string>> ListRangeAsync(string redisKey, int start, int stop);
/// <summary>
/// 删除List中的元素 并返回删除的个数
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="type"></param>
/// <returns></returns>
Task<long> ListDelRangeAsync(string redisKey, string redisValue, long type = 0);
/// <summary>
/// 清空List
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
Task ListClearAsync(string redisKey);
/// <summary>
/// 有序集合/定时任务延迟队列用的多
/// </summary>
/// <param name="redisKey">key</param>
/// <param name="redisValue">元素</param>
/// <param name="score">分数</param>
Task SortedSetAddAsync(string redisKey, string redisValue, double score);
}
}
继承IRedisOperationRepository接口，实现类
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using StackExchange.Redis;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace WebApplication2
{
public class RedisOperationRepository : IRedisOperationRepository
{
private readonly ILogger<RedisOperationRepository> _logger;
private readonly ConnectionMultiplexer _redis;
private readonly IDatabase _database;
public RedisOperationRepository(ILogger<RedisOperationRepository> logger, ConnectionMultiplexer redis)
{
_logger = logger;
_redis = redis;
_database = redis.GetDatabase();
}
private IServer GetServer()
{
var endpoint = _redis.GetEndPoints();
return _redis.GetServer(endpoint.First());
}
public async Task Clear()
{
foreach (var endPoint in _redis.GetEndPoints())
{
var server = GetServer();
foreach (var key in server.Keys())
{
await _database.KeyDeleteAsync(key);
}
}
}
public async Task<bool> Exist(string key)
{
return await _database.KeyExistsAsync(key);
}
public async Task<string> Get(string key)
{
return await _database.StringGetAsync(key);
}
public async Task Remove(string key)
{
await _database.KeyDeleteAsync(key);
}
public async Task Set(string key, object value, TimeSpan cacheTime)
{
if (value != null)
{
//序列化，将object值生成RedisValue
await _database.StringSetAsync(key, JsonConvert.SerializeObject(value), cacheTime);
}
}
public async Task<TEntity> Get<TEntity>(string key)
{
var value = await _database.StringGetAsync(key);
if (value.HasValue)
{
//需要用的反序列化，将Redis存储的Byte[]，进行反序列化
return JsonConvert.DeserializeObject<TEntity>(value);
}
else
{
return default;
}
}
/// <summary>
/// 根据key获取RedisValue
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<RedisValue[]> ListRangeAsync(string redisKey)
{
return await _database.ListRangeAsync(redisKey);
}
/// <summary>
/// 在列表头部插入值。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListLeftPushAsync(string redisKey, string redisValue)
{
return await _database.ListLeftPushAsync(redisKey, redisValue);
}
/// <summary>
/// 在列表尾部插入值。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListRightPushAsync(string redisKey, string redisValue)
{
return await _database.ListRightPushAsync(redisKey, redisValue);
}
/// <summary>
/// 在列表尾部插入数组集合。如果键不存在，先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListRightPushAsync(string redisKey, IEnumerable<string> redisValue)
{
var redislist = new List<RedisValue>();
foreach (var item in redisValue)
{
redislist.Add(item);
}
return await _database.ListRightPushAsync(redisKey, redislist.ToArray());
}
/// <summary>
/// 移除并返回存储在该键列表的第一个元素 反序列化
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<T> ListLeftPopAsync<T>(string redisKey) where T : class
{
var cacheValue = await _database.ListLeftPopAsync(redisKey);
if (string.IsNullOrEmpty(cacheValue)) return null;
var res = JsonConvert.DeserializeObject<T>(cacheValue);
return res;
}
/// <summary>
/// 移除并返回存储在该键列表的最后一个元素 反序列化
/// 只能是对象集合
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<T> ListRightPopAsync<T>(string redisKey) where T : class
{
var cacheValue = await _database.ListRightPopAsync(redisKey);
if (string.IsNullOrEmpty(cacheValue)) return null;
var res = JsonConvert.DeserializeObject<T>(cacheValue);
return res;
}
/// <summary>
/// 移除并返回存储在该键列表的第一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<string> ListLeftPopAsync(string redisKey)
{
return await _database.ListLeftPopAsync(redisKey);
}
/// <summary>
/// 移除并返回存储在该键列表的最后一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<string> ListRightPopAsync(string redisKey)
{
return await _database.ListRightPopAsync(redisKey);
}
/// <summary>
/// 列表长度
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<long> ListLengthAsync(string redisKey)
{
return await _database.ListLengthAsync(redisKey);
}
/// <summary>
/// 返回在该列表上键所对应的元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<IEnumerable<string>> ListRangeAsync(string redisKey, int db = -1)
{
var result = await _database.ListRangeAsync(redisKey);
return result.Select(o => o.ToString());
}
/// <summary>
/// 根据索引获取指定位置数据
/// </summary>
/// <param name="redisKey"></param>
/// <param name="start"></param>
/// <param name="stop"></param>
/// <returns></returns>
public async Task<IEnumerable<string>> ListRangeAsync(string redisKey, int start, int stop)
{
var result = await _database.ListRangeAsync(redisKey, start, stop);
return result.Select(o => o.ToString());
}
/// <summary>
/// 删除List中的元素 并返回删除的个数
/// </summary>
/// <param name="redisKey">key</param>
/// <param name="redisValue">元素</param>
/// <param name="type">大于零 : 从表头开始向表尾搜索，小于零 : 从表尾开始向表头搜索，等于零：移除表中所有与 VALUE 相等的值</param>
/// <returns></returns>
public async Task<long> ListDelRangeAsync(string redisKey, string redisValue, long type = 0)
{
return await _database.ListRemoveAsync(redisKey, redisValue, type);
}
/// <summary>
/// 清空List
/// </summary>
/// <param name="redisKey"></param>
public async Task ListClearAsync(string redisKey)
{
await _database.ListTrimAsync(redisKey, 1, 0);
}
/// <summary>
/// 有序集合/定时任务延迟队列用的多
/// </summary>
/// <param name="redisKey">key</param>
/// <param name="redisValue">元素</param>
/// <param name="score">分数</param>
public async Task SortedSetAddAsync(string redisKey, string redisValue, double score)
{
await _database.SortedSetAddAsync(redisKey, redisValue, score);
}
}
}
为IServiceCollection 定义一个扩展类，主要是用于注入单例的服务，这边提供了两个扩展方法，其他配置可以有需要可以在RedisOption里面加。
/// <summary>
/// Redis缓存 启用服务
/// </summary>
public static class RedisCacheSetupExtensions
{
public static void AddRedisCacheSetup(this IServiceCollection services,RedisOption redisOption)
{
if (services == null) throw new ArgumentNullException(nameof(services));
services.AddTransient<IRedisOperationRepository, RedisOperationRepository>();
// 配置启动Redis服务，虽然可能影响项目启动速度，但是不能在运行的时候报错，所以是合理的
services.AddSingleton<ConnectionMultiplexer>(sp =>
{
//获取连接字符串
string redisConfiguration = redisOption.ConnectionString;
var configuration = ConfigurationOptions.Parse(redisConfiguration, true);
configuration.ResolveDns = true;
return ConnectionMultiplexer.Connect(configuration);
});
}
public static void AddRedisCacheSetup(this IServiceCollection services, ConfigurationOptions configurationOptions)
{
if (services == null) throw new ArgumentNullException(nameof(services));
services.AddTransient<IRedisOperationRepository, RedisOperationRepository>();
// 配置启动Redis服务，虽然可能影响项目启动速度，但是不能在运行的时候报错，所以是合理的
services.AddSingleton<ConnectionMultiplexer>(sp =>
{
return ConnectionMultiplexer.Connect(configurationOptions);
});
}
}
进行服务配置
public void ConfigureServices(IServiceCollection services)
{
RedisOption redisOption= confiiguration.GetSection(RedisOption.sectionName).Get<RedisOption>();
//Redis缓存
services.AddRedisCacheSetup(redisOption);
services.AddControllersWithViews();
}
appsettings.json 里面的连接配置，有密码的要带上密码，我这边不用密码，使用第二个，第一个被我注释了。
"RedisConfig": {
// "ConnectionString": "127.0.0.1:6379,password=,connectTimeout=3000,connectRetry=1,syncTimeout=10000,DefaultDatabase=10" //redis数据库连接字符串
"ConnectionString": "127.0.0.1:6379,connectTimeout=3000,connectRetry=1,syncTimeout=10000,DefaultDatabase=10"
}
对缓存redis 进行注入使用。
public class HomeController : Controller
{
private readonly IRedisOperationRepository redisOperationRepository;
public HomeController(IRedisOperationRepository redisOperationRepository)
{
this.redisOperationRepository = redisOperationRepository;
}
// GET: HomeController
public ActionResult Index()
{
redisOperationRepository.Set("name", "keyy" ,TimeSpan.FromSeconds(100));
return View();
}
}
经过以上的配置，就可以进行运用了。
使用场景一般有商品秒杀，菜单加载，其他配置选项，用于数据变动不大的每日公告等缓存。
代码路径在https://gitee.com/Henry173265046/redisdemo
3888
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
