Odłączonych jednostek.Disconnected entities

Wystąpienie typu DbContext automatycznie śledzi zwróconych z bazy danych.A DbContext instance will automatically track entities returned from the database. Zmiany wprowadzone do tych jednostek następnie zostanie wykryty, gdy jest wywoływana SaveChanges i bazy danych zostanie zaktualizowany zgodnie z potrzebami.Changes made to these entities will then be detected when SaveChanges is called and the database will be updated as needed. Zobacz podstawowe zapisać i dane dotyczące szczegółowe informacje.See Basic Save and Related Data for details.

Jednak czasami jednostek będą pytani, przy użyciu jednego wystąpienia kontekstu, a następnie zapisane przy użyciu innego wystąpienia.However, sometimes entities are queried using one context instance and then saved using a different instance. Odbywa się to często w "odłączony" scenariuszy, takich jak aplikacji sieci web, w którym jednostek są proszeni, wysyłane do klienta zmodyfikowane, wysyłane z powrotem do serwera w żądaniu i zapisany.This often happens in "disconnected" scenarios such as a web application where the entities are queried, sent to the client, modified, sent back to the server in a request, and then saved. W takim przypadku kontekst drugiego wystąpienia musi wiedzieć, czy jednostki są nowe (powinny zostać wstawione) lub istniejące (powinien być zaktualizowany).In this case, the second context instance needs to know whether the entities are new (should be inserted) or existing (should be updated).

Porada

Można wyświetlić w tym artykule próbki w witrynie GitHub.You can view this article's sample on GitHub.

Identyfikowanie nowych jednostekIdentifying new entities

Klient identyfikuje nowe jednostkiClient identifies new entities

Najprostszym przypadku radzenia sobie z jest, gdy klient informuje serwer, czy jednostka jest nowy lub istniejący.The simplest case to deal with is when the client informs the server whether the entity is new or existing. Na przykład często żądania, aby wstawić nową jednostkę różni się od żądania w celu zaktualizowania istniejącej jednostki.For example, often the request to insert a new entity is different from the request to update an existing entity.

W pozostałej części tej sekcji omówiono przypadkach gdy niezbędne do określenia w inny sposób, czy można wstawić ani zaktualizować go.The remainder of this section covers the cases where it necessary to determine in some other way whether to insert or update.

Z automatycznego generowania kluczyWith auto-generated keys

Wartość klucza automatycznie generowanych często może służyć do określenia, czy jednostka musi być wstawiane lub aktualizowane.The value of an automatically generated key can often be used to determine whether an entity needs to be inserted or updated. Jeśli klucz nie został ustawiony, (tj. nadal posiada CLR domyślna wartość null, zero, itp.), jednostki musi być nowy i wymaga Wstawianie.If the key has not been set (i.e. it still has the CLR default value of null, zero, etc.), then the entity must be new and needs inserting. Z drugiej strony Jeśli ustawiono wartość tego klucza, następnie je musi już zostały wcześniej zapisane i teraz konieczna jest aktualizacja.On the other hand, if the key value has been set, then it must have already been previously saved and now needs updating. Innymi słowy Jeśli klucz ma wartość, następnie jednostki kwerendy, wysyłane do klienta i ma teraz wróć do zaktualizowania.In other words, if the key has a value, then entity was queried, sent to the client, and has now come back to be updated.

Jest łatwy do sprawdzenia nie ustawiono klucza, gdy jest znany typ jednostki:It is easy to check for an unset key when the entity type is known:

public static bool IsItNew(Blog blog) 
    => blog.BlogId == 0;

EF ma również wbudowane sposób w tym celu dla typu jednostki, a typ klucza:However, EF also has a built-in way to do this for any entity type and key type:

public static bool IsItNew(DbContext context, object entity) 
    => !context.Entry(entity).IsKeySet;

Porada

Klucze są ustawiane jak jednostki są śledzone przez kontekst, nawet jeśli obiekt jest w stanie Added.Keys are set as soon as entities are tracked by the context, even if the entity is in the Added state. Dzięki temu podczas przesyłania wykres jednostek i decydowanie o każdym, takich jak przy użyciu interfejsu API TrackGraph.This helps when traversing a graph of entities and deciding what to do with each, such as when using the TrackGraph API. Wartość klucza należy używać tylko w taki sposób, w tym miejscu pokazano przed żadnych wywołanie do śledzenia jednostki.The key value should only be used in the way shown here before any call is made to track the entity.

Z kluczyWith other keys

Niektóre inny mechanizm jest potrzebna do nowych jednostek tożsamości, gdy wartości klucza nie są generowane automatycznie.Some other mechanism is needed to identity new entities when key values are not generated automatically. Istnieją dwie metody ogólne do poniższego:There are two general approaches to this:

  • Zapytanie dla jednostkiQuery for the entity
  • Przekaż flagę z klientaPass a flag from the client

Dla obiekt kwerendy, po prostu użyj metody Find:To query for the entity, just use the Find method:

public static bool IsItNew(BloggingContext context, Blog blog)
    => context.Blogs.Find(blog.BlogId) == null;

Wykracza poza zakres tego dokumentu, aby wyświetlić pełny kod może być przekazywany flagę od klienta.It is beyond the scope of this document to show the full code for passing a flag from a client. W aplikacji sieci web zwykle oznacza to, wysyłania żądań różne dla różnych działań, lub przekazywanie niektórych stanu w żądaniu, a następnie wyodrębnij go w kontrolerze.In a web app, it usually means making different requests for different actions, or passing some state in the request then extracting it in the controller.

Zapisywanie pojedynczych jednostekSaving single entities

Jeśli wiadomo, czy jest konieczne insert lub update, a następnie dodaj lub zaktualizuj można odpowiednio:If it is known whether or not an insert or update is needed, then either Add or Update can be used appropriately:

public static void Insert(DbContext context, object entity)
{
    context.Add(entity);
    context.SaveChanges();
}

public static void Update(DbContext context, object entity)
{
    context.Update(entity);
    context.SaveChanges();
}

Jednak jeśli jednostka używa automatycznego generowania wartości klucza, następnie metody aktualizacji można użyć w obu przypadkach:However, if the entity uses auto-generated key values, then the Update method can be used for both cases:

public static void InsertOrUpdate(DbContext context, object entity)
{
    context.Update(entity);
    context.SaveChanges();
}

Metody aktualizacji zwykle oznacza jednostki aktualizacji nie insert.The Update method normally marks the entity for update, not insert. Jednak jeśli jednostka ma klucz wygenerowany automatycznie, a nie wartość klucza nie ustawiono, jednostki zamiast tego jest automatycznie oznaczone do wstawienia.However, if the entity has a auto-generated key, and no key value has been set, then the entity is instead automatically marked for insert.

Porada

To zachowanie została wprowadzona w programie EF Core 2.0.This behavior was introduced in EF Core 2.0. W starszych wersjach należy zawsze jawnie wybierz polecenie Dodaj lub zaktualizuj.For earlier releases it is always necessary to explicitly choose either Add or Update.

Jeśli jednostka nie używa automatycznego generowania kluczy, a następnie aplikacji należy zdecydować, czy jednostka powinna być wstawiane lub aktualizowane: na przykład:If the entity is not using auto-generated keys, then the application must decide whether the entity should be inserted or updated: For example:

public static void InsertOrUpdate(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs.Find(blog.BlogId);
    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
    }

    context.SaveChanges();
}

Czynności opisane w tym miejscu są:The steps here are:

  • Dodaj Znajdź zwraca wartość null, a następnie bazy danych nie zawiera już blog o tym identyfikatorze, dlatego nazywamy Oznacz ją do wstawienia.If Find returns null, then the database doesn't already contain the blog with this ID, so we call Add mark it for insertion.
  • Jeśli Znajdź zwraca jednostkę, następnie istnieje w bazie danych i kontekst teraz śledzi istniejącej jednostkiIf Find returns an entity, then it exists in the database and the context is now tracking the existing entity
    • Następnie używamy SetValues można ustawić wartości dla wszystkich właściwości dla tej jednostki do tych, które pochodzą od klienta.We then use SetValues to set the values for all properties on this entity to those that came from the client.
    • Wywołanie SetValues oznaczy jednostka do zaktualizowania zgodnie z potrzebami.The SetValues call will mark the entity to be updated as needed.

Porada

SetValues oznaczy tylko modyfikowanie właściwości, które mają różne wartości określone w śledzonych jednostki.SetValues will only mark as modified the properties that have different values to those in the tracked entity. Oznacza to, że po wysłaniu aktualizacji, tylko te kolumny, które faktycznie zostały zmienione zostaną zaktualizowane.This means that when the update is sent, only those columns that have actually changed will be updated. (I nic się nie zmieniło, aktualizacja nie zostanie wysłana na wszystkich.)(And if nothing has changed, then no update will be sent at all.)

Praca z wykresówWorking with graphs

Wszystkie nowe/wszystkich istniejących obiektów.All new/all existing entities

Przykład pracy wykresami jest wstawiania lub aktualizowania blogu wraz z jego kolekcja wpisów skojarzone.An example of working with graphs is inserting or updating a blog together with its collection of associated posts. Jeśli wszystkie jednostki na wykresie powinny zostać wstawione lub wszystkie powinien zostać zaktualizowany, następnie proces jest taka sama, jak opisano powyżej dla jednej jednostki.If all the entities in the graph should be inserted, or all should be updated, then the process is the same as described above for single entities. Na przykład wykres blogów i wpisy utworzone w następujący sposób:For example, a graph of blogs and posts created like this:

var blog = new Blog
{
    Url = "http://sample.com",
    Posts = new List<Post>
    {
        new Post {Title = "Post 1"},
        new Post {Title = "Post 2"},
    }
};

mogą być wstawiane następująco:can be inserted like this:

public static void InsertGraph(DbContext context, object rootEntity)
{
    context.Add(rootEntity);
    context.SaveChanges();
}

Wywołania do Add oznaczy blogu i wszystkie wpisy do wstawienia.The call to Add will mark the blog and all the posts to be inserted.

Podobnie jeśli wszystkie jednostki na wykresie muszą zostać zaktualizowane, następnie aktualizacja można:Likewise, if all the entities in a graph need to be updated, then Update can be used:

public static void UpdateGraph(DbContext context, object rootEntity)
{
    context.Update(rootEntity);
    context.SaveChanges();
}

Blog i wszystkie jego wpisy zostaną oznaczone do zaktualizowania.The blog and all its posts will be marked to be updated.

Mieszane nowych i istniejących jednostekMix of new and existing entities

Z automatycznego generowania kluczy aktualizacji ponownie można dla operacji wstawiania i aktualizacji, nawet jeśli wykres zawiera różnych jednostek, które wymagają Wstawianie oraz te, które wymagają zaktualizowania:With auto-generated keys, Update can again be used for both inserts and updates, even if the graph contains a mix of entities that require inserting and those that require updating:

public static void InsertOrUpdateGraph(DbContext context, object rootEntity)
{
    context.Update(rootEntity);
    context.SaveChanges();
}

Aktualizacja spowoduje oznaczenie dowolnej jednostki na wykresie, blog lub post przez operację wstawiania, jeśli nie ma ustawioną wartość klucza, podczas gdy inne jednostki są oznaczone dla aktualizacji.Update will mark any entity in the graph, blog or post, for insertion if it does not have a key value set, while all other entities are marked for update.

Jako przed, gdy nie używa automatycznego generowania kluczy, kwerendy i przetwarza mogą być używane:As before, when not using auto-generated keys, a query and some processing can be used:

public static void InsertOrUpdateGraph(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs
        .Include(b => b.Posts)
        .FirstOrDefault(b => b.BlogId == blog.BlogId);

    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
        foreach (var post in blog.Posts)
        {
            var existingPost = existingBlog.Posts
                .FirstOrDefault(p => p.PostId == post.PostId);

            if (existingPost == null)
            {
                existingBlog.Posts.Add(post);
            }
            else
            {
                context.Entry(existingPost).CurrentValues.SetValues(post);
            }
        }
    }

    context.SaveChanges();
}

Obsługa usuwaHandling deletes

Delete mogą być trudnych do obsługi, ponieważ często Brak jednostki oznacza, że należy ją usunąć.Delete can be tricky to handle since often the absence of an entity means that it should be deleted. Jednym ze sposobów postępowania w przypadku to jest do użycia "usuwania nietrwałego" w taki sposób, że jednostka jest oznaczone jako usunięte zamiast faktycznie usunięte.One way to deal with this is to use "soft deletes" such that the entity is marked as deleted rather than actually being deleted. Usuwa, a następnie staje się taka sama jak aktualizacje.Deletes then becomes the same as updates. Elastyczne usuwa można zaimplementować przy użyciu zapytania filtry.Soft deletes can be implemented in using query filters.

Dla usunięć wartość true jest użycie rozszerzenia wzorca zapytania do wykonania, co to jest zasadniczo różn. wykres wspólnego wzorca Na przykład:For true deletes, a common pattern is to use an extension of the query pattern to perform what is essentially a graph diff. For example:

public static void InsertUpdateOrDeleteGraph(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs
        .Include(b => b.Posts)
        .FirstOrDefault(b => b.BlogId == blog.BlogId);

    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
        foreach (var post in blog.Posts)
        {
            var existingPost = existingBlog.Posts
                .FirstOrDefault(p => p.PostId == post.PostId);

            if (existingPost == null)
            {
                existingBlog.Posts.Add(post);
            }
            else
            {
                context.Entry(existingPost).CurrentValues.SetValues(post);
            }
        }

        foreach (var post in existingBlog.Posts)
        {
            if (!blog.Posts.Any(p => p.PostId == post.PostId))
            {
                context.Remove(post);
            }
        }
    }

    context.SaveChanges();
}

TrackGraphTrackGraph

Wewnętrznie, Dodaj Attach i aktualizacji za pomocą wykresu przechodzenie określenie wprowadzone dla każdej jednostki określające, czy jego powinien być oznaczony jako Added (Aby wstawić), zmodyfikowany (w celu aktualizacji), Unchanged (nic nie rób), lub usunięte (Aby usunąć).Internally, Add, Attach, and Update use graph-traversal with a determination made for each entity as to whether it should be marked as Added (to insert), Modified (to update), Unchanged (do nothing), or Deleted (to delete). Ten mechanizm jest uwidaczniany za pomocą interfejsu API TrackGraph.This mechanism is exposed via the TrackGraph API. Na przykład załóżmy, że że gdy klient przesyła wykres jednostek ustawia niektóre flagi dla każdej jednostki wskazującą sposób obsługi.For example, let's assume that when the client sends back a graph of entities it sets some flag on each entity indicating how it should be handled. Następnie można TrackGraph do przetworzenia tej flagi:TrackGraph can then be used to process this flag:

public static void SaveAnnotatedGraph(DbContext context, object rootEntity)
{
    context.ChangeTracker.TrackGraph(
        rootEntity,
        n =>
        {
            var entity = (EntityBase)n.Entry.Entity;
            n.Entry.State = entity.IsNew
                ? EntityState.Added
                : entity.IsChanged
                    ? EntityState.Modified
                    : entity.IsDeleted
                        ? EntityState.Deleted
                        : EntityState.Unchanged;
        });

    context.SaveChanges();
}

Flagi są wyświetlane tylko w ramach jednostki dla uproszczenia przykładu.The flags are only shown as part of the entity for simplicity of the example. Zazwyczaj flagi powinien być częścią DTO lub inny stan zawarte w żądaniu.Typically the flags would be part of a DTO or some other state included in the request.