[水煮 ASP.NET Web API2 方法论]（1-8）添加 Session 状态

问题

ASP.NET Web API 构建 Web 应用程序时，要求使用 Session 在服务器存储一些用户特定的信息

解决方案

ASP.NET Web API 不支持 Session，因为 API 根本不依赖于System.Web。他想试图摆脱伪造 Session，非 HTTP这样的概念。

然而，如果我们 在 ASP.NET 运行时中运行 ASP.NET Web API，还想启用 Session。我们可以通过两种方式来做：

  • 全局：应用于整个 API
  • 局部：应用于指定路由

启用全局方式，我们需要在  Global.asax 中 通过 SesssionStateBehavior.Required显示的设置启用 Session 行为。


1

2

3

4

protected void Application_PostAuthorizeRequest()

{

    HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);

}

启用指定路由（局部方式），我们可以通过过使用路由处理器，让路由处理器继承自 IRequiresSessionState。然后，我们可以在指定的路由上附加处理器，这个就在请求指定路由的时候启用了 Session。

工作原理

默认的 ASP.NET Web API 模板，会帮我们在 WebApiConfig 静态类中使用 HttpConfiguration 定义默认路由，因为，框架附带的扩展方法是支持我们使用 System.Web.RouteCollection，在定义 MVC 路由的地方定义 Web API路由。

虽然 MapHttpRoute 的多个重载方法经常被使用，但是这些重载方法都是 void （无返回值）方法，实际上，方法还是返回了一个最新声明路由的实例，只是方法的调用结果一般都是被抛弃掉的。在使用Syste.Web.RouteCollection 直接定义路由的情况下，返回值是 System.Web.Route 的对象，我们可以将其赋值给 IrouteHandler。

当运行在 ASP.NET 的时候，ASP.NET Web API 框架使用同样的机制来确保 Api 请求可以准确到达，他会赋值HttpControllerRouteHandler 给每一个 Web API 路由，HttpControllerRouteHandler 是 GetHttpHandler 方法返回的一个HttpControllerHandler 实例，这是 ASP.NET Web API 管道的入口点。HttpControllerHandler（WEB API 的核心）虽然很复杂，但是究其原理也就是一个传统的 IHttpAsyncHandler（旧的 IHttpHandler 的一个异步的版本）。

我们可以通过实现IRequiresSessionState 的接口，来强制在 IHttpHandler 中使用 Session。ASP.NET 将会显示的为每一个实现了这个接口路由启用 Session。

另外要在全局范围内调用 HttpContext.Current.SetSessionStateBehavior 方法和传递 SessionStateBehavior，需要为当前的 HttpContext 显示的启用 Session。SetSessionStateBehavior方法必须在 AcquireRequestState 事件之前调用。

代码演示

继承两个类：

  • HttpControllerHandler
  • HttpControllerRouteHandler

我们将创建两个自定义类

  • SessionHttpControllerHandler：实现     IRequiresSessionState
  • SessionHttpControllerRouteHandler：只是代替默认类型，来充当返回     SessionHttpControllerHandler 的工厂

如清单 1-26 所示。

清单 1-26. 定制 HttpControllerHandler和 HttpControllerRouteHandler


1

2

3

4

5

6

7

8

9

10

11

12

13

public class SessionControllerHandler : HttpControllerHandler, IRequiresSessionState

{

    public SessionControllerHandler(RouteData routeData)

        : base(routeData)

    { }

}

public class SessionHttpControllerRouteHandler : HttpControllerRouteHandler

{

    protected override IHttpHandler GetHttpHandler(RequestContext requestContext)

    {

        return new SessionControllerHandler(requestContext.RouteData);

    }

}

现在我们需要将我们的注意力从 WebApiConfig 类转移到 RouteConfig 类，因为我们需要执行RouteCollection。接下来，我们应该在创建路由的时候，将 SessionHttpControllerRouteHandler 赋值给RouteHandler。如清单 1-27 所示。

清单 1-27.  在System.Web.RouteCollection 中注册 Web API 路由


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

public static void RegisterRoutes(RouteCollection routes)

{

    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    //Web API

    routes.MapHttpRoute(

    name: "DefaultApi",

    routeTemplate: "api/{controller}/{id}",

    defaults: new { id = RouteParameter.Optional }

    ).RouteHandler = new SessionHttpControllerRouteHandler();

    //MVC

    routes.MapRoute(

    name: "Default",

    url: "{controller}/{action}/{id}",

    defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }

    );

}

如果想激进一点，还是有其他的方式来执行这个功能的。不再需要跑到 RouteConfig 中注册 Api 的路由，而是需要使用 WebApiConfig 中的 HttpConfiguration 做一些必要的处理，可以同样达对所有  Web API 路由启用Session。

当我们通过 Web API 的配置注册路由的时候，路由是被注册在 RouteTable 中，同时，使用一个单利HttpControllerRouteHandler.Instance 处理器来处理路由。这样，我们可以让 ASP.NET 所有调用转到Web API路由，进入到 Web API 的管道。这里说到的单例其实就是一个 Lazy<HttpControllerRputeHandler>。我们可以在应用程序启动的地方使用自己的类似 SessionHttpControllerRouteHandler 的类实例，然后继续注册路由到HttpConfiguration，同时，这样可以确保每一个 Web API 路由都使用了SessionHttpControllerRouteHandler，也就是说所有的路由都可以访问Session。这个简单的代码如清单 1-28 所示。

清单 1-28. 配置 Session


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

public static class WebApiConfig

{

    public static void Register(HttpConfiguration config)

    {

        var httpControllerRouteHandler = typeof(HttpControllerRouteHandler).GetField("_instance",

        BindingFlags.Static | BindingFlags.NonPublic);

        if (httpControllerRouteHandler != null)

        {

            httpControllerRouteHandler.SetValue(null,

            new Lazy<HttpControllerRouteHandler>(() => new SessionHttpControllerRouteHandler(),

            true));

        }

        config.Routes.MapHttpRoute(

        name: "DefaultApi",

        routeTemplate: "api/{controller}/{id}",

        defaults: new { id = RouteParameter.Optional }

        );

        config.MapHttpAttributeRoutes();

    }

}

现在，我们需要证明这个起作用了，需要做一个简单模拟掷骰子的 ApiController 例子。首先，生成一个 1 到6 之间的随机数，将 Session 中上一次的值使用当前投掷的值赋值。

清单 1-29. 使用 Session 的 ApiController 简单例子


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

public class DiceResult

{

    public int NewValue { get; set; }

    public int LastValue { get; set; }

}

public class DiceController : ApiController

{

    public DiceResult Get()

    {

        var newValue = new Random().Next(1, 7);

        object context;

        if (Request.Properties.TryGetValue("MS_HttpContext", out context))

        {

            var httpContext = context as HttpContextBase;

            if (httpContext != null && httpContext.Session != null)

            {

                var lastValue = httpContext.Session["LastValue"] as int?;

                httpContext.Session["LastValue"] = newValue;

                return new DiceResult

                {

                    NewValue = newValue,

                    LastValue = lastValue ?? 0

                };

            }

        }

        return new DiceResult { NewValue = newValue };

    }

}

值得注意的是，我们刚刚获取的 HttpContext 是从 HttpRequestMessage 属性字典中通过“MS_HttpContext”获取的。这个比直接从 System.HttpContext.Current中获取更具可测性。

时间： 2024-11-03 21:24:22

[水煮 ASP.NET Web API2 方法论]（1-8）添加 Session 状态的相关文章

[水煮 ASP.NET Web API2 方法论]（3-9）空气路由的设置

阅读导航 问题 解决方案 工作原理 代码演示 在此解释一下,空气路由,是本人臆想出来,觉着更能表达 IgnoreRoute 的意图,如果看着辣眼睛^^,请见谅. 问题 我们在之定义过集中式路由,集中式路由有一个特点就是短路,但是现在我们不想让某些路由工作(匹配并由路由引擎处理请求).那么我们应该怎么办呢? 解决方案 其实思路很简单,就是想把某些路由忽略了.ASP.NET WEB API 提供了一个叫做的 StopRoutingHandler 的处理器,简单说,他就是一个消息处理器,可以通过他来强

[水煮 ASP.NET Web API2 方法论]（1-5）ASP.NET Web API Scaffolding（模板）

问题 我们想快速启动一个 ASP.NET Web API 解决方案. 解决方案 APS.NET 模板一开始就支持 ASP.NET Web API.使用模板往我们的项目中添加 Controller,在我们解决方案的 Controllers 文件夹上右键,选择"添加"->"Scaffolding". 即用模式,可以从下面选择一个: Web API2 Controller Web API2 Controller with      actions, using En

[水煮 ASP.NET Web API2 方法论]（3-2）直接式路由/属性路由

问题 怎么样可以使用更贴近资源(Controller,Action)的方式定义路由. 解决方案 可以使用属性路由直接在资源级别声明路由.只要简单的在 Action 上使用属性路由 RouteAttribute,然后传一个相关路由模板就可以.属性路由与集中式路由在路由模板含义上基本是一样的,所有路由参数应该使用花括号,同时要与使用的 Action 相匹配.直接式路由支持默认路由,可选参数,约束.详细分析请往下走. 1 [Route("api/teams/{id}")] 2 public

[水煮 ASP.NET Web API2 方法论]（12-3）OData 查询

问题 Web API 怎么支持通用的 OData 系统查询项,例如 $select 或 $filter. 解决方案 为了在 Web API 中启用查询项,我们需要在 Action 上使用 EnableQueryAttribute. 如果 Action 没有返回集合,而是返回单个对象的实例,调用端仍然可以使用 $expand 和 $select 两个查询语句,要达到这个目的,我们必须将返回对象包装在 SingleResult<T> 中.集合和单个对象实例作为返回值的例子如订单 12-7 所示 清

[水煮 ASP.NET Web API2 方法论]（1-7）CSRF-Cross-Site Request Forgery

问题 通过 CSRF(Cross-Site Request Forgery)防护,保护从 MVC 页面提交到ASP.NET Web API 的数据. 解决方案 ASP.NET 已经加入了 CSRF 防护功能,只要通过 System.web.Helpers.AntiForgery 类(System.Web.WebPages 的一部分)就可以. 他会生成两个 Token: Cookie Token 基于字符串的 Token 基于字符串的 Token 是可以嵌入到表单或者请求头(使用 Ajax 的情况

[水煮 ASP.NET Web API2 方法论]（3-5）路由约束

问题 怎么样限制路由中参数的值. 解决方案 ASP.NET WEB API 允许我们通过 IHttpRouteConstraint 接口设置路由约束.集中式路由和直接式路由都可以使用 IHttpRouteConstraint. 框架提供了 18 个接口,他提供了大部分类型的约束,例如,路由参数长度相关的约束,可以确保值都在定义范围内,或者限制数据类型.当然也可以通过实现接口 IHttpRouteConstraint 来自定义约束逻辑. 工作原理 IHttpRoutConstraint 是一个 H

[水煮 ASP.NET Web API2 方法论]（3-4）设置路由可选项

问题 怎么样创建一个路由,不管客户端传不传这个参数,都可以被成功匹配. 解决方案 ASP.NET WEB API 的集中式路由和属性路由都支持路由声明可选参数. 在用集中式路由中可以通过 RouteParameter.Optional 指定一个可选参数,RouteParameter.Optional 等同于MVC 中的 UrlParameter.Option. 属性路由,通过在可选参数后面添加一个问好作为后缀.同时,必须为其指定默认值 工作原理 从根本上看,ASP.NET WEB API 支持的

[水煮 ASP.NET Web API2 方法论]（12-1）创建 OData

问题 怎样用在 Web API 中创建 OData 服务. 解决方案 对于我们来说,在 Web API 中使用 OData最简单的方式就是使用 ASP.NET 模板来创建Odata Controller.在 Controllers 文件夹上鼠标右键->添加->新建项. 显示一个如图 12-1 的对话框,在这里我们可以选择两个 "Web API 2 OData" 相关的模板.Vistual Studio 将会生成相关的 OData Controller,同时,从 NuGet

[水煮 ASP.NET Web API2 方法论]（1-4）从 MVC Controller 链接到 API Controller 以及反向链接

问题 想创建一个从 ASP.NET MVC controller 到 ASP.NET Web API controller 的直接链接,或者反向链接. 解决方案 可以使用 System.Web.Http.Routing.UrlHelp 的实例来创建一个指向 Controller的链接,来暴露ApiController(作为 Url 属性).着和在 RequestContext 上一样,会被附加到 HttpRequestMessage 实例.为了达到这个目的,我们需要调用链接方法或路由方法,然后传