49

我正在尝试在 Web API中缓存ApiController方法的输出。

这是控制器代码：

public class TestController : ApiController
{
    [OutputCache(Duration = 10, VaryByParam = "none", Location = OutputCacheLocation.Any)]
    public string Get()
    {
        return System.DateTime.Now.ToString();
    }
}

注意我还尝试了控制器本身的 OutputCache 属性，以及其参数的几种组合。

路由在 Global.asax 中注册：

namespace WebApiTest
{
    public class Global : HttpApplication
    {
        protected void Application_Start(object sender, EventArgs e)
        {
            RouteTable.Routes.MapHttpRoute("default", routeTemplate: "{controller}");
        }
    }
}

我得到了成功的响应，但它没有缓存在任何地方：

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/xml; charset=utf-8
Expires: -1
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 18 Jul 2012 17:56:17 GMT
Content-Length: 96

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">18/07/2012 18:56:17</string>

我无法在 Web API 中找到输出缓存的文档。

这是 MVC4 中 Web API 的限制还是我做错了什么？

4

5 回答 5

44

WebAPI 没有对该[OutputCache]属性的任何内置支持。查看这篇文章，了解如何自己实现此功能。

于 2012-07-18T18:18:07.547 回答
34

Aliostad 的回答指出 Web API 关闭了缓存，而 HttpControllerHandler 的代码显示它在 response.Headers.CacheControl 为空时会这样做。

要使您的示例 ApiController Action 返回可缓存的结果，您可以：

using System.Net.Http;

public class TestController : ApiController
{
    public HttpResponseMessage Get()
    {
        var response = Request.CreateResponse(HttpStatusCode.OK);
        response.Content = new StringContent(System.DateTime.Now.ToString());
        response.Headers.CacheControl = new CacheControlHeaderValue();
        response.Headers.CacheControl.MaxAge = new TimeSpan(0, 10, 0);  // 10 min. or 600 sec.
        response.Headers.CacheControl.Public = true;
        return response;
    }
}

你会得到一个像这样的 HTTP 响应头：

Cache-Control: public, max-age=600
Content-Encoding: gzip
Content-Type: text/plain; charset=utf-8
Date: Wed, 13 Mar 2013 21:06:10 GMT
...
于 2013-03-13T21:27:11.053 回答
17

在过去的几个月里，我一直在研究 ASP.NET Web API 的 HTTP 缓存。我为服务器端的WebApiContrib做出了贡献，相关信息可以在我的博客上找到。

最近我开始扩展工作并在CacheCow库中添加客户端。现在已经发布了第一个 NuGet 包（感谢Tugberk）。我很快就会就此写一篇博文。所以看空间。

但为了回答您的问题，ASP.NET Web API 默认关闭缓存。如果您希望响应被缓存，您需要将 CacheControl 标头添加到控制器中的响应中（实际上最好是在类似于 CacheCow 中的 CachingHandler 的委托处理程序中）。

此片段来自HttpControllerHandlerASP.NET Web Stack 源代码：

        CacheControlHeaderValue cacheControl = response.Headers.CacheControl;

        // TODO 335085: Consider this when coming up with our caching story
        if (cacheControl == null)
        {
            // DevDiv2 #332323. ASP.NET by default always emits a cache-control: private header.
            // However, we don't want requests to be cached by default.
            // If nobody set an explicit CacheControl then explicitly set to no-cache to override the
            // default behavior. This will cause the following response headers to be emitted:
            //     Cache-Control: no-cache
            //     Pragma: no-cache
            //     Expires: -1
            httpContextBase.Response.Cache.SetCacheability(HttpCacheability.NoCache);
        }
于 2012-07-19T08:09:41.023 回答
6

我很晚了，但仍然想在 WebApi 中发布这篇关于缓存的精彩文章

https://codewala.net/2015/05/25/outputcache-doesnt-work-with-web-api-why-a-solution/

public class CacheWebApiAttribute : ActionFilterAttribute
{
    public int Duration { get; set; }

    public override void OnActionExecuted(HttpActionExecutedContext filterContext)
    {
        filterContext.Response.Headers.CacheControl = new CacheControlHeaderValue()
        {
            MaxAge = TimeSpan.FromMinutes(Duration),
            MustRevalidate = true,
            Private = true
        };
    }
}

在上面的代码中，我们重写了 OnActionExecuted 方法并在响应中设置了所需的标头。现在我将 Web API 调用修饰为

[CacheWebApi(Duration = 20)]
        public IEnumerable<string> Get()
        {
            return new string[] { DateTime.Now.ToLongTimeString(), DateTime.UtcNow.ToLongTimeString() };
        }
于 2018-04-19T13:49:12.487 回答
-22

您可以在常规 MVC 控制器上使用它：

[OutputCache(Duration = 10, VaryByParam = "none", Location = OutputCacheLocation.Any)]
public string Get()
{
    HttpContext.Current.Response.Cache.SetOmitVaryStar(true);
    return System.DateTime.Now.ToString();
}

但是 OutputCache 属性位于 System.Web.Mvc 命名空间中，并且在 ApiController 中不可用。

于 2012-09-26T05:24:18.787 回答