ASP.NET MVC - 正确使用视图模型和命令模式

Question

我编写 ASP.NET MVC 应用程序已经有一段时间了，我发现它们是使用命令模式的好地方：我们将每个用户请求表示为一个命令 - 一组输入参数 -然后处理此命令（处理包括验证和其他域逻辑）并将结果发送回用户。

我在我的应用程序中使用的另一件事是视图模型。我发现它们是将数据传递到视图的一种比使用域对象作为模型或填充 ViewData/ViewBag.

更方便的方法

这两个概念非常适合将显示给用户的数据与用户输入及其处理分开，但它们在 ASP.NET MVC 中并不完全一致。

假设我想在开发一个简单的网上商店时使用命令和视图模型，用户可以在其中浏览产品并可以通过提供他们的姓名和电子邮件地址来订购产品：

class ProductViewModel 
{
    public ProductViewModel(int id) { /* init */ }
    public int Id { get; set; }
    public string Name { get; set; }
    // a LOT of other properties (let's say 50)
}

class OrderProductCommand
{
    public int ProductId { get; set; }

    [Required(ErrorMessage = "Name not specified")]
    public string Name { get; set; }

    [Required(ErrorMessage ="E-Mail not specified")]
    public string Email { get; set; }

    public CommandResult Process() { /* validate, save to DB, send email, etc. */ }
}

在浏览教程和 SO 时，我看到人们建议了几种方法。

选项 1

控制器：

[HttpGet]
public ActionResult Product(int id)
{
    return View(new ProductViewModel(id));
}

[HttpPost]
public ActionResult Product(OrderProductCommand command)
{
    if (ModelState.IsValid)
    {
        var result = command.Process();
        if(result.Success)
            return View("ThankYou");
        else
            result.CopyErrorsToModelState(ModelState);
    }
    return Product(command.Id);
}

查看：

@using (Html.BeginForm())
{
    @Html.Hidden("ProductId", Model.Id)
    @Html.TextBox("Name")
    @Html.TextBox("Email")
    <input type="submit" value="Place order" />
}

优点：视图模型和命令相互分离，HttpPost方法看起来干净

缺点：我不能使用像 @Html.TextBoxFor(model => model.Email) 这样方便的 HTML 助手，我不能使用客户端验证（参见 )

选项 2

我们将 Id、Name 和 Email 连同它们的验证属性从 command 复制到 viewModel。

控制器：

[HttpPost]    
public ActionResult Product(ProductViewModel viewModel)
{
        var command = new OrderProductCommand();
        command.Id = viewModel.Id;
        command.Name = viewModel.Name;
        command.Email = viewModel.Email;        
        if (ModelState.IsValid)
        // ...
}

查看：

@Html.TextBoxFor(m => m.Email)
...

优点：选项 1 的所有缺点都消失了

缺点：复制属性似乎不方便（如果我有 50 个属性怎么办？），在视图模型中验证 Name 和 Email（它应该在域逻辑的其余部分所在的 command 中完成），建模为 POST 参数（见下文）

选项 3

我们使 command 成为 viewModel 的属性。

控制器：

[HttpPost]
public ActionResult Product(ProductViewModel viewModel)
{
        var command = viewModel.Command;
        if (ModelState.IsValid)
        // ...
}

查看：

@Html.TextBoxFor(m => m.Command.Email)
...

优点：选项 1 的所有缺点都消失了

缺点：视图模型应该只包含显示给用户的数据（并且command不显示） , 模型为 POST 参数（见下文）

--

我不喜欢选项 2 和 3 的地方是我们使用视图模型作为 POST 方法参数。此方法用于处理用户输入（在本例中只有 2 个字段 + 1 个隐藏字段）并且该模型包含另外 50 个我永远不会在此方法中使用的属性，它们将始终为空。更不用说必须为视图模型创建一个空的构造函数来处理这个 POST 请求，以及为每个 POST 请求创建大型视图模型对象时不必要的内存消耗。

我的问题是（我知道这是有史以来最长的问题）：是否有正确使用命令的秘密选项 4并查看具有其他模型的所有优点和 none 缺点的模型？还是我偏执，这些缺点并不重要，可以忽略不计？

Answer 1

就个人而言，

如果我必须使用 viewModel 将我的模型传回视图，我会使用选项 4，从我的命令继承我的视图模型。

这样我就可以获得命令的所有属性，并且可以设置视图所需的新属性，例如下拉列表选项等。

让继承为您代劳。

此外，您不需要复制属性，在您的 post 中，不要发回 ViewModel，发回命令。

public ActionResult Product(PreOrderProductCommand command)

不要忘记，Mvc 不关心您的视图中的模型是什么，它只将 formcollection 上的键映射到参数列表中模型中的属性。所以即使你发送了一个 ProductViewModel，你仍然可以得到一个 PreOrderProductCommand。

HTH

Answer 2

似乎唯一其他合适的方法是使用局部视图来呈现表单并使用 OrderProductCommand 作为视图模型。

Product.cshtml:

@model ProductViewModel
...
@Html.Partial("Product_OrderForm", new OrderProductCommand { ProductId = Model.Id })
...

Product_OrderForm.cshtml:

@model OrderProductCommand
...
@using (Html.BeginForm("Product", "Home"))
{
    @Html.HiddenFor(cmd => cmd.ProductId)
    @Html.TextBoxFor(cmd => cmd.Name)
    @Html.TextBoxFor(cmd => cmd.Email)
    <input type="submit" value="Place order" />
}
...

这样就不需要在视图模型和业务对象之间创建数据映射，并且控制器代码可以保持干净，就像在选项 1 中一样：

[HttpGet]
public ActionResult Product(int id)
{
    return View(new ProductViewModel(id));
}

[HttpPost]
public ActionResult Product(OrderProductCommand command)
{
    // process command...
}

Answer 3

这是我对这个问题的看法。

我们引入所有这些层（实体、视图模型、命令等）的原因是为了强制分离关注点。

但是，随着每一层的引入，我们增加了复杂性和错误余地，因为对象和分布式验证之间的映射增加了。

在我看来，实体和视图模型分开实现是绝对正确的；域实体应该代表业务逻辑，并且不应被 UI 特定功能所污染。同样，视图模型不应包含超过满足特定视图所需的内容。

另一方面，命令没有理由为您的体系结构引入一个新层。命令只需要提供数据，不需要依赖具体的实现，因此可以定义为接口：

interface IOrderProductCommand
{
    int ProductId { get; }
    string Name { get; }
    string Email { get; }
}

虽然视图模型不是命令，反之亦然，但视图模型可以充当命令：

class ProductViewModel : IOrderProductCommand
{
    public int ProductId { get; set; }

    [Required(ErrorMessage = "Name not specified")]
    public string Name { get; set; }

    [Required(ErrorMessage ="E-Mail not specified")]
    public string Email { get; set; }

    public ProductViewModel(int id) { /* init */ }

    // a LOT of other properties (let's say 50)
}

这样，验证只在视图模型中进行，我认为这是进行验证的正确位置，因为可以立即向用户提供反馈。

命令应该简单地传输数据，并且它变异的域实体无论如何都应该验证自己；不需要第三层验证。

您的控制器将如下所示：

readonly CommandHandler _handler;

public YourController(CommandHandler handler)
{
    _handler = handler;
}

[HttpGet]
public ActionResult Product(int id)
{
    return View(new ProductViewModel(id));
}

[HttpPost]
public ActionResult Product(ProductViewModel model)
{
    if (!ModelState.IsValid)
    {
        return View(model);
    }

    _handler.HandleProductCommand(model);

    return RedirectToAction(nameof(Product), new { id = model.ProductId });
}

处理程序：

class CommandHandler
{
    void HandleProductCommand(IOrderProductCommand command)
    {
        // Update domain...
    }

    // Other command handling methods...
}

ASP.NET MVC - 正确使用视图模型和命令模式

ASP.NET MVC - Proper usage of View Model and Command pattern

c#

asp.net-mvc

design-patterns

command-pattern

选项 1

选项 2

选项 3