如何使用jQuery在ASP.NET Web API（非MVC）中设置Session

嘿，这个问题问到点子上了！ASP.NET Web API 天生是为无状态的REST场景设计的，所以Session功能默认是关闭的，但咱们完全可以开启它，再通过jQuery和后端API交互来操作Session。下面分情况给你一步步讲：

首先得让Web API能识别并使用Session，因为默认情况下它不会初始化Session状态。

1. 修改Global.asax文件，添加Application_PostAuthenticateRequest事件：

protected void Application_PostAuthenticateRequest()
{
    // 强制开启Session支持
    HttpContext.Current.SetSessionStateBehavior(SessionStateBehavior.Required);
}

这个事件会在认证完成后触发，确保Session能被后续的API请求访问到。

2. 检查Web.config的Session配置（确保存在或正确）：

<system.web>
    <sessionState mode="InProc" cookieless="UseCookies" timeout="20" />
    <!-- 其他已有配置保持不变 -->
</system.web>

这里mode="InProc"表示Session存在进程内，适合开发或小规模场景；如果是生产环境，可能需要用StateServer或SQLServer模式。

前端jQuery没法直接操作服务器端的Session，必须通过API接口来中转。咱们创建一个专门处理Session的控制器：

public class SessionController : ApiController
{
    // 设置Session的POST接口
    [HttpPost]
    public IHttpActionResult SetSession(string key, string value)
    {
        if (string.IsNullOrWhiteSpace(key))
        {
            return BadRequest("Session的键名不能为空");
        }
        
        HttpContext.Current.Session[key] = value;
        return Ok("Session设置成功");
    }

    // 获取Session的GET接口
    [HttpGet]
    public IHttpActionResult GetSession(string key)
    {
        var sessionValue = HttpContext.Current.Session[key]?.ToString();
        return Ok(sessionValue ?? "未找到对应键的Session值");
    }
}

记得确保你的路由配置能正确映射到这个控制器（默认的API路由api/{controller}/{action}就能用）。

现在前端就可以通过AJAX请求来和后端交互，实现Session的读写了：

设置Session的代码： #

// 示例：设置名为"UserName"的Session值为"Sourabh Dhiman"
$.ajax({
    url: '/api/Session/SetSession',
    type: 'POST',
    data: { key: 'UserName', value: 'Sourabh Dhiman' },
    success: function(response) {
        console.log('后端响应:', response);
        alert('Session设置成功！');
    },
    error: function(xhr) {
        console.error('请求失败:', xhr.responseText);
        alert('设置Session出错了，请检查控制台');
    }
});

获取Session的代码： #

// 示例：获取名为"UserName"的Session值
$.ajax({
    url: '/api/Session/GetSession?key=UserName',
    type: 'GET',
    success: function(response) {
        console.log('获取到的Session值:', response);
        alert('当前Session值：' + response);
    },
    error: function(xhr) {
        console.error('请求失败:', xhr.responseText);
        alert('获取Session出错了，请检查控制台');
    }
});

• 跨域场景要额外处理：如果你的前端页面和Web API不在同一个域名下，需要配置CORS（跨域资源共享），并且AJAX请求要带上凭证（Session依赖的SessionID Cookie）。jQuery里要加上xhrFields: { withCredentials: true }，同时后端要允许凭证传递。
• 破坏无状态特性：Web API的设计初衷是无状态，使用Session会让API变成有状态的，这不符合RESTful规范。如果是做身份验证这类场景，更推荐用JWT Token这类无状态的方案，不需要依赖Session。
• Session的局限性：InProc模式的Session会在应用池回收时丢失，多服务器部署时还会出现Session不共享的问题，生产环境要谨慎选择Session存储模式。

如果你用的是.NET Core版本的Web API，开启Session的方式略有不同：

1. 在Startup.cs的ConfigureServices方法里注册Session服务：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSession(options =>
    {
        options.IdleTimeout = TimeSpan.FromMinutes(20); // Session超时时间
        options.Cookie.HttpOnly = true; // 防止前端JS读取Session Cookie，更安全
        options.Cookie.IsEssential = true; // 标记为必要Cookie，符合GDPR要求
    });
    services.AddControllers();
}

2. 在Configure方法里添加Session中间件（必须放在UseRouting之后，UseEndpoints之前）：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 其他中间件（比如UseStaticFiles、UseAuthentication等）
    app.UseRouting();
    app.UseSession(); // 启用Session中间件
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

3. 控制器里直接通过HttpContext.Session操作：

[ApiController]
[Route("api/[controller]")]
public class SessionController : ControllerBase
{
    [HttpPost("SetSession")]
    public IActionResult SetSession(string key, string value)
    {
        if (string.IsNullOrWhiteSpace(key))
        {
            return BadRequest("Session键名不能为空");
        }
        HttpContext.Session.SetString(key, value);
        return Ok("Session设置成功");
    }

    [HttpGet("GetSession")]
    public IActionResult GetSession(string key)
    {
        var value = HttpContext.Session.GetString(key);
        return Ok(value ?? "未找到对应Session值");
    }
}

前端jQuery的调用方式和Framework版本一致，跨域时同样要配置CORS和withCredentials。

内容的提问来源于stack exchange，提问作者Sourabh Dhiman