ASP.NET Core MVC中基于会话的单例服务实现方案咨询

要实现每个浏览器会话对应一个ClientConnector实例且会话内保持一致，你可以结合ASP.NET Session和依赖注入来完成，以下是完整实现步骤：

1. 配置Session服务 #

首先确保项目已启用Session支持，修改Startup.cs：

在ConfigureServices方法中添加： #

// 注册HttpContext访问器，用于后续操作Session
services.AddHttpContextAccessor();

// 配置Session
services.AddSession(options =>
{
    options.IdleTimeout = TimeSpan.FromMinutes(30); // 设置会话超时时间
    options.Cookie.HttpOnly = true; // 防止前端JS访问会话Cookie，提升安全性
    options.Cookie.IsEssential = true; // 标记Cookie为必要，符合隐私规范
});

// 注册HttpClient（如果你的ClientConnector依赖它）
services.AddHttpClient();

// 注册ClientConnector的会话级提供器
services.AddScoped<IClientConnectorProvider, ClientConnectorProvider>();

在Configure方法中添加Session中间件（注意顺序，要在UseMvc之前）： #

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 其他中间件（如UseStaticFiles、UseRouting等）...

    // 启用Session
    app.UseSession();

    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

2. 创建Session扩展方法 #

Session默认只能存储简单类型，我们需要扩展它来支持复杂对象的序列化/反序列化：

using System.Text.Json;
using Microsoft.AspNetCore.Http;

public static class SessionExtensions
{
    // 将复杂对象存入Session
    public static void SetObject<T>(this ISession session, string key, T value)
    {
        var json = JsonSerializer.Serialize(value);
        session.SetString(key, json);
    }

    // 从Session读取复杂对象
    public static T GetObject<T>(this ISession session, string key)
    {
        var json = session.GetString(key);
        return string.IsNullOrEmpty(json) ? default : JsonSerializer.Deserialize<T>(json);
    }
}

如果你习惯使用Newtonsoft.Json，可替换为JsonConvert.SerializeObject和JsonConvert.DeserializeObject。

3. 创建ClientConnector会话提供器 #

定义一个接口和实现类，用于从Session中获取或创建ClientConnector实例：

接口定义： #

public interface IClientConnectorProvider
{
    ClientConnector GetClientConnector();
}

实现类： #

using Microsoft.AspNetCore.Http;

public class ClientConnectorProvider : IClientConnectorProvider
{
    private readonly IHttpContextAccessor _httpContextAccessor;
    private readonly HttpClient _httpClient; // 如果你的ClientConnector依赖HttpClient，可注入

    public ClientConnectorProvider(IHttpContextAccessor httpContextAccessor, HttpClient httpClient)
    {
        _httpContextAccessor = httpContextAccessor;
        _httpClient = httpClient;
    }

    public ClientConnector GetClientConnector()
    {
        var session = _httpContextAccessor.HttpContext.Session;
        const string connectorSessionKey = "UserSessionClientConnector";

        // 尝试从Session读取已有实例
        var connector = session.GetObject<ClientConnector>(connectorSessionKey);
        
        if (connector == null)
        {
            // 实例不存在则创建新的，并初始化（比如设置认证信息）
            connector = new ClientConnector(_httpClient); // 根据你的构造函数调整
            // 这里可以添加初始化逻辑，比如设置默认请求头、认证Token等
            // connector.SetAuthToken(User.Identity.Name);
            
            // 将新实例存入Session
            session.SetObject(connectorSessionKey, connector);
        }

        return connector;
    }
}

4. 在Controller中使用 #

在需要ClientConnector的Controller中注入IClientConnectorProvider，然后获取会话级实例：

public class HomeController : Controller
{
    private readonly IClientConnectorProvider _connectorProvider;

    public HomeController(IClientConnectorProvider connectorProvider)
    {
        _connectorProvider = connectorProvider;
    }

    public IActionResult Index()
    {
        // 获取当前会话的ClientConnector实例
        var connector = _connectorProvider.GetClientConnector();
        
        // 使用connector执行请求、认证等操作
        // var data = connector.FetchServerData();
        
        return View();
    }
}

注意事项 #

• 确保ClientConnector类是可序列化的：如果类中有不可序列化的成员（如未标记[Serializable]的字段/属性），需要调整设计，比如将这类成员改为在获取实例后动态注入，或者标记为[JsonIgnore]（如果不影响会话存储）。
• 会话超时：根据业务需求调整IdleTimeout，避免会话过长导致资源占用，或过短影响用户体验。
• 安全性：Session Cookie设置HttpOnly和IsEssential，避免XSS攻击并符合隐私规范。

内容的提问来源于stack exchange，提问作者Markus H.