ASP.NET Core中的Cookie与Session管理：构建高效的辅助类

Cookie和Session不一样，它们在Web开发中扮演着不同的角色，但经常协同工作以维持和管理Web应用的会话状态。以下是它们之间的主要区别和联系，以及相关的Helper工具介绍。

Cookie和Session的区别

1. 存放位置：

   • Cookie：保存在客户端的浏览器上。
   • Session：保存在服务器端。

2. 存放形式：

   • Cookie：以字符串的形式保存，可以包含会话ID等信息。
   • Session：以对象的形式保存在服务器，包含用户的会话数据。

3. 安全性：

   • Cookie：相对不那么安全，因为存储在客户端，可能会被篡改或窃取。
   • Session：相对更安全，因为存储在服务器端，不易被客户端直接访问或篡改。

4. 用途：

   • Cookie：适合保存用户的个人设置、偏好等不敏感信息，以及会话ID等标识信息。
   • Session：适合做用户的身份验证、会话管理等需要高度安全性的场景。

5. 对服务器的影响：

   • Cookie：对服务器的影响较小，因为主要数据存储在客户端。
   • Session：当访问量增大时，会占用更多的服务器资源，因为每个会话都需要在服务器上维护。

Cookie和Session的联系

• Session需要借助Cookie才能正常工作。当用户首次访问网站时，服务器会创建一个新的Session，并生成一个唯一的Session ID。这个Session ID随后会被发送到客户端，并保存在Cookie中。在后续的请求中，客户端会自动将这个包含Session ID的Cookie发送给服务器，从而使服务器能够识别并处理特定的用户会话。

当然，我可以将上面关于CookieHelper、SessionHelper以及它们如何在ASP.NET Core中使用的说明合并成一篇更完整的文章。以下是合并后的内容：

---

ASP.NET Core中的Cookie和Session辅助类

在ASP.NET Core开发Web应用程序时，管理用户会话（Session）和客户端Cookie是常见的需求。为了简化这些操作，我们可以创建CookieHelper和SessionHelper类来封装与Cookie和Session相关的常见操作。以下是如何实现这些辅助类的详细指南。

CookieHelper

CookieHelper类用于封装与Cookie相关的操作，如写入、读取和删除Cookie。

using Microsoft.AspNetCore.Http;
using System;

public class CookieHelper
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public CookieHelper(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    // 写入Cookie
    public void SetCookie(string key, string value, int? expiresInDays = null)
    {
        var cookieOptions = new CookieOptions();

        if (expiresInDays.HasValue)
        {
            var expiryTime = DateTime.Now.AddDays(expiresInDays.Value);
            cookieOptions.Expires = expiryTime;
        }

        _httpContextAccessor.HttpContext.Response.Cookies.Append(key, value, cookieOptions);
    }

    // 读取Cookie
    public string GetCookie(string key)
    {
        if (_httpContextAccessor.HttpContext.Request.Cookies.TryGetValue(key, out var cookieValue))
        {
            return cookieValue;
        }

        return null;
    }

    // 删除Cookie
    public void DeleteCookie(string key)
    {
        var cookieOptions = new CookieOptions
        {
            Expires = DateTime.Now.AddDays(-1)
        };

        _httpContextAccessor.HttpContext.Response.Cookies.Delete(key, cookieOptions);
    }
}

SessionHelper

SessionHelper类用于封装与Session相关的操作，如添加、获取、删除Session数据等。

using Microsoft.AspNetCore.Http;
using System;
using System.Text.Json; // 确保引入了System.Text.Json命名空间

public class SessionHelper
{
    private readonly ISession _session;

    public SessionHelper(IHttpContextAccessor httpContextAccessor)
    {
        _session = httpContextAccessor.HttpContext?.Session;
    }

    // 添加Session
    public void SetSession<T>(string key, T value)
    {
        if (_session != null)
        {
            var jsonString = JsonSerializer.Serialize(value);
            _session.SetString(key, jsonString);
        }
    }

    // 获取Session
    public T GetSession<T>(string key)
    {
        if (_session != null && _session.TryGetValue(key, out var value))
        {
            return JsonSerializer.Deserialize<T>(value);
        }

        return default;
    }

    // 删除Session
    public void RemoveSession(string key)
    {
        if (_session != null)
        {
            _session.Remove(key);
        }
    }

    // 清除所有Session（可选）
    public void ClearAllSessions()
    {
        if (_session != null)
        {
            var keys = new string[_session.Keys.Count];
            _session.Keys.CopyTo(keys, 0);

            foreach (var key in keys)
            {
                _session.Remove(key);
            }
        }
    }
}

使用说明

1. 配置服务

在你的ASP.NET Core项目的Startup.cs文件中，确保你已经添加了IHttpContextAccessor、Session服务和相关的中间件。

public void ConfigureServices(IServiceCollection services)
{
    // ... 其他服务配置

    services.AddHttpContextAccessor(); // 添加IHttpContextAccessor
    services.AddSession(options =>
    {
        options.Cookie.HttpOnly = true; // 设置为HttpOnly以防止客户端脚本访问
        options.IdleTimeout = TimeSpan.FromMinutes(30); // 设置Session空闲超时时间
    });

    // 如果你的CookieHelper或SessionHelper类作为服务被注入，也需要在这里注册它们
    // 例如：services.AddScoped<CookieHelper>();
    //      services.AddScoped<SessionHelper>();

    // ... 其他服务配置
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ... 其他中间件配置

    app.UseSession(); // 启用Session中间件

    // ... 其他中间件配置
}

2. 注入并使用

在你的控制器或服务中，通过构造函数注入CookieHelper和SessionHelper，并使用它们来管理Cookie和Session。

public class MyController : Controller
{
    private readonly CookieHelper _cookieHelper;
    private readonly SessionHelper _sessionHelper;

    public MyController(IHttpContextAccessor httpContextAccessor)
    {
        _cookieHelper = new CookieHelper(httpContextAccessor);
        _sessionHelper = new SessionHelper(httpContextAccessor);

        // 如果你通过依赖注入注册了CookieHelper和SessionHelper，则可以直接注入它们
        // public MyController(CookieHelper cookieHelper, SessionHelper sessionHelper)
        // {
        //     _cookieHelper = cookieHelper;
        //     _sessionHelper = sessionHelper;
        // }
    }

    // ... 控制器方法，使用_cookieHelper和_sessionHelper
}