Redis Helper封装：静态方法
Redis面试题：
1、什么是事务？2、Redis中有事务吗？3、Redis中的事务可以回滚吗？
答：
1、事务是指一个完整的动作，要么全部执行，要么什么也没有做
2、Redis中有事务，Redis 事务不是严格意义上的事务，只是用于帮助用户在一个步骤中执行多个命令。单个 Redis 命令的执行是原子性的，但 Redis 没有在事务上增加任何维持原子性的机制，所以 Redis 事务的执行并不是原子性的
3、Redis 事务可以理解为一个打包的批量执行脚本，但批量指令并非原子化的操作，中间某条指令的失败不会导致前面已做指令回滚，也不会造成后续的指令不做
事务一般都是为原子性而生，既然Redis事务没有原子性，那他存在的意义是什么
答：redis事务的主要作用就是串联多个命令防止 别的命令插队。
RedisHelper封装
1、添加StackExchange.Redis引用
Install-Package StackExchange.Redis -Version 2.0.6012、封装
using Microsoft.AspNetCore.DataProtection.KeyManagement;
using StackExchange.Redis;
namespace Web.Common
{
///
/// Redis 助手
///
public static class RedisHelper
{
#region 获取Multiplexer实例：单例模式
public static IConnectionMultiplexer ConnMultiplexerInstance
{
get
{
return _ConnectionMultiplexer;// 总是返回同一个实例
}
}
#endregion 其它
#region private field
///
/// 连接字符串
///
private static readonly string ConnectionString;
///
/// redis 连接对象：单例
///
private static IConnectionMultiplexer _ConnectionMultiplexer;
///
/// 默认的 Key 值（用来当作 RedisKey 的前缀）
///
private static readonly string DefaultPrefix;
///
/// 默认的超时时间（单位毫秒）
///
private static readonly TimeSpan? DefaultTimeout;
///
/// 默认库（0-15）
///
private static readonly int DefaultDB;
///
/// 锁
///
private static readonly object Locker = new object();
/
/ 数据库
/
//private readonly IDatabase GetOperationDB(db);
#endregion private field
#region 构造函数
static RedisHelper()
{
var configuration = new ConfigurationBuilder().SetBasePath(AppDomain.CurrentDomain.BaseDirectory).AddJsonFile("appsettings.json").Build();
// 读取Redis连接字符串
ConnectionString = configuration["Redis:Default:Connection"] ?? "127.0.0.1:6379";
//var options = ConfigurationOptions.Parse(ConnectionString);
//options.Password = null; //密码
//_ConnectionMultiplexer=ConnectionMultiplexer.Connect(options);
_ConnectionMultiplexer = ConnectionMultiplexer.Connect(ConnectionString);
//默认Key的前缀
DefaultPrefix = configuration["Redis:Default:DefaultPrefix"];
//默认操作数据库：如果配置了默认库，则按配置的默认库，没有配置则默认库为0
DefaultDB = configuration["Redis:Default:DefaultDB"] == null ? 0 : Convert.ToInt32(configuration["Redis:Default:DefaultDB"]);
//键的默认过期时间：如果配置了过期时间，则按配置规则计算过期时间，没有配置则默认过期时间为7天
DefaultTimeout = configuration["Redis:Default:DefaultTimeout"] != null ? TimeSpan.FromSeconds(Convert.ToInt32(configuration["Redis:Default:DefaultTimeout"])) : TimeSpan.FromSeconds(60);
AddRegisterEvent();
}
///
/// 获取要操作的库
///
/// 库，0和-1都是第一个库，1是第二个库...
///
/// 设置 key 并保存字符串（如果 key 已存在，则覆盖值）
///
/// 键
/// 值
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 保存多个 Key-value
///
/// 键
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > keyValuePairs, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var pairs = keyValuePairs.Select(x => new KeyValuePair(AddKeyPrefix(x.Key, prefix), x.Value));
var result = GetOperationDB(db).StringSet(pairs.ToArray());
_ = keyValuePairs.Select(y => KeyExpire(y.Key, expiry, prefix, db));//设置key的过期时间
return result;
}
///
/// 存储一个对象（该对象会被序列化保存）
///
/// (string key, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var exptime = GetRedisKeyExpireTime(expiry);
try
{
var json = Serialize(redisValue);
return GetOperationDB(db).StringSet(redisKey, json, exptime);
}
catch
{
return false;
}
}
///
/// 获取字符串
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 获取一个对象（会进行反序列化）
///
/// (string redisKey, string? prefix = null, int? db = null)
{
try
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(GetOperationDB(db).StringGet(redisKey));
}
catch
{
return default;
}
}
#region async
///
/// 保存一个字符串值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// StringSetAsync(string redisKey, string redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var exptime = GetRedisKeyExpireTime(expiry);
return await GetOperationDB(db).StringSetAsync(redisKey, redisValue, exptime);
}
///
/// 保存一组字符串值
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// StringSetAsync(IEnumerable> keyValuePairs, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var pairs = keyValuePairs.Select(x => new KeyValuePair(AddKeyPrefix(x.Key, prefix), x.Value));
var result = await GetOperationDB(db).StringSetAsync(pairs.ToArray());
_ = keyValuePairs.Select(y => KeyExpire(y.Key, expiry, prefix, db));//设置key的过期时间
return result;
}
///
/// 存储一个对象（该对象会被序列化保存）
///
/// StringSetAsync(string redisKey, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
try
{
redisKey = AddKeyPrefix(redisKey, prefix);
var json = Serialize(redisValue);
var exptime = GetRedisKeyExpireTime(expiry);
return await GetOperationDB(db).StringSetAsync(redisKey, json, exptime);
}
catch
{
return false;
}
}
///
/// 获取单个值
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// StringGetAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).StringGetAsync(redisKey);
}
///
/// 获取一个对象（会进行反序列化）
///
/// StringGetAsync(string redisKey, string? prefix = null, int? db = null)
{
try
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(await GetOperationDB(db).StringGetAsync(redisKey));
}
catch
{
return default;
}
}
#endregion async
#endregion String 操作
#region Hash 操作
///
/// 在 hash 设定值
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 在 hash 中设定值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
public static void HashSet(string key, IEnumerable> hashFields, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var entries = hashFields.Select(x => new HashEntry(x.Key, x.Value));
GetOperationDB(db).HashSet(redisKey, entries.ToArray());
KeyExpire(key, expiry, prefix, db); //设置key的过期时间
}
///
/// 在 hash 设定值（序列化）
///
/// (string key, string hashField, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
try
{
var redisKey = AddKeyPrefix(key, prefix);
var json = Serialize(redisValue);
var result = GetOperationDB(db).HashSet(redisKey, hashField, json);
KeyExpire(key, expiry, prefix, db);
return result;
}
catch
{
return false;
}
}
///
/// 在 hash 中获取值
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 在 hash 中获取值
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashGet(string redisKey, IEnumerable hashFields, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var fields = hashFields.Select(x => (RedisValue)x);
return ConvertStrings(GetOperationDB(db).HashGet(redisKey, fields.ToArray()));
}
///
/// 从 hash 返回所有的字段值
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashKeys(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(GetOperationDB(db).HashKeys(redisKey));
}
///
/// 返回 hash 中的所有值
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashValues(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(GetOperationDB(db).HashValues(redisKey));
}
///
/// 在 hash 中获取值（反序列化）
///
/// (string redisKey, string hashField, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(GetOperationDB(db).HashGet(redisKey, hashField));
}
///
/// 判断该字段是否存在 hash 中
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 从 hash 中移除指定字段
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 从 hash 中移除指定字段
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// hashFields, string? prefix = null, int? db = null)
{
if (hashFields is null)
{
throw new ArgumentNullException(nameof(hashFields));
}
redisKey = AddKeyPrefix(redisKey, prefix);
var fields = hashFields.Select(x => (RedisValue)x);
return GetOperationDB(db).HashDelete(redisKey, fields.ToArray());
}
#region async
///
/// 在 hash 设定值
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashSetAsync(string key, string hashField, string value, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result= await GetOperationDB(db).HashSetAsync(redisKey, hashField, value);
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在 hash 中设定值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > hashFields, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var entries = hashFields.Select(x => new HashEntry(x.Key, x.Value));
await GetOperationDB(db).HashSetAsync(redisKey, entries.ToArray());
KeyExpire(key, expiry, prefix, db);
}
///
/// 在 hash 设定值（序列化）
///
/// HashSetAsync(string key, string hashField, T value, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
try
{
var redisKey = AddKeyPrefix(key, prefix);
var json = Serialize(value);
var result = await GetOperationDB(db).HashSetAsync(redisKey, hashField, json);
KeyExpire(key, expiry, prefix, db);
return result;
}
catch
{
return false;
}
}
///
/// 判断该字段是否存在 hash 中
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashExistsAsync(string redisKey, string hashField, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).HashExistsAsync(redisKey, hashField);
}
///
/// 从 hash 中移除指定字段
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashDeleteAsync(string redisKey, string hashField, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).HashDeleteAsync(redisKey, hashField);
}
///
/// 从 hash 中移除指定字段
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashDeleteAsync(string redisKey, IEnumerable hashFields, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var fields = hashFields.Select(x => (RedisValue)x);
return await GetOperationDB(db).HashDeleteAsync(redisKey, fields.ToArray());
}
///
/// 在 hash 中获取值
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// HashGetAsync(string redisKey, string hashField, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).HashGetAsync(redisKey, hashField);
}
///
/// 在 hash 中获取值
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > HashGetAsync(string redisKey, IEnumerable hashFields, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var fields = hashFields.Select(x => (RedisValue)x);
return ConvertStrings(await GetOperationDB(db).HashGetAsync(redisKey, fields.ToArray()));
}
///
/// 从 hash 返回所有的字段值
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > HashKeysAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(await GetOperationDB(db).HashKeysAsync(redisKey));
}
///
/// 返回 hash 中的所有值
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > HashValuesAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(await GetOperationDB(db).HashValuesAsync(redisKey));
}
///
/// 在 hash 中获取值（反序列化）
///
/// HashGetAsync(string redisKey, string hashField, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var result = await GetOperationDB(db).HashGetAsync(redisKey, hashField);
return Deserialize(result);
}
#endregion async
#endregion Hash 操作
#region List 操作
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
/// (string key, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = GetOperationDB(db).ListLeftPush(redisKey, Serialize(redisValue));
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
/// push操作后列表的长度。
public static long ListRightPush(string key, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = GetOperationDB(db).ListRightPush(redisKey, Serialize(redisValue));
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 移除并返回存储在该键列表的第一个元素
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// 返回字符串
public static string? ListLeftPop(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return GetOperationDB(db).ListLeftPop(redisKey);
}
///
/// 移除并返回存储在该键列表的第一个元素
///
/// 返回泛型对象
public static T? ListLeftPop(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(GetOperationDB(db).ListLeftPop(redisKey));
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 移除并返回存储在该键列表的最后一个元素：
///
/// 返回泛型对象
public static T? ListRightPop(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(GetOperationDB(db).ListRightPop(redisKey));
}
///
/// 移除列表指定键上与该值相同的元素
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 返回列表上该键的长度，如果不存在，返回 0
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 返回在该列表上键所对应的元素
///
/// 键
///
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListRange(string redisKey, long start = 0L, long stop = -1L, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(GetOperationDB(db).ListRange(redisKey, start, stop));
}
#region List-async
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListRightPushAsync(string key, string redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = await GetOperationDB(db).ListRightPushAsync(redisKey, redisValue);
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListLeftPushAsync(string key, string redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = await GetOperationDB(db).ListLeftPushAsync(redisKey, redisValue);
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在列表头部插入值。如果键不存在，先创建再插入值
///
/// ListLeftPushAsync(string key, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = await GetOperationDB(db).ListLeftPushAsync(redisKey, Serialize(redisValue));
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在列表尾部插入值。如果键不存在，先创建再插入值
///
/// ListRightPushAsync(string key, T redisValue, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = await GetOperationDB(db).ListRightPushAsync(redisKey, Serialize(redisValue));
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 移除并返回存储在该键列表的第一个元素
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListLeftPopAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).ListLeftPopAsync(redisKey);
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListRightPopAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).ListRightPopAsync(redisKey);
}
///
/// 移除列表指定键上与该值相同的元素
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListRemoveAsync(string redisKey, string redisValue, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).ListRemoveAsync(redisKey, redisValue);
}
///
/// 返回列表上该键的长度，如果不存在，返回 0
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// ListLengthAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).ListLengthAsync(redisKey);
}
///
/// 返回在该列表上键所对应的元素
///
/// 键
///
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > ListRangeAsync(string redisKey, long start = 0L, long stop = -1L, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var query = await GetOperationDB(db).ListRangeAsync(redisKey, start, stop);
return query.Select(x => x.ToString());
}
///
/// 移除并返回存储在该键列表的第一个元素
///
/// ListLeftPopAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(await GetOperationDB(db).ListLeftPopAsync(redisKey));
}
///
/// 移除并返回存储在该键列表的最后一个元素
///
/// ListRightPopAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return Deserialize(await GetOperationDB(db).ListRightPopAsync(redisKey));
}
#endregion List-async
#endregion List 操作
#region SortedSet 操作
///
/// SortedSet 新增
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// SortedSet 新增
///
/// (string key, T member, double score, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
try
{
var redisKey = AddKeyPrefix(key, prefix);
var json = Serialize(member);
var result = GetOperationDB(db).SortedSetAdd(redisKey, json, score);
KeyExpire(key, expiry, prefix, db);
return result;
}
catch
{
return false;
}
}
///
/// 增量的得分排序的集合中的成员存储键值键按增量
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 在有序集合中返回指定范围的元素，默认情况下从低到高。
///
/// 键
///
///
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// SortedSetRangeByRank(string redisKey, long start = 0L, long stop = -1L, OrderType order = OrderType.Ascending, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return GetOperationDB(db).SortedSetRangeByRank(redisKey, start, stop, (Order)order).Select(x => x.ToString());
}
///
/// 返回有序集合的元素个数
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 返回有序集合的元素个数
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// SortedSet 新增
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// SortedSetAddAsync(string key, string member, double score, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = await GetOperationDB(db).SortedSetAddAsync(redisKey, member, score);
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// SortedSet 新增
///
/// SortedSetAddAsync(string key, T member, double score, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
try
{
var redisKey = AddKeyPrefix(key, prefix);
var json = Serialize(member);
var result = await GetOperationDB(db).SortedSetAddAsync(redisKey, json, score);
KeyExpire(key, expiry, prefix, db);
return result;
}
catch
{
return false;
}
}
///
/// 增量的得分排序的集合中的成员存储键值键按增量
///
/// 键
///
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// SortedSetIncrementAsync(string key, string member, double value = 1, TimeSpan? expiry = null, string? prefix = null, int? db = null)
{
var redisKey = AddKeyPrefix(key, prefix);
var result = GetOperationDB(db).SortedSetIncrementAsync(redisKey, member, value);
KeyExpire(key, expiry, prefix, db);
return result;
}
///
/// 在有序集合中返回指定范围的元素，默认情况下从低到高。
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// > SortedSetRangeByRankAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return ConvertStrings(await GetOperationDB(db).SortedSetRangeByRankAsync(redisKey));
}
///
/// 返回有序集合的元素个数
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// SortedSetLengthAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).SortedSetLengthAsync(redisKey);
}
///
/// 返回有序集合的元素个数
///
/// 键
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// SortedSetRemoveAsync(string redisKey, string memebr, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).SortedSetRemoveAsync(redisKey, memebr);
}
#endregion SortedSet-Async
#endregion SortedSet 操作
#region key 操作
///
/// 移除指定 Key
///
/// 不带前缀的键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 移除指定 Key
///
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// redisKeys, string? prefix = null, int? db = null)
{
var keys = redisKeys.Select(key => (RedisKey)AddKeyPrefix(key, prefix));
return GetOperationDB(db).KeyDelete(keys.ToArray());
}
///
/// 校验 Key 是否存在
///
/// 不带前缀的键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 重命名 Key
///
/// 不带前缀的键
/// 新的不带前缀的键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 设置 Key 的过期时间
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
///
/// 移除指定 Key
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// KeyDeleteAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).KeyDeleteAsync(redisKey);
}
///
/// 移除指定 Key
///
///
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// KeyDeleteAsync(IEnumerable redisKeys, string? prefix = null, int? db = null)
{
var keys = redisKeys.Select(key => (RedisKey)AddKeyPrefix(key, prefix));
return await GetOperationDB(db).KeyDeleteAsync(keys.ToArray());
}
///
/// 校验 Key 是否存在
///
/// 键
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// KeyExistsAsync(string redisKey, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
return await GetOperationDB(db).KeyExistsAsync(redisKey);
}
///
/// 重命名 Key
///
/// 待重命名的键名称
/// 新的键名称
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// KeyRenameAsync(string oldKey, string newKey, string? prefix = null, int? db = null)
{
var redisOldKey = AddKeyPrefix(oldKey, prefix);
var redisNewKey = AddKeyPrefix(newKey, prefix);
return await GetOperationDB(db).KeyRenameAsync(redisOldKey, redisNewKey);
}
///
/// 设置 Key 的过期时间（单位：毫秒）
///
/// 键
///
/// 过期时间：为Null表示使用appsettings.json配置文件中DefaultTimeout节点的值.如未指定该值且未设置DefaultTimeout则默认库为7天
/// 键的前缀：为Null表示使用appsettings.json配置文件中DefaultPrefix节点的值
/// 库（0-15）：为Null表示使用appsettings.json配置文件中DefaultDB节点的值.如未指定该值且未设置DefaultDB则默认库为0
/// KeyExpireAsync(string redisKey, TimeSpan? expiry, string? prefix = null, int? db = null)
{
redisKey = AddKeyPrefix(redisKey, prefix);
var exptime = GetRedisKeyExpireTime(expiry);
return await GetOperationDB(db).KeyExpireAsync(redisKey, exptime);
}
#endregion key-async
#endregion key 操作
#region private method
///
/// 添加 Key 的前缀
///
/// 键
/// Key 的前缀:如果为空则为appsettings.json中配置节点中的默认前缀DefaultPrefix
///
/// 键的过期时间
///
/// 过期时间
///
/// 转换为字符串
///
/// ConvertStrings(IEnumerable list) where T : struct
{
if (list == null) throw new ArgumentNullException(nameof(list));
return list.Select(x => x.ToString());
}
#region 注册事件
///
/// 添加注册事件
///
private static void AddRegisterEvent()
{
_ConnectionMultiplexer.ConnectionRestored += ConnMultiplexer_ConnectionRestored;
_ConnectionMultiplexer.ConnectionFailed += ConnMultiplexer_ConnectionFailed;
_ConnectionMultiplexer.ErrorMessage += ConnMultiplexer_ErrorMessage;
_ConnectionMultiplexer.ConfigurationChanged += ConnMultiplexer_ConfigurationChanged;
_ConnectionMultiplexer.HashSlotMoved += ConnMultiplexer_HashSlotMoved;
_ConnectionMultiplexer.InternalError += ConnMultiplexer_InternalError;
_ConnectionMultiplexer.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;
return System.Text.Json.JsonSerializer.Deserialize(data);
}
///
/// 排序枚举
///
public enum OrderType
{
///
/// 升序
///
Ascending,
///
/// 降序
///
Descending
}
#endregion private method
}
}
配置文件
在下面这个示例中，我们使用了Sentinel部分来配置Redis哨兵模式。你需要指定MasterName，这是你要连接的Redis主服务器的名称。然后，你需要提供一个Sentinels数组，其中包含哨兵节点的主机和端口信息。在示例中，我们使用了三个哨兵节点，但你可以根据实际情况进行更改。
{
//"RedisConnectionStrings": "127.0.0.1:6379,password=,defaultDatabase=0,connectTimeout=5000,syncTimeout=1000",
"Redis": {
"Host": "127.0.0.1",
"Port": 6379,
"Password": "", //密码
"Database": 0, //默认库
"DefaultPrefix": "slxt", //键的默认前缀
"DefaultTimeout": 604800, //键的默认超时时间 单位：秒
//"ConnectionMultiplexer": "StackExchange.Redis", //Redis使用的客户端实例：如StackExchange.Redis和CsRedis客户端一般我们不需要
//哨兵模式
"Sentinel": {
"MasterName": "mymaster",
"Sentinels": [
{
"Host": "127.0.0.1",
"Port": 26379
},
{
"Host": "127.0.0.1",
"Port": 26380
},
{
"Host": "127.0.0.1",
"Port": 26381
}
]
}
}
}