znyc.cloudcar.admin.api/Znyc.Cloudcar.Admin.Commons/Cache/CacheHelper.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Znyc.Cloudcar.Admin.Commons.Core.App;

namespace Znyc.Cloudcar.Admin.Commons.Cache
{
    /// <summary>
    ///     缓存操作帮助类
    /// </summary>
    public class CacheHelper
    {
        /// <summary>
        ///     缓存提供模式
        /// </summary>
        private static CacheProvider cacheProvider;

        /// <summary>
        ///     缓存接口
        /// </summary>
        private readonly ICacheService cacheservice;

        /// <summary>
        /// </summary>
        public CacheHelper()
        {
            cacheProvider = App.GetService<CacheProvider>();
            if (cacheProvider == null)
            {
                throw new ArgumentNullException(nameof(cacheProvider));
            }

            cacheservice = App.GetService<ICacheService>();
        }

        /// <summary>
        ///     使用MemoryCache缓存操作
        /// </summary>
        /// <param name="isMemoryCache">是否使用MemoryCache</param>
        public CacheHelper(bool isMemoryCache = false)
        {
            cacheProvider = App.GetService<CacheProvider>();
            if (cacheProvider == null)
            {
                throw new ArgumentNullException(nameof(cacheProvider));
            }

            if (isMemoryCache)
            {
                cacheservice = App.GetService<MemoryCacheService>();
            }
            else
            {
                cacheservice = App.GetService<ICacheService>();
            }
        }

        #region 验证缓存项是否存在

        /// <summary>
        ///     验证缓存项是否存在,TryGetValue 来检测 Key是否存在的
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <returns></returns>
        public bool Exists(string key)
        {
            return cacheservice.Exists(key);
        }

        #endregion 验证缓存项是否存在

        #region 添加缓存

        /// <summary>
        ///     添加缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">缓存Value</param>
        /// <returns></returns>
        public bool Add(string key, object value)
        {
            return cacheservice.Add(key, value);
        }

        /// <summary>
        ///     添加缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">缓存Value</param>
        /// <param name="expiresSliding">滑动过期时长（如果在过期时间内有操作，则以当前时间点延长过期时间）</param>
        /// <param name="expiressAbsoulte">绝对过期时长</param>
        /// <returns></returns>
        public bool Add(string key, object value, TimeSpan expiresSliding, TimeSpan expiressAbsoulte)
        {
            return cacheservice.Add(key, value, expiresSliding, expiressAbsoulte);
        }

        /// <summary>
        ///     添加缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">缓存Value</param>
        /// <param name="expiresIn">缓存时长</param>
        /// <param name="isSliding">是否滑动过期（如果在过期时间内有操作，则以当前时间点延长过期时间）</param>
        /// <returns></returns>
        public bool Add(string key, object value, TimeSpan expiresIn, bool isSliding = false)
        {
            return cacheservice.Add(key, value, expiresIn, isSliding);
        }

        #endregion 添加缓存

        #region 删除缓存

        /// <summary>
        ///     删除缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <returns></returns>
        public bool Remove(string key)
        {
            return cacheservice.Remove(key);
        }

        /// <summary>
        ///     批量删除缓存
        /// </summary>
        /// <param name="keys">缓存Key集合</param>
        /// <returns></returns>
        public void RemoveAll(IEnumerable<string> keys)
        {
            cacheservice.RemoveAll(keys);
        }

        /// <summary>
        ///     删除匹配到的缓存
        /// </summary>
        /// <param name="pattern"></param>
        /// <returns></returns>
        public void RemoveByPattern(string pattern)
        {
            cacheservice.RemoveByPattern(pattern);
        }

        /// <summary>
        ///     删除所有缓存
        /// </summary>
        public void RemoveCacheAll()
        {
            cacheservice.RemoveCacheAll();
        }

        #endregion 删除缓存

        #region 获取缓存

        /// <summary>
        ///     获取缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <returns></returns>
        public T Get<T>(string key) where T : class
        {
            return cacheservice.Get<T>(key);
        }

        /// <summary>
        ///     获取缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <returns></returns>
        public object Get(string key)
        {
            return cacheservice.Get(key);
        }

        /// <summary>
        ///     获取缓存集合
        /// </summary>
        /// <param name="keys">缓存Key集合</param>
        /// <returns></returns>
        public IDictionary<string, object> GetAll(IEnumerable<string> keys)
        {
            return cacheservice.GetAll(keys);
        }

        #endregion 获取缓存

        #region 修改缓存

        /// <summary>
        ///     修改缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">新的缓存Value</param>
        /// <returns></returns>
        public bool Replace(string key, object value)
        {
            return cacheservice.Replace(key, value);
        }

        /// <summary>
        ///     修改缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">新的缓存Value</param>
        /// <param name="expiresSliding">滑动过期时长（如果在过期时间内有操作，则以当前时间点延长过期时间）</param>
        /// <param name="expiressAbsoulte">绝对过期时长</param>
        /// <returns></returns>
        public bool Replace(string key, object value, TimeSpan expiresSliding, TimeSpan expiressAbsoulte)
        {
            return cacheservice.Replace(key, value, expiresSliding, expiressAbsoulte);
        }

        /// <summary>
        ///     修改缓存
        /// </summary>
        /// <param name="key">缓存Key</param>
        /// <param name="value">新的缓存Value</param>
        /// <param name="expiresIn">缓存时长</param>
        /// <param name="isSliding">是否滑动过期（如果在过期时间内有操作，则以当前时间点延长过期时间）</param>
        /// <returns></returns>
        public bool Replace(string key, object value, TimeSpan expiresIn, bool isSliding = false)
        {
            return cacheservice.Replace(key, value, expiresIn, isSliding);
        }

        #endregion 修改缓存

        #region Hash

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public bool HSet(string key, string filed, object value)
        {
            return cacheservice.HSet(key, filed, value);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public Task<bool> HSetAsync(string key, string filed, object value)
        {
            return cacheservice.HSetAsync(key, filed, value);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public Task<bool> HMSetAsync(string key, object[] value)
        {
            return cacheservice.HMSetAsync(key, value);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public bool HMSet(string key, object[] value)
        {
            return cacheservice.HMSet(key, value);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public string[] HMGet(string key, string[] filed)
        {
            return cacheservice.HMGet(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public Task<string[]> HMGetAsync(string key, string filed)
        {
            return cacheservice.HMGetAsync(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public long HDel(string key, string[] filed)
        {
            return cacheservice.HDel(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public Task<long> HDelAsync(string key, string filed)
        {
            return cacheservice.HDelAsync(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public bool HExists(string key, string filed)
        {
            return cacheservice.HExists(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public Task<bool> HExistsAsync(string key, string filed)
        {
            return cacheservice.HExistsAsync(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public Task<long> HIncrAsync(string key, string filed)
        {
            return cacheservice.HIncrByAsync(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public long HIncr(string key, string filed)
        {
            return cacheservice.HIncrBy(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public Task<Dictionary<string, string>> HGetAllAsync(string key)
        {
            return cacheservice.HGetAllAsync(key);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public Dictionary<string, string> HGetAll(string key)
        {
            return cacheservice.HGetAll(key);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <returns></returns>
        public Task<string> HGetAsync(string key, string filed)
        {
            return cacheservice.HGetAsync(key, filed);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public Task<bool> HSetNxAsync(string key, string filed, object value)
        {
            return cacheservice.HSetNxAsync(key, filed, value);
        }

        /// <summary>
        /// </summary>
        /// <param name="key"></param>
        /// <param name="filed"></param>
        /// <param name="value"></param>
        /// <returns></returns>
        public bool HSetNx(string key, string filed, object value)
        {
            return cacheservice.HSetNx(key, filed, value);
        }

        #endregion Hash
    }
}