在ASP.NET Core中能否将C#类实例绑定到会话以留存表单数据

完全可以实现将自定义C#类实例绑定到会话，使其生命周期与会话保持一致（默认约20分钟，可配置），以此保留用户表单输入内容，应对刷新或短时间离开页面的场景。下面是具体实现方案：

1. 配置会话支持 #

ASP.NET Core默认需要显式配置会话中间件。在Program.cs中添加以下配置：

var builder = WebApplication.CreateBuilder(args);

// 添加会话服务，可自定义超时时间
builder.Services.AddSession(options =>
{
    options.IdleTimeout = TimeSpan.FromMinutes(20); // 会话超时时间，默认20分钟
    options.Cookie.HttpOnly = true;
    options.Cookie.IsEssential = true;
});

builder.Services.AddControllersWithViews();

var app = builder.Build();

// 启用会话中间件（需在UseRouting之后、UseEndpoints之前）
app.UseSession();

app.UseRouting();
app.UseAuthorization();

app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Home}/{action=Index}/{id?}");

app.Run();

2. 实现自定义会话扩展方法 #

通过扩展ISession接口，封装序列化/反序列化逻辑，模拟你期望的GetObjectValue效果（首次获取时自动创建实例，无需显式注册）：

using System.Text.Json;

public static class SessionExtensions
{
    // 获取或创建会话中的自定义类实例
    public static T GetObjectValue<T>(this ISession session) where T : new()
    {
        var key = typeof(T).FullName; // 用类的完全限定名作为会话存储键
        var json = session.GetString(key);
        
        if (string.IsNullOrEmpty(json))
        {
            var newInstance = new T();
            session.SetObjectValue(newInstance);
            return newInstance;
        }
        
        return JsonSerializer.Deserialize<T>(json)!;
    }

    // 将自定义类实例存入会话
    public static void SetObjectValue<T>(this ISession session, T value)
    {
        var key = typeof(T).FullName;
        var json = JsonSerializer.Serialize(value);
        session.SetString(key, json);
    }
}

3. 在控制器中使用 #

在控制器里通过HttpContext.Session调用扩展方法，即可获取或创建会话绑定的类实例：

public class HomeController : Controller
{
    public IActionResult Index()
    {
        // 获取会话绑定的MySessionDataClass实例，不存在则自动创建
        var sessionData = HttpContext.Session.GetObjectValue<MySessionDataClass>();
        
        // 直接操作实例属性，比如保存表单输入
        sessionData.UserName = "testUser";
        sessionData.FormContent = "用户填写的表单内容";
        
        // 修改属性后需手动保存，会话不会自动追踪对象变化
        HttpContext.Session.SetObjectValue(sessionData);
        
        return View(sessionData);
    }

    public IActionResult RefreshTest()
    {
        // 刷新页面后，仍能获取到之前存储的实例数据
        var sessionData = HttpContext.Session.GetObjectValue<MySessionDataClass>();
        return Content($"保存的用户名：{sessionData.UserName}，表单内容：{sessionData.FormContent}");
    }
}

// 自定义会话数据类
public class MySessionDataClass
{
    public string UserName { get; set; } = string.Empty;
    public string FormContent { get; set; } = string.Empty;
    // 可添加更多需要存储的属性
}

关键说明 #

• 会话中的类实例通过序列化存储，自定义类需为可序列化类型（属性尽量用基本类型或可序列化复杂类型）。
• 实例生命周期完全与会话一致：会话超时或用户清除会话Cookie后，数据会被销毁。
• 修改实例属性后必须调用SetObjectValue重新存入会话，因为会话不会自动追踪对象的变化。

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