using System; using System.Linq; using StackExchange.Redis; using System.Configuration; using System.Collections.Generic; using System.Runtime.Serialization.Formatters.Binary; using System.IO; using System.Threading.Tasks; using System.Runtime.Serialization; using System.Text; namespace IStation { /// /// Redis客户端辅助类 /// public class RedisClientHelper { /// /// redis 连接对象 /// private static IConnectionMultiplexer _connMultiplexer; /// /// 锁 /// private static readonly object Locker = new object(); /// /// 数据库访问对象 /// private readonly IDatabase _db; /// /// 采用双重锁单例模式,保证数据访问对象有且仅有一个 /// /// public IConnectionMultiplexer GetConnectionRedisMultiplexer() { if ((_connMultiplexer == null || !_connMultiplexer.IsConnected)) { lock (Locker) { if ((_connMultiplexer == null || !_connMultiplexer.IsConnected)) { _connMultiplexer = ConnectionMultiplexer.Connect(Settings.Redis.Url); } } } return _connMultiplexer; } /// /// 添加事务处理 /// /// public ITransaction GetTransaction() { //创建事务 return _db.CreateTransaction(); } #region 构造函数 /// /// 静态的构造函数, /// 构造函数是属于类的,而不是属于实例的 /// 就是说这个构造函数只会被执行一次。也就是在创建第一个实例或引用任何静态成员之前,由.NET自动调用。 /// static RedisClientHelper() { _connMultiplexer = ConnectionMultiplexer.Connect(Settings.Redis.Url); RegisterEvent(); } /// /// 重载构造器,获取redis内部数据库的交互式连接 /// /// 要获取的数据库ID public RedisClientHelper(int db = -1) { _db = _connMultiplexer.GetDatabase(db); } #endregion #region 通用方法 /// /// 序列化,用于存储对象 /// private static byte[] Serialize(object obj) { try { if (obj == null) return null; var binaryFormatter = new BinaryFormatter(); using (var memoryStream = new MemoryStream()) { binaryFormatter.Serialize(memoryStream, obj); var data = memoryStream.ToArray(); return data; } } catch (SerializationException ex) { throw ex; } } /// /// 反序列化,用于解码对象 /// private static T Deserialize(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 #region stringGet /// /// 设置key,并保存字符串(如果key 已存在,则覆盖) /// public bool StringSet(string redisKey, string redisValue, TimeSpan? expried = null) { return _db.StringSet(redisKey, redisValue, expried); } public bool StringSetJson(string redisKey, T redisValue, TimeSpan? expried = null) { var json = JsonHelper.Object2Json(redisValue); return _db.StringSet(redisKey, json, expried); } /// /// 保存多个key-value /// /// /// public bool StringSet(IEnumerable> keyValuePairs) { keyValuePairs = keyValuePairs.Select(x => new KeyValuePair(x.Key, x.Value)); return _db.StringSet(keyValuePairs.ToArray()); } /// /// 获取字符串 /// /// /// /// public RedisValue StringGet(string redisKey) { try { return _db.StringGet(redisKey); } catch (TypeAccessException ex) { throw ex; } } public T StringGetJson(string redisKey) { return JsonHelper.Json2Object(_db.StringGet(redisKey)); } /// /// 获取字符串(多个) /// /// /// public RedisValue[] StringGet(List redisKey) { if (redisKey == null || redisKey.Count() == 0) return null; try { List redisKey2 = new List(); redisKey.ForEach(t => redisKey2.Add(t)); return _db.StringGet(redisKey2.ToArray()); } catch (TypeAccessException ex) { throw ex; } } /// /// 存储一个对象,该对象会被序列化存储 /// /// /// /// /// /// public bool StringSet(string redisKey, T redisValue, TimeSpan? expired = null) { var json = Serialize(redisKey); return _db.StringSet(redisKey, json, expired); } /// /// 获取一个对象(会进行反序列化) /// /// /// /// public T StringSet(string redisKey) { return Deserialize(_db.StringGet(redisKey)); } /// /// 保存一个字符串值 /// /// /// /// /// public async Task StringSetAsync(string redisKey, string redisValue, TimeSpan? expired = null) { return await _db.StringSetAsync(redisKey, redisValue, expired); } /// /// 保存一个字符串值 /// /// /// public async Task StringSetAsync(IEnumerable> keyValuePairs) { if (keyValuePairs == null || keyValuePairs.Count() == 0) return false; keyValuePairs = keyValuePairs.Select(x => new KeyValuePair(x.Key, x.Value)); return await _db.StringSetAsync(keyValuePairs.ToArray()); } /// /// 获取单个值 /// /// /// /// /// public async Task StringGetAsync(string redisKey, string redisValue, TimeSpan? expired = null) { return await _db.StringGetAsync(redisKey); } /// /// 存储一个对象(该对象会被序列化保存) /// /// /// /// /// /// public async Task StringSetAsync(string redisKey, string redisValue, TimeSpan? expired = null) { var json = Serialize(redisValue); return await _db.StringSetAsync(redisKey, json, expired); } /// /// 获取一个对象(反序列化) /// /// /// /// /// /// public async Task StringGetAsync(string redisKey, string redisValue, TimeSpan? expired = null) { return Deserialize(await _db.StringGetAsync(redisKey)); } #endregion #region Hash /// /// 判断字段是否在hash中 /// /// /// /// public bool HashExist(string redisKey, string hashField) { return _db.HashExists(redisKey, hashField); } /// /// 从hash 中删除字段 /// /// /// /// public bool HashDelete(string redisKey, string hashField) { return _db.HashDelete(redisKey, hashField); } /// /// 从hash中移除指定字段 /// /// /// /// public long HashDelete(string redisKey, IEnumerable hashField) { return _db.HashDelete(redisKey, hashField.ToArray()); } /// /// 在hash中设定值 /// /// /// /// /// public bool HashSet(string redisKey, string hashField, string value) { return _db.HashSet(redisKey, hashField, value); } /// /// 从Hash 中获取值 /// public RedisValue HashGet(string redisKey, string hashField) { return _db.HashGet(redisKey, hashField); } /// /// 从Hash 中获取值 /// /// /// /// public RedisValue[] HashGet(string redisKey, RedisValue[] hashField) { return _db.HashGet(redisKey, hashField); } /// /// 获取所有 /// /// /// public HashEntry[] HashGetAll(string redisKey) { return _db.HashGetAll(redisKey); } /// /// 从hash 返回所有的key值 /// /// /// public IEnumerable HashKeys(string redisKey) { return _db.HashKeys(redisKey); } /// /// 根据key返回hash中的值 /// public RedisValue[] HashValues(string redisKey) { return _db.HashValues(redisKey); } /// /// 根据关键词模糊匹配所有key /// /// /// public string[] AllKeys(string keyPattern) { var script = "return redis.call('keys',@pattern)"; var prepared = LuaScript.Prepare(script); var cacheResult = _db.ScriptEvaluate(prepared, new { pattern = keyPattern }); if (cacheResult.IsNull) { return null; } return (string[])cacheResult; } /// /// 在hash中设定值 /// public bool HashSet(string redisKey, string hashField, T value) { var json = Serialize(value); return _db.HashSet(redisKey, hashField, json); } /// /// 在hash 中获取值 (反序列化) /// public T HashGet(string redisKey, string hashField) { return Deserialize(_db.HashGet(redisKey, hashField)); } /// /// 在hash 中获取所有值 (反序列化) /// public List HashGetAll(string RedisKey) { var all = _db.HashValues(RedisKey); if (all == null || all.Count() < 1) return default; return all.Select(x => Deserialize(x)).ToList(); } /// /// 在hash中设定值 json序列化 /// public bool HashSetJosn(string redisKey, string hashField, T value) { var json = JsonHelper.Object2Json(value); return _db.HashSet(redisKey,hashField,json); } /// /// 在hash 中获取值 json反序列化 /// public T HashGetJson(string redisKey, string hashField) { var redisValue = _db.HashGet(redisKey, hashField); return JsonHelper.Json2Object(redisValue); } /// /// 在hash 中删除 hashkey /// public bool HashDeleteJson(string redisKey, string hashField) { return _db.HashDelete(redisKey, hashField); } /// /// 判断字段是否存在hash 中 /// public async Task HashExistsAsync(string redisKey, string hashField) { return await _db.HashExistsAsync(redisKey, hashField); } /// /// 从hash中移除指定字段 /// public async Task HashDeleteAsync(string redisKey, string hashField) { return await _db.HashDeleteAsync(redisKey, hashField); } /// /// 从hash中移除指定字段 /// public async Task HashDeleteAsync(string redisKey, IEnumerable hashField) { return await _db.HashDeleteAsync(redisKey, hashField.ToArray()); } /// /// 在hash 设置值 /// public async Task HashSetAsync(string redisKey, string hashField, string value) { return await _db.HashSetAsync(redisKey, hashField, value); } /// /// 在hash 中设定值 /// public async Task HashSetAsync(string redisKey, IEnumerable hashFields) { await _db.HashSetAsync(redisKey, hashFields.ToArray()); } /// /// 在hash 中设定值 /// public async Task HashGetAsync(string redisKey, string hashField) { return await _db.HashGetAsync(redisKey, hashField); } /// /// 在hash 中获取值 /// public async Task> HashGetAsync(string redisKey, RedisValue[] hashField, string value) { return await _db.HashGetAsync(redisKey, hashField); } /// /// 从hash返回所有的字段值 /// public async Task> HashKeysAsync(string redisKey) { return await _db.HashKeysAsync(redisKey); } /// /// 返回hash中所有的值 /// public async Task> HashValuesAsync(string redisKey) { return await _db.HashValuesAsync(redisKey); } /// /// 在hash 中设定值(序列化) /// public async Task HashSetAsync(string redisKey, string hashField, T value) { var json = Serialize(value); return await _db.HashSetAsync(redisKey, hashField, json); } /// /// 在hash中获取值(反序列化) /// public async Task HashGetAsync(string redisKey, string hashField) { return Deserialize(await _db.HashGetAsync(redisKey, hashField)); } #endregion #region list operation /// /// 移除并返回key所对应列表的第一个元素 /// /// /// public string ListLeftPop(string redisKey) { return _db.ListLeftPop(redisKey); } /// /// 移除并返回key所对应列表的最后一个元素 /// /// /// public string ListRightPop(string redisKey) { return _db.ListRightPop(redisKey); } /// /// 移除指定key及key所对应的元素 /// /// /// /// public long ListRemove(string redisKey, string redisValue) { return _db.ListRemove(redisKey, redisValue); } /// /// 在列表尾部插入值,如果键不存在,先创建再插入值 /// /// /// /// public long ListRightPush(string redisKey, string redisValue) { return _db.ListRightPush(redisKey, redisValue); } /// /// 在列表头部插入值,如果键不存在,先创建再插入值 /// /// /// /// public long ListLeftPush(string redisKey, string redisValue) { return _db.ListLeftPush(redisKey, redisValue); } /// /// 在列表头部插入值,如果键不存在,创建后插入值,先创建再插入值 /// /// /// /// /// public long ListLeftPush(string redisKey, T redisValue) { return _db.ListRightPush(redisKey, Serialize(redisValue)); } /// /// /// /// /// /// public void ListLtrim(string redisKey, long start, long stop) { _db.ListTrim(redisKey, start, stop); } /// /// 返回列表上该键的长度,如果不存在,返回0 /// /// /// public long ListLength(string redisKey) { return _db.ListLength(redisKey); } /// /// 返回在该列表上键所对应的元素 /// /// /// public IEnumerable ListRange(string redisKey) { try { return _db.ListRange(redisKey); } catch (Exception ex) { throw ex; } } /// /// 返回在该列表上键所对应的元素 /// /// /// 获取记录数量,默认一条 /// 是否加入前缀 /// public IEnumerable ListLastRecord(string redisKey, int iCount = 1) { try { return _db.ListRange(redisKey, 0, iCount - 1); } catch (Exception ex) { throw ex; } } /// /// 移除并返回存储在该键列表的第一个元素 /// /// /// /// public T ListLeftPop(string redisKey) { return Deserialize(_db.ListLeftPop(redisKey)); } /// /// 移除并返回该列表上的最后一个元素 /// /// /// /// public T ListRightPop(string redisKey) { return Deserialize(_db.ListRightPop(redisKey)); } /// /// 在列表尾部插入值,如果键不存在,先创建再插入值 /// /// /// /// /// public long ListRightPush(string redisKey, T redisValue) { return _db.ListRightPush(redisKey, Serialize(redisValue)); } /// /// 移除并返回存储在该键列表的第一个元素 /// /// /// public async Task ListLeftPopAsync(string redisKey) { return await _db.ListLeftPopAsync(redisKey); } /// /// 移除并返回存储在该键列表的最后一个元素 /// /// /// public async Task ListRightPopAsync(string redisKey) { return await _db.ListRightPopAsync(redisKey); } /// /// 移除列表指定键上与值相同的元素 /// /// /// public async Task ListRemoveAsync(string redisKey, string redisValue) { return await _db.ListRemoveAsync(redisKey, redisValue); } /// /// 在列表尾部差入值,如果键不存在,先创建后插入 /// /// /// /// public async Task ListRightPushAsync(string redisKey, string redisValue) { return await ListRightPushAsync(redisKey, redisValue); } /// /// 在列表头部插入值,如果键不存在,先创建后插入 /// /// /// /// public async Task ListLeftPushAsync(string redisKey, string redisValue) { return await _db.ListLeftPushAsync(redisKey, redisValue); } /// /// 返回列表上的长度,如果不存在,返回0 /// /// /// public async Task ListLengthAsync(string redisKey) { return await _db.ListLengthAsync(redisKey); } /// /// 返回在列表上键对应的元素 /// /// /// public async Task> ListRangeAsync(string redisKey) { return await _db.ListRangeAsync(redisKey); } /// /// 移除并返回存储在key对应列表的第一个元素 /// /// /// /// public async Task ListLeftPopAsync(string redisKey) { return Deserialize(await _db.ListLeftPopAsync(redisKey)); } /// /// 移除并返回存储在key 对应列表的最后一个元素 /// /// /// /// public async Task ListRightPopAsync(string redisKey) { return Deserialize(await _db.ListRightPopAsync(redisKey)); } /// /// 在列表尾部插入值,如果值不存在,先创建后写入值 /// /// /// /// /// public async Task ListRightPushAsync(string redisKey, string redisValue) { return await _db.ListRightPushAsync(redisKey, Serialize(redisValue)); } /// /// 在列表头部插入值,如果值不存在,先创建后写入值 /// /// /// /// /// public async Task ListLeftPushAsync(string redisKey, string redisValue) { return await _db.ListLeftPushAsync(redisKey, Serialize(redisValue)); } #endregion #region SortedSet 操作 /// /// sortedset 新增 /// /// /// /// /// public bool SortedSetAdd(string redisKey, string member, double score) { return _db.SortedSetAdd(redisKey, member, score); } /// /// 在有序集合中返回指定范围的元素,默认情况下由低到高 /// /// /// public IEnumerable SortedSetRangeByRank(string redisKey) { return _db.SortedSetRangeByRank(redisKey); } /// /// 返回有序集合的个数 /// /// /// public long SortedSetLength(string redisKey) { return _db.SortedSetLength(redisKey); } /// /// 返回有序集合的元素个数 /// /// /// /// public bool SortedSetLength(string redisKey, string member) { return _db.SortedSetRemove(redisKey, member); } /// /// sorted set Add /// /// /// /// /// /// public bool SortedSetAdd(string redisKey, T member, double score) { var json = Serialize(member); return _db.SortedSetAdd(redisKey, json, score); } #region SortedSet-Async /// /// SortedSet 新增 /// /// /// /// /// public async Task SortedSetAddAsync(string redisKey, string member, double score) { return await _db.SortedSetAddAsync(redisKey, member, score); } /// /// 在有序集合中返回指定范围的元素,默认情况下由低到高 /// /// /// public async Task> SortedSetRangeByRankAsync(string redisKey) { return await _db.SortedSetRangeByRankAsync(redisKey); } /// /// 返回有序集合的元素个数 /// /// /// public async Task SortedSetLengthAsync(string redisKey) { return await _db.SortedSetLengthAsync(redisKey); } /// /// 返回有序集合的元素个数 /// /// /// /// public async Task SortedSetRemoveAsync(string redisKey, string member) { return await _db.SortedSetRemoveAsync(redisKey, member); } /// /// SortedSet 新增 /// /// /// /// /// /// public async Task SortedSetAddAsync(string redisKey, T member, double score) { var json = Serialize(member); return await _db.SortedSetAddAsync(redisKey, json, score); } #endregion SortedSet-Async #endregion #region key operation /// /// 移除指定key /// /// /// public bool KeyDelete(string redisKey) { return _db.KeyDelete(redisKey); } /// /// 移除start开始的所有key /// /// 开始字符 /// public long KeyDeleteStartWidth(string start) { var mutlti = GetConnectionRedisMultiplexer(); List keyList = new List(); var endpoints = mutlti.GetEndPoints(); foreach (var ep in endpoints) { IServer server = mutlti.GetServer(ep); var keys = server.Keys(0, string.Format("{0}*", start)); foreach (var item in keys) { keyList.Add((string)item); } } //redisKey = AddKeyPrefix(redisKey); var keys2 = keyList.Select(x => (RedisKey)x); return _db.KeyDelete(keys2.ToArray()); } /// /// 删除指定key /// /// /// public long KeyDelete(IEnumerable redisKeys) { var keys = redisKeys.Select(x => (RedisKey)x); return _db.KeyDelete(keys.ToArray()); } /// /// 所有key /// /// /// public List AllKey() { var mutlti = GetConnectionRedisMultiplexer(); var endpoints = mutlti.GetEndPoints(); List keyList = new List(); foreach (var ep in endpoints) { var server = mutlti.GetServer(ep); var keys = server.Keys(0, "*"); foreach (var item in keys) { keyList.Add((string)item); } } //mutlti.Close(true); return keyList; // //throw new Exception(string.Join(",", keyList)); } /// /// 检验key是否存在 /// /// /// public List AllKeyStartWidth(string start) { var mutlti = GetConnectionRedisMultiplexer(); var endpoints = mutlti.GetEndPoints(); List keyList = new List(); foreach (var ep in endpoints) { var server = mutlti.GetServer(ep); var keys = server.Keys(0, string.Format("{0}*", start)); foreach (var item in keys) { keyList.Add((string)item); } } //mutlti.Close(true); return keyList; } /// /// 检验key是否存在 /// /// 外部输入匹配字符 /// public List AllKeyPattern(string pattern) { var mutlti = GetConnectionRedisMultiplexer(); var endpoints = mutlti.GetEndPoints(); //List keyList = new List(); var keyList = new List(); foreach (var ep in endpoints) { var server = mutlti.GetServer(ep); var keys = server.Keys(0, pattern); foreach (var item in keys) { keyList.Add(item); } } //mutlti.Close(true); return keyList; } /// /// 检验key是否存在 /// /// /// public bool KeyExists(string redisKey) { return _db.KeyExists(redisKey); } /// /// 重命名key /// /// /// /// public bool KeyReName(string oldKeyName, string newKeyName) { return _db.KeyRename(oldKeyName, newKeyName); } /// /// 设置key 的过期时间 /// /// /// /// public bool KeyExpire(string redisKey, TimeSpan? expired = null) { return _db.KeyExpire(redisKey, expired); } #region key-async /// /// 移除指定的key /// /// /// public async Task KeyDeleteAsync(string redisKey) { return await _db.KeyDeleteAsync(redisKey); } /// /// 删除指定的key /// /// /// public async Task KeyDeleteAsync(IEnumerable redisKeys) { var keys = redisKeys.Select(x => (RedisKey)x); return await _db.KeyDeleteAsync(keys.ToArray()); } /// /// 检验key 是否存在 /// /// /// public async Task KeyExistsAsync(string redisKey) { return await _db.KeyExistsAsync(redisKey); } /// /// 重命名key /// /// /// /// public async Task KeyRenameAsync(string redisKey, string redisNewKey) { return await _db.KeyRenameAsync(redisKey, redisNewKey); } /// /// 设置 key 时间 /// /// /// /// public async Task KeyExpireAsync(string redisKey, TimeSpan? expired) { return await _db.KeyExpireAsync(redisKey, expired); } #endregion key-async #endregion #region 发布订阅 /// /// 订阅 /// /// 频道 /// 事件 public void Subscribe(RedisChannel channel, Action handle) { //getSubscriber() 获取到指定服务器的发布者订阅者的连接 var sub = _connMultiplexer.GetSubscriber(); //订阅执行某些操作时改变了 优先/主动 节点广播 sub.Subscribe(channel, handle); } /// /// 发布 /// /// /// /// public long Publish(RedisChannel channel, RedisValue message) { var sub = _connMultiplexer.GetSubscriber(); return sub.Publish(channel, message); } /// /// 发布(使用序列化) /// /// /// /// /// public long Publish(RedisChannel channel, T message) { var sub = _connMultiplexer.GetSubscriber(); return sub.Publish(channel, Serialize(message)); } #region 发布订阅-async /// /// 订阅 /// /// /// /// public async Task SubscribeAsync(RedisChannel redisChannel, Action handle) { var sub = _connMultiplexer.GetSubscriber(); await sub.SubscribeAsync(redisChannel, handle); } /// /// 发布 /// /// /// /// public async Task PublishAsync(RedisChannel redisChannel, RedisValue message) { var sub = _connMultiplexer.GetSubscriber(); return await sub.PublishAsync(redisChannel, message); } /// /// 发布(使用序列化) /// /// /// /// /// public async Task PublishAsync(RedisChannel redisChannel, T message) { var sub = _connMultiplexer.GetSubscriber(); return await sub.PublishAsync(redisChannel, Serialize(message)); } #endregion 发布订阅-async #endregion #region 注册事件 /// /// 注册事件 /// private static void RegisterEvent() { _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 } }