Apollo-hurtigbuffer: normalisering og oppdateringer

InMemoryCache lagrer hvert objekt med en cache-nøkkel som består av __typename og id: User:1, Post:42. Når en spørring returnerer en User med id "1", lagres den én gang under denne nøkkelen, uavhengig av hvor mange ulike spørringer som inkluderer den.

Alle påfølgende spørringer som henter den samme User:1, leser fra den ene cache-oppføringen, slik at alle komponenter ser de samme dataene.

Når en mutasjon returnerer et oppdatert User:1-objekt, skriver Apollo det til cache-oppføringen for User:1. Alle aktive spørringer som inkluderer User:1, gjenspeiler automatisk de oppdaterte feltene i brukergrensesnittet uten ekstra kode.

Denne automatiske videreformidlingen er den viktigste fordelen med en normalisert cache sammenlignet med en dokumentcache (basert på spørringsnøkler).

Les det gjeldende bufrede resultatet av en spørring: cache.readQuery({ query: GET_USERS }) returnerer dataobjektet slik det ville blitt returnert av useQuery. Returnerer null hvis spørringen ikke finnes i cachen.

Bruk readQuery i update-funksjoner for mutasjoner til å lese den gjeldende listen før du endrer den.

cache.writeQuery({ query: GET_USERS, data: { users: updatedUsers } }) skriver direkte til cachen og utløser ny gjengivelse i alle komponenter som leser GET_USERS. Ingen nettverksforespørsel sendes.

Kombiner readQuery og writeQuery for å implementere uforanderlige cache-oppdateringer: les, opprett en ny matrise, og skriv den tilbake.

cache.modify({ id: cache.identify(user), fields: { name: () => 'New Name' } }) endrer feltene til en bestemt bufret entitet direkte. Du trenger ikke først å lese en spørring når du kjenner entitetens cache-ID.

Objektet fields kobler feltnavn til modifikatorfunksjoner som mottar den gjeldende verdien og returnerer den nye verdien.

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

Dette legger det nye innlegget til i brukerens bufrede liste over innlegg og oppdaterer alle komponenter som viser brukerens innleggs liste.

cache.evict({ id: 'User:1' }) fjerner User:1-oppføringen fra cachen. Alle aktive spørringer som inkluderte User:1, gjengis på nytt med denne entiteten fjernet fra resultatet.

Etter at du har fjernet oppføringer, kaller du cache.gc() for å fjerne objekter som ikke lenger kan nås fra rotspørringer. Dette hindrer minnelekkasjer i applikasjoner som kjører lenge.

cache.gc() går gjennom cache-grafen med utgangspunkt i alle aktive spørringer og fjerner entiteter som ikke lenger kan nås. Det er trygt å kalle funksjonen med jevne mellomrom eller etter batchmutasjoner som sletter mange entiteter.

Entiteter som refereres til av aktive useQuery-hooks, blir aldri samlet inn av søppeltømmingen. Det er bare foreldreløse entiteter som ikke lenger inngår i noe spørringsresultat, som fjernes.

Hvis du spør etter én entitet (GET_USER med id) som allerede er bufret som en del av en listespørring, kan Apollo lese den fra cachen uten en ny nettverksforespørsel ved hjelp av feltpolicyer: keyArgs og read-funksjoner i typepolicyen.

read-funksjonen returnerer en cacherreferanse: return toReference({ __typename: 'User', id: args.id }), som forteller Apollo å lese fra den eksisterende User:id-cacheoppføringen.

Hvis entitetene dine bruker et annet felt enn id som unik nøkkel, for eksempel slug eller uuid, konfigurerer du det i typepolicyen: new InMemoryCache({ typePolicies: { Post: { keyFields: ['slug'] } } }).

Apollo bruker da Post:my-post-slug som cache-nøkkel i stedet for å kreve et id-felt, slik at normaliseringen også bevares for skjemaer med andre nøkkelfelt.

refetchQueries: [{ query: GET_USERS }] i useMutation-alternativene utløser en ny nettverksforespørsel etter at mutasjonen er fullført. Det er enklere, men sender alltid en nettverksforespørsel.

update-funksjonen endrer cachen lokalt og unngår nettverksforespørselen. Bruk refetchQueries når cache-oppdateringslogikken er for kompleks å skrive, eller når serverberegnede felt gjør lokale cache-oppdateringer upålitelige.

InMemoryCache normaliserer entiteter etter __typename+id, noe som muliggjør automatiske oppdateringer på tvers av spørringer. Les og skriv til cachen med cache.readQuery, cache.writeQuery og cache.modify. Fjern entiteter med cache.evict etterfulgt av cache.gc. Konfigurer egendefinerte nøkkelfelt via typePolicies for primærnøkler som ikke er id.

Bruk update-funksjoner for mutasjoner for effektiv lokal cache-håndtering. Bruk refetchQueries når serverberegnede felt gjør lokale oppdateringer upålitelige.