Add UseTagsAsCacheKey && Rename FirstTag

Add UseTagsAsCacheKey && Rename FirstTag

Author: zzzprojects

src/Z.EntityFramework.Plus.EF5.NET40/ExceptionMessage.cs

@@ -24,7 +24,8 @@ internal class ExceptionMessage
         public static string BatchOperations_AssemblyNotFound = "Oops! The assembly 'Microsoft.EntityFrameworkCore.SqlServer' could not be found. This feature is only supported for SQL Server for .NET Core. For more information, contact us: [email protected]";
 #endif
 #if FULL || QUERY_CACHE
-        public static string QueryCache_FirstTagNullOrEmpty = "Oops! The option 'ForceFirstTagAsCacheKey' is enabled but we found no tag, an empty string, or a null string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";
+        public static string QueryCache_FirstTagNullOrEmpty = "Oops! The option 'UseFirstTagAsCacheKey' is enabled but we found no tag, an empty tag string, or a null tag string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";
+        public static string QueryCache_UseTagsNullOrEmpty = "Oops! The option 'UseTagsAsCacheKey' is enabled but we found no tag, an empty tag string, or a null tag string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";    
 #endif
 #if FULL || QUERY_INCLUDEFILTER
         public static string QueryIncludeFilter_ArgumentExpression = "Oops! immediate method with expression argument are not supported in EF+ Query IncludeFilter. For more information, contact us: [email protected]";

src/Z.EntityFramework.Plus.EF5.NET40/Properties/AssemblyInfo.cs

@@ -18,5 +18,5 @@
 [assembly: AssemblyCulture("")]
 [assembly: ComVisible(false)]
 [assembly: Guid("e4c2af73-caeb-4429-bcb6-0a359484e064")]
-[assembly: AssemblyVersion("1.4.5")]
-[assembly: AssemblyFileVersion("1.4.5")]
+[assembly: AssemblyVersion("1.4.6")]
+[assembly: AssemblyFileVersion("1.4.6")]

src/Z.EntityFramework.Plus.EF5.NET40/QueryCache/QueryCacheManager.cs

@@ -154,10 +154,16 @@ public static Func<MemoryCacheEntryOptions> MemoryCacheEntryOptionsFactory
         public static ConcurrentDictionary<string, List<string>> CacheTags { get; }
 
         /// <summary>
-        ///     Gets or sets a value indicating whether the first tag as cache key should be forced.
+        ///     Gets or sets a value indicating whether this object use first tag as cache key.
         /// </summary>
-        /// <value>true if force first tag as cache key, false if not.</value>
-        public static bool ForceFirstTagAsCacheKey { get; set; }
+        /// <value>true if use first tag as cache key, false if not.</value>
+        public static bool UseFirstTagAsCacheKey { get; set; }
+
+        /// <summary>
+        ///     Gets or sets a value indicating whether this object use tag as cache key.
+        /// </summary>
+        /// <value>true if use tag as cache key, false if not.</value>
+        public static bool UseTagsAsCacheKey { get; set; }
 
         /// <summary>Adds cache tags corresponding to a cached key in the CacheTags dictionary.</summary>
         /// <param name="cacheKey">The cache key.</param>
@@ -235,16 +241,6 @@ public static string GetCacheKey(IQueryable query, string[] tags)
                 }
             }
 
-            if (ForceFirstTagAsCacheKey)
-            {
-                if (tags.Length == 0 || string.IsNullOrEmpty(tags[0]))
-                {
-                    throw new Exception(ExceptionMessage.QueryCache_FirstTagNullOrEmpty);
-                }
-
-                return tags[0];
-            }
-
             var sb = new StringBuilder();
 
 #if EF5 || EF6
@@ -253,7 +249,7 @@ public static string GetCacheKey(IQueryable query, string[] tags)
 
             if (queryCacheUniqueKeyMethod != null)
             {
-                var queryCacheUniqueKey = (string) queryCacheUniqueKeyMethod.Invoke(query, null);
+                var queryCacheUniqueKey = (string)queryCacheUniqueKeyMethod.Invoke(query, null);
 
                 if (!string.IsNullOrEmpty(queryCacheUniqueKey))
                 {
@@ -267,37 +263,7 @@ public static string GetCacheKey(IQueryable query, string[] tags)
 
             if (IncludeConnectionInCacheKey)
             {
-                var connection = ((EntityConnection) objectQuery.Context.Connection).GetStoreConnection();
-
-                // FORCE database name in case "ChangeDatabase()" method is used
-                sb.AppendLine(connection.DataSource ?? "");
-                sb.AppendLine(connection.Database ?? "");
-                sb.AppendLine(connection.ConnectionString);
-            }
-
-            sb.AppendLine(string.Join(";", tags));
-#endif
-
-#if EF5
-            sb.AppendLine(objectQuery.ToTraceString());
-
-            foreach (var parameter in objectQuery.Parameters)
-            {
-                sb.Append(parameter.Name);
-                sb.Append(";");
-                sb.Append(parameter.Value);
-                sb.AppendLine(";");
-            }
-#elif EF6
-            var commandTextAndParameters = objectQuery.GetCommandTextAndParameters();
-            sb.AppendLine(commandTextAndParameters.Item1);
-
-            foreach (DbParameter parameter in commandTextAndParameters.Item2)
-            {
-                sb.Append(parameter.ParameterName);
-                sb.Append(";");
-                sb.Append(parameter.Value);
-                sb.AppendLine(";");
+                sb.AppendLine(GetConnectionStringForCacheKey(query));
             }
 #elif EFCORE
             RelationalQueryContext queryContext;
@@ -307,56 +273,33 @@ public static string GetCacheKey(IQueryable query, string[] tags)
 
             if (IncludeConnectionInCacheKey)
             {
-                var connection = queryContext.Connection.DbConnection;
-
-                // FORCE database name in case "ChangeDatabase()" method is used
-                sb.AppendLine(connection.DataSource ?? "");
-                sb.AppendLine(connection.Database ?? "");
-                sb.AppendLine(connection.ConnectionString);
-            }
-
-            sb.AppendLine(string.Join(";", tags));
-            sb.AppendLine(query.Expression.ToString());
-            sb.AppendLine(command.CommandText);
-
-            foreach (var parameter in queryContext.ParameterValues)
-            {
-                sb.Append(parameter.Key);
-                sb.Append(";");
-                sb.Append(parameter.Value);
-                sb.AppendLine(";");
+                sb.AppendLine(GetConnectionStringForCacheKey(queryContext));
             }
 #endif
 
-            return sb.ToString();
-        }
-
-        /// <summary>Gets cached keys used to cache or retrieve a query from the QueryCacheManager.</summary>
-        /// <typeparam name="T">Generic type parameter.</typeparam>
-        /// <param name="query">The query to cache or retrieve from the QueryCacheManager.</param>
-        /// <param name="tags">A variable-length parameters list containing tags to create the cache key.</param>
-        /// <returns>The cache key used to cache or retrieve a query from the QueryCacheManager.</returns>
-        public static string GetCacheKey<T>(QueryDeferred<T> query, string[] tags)
-        {
-            var sb = new StringBuilder();
-
-#if EF5 || EF6
-            var objectQuery = query.Query.GetObjectQuery();
+            if (UseFirstTagAsCacheKey)
+            {
+                if (tags == null || tags.Length == 0 || string.IsNullOrEmpty(tags[0]))
+                {
+                    throw new Exception(ExceptionMessage.QueryCache_FirstTagNullOrEmpty);
+                }
 
-            sb.AppendLine(CachePrefix);
+                sb.AppendLine(tags[0]);
+                return sb.ToString();
+            }
 
-            if (IncludeConnectionInCacheKey)
+            if (UseTagsAsCacheKey)
             {
-                var connection = ((EntityConnection) objectQuery.Context.Connection).GetStoreConnection();
+                if (tags == null || tags.Length == 0 || tags.Any(string.IsNullOrEmpty))
+                {
+                    throw new Exception(ExceptionMessage.QueryCache_UseTagsNullOrEmpty);
+                }
 
-                // FORCE database name in case "ChangeDatabase()" method is used
-                sb.AppendLine(connection.DataSource ?? "");
-                sb.AppendLine(connection.Database ?? "");
-                sb.AppendLine(connection.ConnectionString);
+                sb.AppendLine(string.Join(";", tags));
+                return sb.ToString();
             }
 
             sb.AppendLine(string.Join(";", tags));
-#endif
 
 #if EF5
             sb.AppendLine(objectQuery.ToTraceString());
@@ -380,22 +323,6 @@ public static string GetCacheKey<T>(QueryDeferred<T> query, string[] tags)
                 sb.AppendLine(";");
             }
 #elif EFCORE
-            RelationalQueryContext queryContext;
-            var command = query.Query.CreateCommand(out queryContext);
-
-            sb.AppendLine(CachePrefix);
-
-            if (IncludeConnectionInCacheKey)
-            {
-                var connection = queryContext.Connection.DbConnection;
-
-                // FORCE database name in case "ChangeDatabase()" method is used
-                sb.AppendLine(connection.DataSource ?? "");
-                sb.AppendLine(connection.Database ?? "");
-                sb.AppendLine(connection.ConnectionString);
-            }
-
-            sb.AppendLine(string.Join(";", tags));
             sb.AppendLine(query.Expression.ToString());
             sb.AppendLine(command.CommandText);
 
@@ -410,5 +337,50 @@ public static string GetCacheKey<T>(QueryDeferred<T> query, string[] tags)
 
             return sb.ToString();
         }
+
+        public static string GetConnectionStringForCacheKey(IQueryable query)
+        {
+#if EF5 || EF6
+            var connection = ((EntityConnection) query.GetObjectQuery().Context.Connection).GetStoreConnection();
+
+            // FORCE database name in case "ChangeDatabase()" method is used
+            var connectionString = string.Concat(connection.DataSource ?? "", 
+                Environment.NewLine, 
+                connection.Database ?? "",
+                Environment.NewLine,
+                connection.ConnectionString ?? "");
+            return connectionString;
+#elif EFCORE
+            RelationalQueryContext queryContext;
+            var command = query.CreateCommand(out queryContext);
+            return GetConnectionStringForCacheKey(queryContext);
+#endif
+        }
+
+#if EFCORE
+        public static string GetConnectionStringForCacheKey(RelationalQueryContext queryContext)
+        {
+            var connection = queryContext.Connection.DbConnection;
+
+            // FORCE database name in case "ChangeDatabase()" method is used
+            var connectionString = string.Concat(connection.DataSource ?? "", 
+                Environment.NewLine, 
+                connection.Database ?? "",
+                Environment.NewLine,
+                connection.ConnectionString ?? "");
+            return connectionString;
+        }
+#endif
+
+
+        /// <summary>Gets cached keys used to cache or retrieve a query from the QueryCacheManager.</summary>
+        /// <typeparam name="T">Generic type parameter.</typeparam>
+        /// <param name="query">The query to cache or retrieve from the QueryCacheManager.</param>
+        /// <param name="tags">A variable-length parameters list containing tags to create the cache key.</param>
+        /// <returns>The cache key used to cache or retrieve a query from the QueryCacheManager.</returns>
+        public static string GetCacheKey<T>(QueryDeferred<T> query, string[] tags)
+        {
+            return GetCacheKey(query.Query, tags);
+        }
     }
 }

src/Z.EntityFramework.Plus.EF5/ExceptionMessage.cs

@@ -24,7 +24,8 @@ internal class ExceptionMessage
         public static string BatchOperations_AssemblyNotFound = "Oops! The assembly 'Microsoft.EntityFrameworkCore.SqlServer' could not be found. This feature is only supported for SQL Server for .NET Core. For more information, contact us: [email protected]";
 #endif
 #if FULL || QUERY_CACHE
-        public static string QueryCache_FirstTagNullOrEmpty = "Oops! The option 'ForceFirstTagAsCacheKey' is enabled but we found no tag, an empty string, or a null string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";
+        public static string QueryCache_FirstTagNullOrEmpty = "Oops! The option 'UseFirstTagAsCacheKey' is enabled but we found no tag, an empty tag string, or a null tag string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";
+        public static string QueryCache_UseTagsNullOrEmpty = "Oops! The option 'UseTagsAsCacheKey' is enabled but we found no tag, an empty tag string, or a null tag string instead. Make sure a tag is provided, and it's not null or empty. For more information, contact us: [email protected]";    
 #endif
 #if FULL || QUERY_INCLUDEFILTER
         public static string QueryIncludeFilter_ArgumentExpression = "Oops! immediate method with expression argument are not supported in EF+ Query IncludeFilter. For more information, contact us: [email protected]";

src/Z.EntityFramework.Plus.EF5/Properties/AssemblyInfo.cs

@@ -18,5 +18,5 @@
 [assembly: AssemblyCulture("")]
 [assembly: ComVisible(false)]
 [assembly: Guid("abcbb878-043c-4957-a334-90e9872e684e")]
-[assembly: AssemblyVersion("1.4.5")]
-[assembly: AssemblyFileVersion("1.4.5")]
+[assembly: AssemblyVersion("1.4.6")]
+[assembly: AssemblyFileVersion("1.4.6")]