c#在WebAPI使用Session的方法

C# 在 WebAPI 中使用 Session 的方法

Session 是 Web 应用程序中常用的一种状态管理技术，可以保存用户登录状态、购物车信息等。在 ASP.NET Web Forms 应用程序中，开发者可以直接使用 Session 对象来管理 Session 状态。但在 ASP.NET Web API 应用程序中，由于其无状态的架构设计，Session 对象不再直接可用。本文将介绍如何在 Web API 中使用 Session 对象。

步骤一：安装 NuGet 包

在 Web API 项目中使用 Session 对象需要安装 Microsoft.AspNet.WebApi.Core 包。右击项目，选择 “Manage NuGet Packages…” 菜单，搜索 Microsoft.AspNet.WebApi.Core 包并进行安装。

步骤二：启用 Session

在 Web API 应用程序中启用 Session 需要更改 Global.asax 文件中的配置。打开 Global.asax 文件，找到 Application_Start 方法，添加以下代码：

protected void Application_Start()
{
    GlobalConfiguration.Configure(WebApiConfig.Register);
    GlobalConfiguration.Configuration.Services.Add(typeof(System.Web.Http.Filters.IFilterProvider),
        new SessionFilterProvider());
}

步骤三：编写 SessionFilterProvider 类

在 Application_Start 方法中添加的 SessionFilterProvider 类负责将 Session 对象注入到 Web API 控制器中。以下是 SessionFilterProvider 类的示例代码：

public class SessionFilterProvider : IFilterProvider
{
    public IEnumerable<FilterInfo> GetFilters(HttpConfiguration configuration, HttpActionDescriptor actionDescriptor)
    {
        var sessionStateBehavior = actionDescriptor.GetCustomAttributes<SessionStateAttribute>().SingleOrDefault();
        if (sessionStateBehavior == null)
        {
            return Enumerable.Empty<FilterInfo>();
        }

        var filter = new SessionStateFilter(sessionStateBehavior.Behavior);
        return new List<FilterInfo>() { new FilterInfo(filter, FilterScope.Global, null) };
    }
}

步骤四：编写 SessionStateFilter 类

SessionStateFilter 类是一个自定义的 ActionFilterAttribute，它负责将 Session 对象注入到 Web API 控制器中。以下是 SessionStateFilter 类的示例代码：

public class SessionStateFilter : ActionFilterAttribute
{
    private readonly SessionStateBehavior _behavior;

    public SessionStateFilter(SessionStateBehavior behavior)
    {
        _behavior = behavior;
    }

    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (_behavior == SessionStateBehavior.Required || _behavior == SessionStateBehavior.ReadOnly)
        {
            HttpContextBase httpContextBase = actionContext.Request.Properties["MS_HttpContext"] as HttpContextBase;
            if (httpContextBase != null)
            {
                HttpSessionStateBase sessionStateBase = httpContextBase.Session;
            }
        }

        base.OnActionExecuting(actionContext);
    }
}

步骤五：在控制器中使用 Session

现在，你已经在 Web API 项目中启用了 Session，并创建了一个自定义的 ActionFilter，可以将 Session 对象注入 Web API 控制器中。以下是在控制器中使用 Session 的代码示例：

public class MyController : ApiController
{
    [HttpGet]
    [SessionState(SessionStateBehavior.Required)]
    public string GetName()
    {
        HttpSessionStateBase session = HttpContext.Current.Session;
        string name = (string)session["Name"];
        return name;
    }

    [HttpPost]
    [SessionState(SessionStateBehavior.Required)]
    public void SetName([FromBody]string name)
    {
        HttpSessionStateBase session = HttpContext.Current.Session;
        session["Name"] = name;
    }
}

在上面的示例代码中，GetName 方法从 Session 中获取名字并返回，SetName 方法将名字保存到 Session 中。

注意事项：

1. ActionFilter 必须要放在控制器方法之上才能使用；
2. 在调用 Session 对象之前，一定要确保已经启用 Session，否则将会抛出 NullReferenceException 异常；
3. 只有当 HttpContext 初始化的时候才能使用 HttpContext.Current，需要在 Global.asax 的 Session_Start 方法中访问一下 HttpContext.Current 才能使其可用。