Кэш Apollo: нормализация и обновления

InMemoryCache сохраняет каждый объект по ключу кэша, составленному из __typename и id: User:1, Post:42. Когда запрос возвращает User с id "1", объект сохраняется один раз по этому ключу независимо от того, сколько разных запросов его содержит.

Каждый последующий запрос, получающий тот же User:1, читает данные из единственной записи кэша, поэтому все компоненты видят одинаковые данные.

Когда мутация возвращает обновлённый объект User:1, Apollo записывает его в запись кэша User:1. Каждый активный запрос, содержавший User:1, автоматически отражает обновлённые поля в интерфейсе без дополнительного кода.

Такое автоматическое распространение изменений — главное преимущество нормализованного кэша перед кэшем документов, организованным по ключам запросов.

Прочитайте текущий результат запроса из кэша: cache.readQuery({ query: GET_USERS }) возвращает объект данных так, как если бы его вернул useQuery. Возвращается null, если запроса нет в кэше.

Используйте readQuery внутри функций обновления мутации, чтобы прочитать текущий список перед его изменением.

cache.writeQuery({ query: GET_USERS, data: { users: updatedUsers } }) напрямую записывает данные в кэш, вызывая повторный рендеринг всех компонентов, которые читают GET_USERS. Сетевой запрос не выполняется.

Объединяйте readQuery и writeQuery для реализации неизменяемых обновлений кэша: прочитайте данные, создайте новый массив и запишите его обратно.

cache.modify({ id: cache.identify(user), fields: { name: () => 'New Name' } }) напрямую изменяет поля конкретной сущности в кэше. Сначала читать запрос не нужно, если вы знаете идентификатор сущности в кэше.

Объект полей сопоставляет имена полей с функциями-модификаторами, которые получают текущее значение и возвращают новое.

Передайте функции обновления в useMutation: useMutation(ADD_POST, { update(cache, { data: { addPost } }) { cache.modify({ id: cache.identify(user), fields: { posts: existingPosts => [...existingPosts, addPost] } }); } }).

Это добавляет новую публикацию в массив публикаций пользователя в кэше и обновляет все компоненты, отображающие список публикаций пользователя.

cache.evict({ id: 'User:1' }) удаляет запись User:1 из кэша. Любой активный запрос, содержавший User:1, повторно отрендерится без этой сущности в результате.

После удаления записей вызовите cache.gc(), чтобы удалить объекты, которые теперь недостижимы из корневых запросов. Это предотвращает утечки памяти в приложениях, работающих длительное время.

cache.gc() обходит граф кэша, начиная со всех активных запросов, и удаляет сущности, которые больше недостижимы. Этот метод безопасно вызывать периодически или после пакетных мутаций, удаляющих множество сущностей.

Сущности, на которые ссылаются активные хуки useQuery, никогда не удаляются сборщиком мусора; удаляются только осиротевшие сущности, больше не входящие ни в один результат запроса.

Если вы запрашиваете отдельную сущность (GET_USER по идентификатору), которая уже сохранена в кэше как часть запроса списка, Apollo может прочитать её из кэша без дополнительного сетевого обращения с помощью политик полей: keyArgs и функций чтения в политике типа.

Функция чтения возвращает ссылку на кэш: return toReference({ __typename: 'User', id: args.id }), указывая Apollo прочитать данные из существующей записи кэша User:id.

Если ваши сущности используют в качестве уникального ключа поле, отличное от id (например, slug или uuid), настройте его в политике типа: new InMemoryCache({ typePolicies: { Post: { keyFields: ['slug'] } } }).

После этого Apollo использует Post:my-post-slug как ключ кэша вместо обязательного поля id, сохраняя нормализацию для нестандартных схем.

refetchQueries: [{ query: GET_USERS }] в параметрах useMutation запускает повторный сетевой запрос после завершения мутации. Это проще, но всегда приводит к сетевому запросу.

Функция обновления изменяет кэш локально и избегает дополнительного сетевого обращения. Используйте refetchQueries, когда логику обновления кэша слишком сложно написать или когда вычисляемые сервером поля делают локальные обновления кэша ненадёжными.

Какой формат ключа кэша по умолчанию использует InMemoryCache для хранения сущностей?

InMemoryCache нормализует сущности по __typename+id, обеспечивая автоматические обновления между запросами. Читайте и записывайте данные кэша с помощью cache.readQuery, cache.writeQuery и cache.modify. Удаляйте сущности с помощью cache.evict, а затем cache.gc. Настраивайте пользовательские поля ключа через typePolicies для первичных ключей, отличных от id.

Используйте функции обновления мутаций для эффективной работы с локальным кэшем; применяйте refetchQueries, когда вычисляемые сервером поля делают локальные обновления ненадёжными.