如何在特定控制器上实现会话感知 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

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

        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);
        }
    }

这允许任何控制器在有会话感知或没有会话感知的情况下从客户端请求，因此解决了我的问题。

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

Answer 2

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

也就是说，有一种方法可以根据路线以不同方式处理会话。

您可以使用 IHttpRoute.DataTokens 将自定义字段添加到您的路线。我创建了一个小扩展 class 来分别为每个路由设置 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());
  }
}

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

How do I implement session aware WEB API on specific controllers?

c#

asp.net

asp.net-mvc

asp.net-web-api