完整了解asp.net core MVC中的数据传递

在ASP.NET Core MVC应用开发中，数据传递是构建高效、可靠Web应用的核心环节之一。它涵盖了从控制器到视图、不同请求之间以及与外部数据源交互等多个方面。正确掌握各种数据传递方式对于开发出性能优良、用户体验良好的应用程序至关重要。本文将全面深入地探讨ASP.NET Core MVC中常见的数据传递方式，包括通过视图模型（ViewModel）、ViewData、ViewBag、临时数据（TempData）、缓存（Cache）、会话（Session），以及在控制器之间传递数据的方法。同时，会详细说明这些方式与ControllerBase的关系，并通过丰富的代码示例阐述其功能和应用场景。

文章目录

- 一、视图模型（ViewModel）传递数据
- - 1. 概念与原理
  - 2. 代码示例与应用场景
- 二、ViewData与ViewBag
- - 1. 概念与特点
  - 2. 两者关系及与`ControllerBase`的关系
  - 3. 代码示例与应用场景
- 三、TempData
- - 1. 功能与特点
  - 2. 与`ControllerBase`的关系
  - 3. 代码示例与应用场景
- 四、缓存（Cache）
- - 1. 缓存的概念与配置
  - 2. 代码示例与应用场景
- 五、会话（Session）
- - 1. 会话的特点与工作原理
  - 2. 代码示例与应用场景
- 六、在控制器之间传递数据
- - 1. 使用TempData在控制器之间传递数据
  - 2. 通过路由参数传递数据
  - 3. 使用共享服务或单例模式传递数据

一、视图模型（ViewModel）传递数据

1. 概念与原理

视图模型是专为视图设计的数据结构，用于在控制器与视图之间传递数据。它能将与特定视图相关的数据和逻辑进行封装，可包含一个或多个模型对象的属性，还可添加仅用于视图展示的额外属性，如页面标题、控制视图显示的布尔值等。其目的是提供清晰、类型安全的方式来传递数据，确保视图代码更易于理解和维护。

2. 代码示例与应用场景

以博客系统为例，Post是文章模型，Comment是评论模型。在展示文章详情页面时，需要文章信息及相关评论列表，此时可创建PostViewModel视图模型来封装数据。

// 文章模型
public class Post
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }
}

// 评论模型
public class Comment
{
    public int Id { get; set; }
    public int PostId { get; set; }
    public string Text { get; set; }
}

// 文章详情视图模型
public class PostViewModel
{
    public Post Post { get; set; }
    public List<Comment> Comments { get; set; }
    public string PageTitle { get; set; }
}

// 控制器中的操作方法
public class PostController : Controller
{
    public IActionResult Details(int postId)
    {
        var post = _postService.GetPostById(postId);
        var comments = _commentService.GetCommentsByPostId(postId);
        var viewModel = new PostViewModel
        {
            Post = post,
            Comments = comments,
            PageTitle = $"文章详情 - {post.Title}"
        };
        return View(viewModel);
    }
}

在视图中，可通过强类型方式访问视图模型属性：

@model PostViewModel

<h1>@Model.PageTitle</h1>
<p>@Model.Post.Content</p>

<ul>
    @foreach (var comment in Model.Comments)
    {
        <li>@comment.Text</li>
    }
</ul>

应用场景：适用于视图需要展示多个相关模型数据或需对数据进行特定组合与处理的情况，提供了类型安全和清晰的结构。

二、ViewData与ViewBag

1. 概念与特点

ViewData：是ControllerBase的属性，类型为ViewDataDictionary，即字典结构（IDictionary<string, object>）。用于在控制器向视图传递数据，以键值对形式存储，数据生命周期在当前请求的视图渲染期间。其优点是简单直接，但作为弱类型字典，编译时无法进行类型检查，可能导致视图中使用数据时出现运行时错误。
ViewBag：是ViewData的动态包装器，利用动态属性方式访问数据，如ViewBag.PropertyName，使代码在视图中更简洁。不过，和ViewData一样，编译时不进行类型检查，存在运行时类型不匹配风险。

2. 两者关系及与`ControllerBase`的关系

ViewBag基于ViewData实现，在ControllerBase中，ViewData直接作为属性存在，ViewBag通过动态属性访问方式对ViewData进行包装。当使用ViewBag设置或获取数据时，实际是在操作ViewData字典中的对应键值对。它们是ControllerBase提供给控制器向视图传递数据的机制。
换句话说ViewBag的访问方式比ViewData更优雅一些，更符合对象编程的手法。

3. 代码示例与应用场景

示例代码：
- 控制器中设置数据：

public class HomeController : Controller
{
    public IActionResult Index()
    {
        // 使用ViewData传递数据
        ViewData["Message"] = "这是一条消息 using ViewData";
        // 使用ViewBag传递数据
        ViewBag.Title = "首页 using ViewBag";
        return View();
    }
}

- **视图中获取数据（Index.cshtml）**：

@{
    Layout = null;
}

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>@ViewBag.Title</title>
</head>
<body>
    <p>Message from ViewData: @ViewData["Message"]</p>
    <p>Title from ViewBag: @ViewBag.Title</p>
</body>
</html>

应用场景：适用于传递少量简单、临时数据，如页面标题、提示信息等，数据类型无需编译时严格检查且数据量小、逻辑简单时使用。

三、TempData

1. 功能与特点

TempData也是ControllerBase的属性，用于不同请求间（特别是重定向场景）传递数据。以键值对形式存储，具有一次性读取特性，数据读取一次后标记为删除（下次请求读取为null），可通过Keep方法保留数据以便后续请求使用。

2. 与`ControllerBase`的关系

TempData是ControllerBase提供的在请求间传递临时数据的方式，在控制器操作方法执行中发挥作用。控制器可利用它在不同请求间传递需后续使用但不长期存储的数据，如表单提交重定向后的操作结果或临时消息。

3. 代码示例与应用场景

示例代码：
- 登录控制器：

public class LoginController : Controller
{
    public IActionResult Login(LoginViewModel model)
    {
        if (ModelState.IsValid)
        {
            // 假设登录验证成功
            TempData["SuccessMessage"] = "登录成功！";
            return RedirectToAction("Index", "Home");
        }
        return View(model);
    }
}

- **首页控制器**：

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var message = TempData["SuccessMessage"];
        if (message!= null)
        {
            ViewBag.Message = message;
            // 保留数据以便后续使用（例如在页面刷新时仍然显示消息）
            TempData.Keep("SuccessMessage");
        }
        return View();
    }
}

应用场景：常用于重定向后传递操作结果或临时消息给目标页面，如用户注册、登录、表单提交等操作成功或失败后的提示信息。

四、缓存（Cache）

1. 缓存的概念与配置

缓存用于存储频繁访问但不常变化的数据，以提高应用性能。ASP.NET Core提供多种缓存机制，如内存缓存（IMemoryCache）。在Startup.cs中通过AddMemoryCache方法注册服务，并在需要处通过依赖注入使用。

2. 代码示例与应用场景

以产品列表页面为例，产品数据若相对稳定，可缓存提高性能。

配置缓存服务（在Startup.cs中）：

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

控制器中使用缓存：

public class ProductController : Controller
{
    private readonly IMemoryCache _memoryCache;
    private readonly IProductRepository _productRepository;

    public ProductController(IMemoryCache memoryCache, IProductRepository productRepository)
    {
        _memoryCache = memoryCache;
        _productRepository = productRepository;
    }

    public IActionResult Index()
    {
        if (!_memoryCache.TryGetValue("ProductList", out List<Product> products))
        {
            products = _productRepository.GetAllProducts();
            var cacheEntryOptions = new MemoryCacheEntryOptions()
             .SetSlidingExpiration(TimeSpan.FromMinutes(10));
            _memoryCache.Set("ProductList", products, cacheEntryOptions);
        }
        return View(products);
    }
}

应用场景：适用于存储频繁访问但不常变化的数据，如网站配置信息、下拉菜单选项、常用字典数据等，以及计算成本高或查询耗时操作的结果。

五、会话（Session）

1. 会话的特点与工作原理

会话用于在用户多个请求间存储和共享数据。数据存储在服务器端，会话标识（通常通过Cookie）存于客户端识别用户会话。每个用户有独立会话数据，在整个用户会话期间有效。

2. 代码示例与应用场景

如购物车应用，可使用会话存储用户购物车商品信息。

配置会话服务（在Startup.cs中）：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSession(options =>
    {
        options.IdleTimeout = TimeSpan.FromMinutes(30);
        options.Cookie.HttpOnly = true;
        options.Cookie.IsEssential = true;
    });
    // 其他服务配置...
}

启用会话中间件（在Configure方法中）：

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

控制器中使用会话：

public class CartController : Controller
{
    private readonly ISession _session;

    public CartController(ISession session)
    {
        _session = session;
    }

    public IActionResult AddToCart(int productId)
    {
        var cart = _session.GetObjectFromJson<List<int>>("Cart")?? new List<int>();
        cart.Add(productId);
        _session.SetObjectAsJson("Cart", cart);
        return RedirectToAction("Index");
    }

    public IActionResult Index()
    {
        var cart = _session.GetObjectFromJson<List<int>>("Cart");
        var productsInCart = _productRepository.GetProductsByIds(cart);
        return View(productsInCart);
    }
}

应用场景：常用于存储用户相关状态信息，如登录状态、购物车内容、用户偏好设置等，跨页面共享和维护的数据。

六、在控制器之间传递数据

1. 使用TempData在控制器之间传递数据

TempData可用于控制器间传递数据，尤其在重定向场景。例如，注册成功后将消息传递给另一个控制器显示。

注册控制器：

public class RegistrationController : Controller
{
    public IActionResult Register(RegistrationViewModel model)
    {
        if (ModelState.IsValid)
        {
            // 假设注册成功
            TempData["RegistrationSuccessMessage"] = "注册成功！";
            return RedirectToAction("Welcome", "WelcomeController");
        }
        return View(model);
    }
}

欢迎控制器：

public class WelcomeController : Controller
{
    public IActionResult Welcome()
    {
        var message = TempData["RegistrationSuccessMessage"];
        if (message!= null)
        {
            ViewBag.Message = message;
        }
        return View();
    }
}

2. 通过路由参数传递数据

在重定向或链接到其他控制器操作时，可将数据作为路由参数传递。如订单完成后，将订单ID传递给订单详情控制器。

订单控制器：

public class OrderController : Controller
{
    public IActionResult CompleteOrder(int orderId)
    {
        // 假设订单处理完成
        return RedirectToAction("Details", "OrderDetailsController", new { orderId = orderId });
    }
}

订单详情控制器：

public class OrderDetailsController : Controller
{
    public IActionResult Details(int orderId)
    {
        var order = _orderService.GetOrderById(orderId);
        return View(order);
    }
}

3. 使用共享服务或单例模式传递数据

创建共享服务（如DataService）或使用单例模式可在控制器间共享数据。例如：

定义共享服务：

public class DataService
{
    private List<string> _dataList = new List<string>();

    public void AddData(string data)
    {
        _dataList.Add(data);
    }

    public List<string> GetData()
    {
        return _dataList;
    }
}

注册服务为单例（在Startup.cs中）：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<DataService>();
    // 其他服务配置...
}

控制器使用共享服务：

public class ControllerA : Controller
{
    private readonly DataService _dataService;

    public ControllerA(DataService dataService)
    {
        _dataService = dataService;
    }

    public IActionResult AddData(string data)
    {
        _dataService.AddData(data);
        return RedirectToAction("GetData", "ControllerB");
    }
}

public class ControllerB : Controller
{
    private readonly DataService _dataService;

    public ControllerB(DataService dataService)
    {
        _dataService = dataService;
    }

    public IActionResult GetData()
    {
        var dataList = _dataService.GetData();
        return View(dataList);
    }
}