RedisHelper .Net Core StackExchange.Redis
Install-Package StackExchange.Redis -Version 2.0.601using StackExchange.Redis;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.Serialization.Formatters.Binary;
using System.Text;
using System.Threading.Tasks;
namespace RedisDemo
{
///
/// Redis 助手
///
public class RedisHelper
{
///
/// 连接字符串
///
private readonly string ConnectionString;
///
/// redis 连接对象
///
private IConnectionMultiplexer _connMultiplexer;
///
/// 默认的 Key 值（用来当作 RedisKey 的前缀）
///
private readonly string DefaultKey;
///
/// 锁
///
private readonly object Locker = new object();
///
/// 数据库
///
private readonly IDatabase _db;
///
/// 获取 Redis 连接对象
///
///
/// 设置 key 并保存字符串（如果 key 已存在，则覆盖值）
///
///
///
///
///
/// 保存多个 Key-value
///
///
/// > keyValuePairs)
{
keyValuePairs =
keyValuePairs.Select(x => new KeyValuePair(AddKeyPrefix(x.Key), x.Value));
return _db.StringSet(keyValuePairs.ToArray());
}
///
/// 获取字符串
///
///
///
///
/// 存储一个对象（该对象会被序列化保存）
///
///
///
///
/// (string redisKey, T redisValue, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(redisValue);
return _db.StringSet(redisKey, json, expiry);
}
///
/// 获取一个对象（会进行反序列化）
///
///
///
/// (string redisKey, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(_db.StringGet(redisKey));
}
#region async
///
/// 保存一个字符串值
///
///
///
///
/// StringSetAsync(string redisKey, string redisValue, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.StringSetAsync(redisKey, redisValue, expiry);
}
///
/// 保存一组字符串值
///
///
/// StringSetAsync(IEnumerable> keyValuePairs)
{
keyValuePairs =
keyValuePairs.Select(x => new KeyValuePair(AddKeyPrefix(x.Key), x.Value));
return await _db.StringSetAsync(keyValuePairs.ToArray());
}
///
/// 获取单个值
///
///
///
///
/// StringGetAsync(string redisKey, string redisValue, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.StringGetAsync(redisKey);
}
///
/// 存储一个对象（该对象会被序列化保存）
///
///
///
///
/// StringSetAsync(string redisKey, T redisValue, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(redisValue);
return await _db.StringSetAsync(redisKey, json, expiry);
}
///
/// 获取一个对象（会进行反序列化）
///
///
///
/// StringGetAsync(string redisKey, TimeSpan? expiry = null)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(await _db.StringGetAsync(redisKey));
}
#endregion async
#endregion String 操作
#region Hash 操作
///
/// 判断该字段是否存在 hash 中
///
///
///
///
/// 从 hash 中移除指定字段
///
///
///
///
/// 从 hash 中移除指定字段
///
///
///
/// hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashDelete(redisKey, hashField.ToArray());
}
///
/// 在 hash 设定值
///
///
///
///
///
/// 在 hash 中设定值
///
///
///
public void HashSet(string redisKey, IEnumerable hashFields)
{
redisKey = AddKeyPrefix(redisKey);
_db.HashSet(redisKey, hashFields.ToArray());
}
///
/// 在 hash 中获取值
///
///
///
///
/// 在 hash 中获取值
///
///
///
///
///
/// 从 hash 返回所有的字段值
///
///
/// HashKeys(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashKeys(redisKey);
}
///
/// 返回 hash 中的所有值
///
///
///
/// 在 hash 设定值（序列化）
///
///
///
///
/// (string redisKey, string hashField, T value)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(value);
return _db.HashSet(redisKey, hashField, json);
}
///
/// 在 hash 中获取值（反序列化）
///
///
///
/// (string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(_db.HashGet(redisKey, hashField));
}
#region async
///
/// 判断该字段是否存在 hash 中
///
///
///
/// HashExistsAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashExistsAsync(redisKey, hashField);
}
///
/// 从 hash 中移除指定字段
///
///
///
/// HashDeleteAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashDeleteAsync(redisKey, hashField);
}
///
/// 从 hash 中移除指定字段
///
///
///
/// HashDeleteAsync(string redisKey, IEnumerable hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashDeleteAsync(redisKey, hashField.ToArray());
}
///
/// 在 hash 设定值
///
///
///
///
/// HashSetAsync(string redisKey, string hashField, string value)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashSetAsync(redisKey, hashField, value);
}
///
/// 在 hash 中设定值
///
///
///
public async Task HashSetAsync(string redisKey, IEnumerable hashFields)
{
redisKey = AddKeyPrefix(redisKey);
await _db.HashSetAsync(redisKey, hashFields.ToArray());
}
///
/// 在 hash 中获取值
///
///
///
/// HashGetAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashGetAsync(redisKey, hashField);
}
///
/// 在 hash 中获取值
///
///
///
///
/// > HashGetAsync(string redisKey, RedisValue[] hashField, string value)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashGetAsync(redisKey, hashField);
}
///
/// 从 hash 返回所有的字段值
///
///
/// > HashKeysAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashKeysAsync(redisKey);
}
///
/// 返回 hash 中的所有值
///
///
/// > HashValuesAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashValuesAsync(redisKey);
}
///
/// 在 hash 设定值（序列化）
///
///
///
///
/// HashSetAsync(string redisKey, string hashField, T value)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(value);
return await _db.HashSetAsync(redisKey, hashField, json);
}
///
/// 在 hash 中获取值（反序列化）
///
///
///
/// HashGetAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(await _db.HashGetAsync(redisKey, hashField));
}
#endregion async
#endregion Hash 操作
#region List 操作
///
/// 移除并返回存储在该键列表的第一个元素
///
///
///
/// 移除并返回存储在该键列表的最后一个元素
///
///
///
/// 移除列表指定键上与该值相同的元素
///
///
///
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
///
///
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
///
///
///
/// 返回列表上该键的长度，如果不存在，返回 0
///
///
///
/// 返回在该列表上键所对应的元素
///
///
/// ListRange(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRange(redisKey);
}
///
/// 移除并返回存储在该键列表的第一个元素
///
///
/// (string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(_db.ListLeftPop(redisKey));
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
///
/// (string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(_db.ListRightPop(redisKey));
}
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
///
///
/// (string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRightPush(redisKey, Serialize(redisValue));
}
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
///
///
/// (string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListLeftPush(redisKey, Serialize(redisValue));
}
#region List-async
///
/// 移除并返回存储在该键列表的第一个元素
///
///
/// ListLeftPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPopAsync(redisKey);
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
///
/// ListRightPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRightPopAsync(redisKey);
}
///
/// 移除列表指定键上与该值相同的元素
///
///
///
/// ListRemoveAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRemoveAsync(redisKey, redisValue);
}
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
///
///
/// ListRightPushAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRightPushAsync(redisKey, redisValue);
}
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
///
///
/// ListLeftPushAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPushAsync(redisKey, redisValue);
}
///
/// 返回列表上该键的长度，如果不存在，返回 0
///
///
/// ListLengthAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLengthAsync(redisKey);
}
///
/// 返回在该列表上键所对应的元素
///
///
/// > ListRangeAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRangeAsync(redisKey);
}
///
/// 移除并返回存储在该键列表的第一个元素
///
///
/// ListLeftPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(await _db.ListLeftPopAsync(redisKey));
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
///
/// ListRightPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize(await _db.ListRightPopAsync(redisKey));
}
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
///
///
/// ListRightPushAsync(string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRightPushAsync(redisKey, Serialize(redisValue));
}
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
///
///
/// ListLeftPushAsync(string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPushAsync(redisKey, Serialize(redisValue));
}
#endregion List-async
#endregion List 操作
#region SortedSet 操作
///
/// SortedSet 新增
///
///
///
///
///
/// 在有序集合中返回指定范围的元素，默认情况下从低到高。
///
///
/// SortedSetRangeByRank(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.SortedSetRangeByRank(redisKey);
}
///
/// 返回有序集合的元素个数
///
///
///
/// 返回有序集合的元素个数
///
///
///
///
/// SortedSet 新增
///
///
///
///
/// (string redisKey, T member, double score)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(member);
return _db.SortedSetAdd(redisKey, json, score);
}
#region SortedSet-Async
///
/// SortedSet 新增
///
///
///
///
/// SortedSetAddAsync(string redisKey, string member, double score)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetAddAsync(redisKey, member, score);
}
///
/// 在有序集合中返回指定范围的元素，默认情况下从低到高。
///
///
/// > SortedSetRangeByRankAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetRangeByRankAsync(redisKey);
}
///
/// 返回有序集合的元素个数
///
///
/// SortedSetLengthAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetLengthAsync(redisKey);
}
///
/// 返回有序集合的元素个数
///
///
///
/// SortedSetRemoveAsync(string redisKey, string memebr)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetRemoveAsync(redisKey, memebr);
}
///
/// SortedSet 新增
///
///
///
///
/// SortedSetAddAsync(string redisKey, T member, double score)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(member);
return await _db.SortedSetAddAsync(redisKey, json, score);
}
#endregion SortedSet-Async
#endregion SortedSet 操作
#region key 操作
///
/// 移除指定 Key
///
///
///
/// 移除指定 Key
///
///
/// redisKeys)
{
var keys = redisKeys.Select(x => (RedisKey)AddKeyPrefix(x));
return _db.KeyDelete(keys.ToArray());
}
///
/// 校验 Key 是否存在
///
///
///
/// 重命名 Key
///
///
///
///
/// 设置 Key 的时间
///
///
///
///
/// 移除指定 Key
///
///
/// KeyDeleteAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyDeleteAsync(redisKey);
}
///
/// 移除指定 Key
///
///
/// KeyDeleteAsync(IEnumerable redisKeys)
{
var keys = redisKeys.Select(x => (RedisKey)AddKeyPrefix(x));
return await _db.KeyDeleteAsync(keys.ToArray());
}
///
/// 校验 Key 是否存在
///
///
/// KeyExistsAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyExistsAsync(redisKey);
}
///
/// 重命名 Key
///
///
///
/// KeyRenameAsync(string redisKey, string redisNewKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyRenameAsync(redisKey, redisNewKey);
}
///
/// 设置 Key 的时间
///
///
///
/// KeyExpireAsync(string redisKey, TimeSpan? expiry)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyExpireAsync(redisKey, expiry);
}
#endregion key-async
#endregion key 操作
#region 发布订阅
///
/// 订阅
///
///
///
public void Subscribe(RedisChannel channel, Action handle)
{
var sub = _connMultiplexer.GetSubscriber();
sub.Subscribe(channel, handle);
}
///
/// 发布
///
///
///
///
/// 发布（使用序列化）
///
/// (RedisChannel channel, T message)
{
var sub = _connMultiplexer.GetSubscriber();
return sub.Publish(channel, Serialize(message));
}
#region 发布订阅-async
///
/// 订阅
///
///
///
public async Task SubscribeAsync(RedisChannel channel, Action handle)
{
var sub = _connMultiplexer.GetSubscriber();
await sub.SubscribeAsync(channel, handle);
}
///
/// 发布
///
///
///
/// PublishAsync(RedisChannel channel, RedisValue message)
{
var sub = _connMultiplexer.GetSubscriber();
return await sub.PublishAsync(channel, message);
}
///
/// 发布（使用序列化）
///
/// PublishAsync(RedisChannel channel, T message)
{
var sub = _connMultiplexer.GetSubscriber();
return await sub.PublishAsync(channel, Serialize(message));
}
#endregion 发布订阅-async
#endregion 发布订阅
#region private method
///
/// 添加 Key 的前缀
///
///
///
/// 添加注册事件
///
private void AddRegisterEvent()
{
_connMultiplexer.ConnectionRestored += ConnMultiplexer_ConnectionRestored;
_connMultiplexer.ConnectionFailed += ConnMultiplexer_ConnectionFailed;
_connMultiplexer.ErrorMessage += ConnMultiplexer_ErrorMessage;
_connMultiplexer.ConfigurationChanged += ConnMultiplexer_ConfigurationChanged;
_connMultiplexer.HashSlotMoved += ConnMultiplexer_HashSlotMoved;
_connMultiplexer.InternalError += ConnMultiplexer_InternalError;
_connMultiplexer.ConfigurationChangedBroadcast += ConnMultiplexer_ConfigurationChangedBroadcast;
}
///
/// 重新配置广播时（通常意味着主从同步更改）
///
///
///
private static void ConnMultiplexer_ConfigurationChangedBroadcast(object sender, EndPointEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConfigurationChangedBroadcast)}: {e.EndPoint}");
}
///
/// 发生内部错误时（主要用于调试）
///
///
///
private static void ConnMultiplexer_InternalError(object sender, InternalErrorEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_InternalError)}: {e.Exception}");
}
///
/// 更改集群时
///
///
///
private static void ConnMultiplexer_HashSlotMoved(object sender, HashSlotMovedEventArgs e)
{
Console.WriteLine(
$"{nameof(ConnMultiplexer_HashSlotMoved)}: {nameof(e.OldEndPoint)}-{e.OldEndPoint} To {nameof(e.NewEndPoint)}-{e.NewEndPoint}, ");
}
///
/// 配置更改时
///
///
///
private static void ConnMultiplexer_ConfigurationChanged(object sender, EndPointEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConfigurationChanged)}: {e.EndPoint}");
}
///
/// 发生错误时
///
///
///
private static void ConnMultiplexer_ErrorMessage(object sender, RedisErrorEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ErrorMessage)}: {e.Message}");
}
///
/// 物理连接失败时
///
///
///
private static void ConnMultiplexer_ConnectionFailed(object sender, ConnectionFailedEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConnectionFailed)}: {e.Exception}");
}
///
/// 建立物理连接时
///
///
///
private static void ConnMultiplexer_ConnectionRestored(object sender, ConnectionFailedEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConnectionRestored)}: {e.Exception}");
}
#endregion 注册事件
///
/// 序列化
///
///
///
/// 反序列化
///
/// (byte[] data)
{
if (data == null)
return default(T);
var binaryFormatter = new BinaryFormatter();
using (var memoryStream = new MemoryStream(data))
{
var result = (T)binaryFormatter.Deserialize(memoryStream);
return result;
}
}
#endregion private method
}
}
引入nuget ,然后，放进去 RedisHelper，然后，就开始使用。