re:re:actable
Урок 064 минуты чтения

Что такое RTK Query

На этой странице
Кратко

RTK Query — встроенный в Redux Toolkit инструмент для загрузки и кеширования серверных данных. Вы описываете API через createApi — endpoints типа query (чтение) и mutation (изменение), — и RTK Query генерирует хуки (useGetPostsQuery, useAddPostMutation), хранит кеш в Redux store, дедуплицирует запросы, отслеживает загрузку и ошибки, а после мутаций автоматически перезапрашивает данные по тегам (providesTags / invalidatesTags).

Вопрос

Что такое RTK Query и какие проблемы он решает? Как описать API, использовать хуки и инвалидировать кеш через теги? Чем RTK Query отличается от TanStack Query?

Описание API

// services/postsApi.ts
import { createApi, fetchBaseQuery } from "@reduxjs/toolkit/query/react";
 
type Post = { id: number; title: string; body: string };
 
export const postsApi = createApi({
  reducerPath: "postsApi",
  baseQuery: fetchBaseQuery({
    baseUrl: "/api",
    prepareHeaders: (headers, { getState }) => {
      const token = (getState() as RootState).auth.token;
      if (token) headers.set("Authorization", `Bearer ${token}`);
      return headers;
    },
  }),
  tagTypes: ["Post"],
  endpoints: (build) => ({
    getPosts: build.query<Post[], void>({
      query: () => "posts",
      providesTags: (result) =>
        result
          ? [...result.map(({ id }) => ({ type: "Post" as const, id })), { type: "Post", id: "LIST" }]
          : [{ type: "Post", id: "LIST" }],
    }),
    getPost: build.query<Post, number>({
      query: (id) => `posts/${id}`,
      providesTags: (_r, _e, id) => [{ type: "Post", id }],
    }),
    addPost: build.mutation<Post, Omit<Post, "id">>({
      query: (body) => ({ url: "posts", method: "POST", body }),
      invalidatesTags: [{ type: "Post", id: "LIST" }],
    }),
    updatePost: build.mutation<Post, Post>({
      query: ({ id, ...body }) => ({ url: `posts/${id}`, method: "PATCH", body }),
      invalidatesTags: (_r, _e, { id }) => [{ type: "Post", id }],
    }),
  }),
});
 
export const { useGetPostsQuery, useGetPostQuery, useAddPostMutation, useUpdatePostMutation } = postsApi;

Подключение к store

export const store = configureStore({
  reducer: {
    [postsApi.reducerPath]: postsApi.reducer,
    auth: authReducer,
  },
  middleware: (getDefaultMiddleware) => getDefaultMiddleware().concat(postsApi.middleware),
});

Middleware управляет жизненным циклом кеша, подписками и повторными запросами.

Использование в компонентах

function PostsList() {
  const { data: posts, isLoading, isFetching, error, refetch } = useGetPostsQuery();
  const [addPost, { isLoading: isAdding }] = useAddPostMutation();
 
  if (isLoading) return <Spinner />;
  if (error) return <button onClick={refetch}>Повторить</button>;
 
  return (
    <>
      <button disabled={isAdding} onClick={() => addPost({ title: "Новый", body: "" }).unwrap()}>
        Добавить
      </button>
      <ul style={{ opacity: isFetching ? 0.6 : 1 }}>
        {posts?.map((p) => <li key={p.id}>{p.title}</li>)}
      </ul>
    </>
  );
}
 
function PostDetails({ id }: { id?: number }) {
  const { data } = useGetPostQuery(id ?? skipToken);   // не запрашивать, пока нет id
  return <h1>{data?.title}</h1>;
}
ФлагЗначение
isLoadingпервая загрузка, данных еще нет
isFetchingидет любой запрос, в том числе фоновое обновление
isSuccess, isErrorитог последнего запроса
currentDataданные именно для текущих аргументов

Как работают теги

getPosts      providesTags: Post:LIST, Post:1, Post:2
addPost       invalidatesTags: Post:LIST   → getPosts перезапросится
updatePost(1) invalidatesTags: Post:1      → getPosts и getPost(1) перезапросятся

Опции кеша

useGetPostsQuery(undefined, {
  pollingInterval: 30_000,          // опрос каждые 30 с
  refetchOnMountOrArgChange: 60,    // перезапросить, если данные старше 60 с
  refetchOnFocus: true,             // требует setupListeners(store.dispatch)
});

keepUnusedDataFor (по умолчанию 60 секунд) — сколько хранить данные без подписчиков.

Оптимистичное обновление

updatePost: build.mutation<Post, Post>({
  query: ({ id, ...body }) => ({ url: `posts/${id}`, method: "PATCH", body }),
  async onQueryStarted(post, { dispatch, queryFulfilled }) {
    const patch = dispatch(
      postsApi.util.updateQueryData("getPost", post.id, (draft) => {
        Object.assign(draft, post);
      }),
    );
    try {
      await queryFulfilled;
    } catch {
      patch.undo();                 // откат при ошибке
    }
  },
}),

RTK Query и TanStack Query

RTK QueryTanStack Query
Хранилище кешаRedux storeсвой QueryClient
Описаниецентрализованно в createApiхуки по месту, ключи запросов
Инвалидациятегиключи (invalidateQueries)
DevToolsRedux DevToolsReact Query DevTools
Генерация из OpenAPI@rtk-query/codegen-openapiсторонние генераторы
Когда выбиратьпроект уже на Reduxнет Redux или нужна гибкость

Что важно помнить

  • Серверные данные лучше хранить в RTK Query, а не в slices через createAsyncThunk: кеш, дедупликация и повторы уже реализованы.
  • Один createApi на базовый URL; endpoints можно добавлять по фичам через injectEndpoints.
  • Хук мутации возвращает кортеж [trigger, result]; .unwrap() на результате trigger дает Promise с ошибкой при неудаче.
  • Аргументы запроса — ключ кеша: getPost(1) и getPost(2) кешируются отдельно.
  • Без setupListeners не работают refetchOnFocus и refetchOnReconnect.

Мини-шпаргалка

createApi({ reducerPath, baseQuery: fetchBaseQuery, tagTypes, endpoints: build => ({ q: build.query, m: build.mutation }) }) → хуки useXQuery, useXMutation. Подключить api.reducer и api.middleware. Теги: providesTags / invalidatesTags. skipToken, isLoading vs isFetching, updateQueryData + undo для оптимистичных обновлений.

Документация

RTK Query: Overview, RTK Query: Automated Re-fetching, RTK Query: Optimistic Updates, RTK Query: Comparison with Other Tools.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам