Use ObjectPool for StringBuilder

Author: JunTaoLuo

src/Microsoft.AspNetCore.ResponseCaching/ResponseCachingContext.cs

@@ -12,12 +12,21 @@
 using Microsoft.AspNetCore.ResponseCaching.Internal;
 using Microsoft.Extensions.Primitives;
 using Microsoft.Net.Http.Headers;
+using Microsoft.Extensions.ObjectPool;
 
 namespace Microsoft.AspNetCore.ResponseCaching
 {
     public class ResponseCachingContext
     {
         private static readonly CacheControlHeaderValue EmptyCacheControl = new CacheControlHeaderValue();
+
+        private readonly HttpContext _httpContext;
+        private readonly IResponseCache _cache;
+        private readonly ISystemClock _clock;
+        private readonly ObjectPool<StringBuilder> _builderPool;
+        private readonly IResponseCachingCacheabilityValidator _cacheabilityValidator;
+        private readonly IResponseCachingCacheKeySuffixProvider _cacheKeySuffixProvider;
+
         private string _cacheKey;
         private ResponseType? _responseType;
         private RequestHeaders _requestHeaders;
@@ -32,9 +41,10 @@ public class ResponseCachingContext
         public ResponseCachingContext(
             HttpContext httpContext,
             IResponseCache cache,
+            ObjectPool<StringBuilder> builderPool,
             IResponseCachingCacheabilityValidator cacheabilityValidator,
             IResponseCachingCacheKeySuffixProvider cacheKeySuffixProvider)
-            : this(httpContext, cache, new SystemClock(), cacheabilityValidator, cacheKeySuffixProvider)
+            : this(httpContext, cache, new SystemClock(), builderPool, cacheabilityValidator, cacheKeySuffixProvider)
         {
         }
 
@@ -43,14 +53,16 @@ internal ResponseCachingContext(
             HttpContext httpContext, 
             IResponseCache cache,
             ISystemClock clock,
+            ObjectPool<StringBuilder> builderPool,
             IResponseCachingCacheabilityValidator cacheabilityValidator,
             IResponseCachingCacheKeySuffixProvider cacheKeySuffixProvider)
         {
-            HttpContext = httpContext;
-            Cache = cache;
-            Clock = clock;
-            CacheabilityValidator = cacheabilityValidator;
-            CacheKeySuffixProvider = cacheKeySuffixProvider;
+            _httpContext = httpContext;
+            _cache = cache;
+            _clock = clock;
+            _builderPool = builderPool;
+            _cacheabilityValidator = cacheabilityValidator;
+            _cacheKeySuffixProvider = cacheKeySuffixProvider;
         }
 
         internal bool CacheResponse
@@ -70,16 +82,6 @@ internal bool CacheResponse
 
         internal bool ResponseStarted { get; set; }
 
-        private HttpContext HttpContext { get; }
-
-        private IResponseCache Cache { get; }
-
-        private ISystemClock Clock { get; }
-
-        private IResponseCachingCacheabilityValidator CacheabilityValidator { get; }
-
-        private IResponseCachingCacheKeySuffixProvider CacheKeySuffixProvider { get; }
-
         private Stream OriginalResponseStream { get; set; }
 
         private ResponseCacheStream ResponseCacheStream { get; set; }
@@ -92,7 +94,7 @@ private RequestHeaders RequestHeaders
             {
                 if (_requestHeaders == null)
                 {
-                    _requestHeaders = HttpContext.Request.GetTypedHeaders();
+                    _requestHeaders = _httpContext.Request.GetTypedHeaders();
                 }
                 return _requestHeaders;
             }
@@ -104,7 +106,7 @@ private ResponseHeaders ResponseHeaders
             {
                 if (_responseHeaders == null)
                 {
-                    _responseHeaders = HttpContext.Response.GetTypedHeaders();
+                    _responseHeaders = _httpContext.Response.GetTypedHeaders();
                 }
                 return _responseHeaders;
             }
@@ -143,49 +145,61 @@ internal string CreateCacheKey()
 
         internal string CreateCacheKey(CachedVaryBy varyBy)
         {
-            var request = HttpContext.Request;
-            var builder = new StringBuilder()
-                .Append(request.Method.ToUpperInvariant())
-                .Append(";")
-                .Append(request.Path.Value.ToUpperInvariant());
+            var request = _httpContext.Request;
+            var builder = _builderPool?.Get() ?? new StringBuilder();
 
-            if (varyBy?.Headers.Count > 0)
+            try
             {
-                // TODO: resolve key format and delimiters
-                foreach (var header in varyBy.Headers)
-                {
-                    // TODO: Normalization of order, case?
-                    var value = HttpContext.Request.Headers[header];
+                builder
+                    .Append(request.Method.ToUpperInvariant())
+                    .Append(";")
+                    .Append(request.Path.Value.ToUpperInvariant());
 
-                    // TODO: How to handle null/empty string?
-                    if (StringValues.IsNullOrEmpty(value))
+                if (varyBy?.Headers.Count > 0)
+                {
+                    // TODO: resolve key format and delimiters
+                    foreach (var header in varyBy.Headers)
                     {
-                        value = "null";
+                        // TODO: Normalization of order, case?
+                        var value = _httpContext.Request.Headers[header];
+
+                        // TODO: How to handle null/empty string?
+                        if (StringValues.IsNullOrEmpty(value))
+                        {
+                            value = "null";
+                        }
+
+                        builder.Append(";")
+                            .Append(header)
+                            .Append("=")
+                            .Append(value);
                     }
+                }
+                // TODO: Parse querystring params
 
+                // Append custom cache key segment
+                var customKey = _cacheKeySuffixProvider.CreateCustomKeySuffix(_httpContext);
+                if (!string.IsNullOrEmpty(customKey))
+                {
                     builder.Append(";")
-                        .Append(header)
-                        .Append("=")
-                        .Append(value);
+                        .Append(customKey);
                 }
-            }
-            // TODO: Parse querystring params
 
-            // Append custom cache key segment
-            var customKey = CacheKeySuffixProvider.CreateCustomKeySuffix(HttpContext);
-            if (!string.IsNullOrEmpty(customKey))
+                return builder.ToString();
+            }
+            finally
             {
-                builder.Append(";")
-                    .Append(customKey);
+                if (_builderPool != null)
+                {
+                    _builderPool.Return(builder);
+                }
             }
-
-            return builder.ToString();
         }
 
         internal bool RequestIsCacheable()
         {
             // Use optional override if specified by user
-            switch(CacheabilityValidator.RequestIsCacheableOverride(HttpContext))
+            switch(_cacheabilityValidator.RequestIsCacheableOverride(_httpContext))
             {
                 case OverrideResult.UseDefaultLogic:
                     break;
@@ -194,12 +208,12 @@ internal bool RequestIsCacheable()
                 case OverrideResult.Cache:
                     return true;
                 default:
-                    throw new NotSupportedException($"Unrecognized result from {nameof(CacheabilityValidator.RequestIsCacheableOverride)}.");
+                    throw new NotSupportedException($"Unrecognized result from {nameof(_cacheabilityValidator.RequestIsCacheableOverride)}.");
             }
 
             // Verify the method
             // TODO: RFC lists POST as a cacheable method when explicit freshness information is provided, but this is not widely implemented. Will revisit.
-            var request = HttpContext.Request;
+            var request = _httpContext.Request;
             if (string.Equals("GET", request.Method, StringComparison.OrdinalIgnoreCase))
             {
                 _responseType = ResponseType.FullReponse;
@@ -249,7 +263,7 @@ internal bool RequestIsCacheable()
         internal bool ResponseIsCacheable()
         {
             // Use optional override if specified by user
-            switch (CacheabilityValidator.ResponseIsCacheableOverride(HttpContext))
+            switch (_cacheabilityValidator.ResponseIsCacheableOverride(_httpContext))
             {
                 case OverrideResult.UseDefaultLogic:
                     break;
@@ -258,7 +272,7 @@ internal bool ResponseIsCacheable()
                 case OverrideResult.Cache:
                     return true;
                 default:
-                    throw new NotSupportedException($"Unrecognized result from {nameof(CacheabilityValidator.ResponseIsCacheableOverride)}.");
+                    throw new NotSupportedException($"Unrecognized result from {nameof(_cacheabilityValidator.ResponseIsCacheableOverride)}.");
             }
 
             // Only cache pages explicitly marked with public
@@ -281,7 +295,7 @@ internal bool ResponseIsCacheable()
                 return false;
             }
 
-            var response = HttpContext.Response;
+            var response = _httpContext.Response;
 
             // Do not cache responses varying by *
             if (string.Equals(response.Headers[HeaderNames.Vary], "*", StringComparison.OrdinalIgnoreCase))
@@ -359,28 +373,28 @@ internal bool EntryIsFresh(ResponseHeaders responseHeaders, TimeSpan age, bool v
         internal async Task<bool> TryServeFromCacheAsync()
         {
             _cacheKey = CreateCacheKey();
-            var cacheEntry = Cache.Get(_cacheKey);
+            var cacheEntry = _cache.Get(_cacheKey);
             var responseServed = false;
 
             if (cacheEntry is CachedVaryBy)
             {
                 // Request contains VaryBy rules, recompute key and try again
                 _cacheKey = CreateCacheKey(cacheEntry as CachedVaryBy);
-                cacheEntry = Cache.Get(_cacheKey);
+                cacheEntry = _cache.Get(_cacheKey);
             }
 
             if (cacheEntry is CachedResponse)
             {
                 var cachedResponse = cacheEntry as CachedResponse;
                 var cachedResponseHeaders = new ResponseHeaders(cachedResponse.Headers);
 
-                _responseTime = Clock.UtcNow;
+                _responseTime = _clock.UtcNow;
                 var age = _responseTime - cachedResponse.Created;
                 age = age > TimeSpan.Zero ? age : TimeSpan.Zero;
 
                 if (EntryIsFresh(cachedResponseHeaders, age, verifyAgainstRequest: true))
                 {
-                    var response = HttpContext.Response;
+                    var response = _httpContext.Response;
                     // Copy the cached status code and response headers
                     response.StatusCode = cachedResponse.StatusCode;
                     foreach (var header in cachedResponse.Headers)
@@ -425,7 +439,7 @@ internal async Task<bool> TryServeFromCacheAsync()
 
             if (!responseServed && RequestCacheControl.OnlyIfCached)
             {
-                HttpContext.Response.StatusCode = StatusCodes.Status504GatewayTimeout;
+                _httpContext.Response.StatusCode = StatusCodes.Status504GatewayTimeout;
 
                 responseServed = true;
             }
@@ -438,7 +452,7 @@ internal void FinalizeCachingHeaders()
             if (CacheResponse)
             {
                 // Create the cache entry now
-                var response = HttpContext.Response;
+                var response = _httpContext.Response;
                 var varyHeaderValue = response.Headers[HeaderNames.Vary];
                 _cachedResponseValidFor = ResponseCacheControl.SharedMaxAge
                     ?? ResponseCacheControl.MaxAge
@@ -457,7 +471,7 @@ internal void FinalizeCachingHeaders()
                     };
 
                     // TODO: Overwrite?
-                    Cache.Set(_cacheKey, cachedVaryBy, _cachedResponseValidFor);
+                    _cache.Set(_cacheKey, cachedVaryBy, _cachedResponseValidFor);
                     _cacheKey = CreateCacheKey(cachedVaryBy);
                 }
 
@@ -471,7 +485,7 @@ internal void FinalizeCachingHeaders()
                 _cachedResponse = new CachedResponse
                 {
                     Created = ResponseHeaders.Date.Value,
-                    StatusCode = HttpContext.Response.StatusCode
+                    StatusCode = _httpContext.Response.StatusCode
                 };
 
                 foreach (var header in ResponseHeaders.Headers)
@@ -495,7 +509,7 @@ internal void FinalizeCachingBody()
             {
                 _cachedResponse.Body = ResponseCacheStream.BufferedStream.ToArray();
 
-                Cache.Set(_cacheKey, _cachedResponse, _cachedResponseValidFor);
+                _cache.Set(_cacheKey, _cachedResponse, _cachedResponseValidFor);
             }
         }
 
@@ -504,7 +518,7 @@ internal void OnResponseStarting()
             if (!ResponseStarted)
             {
                 ResponseStarted = true;
-                _responseTime = Clock.UtcNow;
+                _responseTime = _clock.UtcNow;
 
                 FinalizeCachingHeaders();
             }
@@ -515,25 +529,25 @@ internal void ShimResponseStream()
             // TODO: Consider caching large responses on disk and serving them from there.
 
             // Shim response stream
-            OriginalResponseStream = HttpContext.Response.Body;
+            OriginalResponseStream = _httpContext.Response.Body;
             ResponseCacheStream = new ResponseCacheStream(OriginalResponseStream);
-            HttpContext.Response.Body = ResponseCacheStream;
+            _httpContext.Response.Body = ResponseCacheStream;
 
             // Shim IHttpSendFileFeature
-            OriginalSendFileFeature = HttpContext.Features.Get<IHttpSendFileFeature>();
+            OriginalSendFileFeature = _httpContext.Features.Get<IHttpSendFileFeature>();
             if (OriginalSendFileFeature != null)
             {
-                HttpContext.Features.Set<IHttpSendFileFeature>(new SendFileFeatureWrapper(OriginalSendFileFeature, ResponseCacheStream));
+                _httpContext.Features.Set<IHttpSendFileFeature>(new SendFileFeatureWrapper(OriginalSendFileFeature, ResponseCacheStream));
             }
         }
 
         internal void UnshimResponseStream()
         {
             // Unshim response stream
-            HttpContext.Response.Body = OriginalResponseStream;
+            _httpContext.Response.Body = OriginalResponseStream;
 
             // Unshim IHttpSendFileFeature
-            HttpContext.Features.Set(OriginalSendFileFeature);
+            _httpContext.Features.Set(OriginalSendFileFeature);
         }
 
         private enum ResponseType