Add support for VaryByQueryKey #2894

src/Microsoft.AspNetCore.Mvc.Core/CacheProfile.cs

@@ -11,7 +11,7 @@ public class CacheProfile
         /// <summary>
         /// Gets or sets the duration in seconds for which the response is cached.
         /// If this property is set to a non null value,
-        /// the "max-age" in "Cache-control" header is set in the 
+        /// the "max-age" in "Cache-control" header is set in the
         /// <see cref="Microsoft.AspNetCore.Http.HttpContext.Response" />.
         /// </summary>
         public int? Duration { get; set; }
@@ -36,5 +36,13 @@ public class CacheProfile
         /// Gets or sets the value for the Vary header in <see cref="Microsoft.AspNetCore.Http.HttpContext.Response" />.
         /// </summary>
         public string VaryByHeader { get; set; }
+
+        /// <summary>
+        /// Gets or sets the query keys to vary by.
+        /// </summary>
+        /// <remarks>
+        /// <see cref="VaryByQueryKeys"/> requires the response cache middleware.
+        /// </remarks>
+        public string[] VaryByQueryKeys { get; set; }
     }
 }

src/Microsoft.AspNetCore.Mvc.Core/Internal/ResponseCacheFilter.cs

@@ -7,6 +7,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Core;
 using Microsoft.AspNetCore.Mvc.Filters;
+using Microsoft.AspNetCore.ResponseCaching;
 using Microsoft.Net.Http.Headers;
 
 namespace Microsoft.AspNetCore.Mvc.Internal
@@ -21,6 +22,7 @@ public class ResponseCacheFilter : IActionFilter, IResponseCacheFilter
         private ResponseCacheLocation? _cacheLocation;
         private bool? _cacheNoStore;
         private string _cacheVaryByHeader;
+        private string[] _cacheVaryByQueryKeys;
 
         /// <summary>
         /// Creates a new instance of <see cref="ResponseCacheFilter"/>
@@ -73,6 +75,18 @@ public string VaryByHeader
             set { _cacheVaryByHeader = value; }
         }
 
+        /// <summary>
+        /// Gets or sets the query keys to vary by.
+        /// </summary>
+        /// <remarks>
+        /// <see cref="VaryByQueryKeys"/> requires the response cache middleware.
+        /// </remarks>
+        public string[] VaryByQueryKeys
+        {
+            get { return _cacheVaryByQueryKeys ?? _cacheProfile.VaryByQueryKeys; }
+            set { _cacheVaryByQueryKeys = value; }
+        }
+
         /// <inheritdoc />
         public void OnActionExecuting(ActionExecutingContext context)
         {
@@ -110,6 +124,16 @@ public void OnActionExecuting(ActionExecutingContext context)
                 headers[HeaderNames.Vary] = VaryByHeader;
             }
 
+            if (VaryByQueryKeys != null)
+            {
+                var responseCachingFeature = context.HttpContext.Features.Get<IResponseCachingFeature>();
+                if (responseCachingFeature == null)
+                {
+                    throw new InvalidOperationException(Resources.FormatVaryByQueryKeys_Requires_ResponseCachingMiddleware(nameof(VaryByQueryKeys)));
+                }
+                responseCachingFeature.VaryByQueryKeys = VaryByQueryKeys;
+            }
+
             if (NoStore)
             {
                 headers[HeaderNames.CacheControl] = "no-store";

src/Microsoft.AspNetCore.Mvc.Core/Resources.resx

@@ -376,4 +376,7 @@
   <data name="FormCollectionModelBinder_CannotBindToFormCollection" xml:space="preserve">
     <value>The '{0}' cannot bind to a model of type '{1}'. Change the model type to '{2}' instead.</value>
   </data>
+  <data name="VaryByQueryKeys_Requires_ResponseCachingMiddleware" xml:space="preserve">
+    <value>'{0}' requires the response cache middleware.</value>
+  </data>
 </root>

src/Microsoft.AspNetCore.Mvc.Core/ResponseCacheAttribute.cs

@@ -77,6 +77,14 @@ public bool NoStore
         /// </summary>
         public string VaryByHeader { get; set; }
 
+        /// <summary>
+        /// Gets or sets the query keys to vary by.
+        /// </summary>
+        /// <remarks>
+        /// <see cref="VaryByQueryKeys"/> requires the response cache middleware.
+        /// </remarks>
+        public string[] VaryByQueryKeys { get; set; }
+
         /// <summary>
         /// Gets or sets the value of the cache profile name.
         /// </summary>
@@ -117,6 +125,7 @@ public IFilterMetadata CreateInstance(IServiceProvider serviceProvider)
             _noStore = _noStore ?? selectedProfile?.NoStore;
             _location = _location ?? selectedProfile?.Location;
             VaryByHeader = VaryByHeader ?? selectedProfile?.VaryByHeader;
+            VaryByQueryKeys = VaryByQueryKeys ?? selectedProfile?.VaryByQueryKeys;
 
             // ResponseCacheFilter cannot take any null values. Hence, if there are any null values,
             // the properties convert them to their defaults and are passed on.
@@ -125,7 +134,8 @@ public IFilterMetadata CreateInstance(IServiceProvider serviceProvider)
                 Duration = _duration,
                 Location = _location,
                 NoStore = _noStore,
-                VaryByHeader = VaryByHeader
+                VaryByHeader = VaryByHeader,
+                VaryByQueryKeys = VaryByQueryKeys,
             });
         }
     }

src/Microsoft.AspNetCore.Mvc.Core/project.json

@@ -24,6 +24,7 @@
     "Microsoft.AspNetCore.Hosting.Abstractions": "1.1.0-*",
     "Microsoft.AspNetCore.Http": "1.1.0-*",
     "Microsoft.AspNetCore.Mvc.Abstractions": "1.1.0-*",
+    "Microsoft.AspNetCore.ResponseCaching.Abstractions": "1.0.0-*",
     "Microsoft.AspNetCore.Routing": "1.1.0-*",
     "Microsoft.AspNetCore.Routing.DecisionTree.Sources": {
       "type": "build",