Redis学习总结
项目需要用到消息队列,了解到Redis是个不错的选择,因此学习了下Redis的使用。
1、Redis简介
REmote DIctionary Server(Redis) 是一个由Salvatore Sanfilippo写的key-value存储系统。Redis是一个开源的使用ANSI C语言编写、遵守BSD协议、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库,并提供多种语言的API。它通常被称为数据结构服务器,因为值(value)可以是 字符串(String), 哈希(Hash), 列表(list), 集合(sets) 和 有序集合(sorted sets)等类型。Redis是字典服务器,可以作为缓存服务器,本身支持MQ功能,所以完全可以当做一个轻量级的队列服务来使用。
本文针对作为消息队列进行分析。
2 、Redis消息队列
Redis消息队列是什么?
Redis消息队列的特点?
3 、Redis消息队列测试
3.1 安装
1.点击下载:Redis下载链接
2.Redis-x64-xxx.zip压缩包到 C 盘,解压后,将文件夹重新命名为 redis。
3.配置:管理员打开CMD 输入
C:\Redis 回车
redis-server.exe redis.windows.conf 回车
4、测试一下:管理员打开第二个CMD输入
C:\Redis 回车
redis-cli.exe -h 127.0.0.1 -p 6379回车
set myKey abc
get myKey
5.以服务形式安装:管理员打开CMD 输入
C:\Redis 回车
redis-server --service-install redis.windows.conf --loglevel verbose
(1)启动命令如下:
redis-server --service-start
(2)停止命令:
redis-server --service-stop
(3)卸载命令:
redis-server --service-uninstall
3.2 消息队列测试
测试程序开发环境VS2017,.net framework 4.5
1.创建C#控制台程序
2.nuget 安装1.26版本(2.0*版本有依赖)
3.创建工具类 RedisHelper(见文末)
4.创建数据模型ChatModels
[Serializable]
public class ChatModels
{
public string userId { get; set; }
public string chat { get; set; }
}
5.修改程序配置
<appSettings>
<add key="Redis.Defaultkey" value="console"/>
</appSettings>
<connectionStrings>
<add name="RedisConnectionString" connectionString="127.0.0.1:6379"/>
</connectionStrings>
6.在控制台中 编写如下逻辑:
static void Main(string[] args)
{
var redisClient = new RedisHelper(2);
int i= 0;
for (; ; )
{
Console.WriteLine("按回车退出循环,按Left入列,按right出列");
if (Console.ReadKey(true).Key == ConsoleKey.LeftArrow)
{
i++;
// 消息出列
ChatModels chatModels = new ChatModels() { userId = "userID"+i.ToString(), chat = "聊天内容 " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") };
var id = redisClient.ListRightPush<ChatModels>("MessageQuene", chatModels);
Console.WriteLine(string.Format("消息入列{2}:Useid={0},chat={1}", chatModels.userId, chatModels.chat, id));
}
else if (Console.ReadKey(true).Key == ConsoleKey.RightArrow)
{
// 消息出列
var chatModels = redisClient.ListLeftPop<ChatModels>("MessageQuene");
if (chatModels != null)
{
Console.WriteLine(string.Format("消息出列:Useid={0},chat={1}", chatModels.userId, chatModels.chat));
}
else
{
Console.WriteLine("队列为空");
}
}
else
{
if (Console.ReadKey(true).Key == ConsoleKey.Enter)
{
break;
}
}
}
}
编译运行即可实现左键入队右键出队.
3.3 发布/订阅测试
1.创建两个新的控制台程序 RedisPublish 和 RedisSubscribe
2.分别修改配置文件
3.RedisPublish主程序
static void Main(string[] args)
{
var redisClient = new RedisHelper(2);
for (; ; )
{
Console.WriteLine("按回车退出循环,按UpArrow 发布");
if (Console.ReadKey(true).Key == ConsoleKey.UpArrow)
{
// 消息发布
ChatModels chatModels = new ChatModels() { userId = "userID" + i.ToString(), chat = "聊天内容 " + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") };
var id =redisClient.Publish<ChatModels>("MessageQuene", chatModels);
Console.WriteLine(string.Format("消息发布{2}:Useid={0},chat={1}", chatModels.userId, chatModels.chat, id));
}
else
{
if (Console.ReadKey(true).Key == ConsoleKey.Enter)
{
break;
}
}
}
}
实现 上键发布消息。
4.RedisSubscribe主程序
` class Program
{
static void Main(string[] args)
{
var redisClient = new RedisHelper(2);
redisClient.Subscribe("MessageQuene", Event);
Console.WriteLine("已订阅 频道 MessageQuene ");
Console.ReadLine();
}
/// <summary>
/// 订阅事件
/// </summary>
/// <param name="redisChannel"></param>
/// <param name="redisValue"></param>
public static void Event(RedisChannel redisChannel, RedisValue redisValue)
{
ChatModels chatModels = null;
chatModels= Deserialize<ChatModels>(redisValue);
if (chatModels!=null)
{
Console.WriteLine(string.Format("消息订阅:Useid={0},chat={1}", chatModels.userId, chatModels.chat));
}
}
/// <summary>
/// 反序列化
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="data"></param>
/// <returns></returns>
private static T Deserialize<T>(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;
}
}
}`
编译两个文件,可以启动多个订阅客户端订阅发布服务端。然后在发布服务端按上键测试发布即可。
4、总结
Redis的消息队列的实现还是很简单的,速度也很快。在一般的消息队列需求下可以应用。
参考:
1、Redis安装
2、Redis消息队列
附 RedisHelper
public class RedisHelper
{
/// <summary>
/// 连接字符串
/// </summary>
private static readonly string ConnectionString;
/// <summary>
/// redis 连接对象
/// </summary>
private static IConnectionMultiplexer _connMultiplexer;
/// <summary>
/// 默认的key值(用来当作RedisKey的前缀)【此部分为自行修改的,无意义】
/// </summary>
public static string DefaultKey { get; private set; }
/// <summary>
/// 锁
/// </summary>
private static readonly object Locker = new object();
/// <summary>
/// 数据库访问对象
/// </summary>
private readonly IDatabase _db;
/// <summary>
/// 采用双重锁单例模式,保证数据访问对象有且仅有一个
/// </summary>
/// <returns></returns>
public IConnectionMultiplexer GetConnectionRedisMultiplexer()
{
if ((_connMultiplexer == null || !_connMultiplexer.IsConnected))
{
lock (Locker)
{
if ((_connMultiplexer == null || !_connMultiplexer.IsConnected))
{
_connMultiplexer = ConnectionMultiplexer.Connect(ConnectionString);
}
}
}
return _connMultiplexer;
}
/// <summary>
/// 添加事务处理
/// </summary>
/// <returns></returns>
public ITransaction GetTransaction()
{
//创建事务
return _db.CreateTransaction();
}
/// <summary>
/// 静态的构造函数,
/// 构造函数是属于类的,而不是属于实例的
/// 就是说这个构造函数只会被执行一次。也就是在创建第一个实例或引用任何静态成员之前,由.NET自动调用。
/// </summary>
static RedisHelper()
{
ConnectionString = ConfigurationManager.ConnectionStrings["RedisConnectionString"].ConnectionString;
_connMultiplexer = ConnectionMultiplexer.Connect(ConnectionString);
DefaultKey = ConfigurationManager.AppSettings["Redis.DefaultKey"];
RegisterEvent();
}
/// <summary>
/// 重载构造器
/// </summary>
/// <param name="db"></param>
public RedisHelper(int db = -1)
{
_db = _connMultiplexer.GetDatabase(db);
}
#region private method
/// <summary>
/// 添加 key 的前缀
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
private static string AddKeyPrefix(string key)
{
return $"{DefaultKey}:{key}";
}
/// <summary>
/// 序列化
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
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;
}
}
/// <summary>
/// 反序列化
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="data"></param>
/// <returns></returns>
private static T Deserialize<T>(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
/// <summary>
/// 设置key,并保存字符串(如果key 已存在,则覆盖)
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expried"></param>
/// <returns></returns>
public bool StringSet(string redisKey, string redisValue, TimeSpan? expried = null)
{
redisKey = AddKeyPrefix(redisKey);
return _db.StringSet(redisKey, redisValue, expried);
}
/// <summary>
/// 保存多个key-value
/// </summary>
/// <param name="keyValuePairs"></param>
/// <returns></returns>
public bool StringSet(IEnumerable<KeyValuePair<RedisKey, RedisValue>> keyValuePairs)
{
keyValuePairs =
keyValuePairs.Select(x => new KeyValuePair<RedisKey, RedisValue>(AddKeyPrefix(x.Key), x.Value));
return _db.StringSet(keyValuePairs.ToArray());
}
/// <summary>
/// 获取字符串
/// </summary>
/// <param name="redisKey"></param>
/// <param name="expired"></param>
/// <returns></returns>
public string StringGet(string redisKey, TimeSpan? expired = null)
{
try
{
redisKey = AddKeyPrefix(redisKey);
return _db.StringGet(redisKey);
}
catch (TypeAccessException ex)
{
throw ex;
}
}
/// <summary>
/// 存储一个对象,该对象会被序列化存储
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expired"></param>
/// <returns></returns>
public bool StringSet<T>(string redisKey, T redisValue, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(redisKey);
return _db.StringSet(redisKey, json, expired);
}
/// <summary>
/// 获取一个对象(会进行反序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="expired"></param>
/// <returns></returns>
public T StringSet<T>(string redisKey, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(_db.StringGet(redisKey));
}
/// <summary>
/// 保存一个字符串值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expired"></param>
/// <returns></returns>
public async Task<bool> StringSetAsync(string redisKey, string redisValue, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.StringSetAsync(redisKey, redisValue, expired);
}
/// <summary>
/// 保存一个字符串值
/// </summary>
/// <param name="keyValuePairs"></param>
/// <returns></returns>
public async Task<bool> StringSetAsync(IEnumerable<KeyValuePair<RedisKey, RedisValue>> keyValuePairs)
{
keyValuePairs
= keyValuePairs.Select(x => new KeyValuePair<RedisKey, RedisValue>(AddKeyPrefix(x.Key), x.Value));
return await _db.StringSetAsync(keyValuePairs.ToArray());
}
/// <summary>
/// 获取单个值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expired"></param>
/// <returns></returns>
public async Task<string> StringGetAsync(string redisKey, string redisValue, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.StringGetAsync(redisKey);
}
/// <summary>
/// 存储一个对象(该对象会被序列化保存)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expired"></param>
/// <returns></returns>
public async Task<bool> StringSetAsync<T>(string redisKey, string redisValue, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(redisValue);
return await _db.StringSetAsync(redisKey, json, expired);
}
/// <summary>
/// 获取一个对象(反序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <param name="expired"></param>
/// <returns></returns>
public async Task<T> StringGetAsync<T>(string redisKey, string redisValue, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(await _db.StringGetAsync(redisKey));
}
#endregion
#region string operation
/// <summary>
/// 判断字段是否在hash中
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public bool HashExist(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashExists(redisKey, hashField);
}
/// <summary>
/// 从hash 中删除字段
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public bool HashDelete(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashDelete(redisKey, hashField);
}
/// <summary>
/// 从hash中移除指定字段
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public long HashDelete(string redisKey, IEnumerable<RedisValue> hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashDelete(redisKey, hashField.ToArray());
}
/// <summary>
/// 在hash中设定值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <param name="value"></param>
/// <returns></returns>
public bool HashSet(string redisKey, string hashField, string value)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashSet(redisKey, hashField, value);
}
/// <summary>
/// 从Hash 中获取值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public RedisValue HashGet(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashGet(redisKey, hashField);
}
/// <summary>
/// 从Hash 中获取值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public RedisValue[] HashGet(string redisKey, RedisValue[] hashField)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashGet(redisKey, hashField);
}
/// <summary>
/// 从hash 返回所有的key值
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public IEnumerable<RedisValue> HashKeys(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashKeys(redisKey);
}
/// <summary>
/// 根据key返回hash中的值
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public RedisValue[] HashValues(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.HashValues(redisKey);
}
/// <summary>
///
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <param name="value"></param>
/// <returns></returns>
public bool HashSet<T>(string redisKey, string hashField, T value)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(value);
return _db.HashSet(redisKey, hashField, json);
}
/// <summary>
/// 在hash 中获取值 (反序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public T HashGet<T>(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(_db.HashGet(redisKey, hashField));
}
/// <summary>
/// 判断字段是否存在hash 中
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public async Task<bool> HashExistsAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashExistsAsync(redisKey, hashField);
}
/// <summary>
/// 从hash中移除指定字段
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public async Task<bool> HashDeleteAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashDeleteAsync(redisKey, hashField);
}
/// <summary>
/// 从hash中移除指定字段
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public async Task<long> HashDeleteAsync(string redisKey, IEnumerable<RedisValue> hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashDeleteAsync(redisKey, hashField.ToArray());
}
/// <summary>
/// 在hash 设置值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <param name="value"></param>
/// <returns></returns>
public async Task<bool> HashSetAsync(string redisKey, string hashField, string value)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashSetAsync(redisKey, hashField, value);
}
/// <summary>
/// 在hash 中设定值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashFields"></param>
/// <returns></returns>
public async Task HashSetAsync(string redisKey, IEnumerable<HashEntry> hashFields)
{
redisKey = AddKeyPrefix(redisKey);
await _db.HashSetAsync(redisKey, hashFields.ToArray());
}
/// <summary>
/// 在hash 中设定值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public async Task<RedisValue> HashGetAsync(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashGetAsync(redisKey, hashField);
}
/// <summary>
/// 在hash 中获取值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <param name="value"></param>
/// <returns></returns>
public async Task<IEnumerable<RedisValue>> HashGetAsync(string redisKey, RedisValue[] hashField, string value)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashGetAsync(redisKey, hashField);
}
/// <summary>
/// 从hash返回所有的字段值
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<IEnumerable<RedisValue>> HashKeysAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashKeysAsync(redisKey);
}
/// <summary>
/// 返回hash中所有的值
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<IEnumerable<RedisValue>> HashValuesAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.HashValuesAsync(redisKey);
}
/// <summary>
/// 在hash 中设定值(序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <param name="value"></param>
/// <returns></returns>
public async Task<bool> HashSetAsync<T>(string redisKey, string hashField, T value)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(value);
return await _db.HashSetAsync(redisKey, hashField, json);
}
/// <summary>
/// 在hash中获取值(反序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="hashField"></param>
/// <returns></returns>
public async Task<T> HashGetAsync<T>(string redisKey, string hashField)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(await _db.HashGetAsync(redisKey, hashField));
}
#endregion
#region list operation
/// <summary>
/// 移除并返回key所对应列表的第一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public string ListLeftPop(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListLeftPop(redisKey);
}
/// <summary>
/// 移除并返回key所对应列表的最后一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public string ListRightPop(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRightPop(redisKey);
}
/// <summary>
/// 移除指定key及key所对应的元素
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public long ListRemove(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRemove(redisKey, redisValue);
}
/// <summary>
/// 在列表尾部插入值,如果键不存在,先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public long ListRightPush(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRightPush(redisKey, redisValue);
}
/// <summary>
/// 在列表头部插入值,如果键不存在,先创建再插入值
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public long ListLeftPush(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListLeftPush(redisKey, redisValue);
}
/// <summary>
/// 返回列表上该键的长度,如果不存在,返回0
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public long ListLength(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListLength(redisKey);
}
/// <summary>
/// 返回在该列表上键所对应的元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public IEnumerable<RedisValue> ListRange(string redisKey)
{
try
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRange(redisKey);
}
catch (Exception ex)
{
throw ex;
}
}
/// <summary>
/// 移除并返回存储在该键列表的第一个元素
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
public T ListLeftPop<T>(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(_db.ListLeftPop(redisKey));
}
/// <summary>
/// 移除并返回该列表上的最后一个元素
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
public T ListRightPop<T>(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(_db.ListRightPop(redisKey));
}
/// <summary>
/// 在列表尾部插入值,如果键不存在,先创建再插入值
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public long ListRightPush<T>(string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRightPush(redisKey, Serialize(redisValue));
}
/// <summary>
/// 在列表头部插入值,如果键不存在,创建后插入值
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public long ListLeftPush<T>(string redisKey, T redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return _db.ListRightPush(redisKey, Serialize(redisValue));
}
/// <summary>
/// 移除并返回存储在该键列表的第一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<string> ListLeftPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPopAsync(redisKey);
}
/// <summary>
/// 移除并返回存储在该键列表的最后一个元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<string> ListRightPopAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRightPopAsync(redisKey);
}
/// <summary>
/// 移除列表指定键上与值相同的元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<long> ListRemoveAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRemoveAsync(redisKey, redisValue);
}
/// <summary>
/// 在列表尾部差入值,如果键不存在,先创建后插入
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListRightPushAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await ListRightPushAsync(redisKey, redisValue);
}
/// <summary>
/// 在列表头部插入值,如果键不存在,先创建后插入
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListLeftPushAsync(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPushAsync(redisKey, redisValue);
}
/// <summary>
/// 返回列表上的长度,如果不存在,返回0
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<long> ListLengthAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLengthAsync(redisKey);
}
/// <summary>
/// 返回在列表上键对应的元素
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<IEnumerable<RedisValue>> ListRangeAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRangeAsync(redisKey);
}
/// <summary>
/// 移除并返回存储在key对应列表的第一个元素
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<T> ListLeftPopAsync<T>(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(await _db.ListLeftPopAsync(redisKey));
}
/// <summary>
/// 移除并返回存储在key 对应列表的最后一个元素
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<T> ListRightPopAsync<T>(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return Deserialize<T>(await _db.ListRightPopAsync(redisKey));
}
/// <summary>
/// 在列表尾部插入值,如果值不存在,先创建后写入值
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListRightPushAsync<T>(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListRightPushAsync(redisKey, Serialize(redisValue));
}
/// <summary>
/// 在列表头部插入值,如果值不存在,先创建后写入值
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="redisValue"></param>
/// <returns></returns>
public async Task<long> ListLeftPushAsync<T>(string redisKey, string redisValue)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.ListLeftPushAsync(redisKey, Serialize(redisValue));
}
#endregion
#region sorted set operation
/// <summary>
/// sortedset 新增
/// </summary>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <param name="score"></param>
/// <returns></returns>
public bool SortedSetAdd(string redisKey, string member, double score)
{
redisKey = AddKeyPrefix(redisKey);
return _db.SortedSetAdd(redisKey, member, score);
}
/// <summary>
/// 在有序集合中返回指定范围的元素,默认情况下由低到高
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public IEnumerable<RedisValue> SortedSetRangeByRank(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.SortedSetRangeByRank(redisKey);
}
/// <summary>
/// 返回有序集合的个数
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public long SortedSetLength(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.SortedSetLength(redisKey);
}
/// <summary>
/// 返回有序集合的元素个数
/// </summary>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <returns></returns>
public bool SortedSetLength(string redisKey, string member)
{
redisKey = AddKeyPrefix(redisKey);
return _db.SortedSetRemove(redisKey, member);
}
/// <summary>
/// sorted set Add
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <param name="score"></param>
/// <returns></returns>
public bool SortedSetAdd<T>(string redisKey, T member, double score)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(member);
return _db.SortedSetAdd(redisKey, json, score);
}
/// <summary>
/// sorted set add
/// </summary>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <param name="score"></param>
/// <returns></returns>
public async Task<bool> SortedSetAddAsync(string redisKey, string member, double score)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetAddAsync(redisKey, member, score);
}
/// <summary>
/// 在有序集合中返回指定范围的元素,默认情况下由低到高
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<IEnumerable<RedisValue>> SortedSetRangeByRankAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetRangeByRankAsync(redisKey);
}
/// <summary>
/// 返回有序集合的元素个数
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<long> SortedSetLengthAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetLengthAsync(redisKey);
}
/// <summary>
/// 返回有序集合的元素个数
/// </summary>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <returns></returns>
public async Task<bool> SortedSetRemoveAsync(string redisKey, string member)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.SortedSetRemoveAsync(redisKey, member);
}
/// <summary>
/// SortedSet 新增
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisKey"></param>
/// <param name="member"></param>
/// <param name="score"></param>
/// <returns></returns>
public async Task<bool> SortedSetAddAsync<T>(string redisKey, T member, double score)
{
redisKey = AddKeyPrefix(redisKey);
var json = Serialize(member);
return await _db.SortedSetAddAsync(redisKey, json, score);
}
#endregion
#region key operation
/// <summary>
/// 移除指定key
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public bool KeyDelete(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.KeyDelete(redisKey);
}
/// <summary>
/// 删除指定key
/// </summary>
/// <param name="redisKeys"></param>
/// <returns></returns>
public long KeyDelete(IEnumerable<string> redisKeys)
{
var keys = redisKeys.Select(x => (RedisKey)AddKeyPrefix(x));
return _db.KeyDelete(keys.ToArray());
}
/// <summary>
/// 检验key是否存在
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public bool KeyExists(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return _db.KeyExists(redisKey);
}
/// <summary>
/// 重命名key
/// </summary>
/// <param name="oldKeyName"></param>
/// <param name="newKeyName"></param>
/// <returns></returns>
public bool KeyReName(string oldKeyName, string newKeyName)
{
oldKeyName = AddKeyPrefix(oldKeyName);
return _db.KeyRename(oldKeyName, newKeyName);
}
/// <summary>
/// 设置key 的过期时间
/// </summary>
/// <param name="redisKey"></param>
/// <param name="expired"></param>
/// <returns></returns>
public bool KeyExpire(string redisKey, TimeSpan? expired = null)
{
redisKey = AddKeyPrefix(redisKey);
return _db.KeyExpire(redisKey, expired);
}
/// <summary>
/// 移除指定的key
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<bool> KeyDeleteAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyDeleteAsync(redisKey);
}
/// <summary>
/// 删除指定的key
/// </summary>
/// <param name="redisKeys"></param>
/// <returns></returns>
public async Task<long> KeyDeleteAsync(IEnumerable<string> redisKeys)
{
var keys = redisKeys.Select(x => (RedisKey)AddKeyPrefix(x));
return await _db.KeyDeleteAsync(keys.ToArray());
}
/// <summary>
/// 检验key 是否存在
/// </summary>
/// <param name="redisKey"></param>
/// <returns></returns>
public async Task<bool> KeyExistsAsync(string redisKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyExistsAsync(redisKey);
}
/// <summary>
/// 重命名key
/// </summary>
/// <param name="redisKey"></param>
/// <param name="redisNewKey"></param>
/// <returns></returns>
public async Task<bool> KeyRenameAsync(string redisKey, string redisNewKey)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyRenameAsync(redisKey, redisNewKey);
}
/// <summary>
/// 设置 key 时间
/// </summary>
/// <param name="redisKey"></param>
/// <param name="expired"></param>
/// <returns></returns>
public async Task<bool> KeyExpireAsync(string redisKey, TimeSpan? expired)
{
redisKey = AddKeyPrefix(redisKey);
return await _db.KeyExpireAsync(redisKey, expired);
}
#endregion
#region Subscribe
/// <summary>
/// 订阅
/// </summary>
/// <param name="channel">频道</param>
/// <param name="handle">事件</param>
public void Subscribe(RedisChannel channel, Action<RedisChannel, RedisValue> handle)
{
//getSubscriber() 获取到指定服务器的发布者订阅者的连接
var sub = _connMultiplexer.GetSubscriber();
//订阅执行某些操作时改变了 优先/主动 节点广播
sub.Subscribe(channel, handle);
}
/// <summary>
/// 发布
/// </summary>
/// <param name="channel"></param>
/// <param name="message"></param>
/// <returns></returns>
public long Publish(RedisChannel channel, RedisValue message)
{
var sub = _connMultiplexer.GetSubscriber();
return sub.Publish(channel, message);
}
/// <summary>
/// 发布(使用序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="channel"></param>
/// <param name="message"></param>
/// <returns></returns>
public long Publish<T>(RedisChannel channel, T message)
{
var sub = _connMultiplexer.GetSubscriber();
return sub.Publish(channel, Serialize(message));
}
/// <summary>
/// 订阅
/// </summary>
/// <param name="redisChannel"></param>
/// <param name="handle"></param>
/// <returns></returns>
public async Task SubscribeAsync(RedisChannel redisChannel, Action<RedisChannel, RedisValue> handle)
{
var sub = _connMultiplexer.GetSubscriber();
await sub.SubscribeAsync(redisChannel, handle);
}
/// <summary>
/// 发布
/// </summary>
/// <param name="redisChannel"></param>
/// <param name="message"></param>
/// <returns></returns>
public async Task<long> PublishAsync(RedisChannel redisChannel, RedisValue message)
{
var sub = _connMultiplexer.GetSubscriber();
return await sub.PublishAsync(redisChannel, message);
}
/// <summary>
/// 发布(使用序列化)
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="redisChannel"></param>
/// <param name="message"></param>
/// <returns></returns>
public async Task<long> PublishAsync<T>(RedisChannel redisChannel, T message)
{
var sub = _connMultiplexer.GetSubscriber();
return await sub.PublishAsync(redisChannel, Serialize(message));
}
#endregion
#region register event
/// <summary>
/// 注册事件
/// </summary>
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;
}
/// <summary>
/// 重新配置广播时(主从同步更改)
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_ConfigurationChangedBroadcast(object sender, EndPointEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConfigurationChangedBroadcast)}: {e.EndPoint}");
}
/// <summary>
/// 发生内部错误时(调试用)
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_InternalError(object sender, InternalErrorEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_InternalError)}: {e.Exception}");
}
/// <summary>
/// 更改集群时
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
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} ");
}
/// <summary>
/// 配置更改时
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_ConfigurationChanged(object sender, EndPointEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConfigurationChanged)}: {e.EndPoint}");
}
/// <summary>
/// 发生错误时
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_ErrorMessage(object sender, RedisErrorEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ErrorMessage)}: {e.Message}");
}
/// <summary>
/// 物理连接失败时
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_ConnectionFailed(object sender, ConnectionFailedEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConnectionFailed)}: {e.Exception}");
}
/// <summary>
/// 建立物理连接时
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private static void ConnMultiplexer_ConnectionRestored(object sender, ConnectionFailedEventArgs e)
{
Console.WriteLine($"{nameof(ConnMultiplexer_ConnectionRestored)}: {e.Exception}");
}
#endregion
#region physical save - undo
#endregion
}