asp.net-web-api – 在ASP.NET Core Web API中实现HTTP缓存(ETag

经过一段时间的尝试使其与中间件一起工作,我发现MVC action filters实际上更适合这个功能.

在这个例子中,我借用了Bennie的ETag生成代码：

public class ETagFilter : Attribute,IActionFilter
{
    private readonly int[] _statusCodes;

    public ETagFilter(params int[] statusCodes)
    {
        _statusCodes = statusCodes;
        if (statusCodes.Length == 0) _statusCodes = new[] {200};
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        if (context.HttpContext.Request.Method == "GET")
        {
            if (_statusCodes.Contains(context.HttpContext.Response.StatusCode))
            {
                //I just serialize the result to JSON,could implement IEquality<> for better performance. 
                var content = context.Result.ToJson();

                var etag = ETagGenerator.GetETag(context.HttpContext.Request.Path.ToString(),Encoding.UTF8.GetBytes(content));

                if (context.HttpContext.Request.Headers.Keys.Contains("If-None-Match") && context.HttpContext.Request.Headers["If-None-Match"].ToString() == etag)
                {
                    context.Result = new StatusCodeResult(304);
                }                        
                context.HttpContext.Response.Headers.Add("ETag",new[] { etag });
            }
        }
    }
}

然后将其用作您想要的动作或控制器作为属性：

[HttpGet]
[Route("/api/data/")]
[ETagFilter(200)]
public async Task<IActionResult> GetDataFromApi()
{
 ...
}

这两种方法之间的重要区别在于,您的中间件可以在MVC middlware之前和之后运行,并且只能使用HttpContext.一旦MVC开始将响应发送回客户端,为时已晚,无法进行任何更改.

另一方面,动作过滤器是MVC中间件的一部分.他们可以访问MVC上下文,在这种情况下,实现此功能更为简单. More on Filters及其在MVC中的管道.