ASP.NET Web Api中使用Session、Cache和Application的幾個方法

阿新 • • 發佈：2019-01-17

在ASP.NET中，Web Api的控制器類派生自ApiControll，該類與ASP.NET的Control類沒有直接關係，因此不能像在ASPX.CS程式碼隱藏類中直接使用HttpContext、HttpApplicationState或HttpSessionState等狀態資料。要使用的話，一般是從System.Web.HttpContext.Current靜態物件引用HttpContext，從而使用Session等狀態資料。

不過，要在控制器類中通過HttpContext的Session屬性直接使用Session狀態資料，將丟擲null reference異常。網查主要有兩個解決辦法，一個是過載Global的Init()方法，在該方法的中開放Session狀態，另一個設計帶Session的路由處理器。

下面程式碼是包含兩個解決方法的Global類。

<pre name="code" class="csharp">using System;
using System.Web;
using System.Web.Routing;
using System.Web.Http;
using System.Web.Http.WebHost;
using System.Web.SessionState;

namespace ApiControllerExample
{
    public class Global : System.Web.HttpApplication
    {

        public override void Init()
        {
            //this.PostAuthenticateRequest += (s, e) => HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);
            base.Init();
        }

        protected void Application_Start(object sender, EventArgs e)
        {
            RouteConfig.RegisterRoutes(RouteTable.Routes);  // 註冊路由
        }
    }

    public class SessionableControllerHandler : HttpControllerHandler, IRequiresSessionState
    {
        public SessionableControllerHandler(RouteData routeData) : base(routeData) { }
    }

    public class SessionStateRouteHandler : IRouteHandler
    {
        IHttpHandler IRouteHandler.GetHttpHandler(RequestContext requestContext)
        {
            return new SessionableControllerHandler(requestContext.RouteData);
        }
    }

    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.MapHttpRoute(
                name: "WebApiRoute1",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            ).RouteHandler = new SessionStateRouteHandler();  // 使用Session


            routes.MapHttpRoute(
              name: "WebApiRoute2",
              routeTemplate: "api/{controller}/{id}/{id2}",
              defaults: new{id = RouteParameter.Optional }
          );  // 不使用Session
        }
    }
}

為測試上述行為，編寫了如下控制器程式碼。

using System;
using System.Web.Http;

namespace ApiControllerExample
{
    public class StateController : ApiController
    {
        public string Get(int id)
        {
            try
            {
                return  GetStateInfo(id);
            }
            catch (Exception err)
            {
                return "excep: " + err.Message;
            }
        }

        private string GetStateInfo(int id)
        {
            System.Web.HttpContext context = System.Web.HttpContext.Current;

            if (id == 1)
            {
                return context.Session["state"].ToString();
            }
            else if (id == 2)
            {
                return context.Cache["state"].ToString();
            }
            else
            {
                return context.Application["state"].ToString();
            }
        }
 
        public string Get(int id, int id2)
        {
            System.Web.HttpContext context = System.Web.HttpContext.Current;

            try
            {
                return context.Session["state"].ToString();
            }
            catch (Exception err)
            {
                return "excep: " + err.Message;
            }
        }
    }
}

下面是測試用的ASPX網頁程式碼。

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="ApiControllerExample.Test" %>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title></title>
    <script>
        function GetXmlHttpRequest() {
            if (window.XMLHttpRequest) {
                return new XMLHttpRequest();
            }
            else if (window.ActiveXObject) {
                return new ActiveXObject("Microsoft.XMLHTTP");
            }
            return null;
        }

        function GetState(id) {
            var request = GetXmlHttpRequest();
            var url = "/api/state/" + id;
            request.open("GET", url, false);
            request.send(null);
            alert(request.responseText);
        }

        function GetState2() {
            var request = GetXmlHttpRequest();
            var url = "/api/state/1/1";
            request.open("GET", url, false);
            request.send(null);
            alert(request.responseText);
        }
    </script>
</head>
<body>
    <input type="button" value="GetSession" onclick="GetState(1)" />
    <input type="button" value="GetCache" onclick="GetState(2)" />
    <input type="button" value="GetAppication" onclick="GetState(3)" />
    <input type="button" value="GetSession(state2)" onclick="GetState2()" />
</body>
</html>

下面是網頁的程式碼隱藏類。

using System;

namespace ApiControllerExample
{
    public partial class Test : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            string time = DateTime.Now.ToString();

            Session["state"] = time;
            Cache["state"] = time;
            Application["state"] = time;
        }
    }
}

測試時，可以取消Global類中的有關注釋即可。

比較兩個實現方法可以知道，使用帶Session的路由處理器方法可以指定某個路由開放Session（比如上面的api/{controller}/{id}/{id2}，就不能讀取Session中的資料）。而使用Global的Init()方法中開放Session，將使得全部Api都可以訪問Session。

ASP.NET Web Api中使用Session、Cache和Application的幾個方法

ASP.NET Web Api中使用Session、Cache和Application的幾個方法

（四）Asp.net web api中的坑-【api的返回值】

ASP.NET Web API中使用GZIP 或 Deflate壓縮

ASP.NET Web API中對Headers的操作

ASP.NET Web API 中使用 swagger 來管理 API 文件

理解 ASP.NET Web API 中的 HttpParameterBinding

ASP.NET Web API中如何傳遞引數

php中print_r、var_dump和var_export幾個函式的用法區別。php setcookie一些限制。php不同路徑cookies取值問題。PHP獲取站點根目錄

在ASP.NET中使用Session、Cache與Application時注意IIS應用程式池的空閒超時

How ASP.NET Web API 2.0 Works?[持續更新中…]

ASP.NET Web API 過濾器創建、執行過程(二)

關於ASP.NET Web API 客戶端的請求報文中新增 Authorization

ASP.NET Web API 2 中的特性路由

.net web api 中呼叫post方法和呼叫自定義方法名session使用

asp.net web api 開啟HttpContext 的Session功能

Asp.net Web Api 解決跨域問題

[ASP.NET Web API]如何Host定義在獨立程序集中的Controller

[轉]ASP.NET web API 2 OData enhancements

探秘如何操作 ASP.NET Web API （三）

【Web API系列教程】1.1 — ASP.NET Web API入門

ASP.NET Web Api中使用Session、Cache和Application的幾個方法

相關推薦