Asp.net core ViewData的使用

ViewData 是 ASP.NET Core MVC 中用于从 Controller 向 View 传递数据 的核心机制之一。它本质上是一个字典容器，生命周期仅限于单次 HTTP 请求。

以下是关于 ViewData 的详细解析、使用方法及最佳实践。

1. 核心特性

特性	说明
类型	`ViewDataDictionary` (继承自 `Dictionary<string, object?>`)
键类型	`string`（区分大小写）
值类型	`object?`（存取时通常需要强制转换）
生命周期	仅在当前请求内有效，重定向后丢失
底层存储	存储在 `HttpContext.Items` 中
编译检查	❌ 无（字符串键名拼写错误不会报错，运行时才暴露）

2. 基本使用方法

✅ 在 Controller 中赋值

csharp 复制代码

public IActionResult Index()
{
    // 方式1：索引器赋值
    ViewData["Title"] = "用户列表";
    ViewData["CurrentPage"] = 1;
    
    // 方式2：Add 方法
    ViewData.Add("Message", "欢迎回来");
    
    // 传递复杂对象
    var user = new User { Name = "张三", Age = 25 };
    ViewData["User"] = user;
    
    return View();
}

✅ 在 Razor View 中读取

html 复制代码

@* ⚠️ 注意：ViewData 的值是 object 类型，使用时需转换 *@

<h1>@ViewData["Title"]</h1>

@* 安全取值（避免 Key 不存在时报错） *@
<p>@(ViewData["Message"] ?? "默认消息")</p>

@* 复杂对象需要显式转换 *@
@{
    var user = ViewData["User"] as User;
}
@if (user != null)
{
    <span>@user.Name, @user.Age岁</span>
}

@* 或使用 C# 模式匹配（更优雅） *@
@if (ViewData["User"] is User u)
{
    <span>@u.Name, @u.Age岁</span>
}

3. 高级用法

在 Layout / Partial View 中使用

ViewData 会自动流向布局页和分部视图，常用于传递页面级元数据：

csharp 复制代码

// Controller
ViewData["PageDescription"] = "这是产品详情页的SEO描述";

html 复制代码

<!-- _Layout.cshtml -->
<head>
    <meta name="description" content="@ViewData["PageDescription"]" />
</head>

在 Tag Helper 中配合使用

html 复制代码

<a asp-controller="Home" asp-action="Index" 
   class="@(ViewData["ActiveNav"]?.ToString() == "Home" ? "active" : "")">
    首页
</a>

自定义 ViewData 扩展方法

减少重复的类型转换代码：

csharp 复制代码

public static class ViewDataExtensions
{
    public static T? Get<T>(this ViewDataDictionary viewData, string key)
    {
        return viewData[key] is T value ? value : default;
    }
}

// View 中使用
var user = ViewData.Get<User>("User");

4. ⚠️ 常见陷阱与注意事项

键名大小写敏感 ：ViewData["title"] 和 ViewData["Title"] 是两个不同的键。建议统一使用 PascalCase。
NullReferenceException ：访问不存在的键返回 null，直接调用 .ToString() 会抛异常。始终使用 as、is 或 ?? 做安全处理。
序列化问题 ：ViewData 不做序列化，它在内存中直接传递引用。如果修改了 ViewData 中的对象，原始对象也会被修改。
不要存大数据 ：虽然技术上没有限制，但 ViewData 设计目的是传递轻量级视图数据。大集合应通过 ViewModel 传递。
重定向后丢失 ：RedirectToAction 会发起新请求，ViewData 清空。需要跨重定向传数据请用 TempData。

5. 🆚 ViewData vs ViewBag vs TempData vs ViewModel

机制	类型安全	智能提示	生命周期	推荐场景
ViewData	❌	❌	当前请求	少量元数据、Layout 通信
ViewBag	❌	❌	当前请求	ViewData 的动态包装器，本质相同
TempData	❌	❌	当前+下次请求	重定向后的提示消息
ViewModel	✅	✅	当前请求	所有业务数据传递（首选）

💡 关键认知 ：ViewBag 只是 ViewData 的 dynamic 包装器。ViewBag.Title 等价于 ViewData["Title"]。两者共享同一个底层字典，性能上 ViewData 略优（避免了 dynamic 绑定开销）。

6. 🎯 最佳实践建议

业务数据永远用强类型 ViewModel：

csharp 复制代码

// ✅ 推荐
return View(new UserListViewModel { Users = users, Title = "用户列表" });

// ❌ 不推荐
ViewData["Users"] = users;
ViewData["Title"] = "用户列表";

ViewData 仅用于"非业务"的视图元数据：
- 页面标题、面包屑导航
- Layout 需要的 CSS class / body attribute
- 当前激活的菜单项标识
- 简单的提示消息
优先使用 ViewData 而非 ViewBag：
- 有微弱的性能优势
- 键名重构时更容易全局搜索
- 在 .NET 6+ Minimal API 等场景中兼容性更好

考虑使用 [ViewData] 属性自动绑定（.NET 8+）：

csharp 复制代码

// 在 Razor Page 或 Component 中
[ViewData]
public string? Title { get; set; }

7. 与 Blazor 的关系

总结来说，ViewData 是 MVC 时代遗留的弱类型传值工具，在现代 ASP.NET Core 开发中应严格限制其使用范围，将强类型 ViewModel 作为数据传递的主力。