Apollo-cache: Normalisering og opdateringer

InMemoryCache gemmer hvert objekt under en cache-nøgle, der består af __typename og id: User:1, Post:42. Når en forespørgsel returnerer en User med id "1", gemmes den kun én gang under denne nøgle, uanset hvor mange forskellige forespørgsler der indeholder den.

Alle efterfølgende forespørgsler, der henter den samme User:1, læser fra den ene cachepost, så alle komponenter ser de samme data.

Når en mutation returnerer et opdateret User:1-objekt, skriver Apollo det til cacheposten User:1. Alle aktive forespørgsler, der indeholdt User:1, afspejler automatisk de opdaterede felter i brugerfladen uden yderligere kode.

Denne automatiske udbredelse er den primære fordel ved en normaliseret cache sammenlignet med en dokumentcache med forespørgselsnøgler.

Læs det aktuelle cachelagrede resultat af en forespørgsel: cache.readQuery({ query: GET_USERS }) returnerer dataobjektet, som om useQuery havde returneret det. Returnerer null, hvis forespørgslen ikke findes i cachen.

Brug readQuery i opdateringsfunktioner til mutationer for at læse den aktuelle liste, før du ændrer den.

cache.writeQuery({ query: GET_USERS, data: { users: updatedUsers } }) skriver direkte til cachen og udløser genrendering i alle komponenter, der læser GET_USERS. Der foretages ingen netværksforespørgsel.

Kombinér readQuery og writeQuery for at implementere uforanderlige cacheopdateringer: læs, opret et nyt array, skriv det tilbage.

cache.modify({ id: cache.identify(user), fields: { name: () => 'New Name' } }) ændrer direkte felterne i en bestemt cachelagret entitet. Der er ikke behov for først at læse en forespørgsel, når du kender entitetens cache-id.

Objektet fields knytter feltnavne til modifikatorfunktioner, som modtager den aktuelle værdi og returnerer den nye værdi.

Overfør en update-funktion til useMutation: useMutation(ADD_POST, { update(cache, { data: { addPost } }) { cache.modify({ id: cache.identify(user), fields: { posts: existingPosts => [...existingPosts, addPost] } }); } }).

Dette føjer det nye opslag til brugerens cachelagrede array af opslag og opdaterer alle komponenter, der viser brugerens liste over opslag.

cache.evict({ id: 'User:1' }) fjerner posten User:1 fra cachen. Enhver aktiv forespørgsel, der indeholdt User:1, genrenderes med entiteten fjernet fra resultatet.

Når du har fjernet poster, skal du kalde cache.gc() for at fjerne objekter, der nu er utilgængelige fra rodforespørgslerne. Det forhindrer hukommelseslækager i programmer, der kører i lang tid.

cache.gc() gennemløber cachegrafen med udgangspunkt i alle aktive forespørgsler og fjerner entiteter, som ikke længere kan nås. Det er sikkert at kalde den med jævne mellemrum eller efter batchændringer, der sletter mange entiteter.

Entiteter, der refereres til af aktive useQuery-hooks, bliver aldrig skraldeindsamlet – kun forældreløse entiteter, som ikke længere indgår i noget forespørgselsresultat.

Hvis du forespørger efter en enkelt entitet (GET_USER efter id), der allerede er cachelagret som en del af en listeforespørgsel, kan Apollo læse den fra cachen uden en netværksrundtur ved hjælp af feltpolitikker: keyArgs og read-funktioner i typepolitikken.

Read-funktionen returnerer en cachereference: return toReference({ __typename: 'User', id: args.id }), der fortæller Apollo at læse fra den eksisterende cachepost User:id.

Hvis dine entiteter bruger et andet felt end id som deres entydige nøgle (f.eks. slug eller uuid), skal du konfigurere det i typepolitikken: new InMemoryCache({ typePolicies: { Post: { keyFields: ['slug'] } } }).

Apollo bruger derefter Post:my-post-slug som cache-nøgle i stedet for at kræve et id-felt og bevarer dermed normaliseringen for skemaer med ikke-standardiserede nøgler.

refetchQueries: [{ query: GET_USERS }] i indstillingerne for useMutation udløser en ny netværksforespørgsel, når mutationen er fuldført. Det er enklere, men sender altid en netværksforespørgsel.

Opdateringsfunktionen ændrer cachen lokalt og undgår netværksrundturen. Brug refetchQueries, når cacheopdateringslogikken er for kompleks at skrive, eller når serverberegnede felter gør lokale cacheopdateringer upålidelige.

InMemoryCache normaliserer entiteter efter __typename+id, hvilket muliggør automatiske opdateringer på tværs af forespørgsler. Læs fra og skriv til cachen med cache.readQuery, cache.writeQuery og cache.modify. Fjern entiteter med cache.evict efterfulgt af cache.gc. Konfigurer brugerdefinerede nøglefelter via typePolicies for primærnøgler, der ikke er id.

Brug opdateringsfunktioner til mutationer for effektiv lokal cachehåndtering; brug refetchQueries, når serverberegnede felter gør lokale opdateringer upålidelige.