Soft Delete w EF Core - Usuwanie Danych Bez Utraty Historii

W typowych aplikacjach usuwanie rekordu z bazy danych oznacza jego trwałe skasowanie. Czasem jednak zależy nam, aby usunąć dane tylko pozornie, pozostawiając je w bazie do ewentualnego przywrócenia lub do celów audytowych. Takie podejście nazywamy soft delete (miękkim usunięciem). Zamiast trwale usuwać rekord SQL-em DELETE, oznaczamy go specjalną flagą, np. IsDeleted = true, dzięki czemu dane "ukrywamy", ale nie tracimy ich całkowicie. W efekcie aplikacja pomija tak oznaczone rekordy przy pobieraniu danych, ale w razie potrzeby możemy je łatwo przywrócić, zmieniając flagę na false.

Co to jest soft delete i dlaczego warto?

Implementacja soft delete w EF Core

public class Blog  /* przykładowa encja */
{
    public int Id { get; set; }
    public string Name { get; set; }
    public bool IsDeleted { get; set; } = false; /* domyślnie false */
}

Powyżej klasa Blog ma nową kolumnę IsDeleted. Gdy wartość true, rekord uznajemy za usunięty logicznie.
    
2. Globalny filtr zapytań: Skonfiguruj kontekst bazy danych, aby EF Core automatycznie filtrował rekordy oznaczone jako usunięte. Można to zrobić, dodając globalny filtr w metodzie OnModelCreating w klasie kontekstu:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Blog>()
        .HasQueryFilter(b => !b.IsDeleted);
}

Powyższa konfiguracja oznacza: dla encji Blog każdorazowo przy zapytaniu dodawaj warunek WHERE IsDeleted == false. Innymi słowy, EF Core domyślnie pomija rekordy, które mają IsDeleted = true. Dzięki temu nie musimy za każdym razem pamiętać o dopisywaniu warunku w kodzie. Filtr działa globalnie w całej aplikacji. Gdy wykonamy np. context.Blogs.ToList(), otrzymamy tylko blogi nieusunięte.
    
3. Oznaczanie rekordu jako usuniętego: W momencie, gdy chcemy "usunąć" dany obiekt, zamiast usuwać go fizycznie z bazy, powinniśmy ustawić jego flagę IsDeleted na true. Można to zrobić na dwa sposoby:

-Ręczne oznaczenie: Pobieramy obiekt, ustawiamy mu IsDeleted = true i zapisujemy zmiany. Np.:

var blog = await context.Blogs.FirstOrDefaultAsync(b => b.Id == id);
if(blog != null)
{
    blog.IsDeleted = true;
    await context.SaveChangesAsync();
}

Taki kod ustawi flagę i dzięki globalnemu filtrowi dany rekord nie będzie już pojawiał się w wynikach zwykłych zapytań.

 -Nadpisanie metody SaveChanges: Możemy pójść o krok dalej i zautomatyzować soft delete, przechwytując operację usunięcia. W klasie naszego DbContext nadpisujemy metodę SaveChanges/SaveChangesAsync, aby wychwycić encje oznaczone do usunięcia i zamiast kasować, ustawić im flagę:

public override int SaveChanges()
{
    foreach (var entry in ChangeTracker.Entries<Blog>()
                                      .Where(e => e.State == EntityState.Deleted))
    {
        /* Zamiast usuwać, oznacz jako zmodyfikowany i ustaw IsDeleted */
        entry.State = EntityState.Modified;
        entry.CurrentValues["IsDeleted"] = true;
    }
    return base.SaveChanges();
}

Powyżej iterujemy przez śledzone encje, których stan to Deleted (usunięte) i zamieniamy je na Modified (zmodyfikowane), jednocześnie ustawiając wartość IsDeleted na true. Dzięki temu możesz w kodzie aplikacji używać standardowego context.Remove(obj) czy context.YourEntities.Remove(obj), a kontekst EF Core i tak zamieni to pod spodem na soft delete. Nie musisz pamiętać o ręcznym ustawianiu flagi za każdym razem.
    
4. Pobieranie również usuniętych danych (gdy potrzebne): Zdarzają się sytuacje, że zechcesz jednak wyciągnąć także rekordy oznaczone jako usunięte, na przykład w panelu administratora lub do celów analitycznych. Wtedy EF Core umożliwia lokalne wyłączenie globalnego filtra za pomocą metody .IgnoreQueryFilters(). Przykład:

/* pobierz wszystkie blogi, łącznie z tymi miękko usuniętymi: */
var allBlogs = await context.Blogs
                            .IgnoreQueryFilters()
                            .ToListAsync();

Po dodaniu IgnoreQueryFilters() zapytanie zignoruje globalne filtry i zwróci pełen zestaw danych, włącznie z rekordami o IsDeleted = true. Domyślnie jednak, bez wywołania tej metody, filtry pozostają aktywne, co chroni przed przypadkowym wykorzystaniem "usuniętych" danych w aplikacji.

Podsumowanie