Linq to Entities でエンティティを追加したり取得したりする場合、デフォルトではエンティティは DbContext にキャッシュされるそうです。それでハマったので、再びそういうことがないよう備忘録を書いておくことにしました。
元の話は Teratail のスレッド「[C#,.NET5,EFCore5+Microsfot.Data.Sqlite] トランザクションのロールバックが意図通りに動かない」です。その話は表題とは異なり、ロールバックは期待通り動いていたがキャッシュのために動いてないと勘違いしたというものです。
本題に入る前に、まずトランザクション / ロールバックの話を書いておきます。
トランザクションは、保留中の状態 (BeginTransaction の呼び出し後、Commit の呼び出し前) だけからロールバックできるようになっています。逆に言えば、保留中の状態であれば RollBack を呼び出せばロールバックできます。
Microsoft のドキュメント「トランザクションの使用」の「トランザクションを制御する」のセクションのサンプルコードを見てください。
SaveChanges はすべて完全に成功していても、transaction は SaveChanges でコミットされるわけではない（保留中の状態にある）ので、transaction.Commit(); がないと transaction が Dispose される時にロールバックされます。
そのコードで transaction.Commit(); ⇒ transaction.RollBack(); としたのが Teratail のスレッドの話ですが、その場合はもちろん無条件でロールバックされます。
DB はロールバックはされたのですが、キャッシュされたエンティティまではロールバックされないので、キャッシュされたエンティティを使ってその後の操作を行った結果ロールバックが失敗しているように見えたという話です。
エンティティをキャッシュする理由は、Microsoft のドキュメント「追跡と追跡なしのクエリ」に書いてあるように、追跡を行うためということです。どういうことかと言うと、エンティティに加えられた変更を追跡していって、SaveChanges メソッドで変更結果を DB に反映するということらしいです。
その記事に書いてある "If EF Core finds an existing entity, then the same instance is returned. EF Core won't overwrite current and original values of the entity's properties in the entry with the database values." というのは「エンティティがキャッシュにあればキャッシュから取得する。DB の値で上書きされることはない」と言っているように思えます。
"If the entity isn't found in the context, then EF Core will create a new entity instance and attach it to the context." というのは「context.Blogs.Add(...) というようにするとそのエンティティも DbContext にキャッシュされる」ということのように思えます。
Teratail のスレッドのように、自分で RollBack と書くようなことはしないはずなので、普通はキャッシュによる問題には遭遇しなそうな気がします。
そこを、若干無理やりですが、こんなことをすると問題になるかもしれないと作ったサンプルが下のコードです。Visual Studio 2019 のテンプレートで作った .NET 5.0 のコンソールアプリです。DB は SQLite を使っています。
Teratail のものとは違って、普通に Commit と書いて例外発生時のみロールバックするようにしています。ただし、例外を catch してなかったことにしているので、その後キャッシュされたエンティティを使っての作業が継続できるというものです。
これを実行した結果の DB の内容が上の画像です。Name が SEQ1, SEQ2, SEQ3 の既存のレコードがあって、それに赤枠で囲った SEQ5 のレコードを追加しています。
transaction で囲った 1 つ目の SaveChanges で SEQ5 の Value を 2 に UPDATE していますが、2 つ目の SaveChanges で PK 制約違反の例外が発生するので Commit できずロールバックされるようになっています。DB 上では上の画像の通りロールバックされて SEQ5 の Value は初期値 1 のままになっています。
コードのコメント「ここでエンティティがキャッシュされる」のところで SEQ5 のエンティティがキャッシュされています。ロールバックされた後、変数 seq1, seq2, seq3 に SEQ5 のエンティティを取得してその Value プロパティをコンソールに書き出すと以下のように順に 2, 2, 1 となります。
seq1, seq2 はキャッシュから取得されており、キャッシュはロールバックされないので、それらの Value はコードで書き換えた 2 のままになっています。
予想外だったのは seq2 です。これは要注意だと思いました。context.Sequences.ToListAsync() で DB に SELECT クエリを発行してロールバック後のすべてのレコードを取得してくるのですが、SEQ5 のエンティティのみはキャッシュで書き換えられてしまっています。
seq3 は Reload して DB からデータを取得してキャッシュを書き換えた結果です。上の画像のロールバック後の DB の値が Reload で取得されて Value は 1 になっています。
using System;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using Microsoft.EntityFrameworkCore;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace ConsoleAppSQLite
{
class Program
{
static async Task Main(string[] args)
{
using (var context = new TestDBContext())
{
// ここでエンティティがキャッシュされる
context.Sequences.Add(
new SequenceValue { Name = "SEQ5", Value = 1 });
// 上で作った Name = "SEQ5", Value = 1 の新規データを INSERT
context.SaveChanges();
try
{
using (var transaction = context.Database.BeginTransaction())
{
// 上で INSERT した Name = "SEQ5", Value = 1 のレコード
// の Value を 2 にして UPDATE
SequenceValue seq = context.Sequences.Find("SEQ5");
seq.Value = 2;
context.SaveChanges();
// Name = "SEQ2", Value = 1 のレコードを INSERT
// Name は主キーで "SEQ2" のレコードは DB に存在する
// ので PK 制約違反
context.Sequences.Add(
new SequenceValue { Name = "SEQ2", Value = 100 });
context.SaveChanges();
// 上の SaveChanges で例外が発生するので Commit されない
// 結果 transaction が Dispose される際ロールバックされる
transaction.Commit();
}
}
catch (Exception)
{
// 例外処理・・・何もしないと例外はなかったことになる
}
// キャッシュから取得する。ロールバックはキャッシュは書き換え
// ないので、上のコードで seq.Value = 2 とした結果が取得される
SequenceValue seq1 = context.Sequences.Find("SEQ5");
// キャッシュから取得しないようにするには AsNoTracking() を
// 追加して以下のようにする
//SequenceValue seq1 = await context.Sequences
// .AsNoTracking()
// .SingleAsync(x => x.Name == "SEQ5");
Console.WriteLine(seq1.Value);
// DB に SELECT クエリを発行して全てレコードを取得してくるが
// Name（主キー）が "SEQ5" のエンティティだけはキャッシュから
// 取得して list を書き換える。
List<SequenceValue> list = await context.Sequences.ToListAsync();
// 書き換えられないようにするには AsNoTracking() を追加して
// 以下のようにする
//List<SequenceValue> list =
// await context.Sequences.AsNoTracking().ToListAsync();
SequenceValue seq2 = list.Find(x => x.Name == "SEQ5");
Console.WriteLine(seq2.Value);
// Reload すると DB からデータを取得してキャッシュを書き換
// えるので Value はロールバック後の値 1 になる
SequenceValue seq3 = context.Sequences.Find("SEQ5");
await context.Entry(seq3).ReloadAsync();
Console.WriteLine(seq3.Value);
}
}
}
[Table("SEQUENCES")]
public class SequenceValue
{
[Key, Column("NAME")]
public string Name { get; set; }
[Column("VALUE")]
public int Value { get; set; }
}
public class TestDBContext : DbContext
{
protected override void OnConfiguring(DbContextOptionsBuilder builder)
{
var path = @"C:\Users\...省略...\test.db";
var connStr = "Data Source=" + path;
builder.UseSqlite(connStr);
// 出力ウィンドウに EF Core ログを表示
builder.LogTo(msg => System.Diagnostics.Debug.WriteLine(msg));
}
public DbSet<SequenceValue> Sequences { get; set; }
}
}
あと、コメントにも書きましたが、DbExtensions.AsNoTracking メソッドを適用すると "Returns a new query where the entities returned will not be cached in the DbContext or ObjectContext." ということで、キャッシュは使われなくなるようです。こういうやり方が正解なのかどうかは分かりませんが。