如何设计ViewModel

时间:2012-03-27 00:30:47

标签: entity-framework viewmodel

我在项目中实施了EF 4。在其中,有表客户和订单。其中一个(客户)与多个(订单)有关系。

我正在为(CustomerViewModel和OrderViewModel)创建一个viewmodel,从我的域层传递到接口层(在本例中为MVC)。

现在问题是“我是否需要引用两个viewmodel?例如在customerviewmodel中有IEnumerable<OrderViewModel>而orderviewmodel有CustomerViewModel。如果是这样,我该如何设计它(作为最佳实践)所以IEnumerable<OrderViewModel>CustomerViewModel是否填充了正确的引用?

1 个答案:

答案 0 :(得分:26)

我总是会考虑到特定的视图来驱动ViewModels的设计,而不是从域模型(=实体)的角度来看。 ViewModel的外观取决于您要在视图中显示的内容和要修改的内容。

因此,您没有OrderViewModelCustomerViewModel,因为您有不同的视图,可以显示或编辑订单或客户或其中的部分内容。因此,您可以将这些ViewModel用于特定目的和视图,因此可以在不同的变体中多次使用。

假设您有一个OrderEditView,此视图将允许编辑订单信息并显示该订单的客户。你会有OrderEditViewModel这样的:

public class OrderEditViewModel
{
    public int OrderId { get; set; }

    public DateTime? ShippingDate { get; set; }

    [StringLength(500)]
    public string Remark { get; set; }
    //...

    public OrderEditCustomerViewModel Customer { get; set; }
}

public class OrderEditCustomerViewModel
{
    [ReadOnly(true)]
    public string Name { get; set; }

    [ReadOnly(true)]
    public string City { get; set; }
    // ...
}

OrderEditCustomerViewModel不需要引用OrderEditViewModel

您可以像这样填充此ViewModel:

var orderEditViewModel = context.Orders
    .Where(o => o.OrderId == 5)
    .Select(o => new OrderEditViewModel
    {
        OrderId = o.OrderId,
        ShippingDate = o.ShippingDate,
        Remark = o.Remark,
        Customer = new OrderEditCustomerViewModel
        {
            Name = o.Customer.Name,
            City = o.Customer.City
        }
    })
    .SingleOrDefault();

另一方面,如果您有CustomerEditView允许编辑客户信息并在列表中显示客户的订单,则ViewModel可能是:

public class CustomerEditViewModel
{
    public int CustomerId { get; set; }

    [Required, StringLength(50)]
    public string Name { get; set; }

    [Required, StringLength(50)]
    public string City { get; set; }
    //...

    public IEnumerable<CustomerEditOrderViewModel> Orders { get; set; }
}

public class CustomerEditOrderViewModel
{
    [ReadOnly(true)]
    public DateTime? ShippingDate { get; set; }

    [ReadOnly(true)]
    public string Remark { get; set; }
    // ...
}

此处CustomerEditOrderViewModel不需要对CustomerEditViewModel的引用,您可以通过这种方式从数据库创建ViewModel,例如:

var customerEditViewModel = context.Customers
    .Where(c => c.CustomerId == 8)
    .Select(c => new CustomerEditViewModel
    {
        CustomerId = c.CustomerId,
        Name = c.Name,
        City = c.City,
        Orders = c.Orders.Select(o => new CustomerEditOrderViewModel
        {
            ShippingDate = o.ShippingDate,
            Remark = o.Remark
        })
    })
    .SingleOrDefault();

Customer(*)ViewModelOrder(*)ViewModel是不同的 - 关于必要的引用,属性和数据注释,具体取决于它们的使用位置。

考虑到这些注意事项,OrderViewModelCustomerViewModel之间相互正确引用的问题会消失,因为您通常不需要对视图进行此类双向引用。