Refactoring of the caching system

Author: skoshelev

src/Libraries/Nop.Core/Caching/CacheKey.cs

@@ -1,7 +1,6 @@
-using System.Collections.Generic;
-using System.Globalization;
+using System;
+using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 
 namespace Nop.Core.Caching
 {
@@ -15,6 +14,19 @@ public partial class CacheKey
 
         #region Ctor
 
+        public CacheKey(CacheKey cacheKey, Func<object, object> createCacheKeyParameters, params object[] keyObjects)
+        {
+            Init(cacheKey.Key, cacheKey.CacheTime, cacheKey.Prefixes.ToArray());
+
+            if(!keyObjects.Any())
+                return;
+
+            Key = string.Format(_keyFormat, keyObjects.Select(createCacheKeyParameters).ToArray());
+
+            for (var i = 0; i < Prefixes.Count; i++)
+                Prefixes[i] = string.Format(Prefixes[i], keyObjects.Select(createCacheKeyParameters).ToArray());
+        }
+
         public CacheKey(string cacheKey, int? cacheTime = null, params string[] prefixes)
         {
             Init(cacheKey, cacheTime, prefixes);
@@ -44,74 +56,20 @@ protected void Init(string cacheKey, int? cacheTime = null, params string[] pref
             if (cacheTime.HasValue)
                 CacheTime = cacheTime.Value;
 
-            Prefixes.AddRange(prefixes);
-        }
-        
-        /// <summary>
-        /// Creates the hash sum of identifiers list
-        /// </summary>
-        /// <param name="ids"></param>
-        /// <returns></returns>
-        private static string CreateIdsHash(IEnumerable<int> ids)
-        {
-            var identifiers = ids.ToList();
-
-            if (!identifiers.Any())
-                return string.Empty;
-
-            return HashHelper.CreateHash(Encoding.UTF8.GetBytes(string.Join(", ", identifiers.OrderBy(id => id))), "SHA512");
-        }
-
-        /// <summary>
-        /// Converts an object to cache parameter
-        /// </summary>
-        /// <param name="parameter">Object to convert</param>
-        /// <returns>Cache parameter</returns>
-        private static object CreateCacheKeyParameters(object parameter)
-        {
-            return parameter switch
-            {
-                null => "null",
-                IEnumerable<int> ids => CreateIdsHash(ids),
-                IEnumerable<BaseEntity> entities => CreateIdsHash(entities.Select(e => e.Id)),
-                BaseEntity entity => entity.Id,
-                decimal param => param.ToString(CultureInfo.InvariantCulture),
-                _ => parameter,
-            };
+            Prefixes.AddRange(prefixes.Where(prefix=> !string.IsNullOrEmpty(prefix)));
         }
 
         #endregion
 
-        /// <summary>
-        /// Fills the cache key
-        /// </summary>
-        /// <param name="keyObjects">Parameters to create cache key</param>
-        /// <returns>Cache key</returns>
-        public CacheKey FillCacheKey(params object[] keyObjects)
-        {
-            Key = keyObjects?.Any() ?? false
-                ? string.Format(_keyFormat, keyObjects.Select(CreateCacheKeyParameters).ToArray())
-                : Key;
-
-            for (var i = 0; i < Prefixes.Count; i++)
-            {
-                Prefixes[i] = keyObjects?.Any() ?? false
-                    ? string.Format(Prefixes[i], keyObjects.Select(CreateCacheKeyParameters).ToArray())
-                    : Prefixes[i];
-            }
-
-            return this;
-        }
-
         /// <summary>
         /// Cache key
         /// </summary>
-        public string Key { get; set; }
+        public string Key { get; protected set; }
 
         /// <summary>
         /// Prefixes to remove by prefix functionality
         /// </summary>
-        public List<string> Prefixes { get; set; } = new List<string>();
+        public List<string> Prefixes { get; protected set; } = new List<string>();
 
         /// <summary>
         /// Cache time in minutes

src/Libraries/Nop.Core/Domain/Vendors/NopVendorDefaults.cs

@@ -8,7 +8,6 @@
 using Nop.Data;
 using Nop.Services.Caching.Extensions;
 using Nop.Services.Common;
-using Nop.Services.Defaults;
 using Nop.Services.Events;
 using Nop.Services.Seo;
 
@@ -163,6 +162,7 @@ where a_o.Any()
             query = query.OrderByDescending(a => a.Id);
 
             var affiliates = new PagedList<Affiliate>(query, pageIndex, pageSize);
+
             return affiliates;
         }
 

src/Libraries/Nop.Services/Affiliates/AffiliateService.cs

@@ -1,6 +1,7 @@
 using Nop.Core.Domain.Affiliates;
+using Nop.Services.Caching;
 
-namespace Nop.Services.Caching.CacheEventConsumers.Affiliates
+namespace Nop.Services.Affiliates.Caching
 {
     /// <summary>
     /// Represents an affiliate cache event consumer

src/Libraries/Nop.Services/Caching/CacheEventConsumers/Affiliates/AffiliateCacheEventConsumer.cs renamed to src/Libraries/Nop.Services/Affiliates/Caching/AffiliateCacheEventConsumer.cs

@@ -1,4 +1,4 @@
-namespace Nop.Services.Defaults
+namespace Nop.Services.Affiliates
 {
     /// <summary>
     /// Represents default values related to affiliate services

src/Libraries/Nop.Services/Defaults/NopAffiliateDefaults.cs renamed to src/Libraries/Nop.Services/Affiliates/NopAffiliateDefaults.cs

@@ -7,7 +7,7 @@
 using Nop.Core.Domain.Catalog;
 using Nop.Core.Domain.Stores;
 using Nop.Data;
-using Nop.Services.Caching.CachingDefaults;
+using Nop.Services.Caching;
 using Nop.Services.Caching.Extensions;
 using Nop.Services.Events;
 
@@ -171,7 +171,7 @@ public virtual IPagedList<BlogPost> GetAllBlogPostsByTag(int storeId = 0,
         /// <returns>Blog post tags</returns>
         public virtual IList<BlogPostTag> GetAllBlogPostTags(int storeId, int languageId, bool showHidden = false)
         {
-            var cacheKey = NopBlogsCachingDefaults.BlogTagsModelCacheKey.FillCacheKey(languageId, storeId);
+            var cacheKey = NopBlogsDefaults.BlogTagsModelCacheKey.FillCacheKey(languageId, storeId);
 
             var blogPostTags = _cacheManager.Get(cacheKey, () =>
             {
@@ -395,7 +395,7 @@ public virtual int GetBlogCommentsCount(BlogPost blogPost, int storeId = 0, bool
             if (isApproved.HasValue)
                 query = query.Where(comment => comment.IsApproved == isApproved.Value);
 
-            var cacheKey = NopBlogsCachingDefaults.BlogCommentsNumberCacheKey.FillCacheKey(blogPost, storeId, isApproved);
+            var cacheKey = NopBlogsDefaults.BlogCommentsNumberCacheKey.FillCacheKey(blogPost, storeId, isApproved);
 
             return _cacheManager.Get(cacheKey, () => query.Count());
         }

src/Libraries/Nop.Services/Blogs/BlogService.cs

@@ -1,7 +1,7 @@
 using Nop.Core.Domain.Blogs;
-using Nop.Services.Caching.CachingDefaults;
+using Nop.Services.Caching;
 
-namespace Nop.Services.Caching.CacheEventConsumers.Blogs
+namespace Nop.Services.Blogs.Caching
 {
     /// <summary>
     /// Represents a blog comment cache event consumer
@@ -14,7 +14,7 @@ public partial class BlogCommentCacheEventConsumer : CacheEventConsumer<BlogComm
         /// <param name="entity">Entity</param>
         protected override void ClearCache(BlogComment entity)
         {
-            RemoveByPrefix(string.Format(NopBlogsCachingDefaults.BlogCommentsNumberPrefixCacheKey, entity.BlogPostId));
+            RemoveByPrefix(string.Format(NopBlogsDefaults.BlogCommentsNumberPrefixCacheKey, entity.BlogPostId));
         }
     }
 }

src/Libraries/Nop.Services/Caching/CacheEventConsumers/Blogs/BlogCommentCacheEventConsumer.cs renamed to src/Libraries/Nop.Services/Blogs/Caching/BlogCommentCacheEventConsumer.cs

@@ -1,7 +1,7 @@
 using Nop.Core.Domain.Blogs;
-using Nop.Services.Caching.CachingDefaults;
+using Nop.Services.Caching;
 
-namespace Nop.Services.Caching.CacheEventConsumers.Blogs
+namespace Nop.Services.Blogs.Caching
 {
     /// <summary>
     /// Represents a blog post cache event consumer
@@ -14,7 +14,7 @@ public partial class BlogPostCacheEventConsumer : CacheEventConsumer<BlogPost>
         /// <param name="entity">Entity</param>
         protected override void ClearCache(BlogPost entity)
         {
-            RemoveByPrefix(NopBlogsCachingDefaults.BlogTagsPrefixCacheKey);
+            RemoveByPrefix(NopBlogsDefaults.BlogTagsPrefixCacheKey);
         }
     }
 }

src/Libraries/Nop.Services/Caching/CacheEventConsumers/Blogs/BlogPostCacheEventConsumer.cs renamed to src/Libraries/Nop.Services/Blogs/Caching/BlogPostCacheEventConsumer.cs

@@ -1,12 +1,14 @@
 using Nop.Core.Caching;
 
-namespace Nop.Services.Caching.CachingDefaults
+namespace Nop.Services.Blogs
 {
     /// <summary>
     /// Represents default values related to blogs services
     /// </summary>
-    public static partial class NopBlogsCachingDefaults
+    public static partial class NopBlogsDefaults
     {
+        #region Caching defaults
+
         /// <summary>
         /// Key for number of blog comments
         /// </summary>
@@ -38,5 +40,7 @@ public static partial class NopBlogsCachingDefaults
         /// Gets a key pattern to clear cache
         /// </summary>
         public static string BlogTagsPrefixCacheKey => "Nop.blog.tags";
+
+        #endregion
     }
 }

src/Libraries/Nop.Services/Caching/CachingDefaults/NopBlogsCachingDefaults.cs renamed to src/Libraries/Nop.Services/Blogs/NopBlogsDefaults.cs

@@ -4,7 +4,7 @@
 using Nop.Core.Infrastructure;
 using Nop.Services.Events;
 
-namespace Nop.Services.Caching.CacheEventConsumers
+namespace Nop.Services.Caching
 {
     public abstract partial class CacheEventConsumer<TEntity> : IConsumer<EntityInsertedEvent<TEntity>>,
         IConsumer<EntityUpdatedEvent<TEntity>>,