Wprowadzenie

Dzisiejszy wpis jest inspirowany jednym z ostatnich code review, jakie robiłem. Zauważyłem, że gdy pracujemy z Entity Framework, często niektóre rzeczy zaczynamy robić nieefektywnie względem tego, jakbyśmy zrobili to chociażby w przypadku ADO.NET. Taką właśnie czynnością jest aktualizowanie oraz usuwanie obiektów z bazy.

Aktualizacja obiektu z jego pobraniem

Standardowo, gdy zaczynamy uczyć się pracować z Entity Framework, do aktualizacji obiektu możemy użyć mniej więcej takiego kodu:

Po utworzeniu instancji obiektu kontekstowego za pomocą metody FirstOrDefault wyciągamy interesujący nas obiekt z bazy na podstawie klucza głównego (Id). Następnie aktualizujemy jego właściwości oraz wywołujemy metodę SaveChanges, które wykona stosowny update na bazie. Wynik wykonania powyższego fragmentu kody wygląda tak (jest to log wygenerowany przez Entity Framework – pierwsza linijka w using):

Jak widać, w pierwszej kolejności na bazie wykonywany jest select i później update. W niektórych sytuacjach takie podejście może rzutować na działanie aplikacji. Przykładowo, gdy tworzymy funkcjonalność blokowania edycji danych (tylko jeden użytkownik może naraz je edytować), moglibyśmy co 30 sekund (albo jakąś inną wartość) z widoku wysyłać informację, że obiekt jest edytowany, i w bazie zapisywać aktualny czas. Następnie podczas wyświetlania formularza analizowalibyśmy ten czas i odpowiednio blokowali widok lub nie. W takiej sytuacji musimy zaktualizować jedno pole w bazie na podstawie Id obiektu, a inne pola nas nie interesują. Również nie interesuje nas poprzednia wartość tego pola, ważne, aby pojawiła się tam nowa wartość.

W takiej sytuacji pobieranie za każdym razem całego obiektu przy sporej liczbie użytkowników może dość mocno obciążyć bazę danych przez wykonywanie niepotrzebnych operacji. W klasycznym ADO.NET wykonalibyśmy prosty update bez żadnych selectów.

Aktualizacja obiektu bez jego pobierania

Na szczęście Entity Framework daje nam możliwość zaktualizowania danych bez ich wcześniejszego pobierania. Co istotne, aby ten mechanizm zadziałał, musimy bazować na kluczu głównym naszej encji (w tym przypadku Id). Poniżej zmieniony kod, który zaktualizuje rekord w bazie bez jego pobierania.

W pierwszej kolejności tworzymy nową instancję obiektu z ustawieniem klucza głównego (w przykładzie to Id). Następnie z wykorzystaniem metody Attach podpinamy utworzony obiekt do obiektu kontekstowego, który będzie teraz śledził zmiany. Dalsza część kodu jest taka sama, jak wcześniej – czyli zmiana właściwości oraz wywołanie metody SaveChanges. W logu wyraźnie widać, że znajduje się tam tylko update, bez select.

Powyższy fragment kodu nie jest do końca idealny i ma jeden problem. W wykonanym sqlu widać, że nastąpiła tylko aktualizacja kolumny LockTime, mimo że w kodzie aktualizowane są dwie właściwości. Dzieje się tak, ponieważ Entity Framework wykrywa zmiany tylko w momencie, gdy wartość jest różna od wartości domyślnej dla danego typu. W przykładzie Count jest wartością typu int, dlatego próba wyzerowania wartości w bazie się nie powiodła – warto o tym pamiętać. Na szczęście i na to jest rozwiązanie: trzeba dodać jedną linijkę dla właściwości:

Ręcznie informujemy Entity Framework, że właściwość została zaktualizowana, więc teraz w update będą zaktualizowane dwie kolumny:

Usuwanie obiektu bez jego pobierania

Podobna sytuacja zaistnieje w przypadku usuwania obiektu – możemy ją wykonać bez pobierania encji. Rozwiązanie tego problemu jest bardzo podobne – tutaj też bazujemy na kluczu naszej encji:

Sam log wykonania powyższego kodu wygląda tak:

W tym przypadku tym bardziej widać, jak niepotrzebne jest pobieranie obiektu w momencie, gdy chcemy go usunąć. Zachęcam do usuwania obiektu w ten sposób, bez wcześniejszego jego pobierania.

W obu przypadkach, gdy obiektu nie ma w bazie, to podczas wykonywania operacji nie otrzymamy błędu. Po prostu zapytanie wykona się, ale żadne dane nie zostaną zmienione lub usunięte z bazy.

Przykład

Na githubie (https://github.com/danielplawgo/UpdateInEntityFramework) znajduje się przykład pokazujący działanie tego mechanizmu. Aplikacja korzysta z mechanizmu migracji Entity Framework, w tym metody Seed, która dodaje testowy obiekt do bazy. Dlatego przed uruchomieniem aplikacji w app.config należy ustawić connection stringa do testowej bazy.

Aplikacja na końcu usuwa testowy obiekt, dlatego przed jej kolejnym uruchomieniem należy wykonać aktualizację bazy (update-database w konsoli nugeta), który wywoła metodę Seed przywracającą dane testowe.

Gorąco zachęcam do pobrania projektu oraz testów tego rozwiązania.

Podsumowanie

Jednym z najczęściej popełnianych błędów podczas pracy z Entity Framework jest zbyt częste pobieranie danych do aplikacji, w szczególności gdy chcemy zmienić tylko niektóre właściwości obiektu lub go usunąć. Takie podejście może wpłynąć negatywnie na działanie aplikacji, zwłaszcza gdy jest bardzo często wykonywane (patrz przykład z aktualizacją co 30 sekund informacji o tym, że obiekt jest aktualizowany).

Dlatego właśnie warto zwiększyć wydajność aplikacji poprzez zminimalizowanie liczby pobieranych obiektów do aplikacji podczas korzystania z Entity Framework. Oczywiście są również inne sposoby na wykonanie tych operacji efektywnie – na przykład skorzystanie z klasycznego ADO.NET. Ale to temat na inny wpis. 🙂

A w jaki sposób Ty aktualizujesz lub usuwasz dane w bazie, gdy korzystasz z Entity Framework w aplikacji?