如何捕获EF6和SQL Server的UniqueKey违规异常
本文关键字:UniqueKey 异常 Server 何捕获 EF6 SQL | 更新日期: 2023-09-27 18:03:28
我的一个表有一个唯一的键,当我试图插入重复的记录时,它会按预期抛出异常。但我需要将唯一键异常与其他异常区分开来,这样我就可以自定义唯一键约束冲突的错误消息。
我在网上找到的所有解决方案都建议将ex.InnerException
强制转换为System.Data.SqlClient.SqlException
,并检查Number
属性是否等于2601或2627,如下所示:
try
{
_context.SaveChanges();
}
catch (Exception ex)
{
var sqlException = ex.InnerException as System.Data.SqlClient.SqlException;
if (sqlException.Number == 2601 || sqlException.Number == 2627)
{
ErrorMessage = "Cannot insert duplicate values.";
}
else
{
ErrorMessage = "Error while saving data.";
}
}
但问题是,将ex.InnerException
强制转换为System.Data.SqlClient.SqlException
会导致无效的强制转换错误,因为ex.InnerException
实际上是System.Data.Entity.Core.UpdateException
的类型,而不是System.Data.SqlClient.SqlException
。
上面的代码有什么问题?如何捕获违反唯一密钥约束的情况?
通过EF6和DbContext
API(用于SQL Server(,我目前正在使用以下代码:
try
{
// Some DB access
}
catch (Exception ex)
{
HandleException(ex);
}
public virtual void HandleException(Exception exception)
{
if (exception is DbUpdateConcurrencyException concurrencyEx)
{
// A custom exception of yours for concurrency issues
throw new ConcurrencyException();
}
else if (exception is DbUpdateException dbUpdateEx)
{
if (dbUpdateEx.InnerException != null
&& dbUpdateEx.InnerException.InnerException != null)
{
if (dbUpdateEx.InnerException.InnerException is SqlException sqlException)
{
switch (sqlException.Number)
{
case 2627: // Unique constraint error
case 547: // Constraint check violation
case 2601: // Duplicated key row error
// Constraint violation exception
// A custom exception of yours for concurrency issues
throw new ConcurrencyException();
default:
// A custom exception of yours for other DB issues
throw new DatabaseAccessException(
dbUpdateEx.Message, dbUpdateEx.InnerException);
}
}
throw new DatabaseAccessException(dbUpdateEx.Message, dbUpdateEx.InnerException);
}
}
// If we're here then no exception has been thrown
// So add another piece of code below for other exceptions not yet handled...
}
正如您提到的UpdateException
,我假设您使用的是ObjectContext
API,但它应该是类似的。
在我的例子中,我使用的是EF 6,并用装饰了我模型中的一个属性
[Index(IsUnique = true)]
为了捕捉违规行为,我使用C#7执行以下操作,这变得容易得多:
protected async Task<IActionResult> PostItem(Item item)
{
_DbContext.Items.Add(item);
try
{
await _DbContext.SaveChangesAsync();
}
catch (DbUpdateException e)
when (e.InnerException?.InnerException is SqlException sqlEx &&
(sqlEx.Number == 2601 || sqlEx.Number == 2627))
{
return StatusCode(StatusCodes.Status409Conflict);
}
return Ok();
}
请注意,这将只捕获唯一索引约束冲突。
try
{
// do your insert
}
catch(Exception ex)
{
if (ex.GetBaseException().GetType() == typeof(SqlException))
{
Int32 ErrorCode = ((SqlException)ex.InnerException).Number;
switch(ErrorCode)
{
case 2627: // Unique constraint error
break;
case 547: // Constraint check violation
break;
case 2601: // Duplicated key row error
break;
default:
break;
}
}
else
{
// handle normal exception
}
}
// put this block in your loop
try
{
// do your insert
}
catch(SqlException ex)
{
// the exception alone won't tell you why it failed...
if(ex.Number == 2627) // <-- but this will
{
//Violation of primary key. Handle Exception
}
}
编辑:
您也可以只检查异常的消息组件。类似这样的东西:
if (ex.Message.Contains("UniqueConstraint")) // do stuff
我认为展示一些代码可能很有用,不仅可以处理重复行异常,还可以提取一些可用于编程目的的有用信息。例如,撰写自定义消息。
这个Exception
子类使用regex来提取数据库表名、索引名和键值。
public class DuplicateKeyRowException : Exception
{
public string TableName { get; }
public string IndexName { get; }
public string KeyValues { get; }
public DuplicateKeyRowException(SqlException e) : base(e.Message, e)
{
if (e.Number != 2601)
throw new ArgumentException("SqlException is not a duplicate key row exception", e);
var regex = @"'ACannot insert duplicate key row in object ''(?<TableName>.+?)'' with unique index ''(?<IndexName>.+?)'''. The duplicate key value is '((?<KeyValues>.+?)')";
var match = new System.Text.RegularExpressions.Regex(regex, System.Text.RegularExpressions.RegexOptions.Compiled).Match(e.Message);
Data["TableName"] = TableName = match?.Groups["TableName"].Value;
Data["IndexName"] = IndexName = match?.Groups["IndexName"].Value;
Data["KeyValues"] = KeyValues = match?.Groups["KeyValues"].Value;
}
}
DuplicateKeyRowException
类很容易使用。。。只需创建一些错误处理代码,就像前面的答案一样。。。
public void SomeDbWork() {
// ... code to create/edit/update/delete entities goes here ...
try { Context.SaveChanges(); }
catch (DbUpdateException e) { throw HandleDbUpdateException(e); }
}
public Exception HandleDbUpdateException(DbUpdateException e)
{
// handle specific inner exceptions...
if (e.InnerException is System.Data.SqlClient.SqlException ie)
return HandleSqlException(ie);
return e; // or, return the generic error
}
public Exception HandleSqlException(System.Data.SqlClient.SqlException e)
{
// handle specific error codes...
if (e.Number == 2601) return new DuplicateKeyRowException(e);
return e; // or, return the generic error
}
如果您想捕获唯一约束
try {
// code here
}
catch(Exception ex) {
//check for Exception type as sql Exception
if(ex.GetBaseException().GetType() == typeof(SqlException)) {
//Violation of primary key/Unique constraint can be handled here. Also you may //check if Exception Message contains the constraint Name
}
}
在编写代码时必须非常具体。
try
{
// do your stuff here.
{
catch (Exception ex)
{
if (ex.Message.Contains("UNIQUE KEY"))
{
Master.ShowMessage("Cannot insert duplicate Name.", MasterSite.MessageType.Error);
}
else { Master.ShowMessage(ex.Message, MasterSite.MessageType.Error); }
}
我刚刚更新了上面的代码,它对我有效。