在开发Web应用程序时，经常需要确保数据库表中的某些字段或属性值是唯一的。例如，用户名字段就应该是唯一的，以避免用户重复注册相同的用户名。本文将介绍在ASP.NET MVC中实现模型属性唯一性约束的两种方法，并讨论如何修复在更新现有实体时遇到的一个问题。
本文首先介绍了两种在ASP.NET MVC中实现唯一性或唯一键属性的方法：使用IValidatableObject接口和使用远程验证属性。第一种方法没有问题，但是第二种方法存在漏洞，因为它是基于JavaScript的客户端验证。如果用户禁用了浏览器中的JavaScript，那么他们可能会插入重复的值。因此，需要在第二种方法中添加服务器端验证，以确保即使在客户端验证被禁用的情况下也能正常工作。
为了保持文章的合理长度，决定将文章分为两部分：第一部分是使用IValidatableObject接口的方法，第二部分是使用远程验证属性并添加自定义服务器端验证的方法。
有时，不希望数据库表中的某个列或属性出现重复值。例如，对于数据库表中的用户名列或属性，不应该允许用户插入已经存在于数据库表中的值，因为用户名是唯一的值。
假设有一个库存系统，其中有一个产品表/类，用于跟踪所有产品。因此，有理由不允许用户插入已经存在于表中的产品名称。以下是将在本文中使用的产品模型类：
public class Product
{
public int Id { get; set; }
public string ProductName { get; set; }
public int ProductQuantity { get; set; }
public decimal UnitPrice { get; set; }
}
步骤1：在ProductName属性上添加"Index"属性，并设置"IsUnique"参数。请记住，使用"Index"属性时，还必须使用"StringLength"属性。
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
namespace ImplementingUniqueKey.Models
{
public class Product
{
public int Id { get; set; }
[Required]
[StringLength(50)]
[Index("Ix_ProductName", Order = 1, IsUnique = true)]
public string ProductName { get; set; }
public int ProductQuantity { get; set; }
public decimal UnitPrice { get; set; }
}
}
在进行这些更改之前，如果数据库中已经有产品表/类，请使用代码优先迁移更新数据库，或者如果没有现有数据问题，可以简单地删除表。
现在运行项目并尝试插入一个已经存在于表中的产品名称的产品实体。将收到一个异常，错误消息如下：
Cannot insert duplicate key row in object 'dbo.Products' with unique index 'Ix_ProductName'. The duplicate key value is (ProductName). The statement has been terminated.
这对客户端用户来说毫无意义。因此，需要处理异常，以便向客户端用户提供有意义的消息。
步骤2：现在需要继承IValidatableObject接口，并提供IValidatableObject接口Validate()方法的实现。
完成此操作后，Product类将如下所示：
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
namespace ImplementingUniqueKey.Models
{
public class Product : IValidatableObject
{
public int Id { get; set; }
[Required]
[StringLength(50)]
[Index("Ix_ProductName", Order = 1, IsUnique = true)]
public string ProductName { get; set; }
public int ProductQuantity { get; set; }
public decimal UnitPrice { get; set; }
IEnumerable IValidatableObject.Validate(ValidationContext validationContext)
{
ProductDbContext db = new ProductDbContext();
List validationResult = new List();
var validateName = db.Products.FirstOrDefault(x => x.ProductName == ProductName);
if (validateName != null)
{
ValidationResult errorMessage = new ValidationResult(
"Product name already exists.", new[] { "ProductName" });
validationResult.Add(errorMessage);
}
return validationResult;
}
}
}
到目前为止，它在仅创建新实体时可以正常工作，但在编辑/更新现有实体时无法正常工作。它不允许在更新其他字段时传递唯一字段的原始值。要传递唯一字段的原始值，请按如下方式修改validate()方法：
IEnumerable IValidatableObject.Validate(ValidationContext validationContext)
{
ProductDbContext db = new ProductDbContext();
List validationResult = new List();
var validateName = db.Products.FirstOrDefault(x => x.ProductName == ProductName && x.Id != Id);
if (validateName != null)
{
ValidationResult errorMessage = new ValidationResult(
"Product name already exists.", new[] { "ProductName" });
validationResult.Add(errorMessage);
return validationResult;
}
else
{
return validationResult;
}
}
还可以将validate()方法以更简化的形式编写如下：
IEnumerable IValidatableObject.Validate(ValidationContext validationContext)
{
ProductDbContext db = new ProductDbContext();
var validateName = db.Products.FirstOrDefault(x => x.ProductName == ProductName && x.Id != Id);
if (validateName != null)
{
ValidationResult errorMessage = new ValidationResult(
"Product name already exists.", new[] { "ProductName" });
yield return errorMessage;
}
else
{
yield return ValidationResult.Success;
}
}
在运行项目之前，请记住在控制器类中，db.SaveChanges()方法必须在ModelState.IsValid检查中。Create和Edit/Update方法应该如下所示：
[HttpPost]
[ValidateAntiForgeryToken]
public ActionResult Create([Bind(Include = "Id,ProductName,ProductQuantity,UnitPrice")] Product product)
{
if (ModelState.IsValid)
{
db.Products.Add(product);
db.SaveChanges();
return RedirectToAction("Index");
}
return View(product);
}
[HttpPost]
[ValidateAntiForgeryToken]
public ActionResult Edit([Bind(Include = "Id,ProductName,ProductQuantity,UnitPrice")] Product product)
{
if (ModelState.IsValid)
{
db.Entry(product).State = EntityState.Modified;
db.SaveChanges();
return RedirectToAction("Index");
}
return View(product);
}