テーブルの1つに一意のキーがあり、重複レコードを挿入しようとすると、期待どおりに例外がスローされます。ただし、一意のキー制約違反に対するエラーメッセージをカスタマイズできるように、一意のキー例外を他の例外と区別する必要があります。
オンラインで見つけたすべてのソリューションは、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を使用しており、モデルのプロパティの1つを次のように装飾しています。
[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();
}
これは、一意のインデックス制約違反のみをキャッチすることに注意してください。
// 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
ユニーク制約をキャッチしたい場合
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 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
}
}
重複行の例外を処理するだけでなく、プログラムの目的に使用できる有用な情報を抽出するコードを表示することが役立つと思いました。例えば。カスタムメッセージを作成します。
このException
サブクラスは正規表現を使用して、dbテーブル名、インデックス名、およびキー値を抽出します。
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
}