如何在特定控制器上实现会话感知 WEB API？

Question

我正在创建一些需要会话感知的 WEB API 2 控制器。我以前通过添加

来做到这一点

/// <summary>
/// Application_s the post authorize request.
/// </summary>
protected void Application_PostAuthorizeRequest()
{
     HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);
}

但是，我们在解决方案中为站点的其他业务关键部分提供了 API 控制器，这些部分已经过高度优化，并且返回的响应大约为 500 毫秒，如果启用此功能，则持续时间最长可达 2 秒。这些控制器不需要会话感知。

我们只需要给定会话访问权限的某些控制器，我已经阅读了这篇文章 http://www.codeproject.com/Tips/513522/Providing-session-state-in-ASP-NET-WebAPI，并且正在考虑是否可以添加具有会话感知能力的不同路由，但映射时没有 RouteHandler 属性路线。

有人有什么想法吗？

Answer 1

请记住，使用 SessionStateBehavior.Required 会产生相当大的影响，并且只有部分路由实际上需要对会话的写入权限。最糟糕的是每个用户一次只能处理一个请求，因为会话必须被锁定。

话虽如此，有一种方法可以根据路线以不同的方式处理会话。

您可以使用IHttpRoute.DataTokens 将自定义字段添加到您的路线。 我创建了一个小的扩展类来分别为每个路由设置 SessionStateBehavior：

public static class SessionHelper
{
  private static SessionStateBehavior GetSessionStateBehavior(IDictionary<string, object> dataTokens)
  {
    return dataTokens.ContainsKey("SessionStateBehavior") ? (SessionStateBehavior)dataTokens["SessionStateBehavior"] : SessionStateBehavior.Default;
  }

  public static SessionStateBehavior GetSessionStateBehavior(this IHttpRoute route)
  {
    return GetSessionStateBehavior(route.DataTokens);
  }

  public static SessionStateBehavior GetSessionStateBehavior(this RouteData routeData)
  {
    return GetSessionStateBehavior(routeData.DataTokens);
  }

  public static void SetSessionStateBehavior(this IHttpRoute route, SessionStateBehavior behavior)
  {
    route.DataTokens["SessionStateBehavior"] = behavior;
  }

  public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate, object defaults, SessionStateBehavior behavior)
  {
    return MapHttpRoute(routes, name, routeTemplate, defaults, null, behavior);
  }

  public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate, object defaults, object constraints, SessionStateBehavior behavior)
  {
    var route = routes.CreateRoute(routeTemplate, defaults, constraints);
    SetSessionStateBehavior(route, behavior);
    routes.Add(name, route);

    return route;
  }
}

在设置路由时，您可以使用扩展来定义特定的会话状态行为：

config.Routes.MapHttpRoute(
    "DefaultSessionApi",
    "api/{controller}/{id}",
    new { id = RouteParameter.Optional },
    SessionStateBehavior.ReadOnly);

config.Routes.MapHttpRoute(
    "WriteStuffToSession",
    "api/writestufftosession",
    null,
    SessionStateBehavior.Required);

然后，在PostAuthorizeRequest 事件中，您可以解析您的路由并相应地设置 SessionStateBehavior：

protected void Application_PostAuthorizeRequest()
{
  var context = new HttpContextWrapper(HttpContext.Current);
  var path = context.Request.AppRelativeCurrentExecutionFilePath;
  if (path == null || !path.StartsWith("~/api"))
  {
    return;
  }

  var routeData = RouteTable.Routes.GetRouteData(context);
  if (routeData != null)
  {
    context.SetSessionStateBehavior(routeData.GetSessionStateBehavior());
  }
}

Answer 2

我想出了一个可行的解决方案。我在路线注册期间添加了第二条路线，例如

        config.Routes.MapHttpRoute(
            name: "DefaultSessionApi",
            routeTemplate: "sessionapi/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional });

然后在 global.asax.cs 我有

    /// <summary>
    /// Application_s the post authorize request.
    /// </summary>
    protected void Application_PostAuthorizeRequest()
    {
        if (HttpContext.Current.Request.FilePath.StartsWith("/sessionapi"))
        {
            HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);
        }
    }

这允许任何控制器在会话感知或不从客户端发出请求，从而解决我的问题。

我的解决方案在配置常量等方面更简洁一些，但上面的代码就是示例。