Миграция на современный Redux

Неофициальный Бета-перевод

Эта страница переведена PageTurner AI (бета). Не одобрена официально проектом. Нашли ошибку? Сообщить о проблеме →

Что вы узнаете

• Как модернизировать устаревшую "ручную" Redux-логику для использования Redux Toolkit
• Как обновить устаревшие React-Redux компоненты с connect для использования хуков
• Как модернизировать Redux-логику и React-Redux компоненты с TypeScript

Обзор

Redux существует с 2015 года, и наши рекомендуемые подходы к написанию Redux-кода значительно изменились за эти годы. Подобно тому, как React эволюционировал от createClass к React.Component и функциональным компонентам с хуками, Redux прошёл путь от ручной настройки хранилища + редьюсеров с ручным распространением объектов + connect из React-Redux до configureStore + createSlice из Redux Toolkit + хуков React-Redux.

Многие разработчики работают со старыми Redux-кодбазами, созданными до появления современных подходов. Миграция таких кодбаз на современные рекомендации Redux сделает их значительно меньше и проще в поддержке.

Хорошая новость: вы можете переносить код на современный Redux постепенно, по частям, где старый и новый код будут сосуществовать и работать вместе!

На этой странице описаны общие подходы и техники для модернизации существующей устаревшей Redux-кодбазы.

Информация

Подробнее о том, как "современный Redux" с Redux Toolkit + хуками React-Redux упрощает работу, см. в дополнительных материалах:

• Почему Redux Toolkit — это современный способ работы с Redux
• Redux Essentials: Структура приложения с Redux Toolkit
• Redux Fundamentals: Современный Redux с Redux Toolkit
• Доклад: Современный Redux с Redux Toolkit

Модернизация Redux-логики с Redux Toolkit

Общий подход к миграции Redux-логики:

• Замените ручную настройку хранилища на configureStore из Redux Toolkit

• Выберите существующий редьюсер и связанные с ним экшены. Замените их на createSlice из RTK. Повторяйте для каждого редьюсера по очереди.

• При необходимости замените существующую логику получения данных на RTK Query или createAsyncThunk

• Используйте другие API RTK по мере необходимости: createListenerMiddleware или createEntityAdapter

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

Информация

Этот подход показан на практике в Redux Fundamentals, Part 8: Современный Redux с Redux Toolkit.

Настройка хранилища с configureStore

Типичная настройка устаревшего Redux-хранилища включает несколько шагов:

• Комбинирование редьюсеров в корневой редьюсер

• Создание усилителя с мидлварами (обычно thunk), а в разработке — возможно, с дополнительными мидлварами вроде redux-logger

• Добавление усилителя для Redux DevTools и композиция усилителей

• Вызов createStore

Вот как это может выглядеть в существующем приложении:

src/app/store.js

import { createStore, applyMiddleware, combineReducers, compose } from 'redux'
import { thunk } from 'redux-thunk'

import postsReducer from '../reducers/postsReducer'
import usersReducer from '../reducers/usersReducer'

const rootReducer = combineReducers({
  posts: postsReducer,
  users: usersReducer
})

const middlewareEnhancer = applyMiddleware(thunk)

const composeWithDevTools =
  window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose

const composedEnhancers = composeWithDevTools(middlewareEnhancer)

const store = createStore(rootReducer, composedEnhancers)

Все эти шаги заменяются единственным вызовом API configureStore из Redux Toolkit.

RTK's configureStore оборачивает оригинальный метод createStore и автоматически выполняет большую часть настройки хранилища. Фактически, мы можем сократить процесс до одного шага:

Basic Store Setup: src/app/store.js

import { configureStore } from '@reduxjs/toolkit'

import postsReducer from '../reducers/postsReducer'
import usersReducer from '../reducers/usersReducer'

// Automatically adds the thunk middleware and the Redux DevTools extension
const store = configureStore({
  // Automatically calls `combineReducers`
  reducer: {
    posts: postsReducer,
    users: usersReducer
  }
})

Один вызов configureStore выполнил всю работу:

• Вызов combineReducers для объединения postsReducer и usersReducer в корневой редьюсер, который будет обрабатывать состояние вида {posts, users}

• Вызов createStore для создания Redux-хранилища с использованием этого корневого редьюсера

• Автоматическое добавление thunk-мидлвары и вызов applyMiddleware

• Добавил дополнительную мидлвару для выявления распространённых ошибок (например, случайной мутации состояния)

• Настроил подключение Redux DevTools Extension

Если ваша настройка хранилища требует дополнительных шагов, таких как добавление дополнительных middleware, передача extra-аргумента в thunk-мидлвару или создание персистентного редьюсера, вы также можете это сделать. Вот расширенный пример, демонстрирующий кастомизацию встроенных middleware и подключение Redux-Persist, который показывает возможности работы с configureStore:

Detailed Example: Custom Store Setup with Persistence and Middleware

This example shows several possible common tasks when setting up a Redux store:

• Combining the reducers separately (sometimes needed due to other architectural constraints)
• Adding additional middleware, both conditionally and unconditionally
• Passing an "extra argument" into the thunk middleware, such as an API service layer
• Using the Redux-Persist library, which requires special handling for its non-serializable action types
• Turning the devtools off in prod, and setting additional devtools options in development

None of these are required, but they do show up frequently in real-world codebases.

Custom Store Setup: src/app/store.js

import { configureStore, combineReducers } from '@reduxjs/toolkit'
import {
  persistStore,
  persistReducer,
  FLUSH,
  REHYDRATE,
  PAUSE,
  PERSIST,
  PURGE,
  REGISTER
} from 'redux-persist'
import storage from 'redux-persist/lib/storage'
import { PersistGate } from 'redux-persist/integration/react'
import logger from 'redux-logger'

import postsReducer from '../features/posts/postsSlice'
import usersReducer from '../features/users/usersSlice'
import { api } from '../features/api/apiSlice'
import { serviceLayer } from '../features/api/serviceLayer'

import stateSanitizerForDevtools from './devtools'
import customMiddleware from './someCustomMiddleware'

// Can call `combineReducers` yourself if needed
const rootReducer = combineReducers({
  posts: postsReducer,
  users: usersReducer,
  [api.reducerPath]: api.reducer
})

const persistConfig = {
  key: 'root',
  version: 1,
  storage
}

const persistedReducer = persistReducer(persistConfig, rootReducer)

const store = configureStore({
  // Pass previously created persisted reducer
  reducer: persistedReducer,
  middleware: getDefaultMiddleware => {
    const middleware = getDefaultMiddleware({
      // Pass in a custom `extra` argument to the thunk middleware
      thunk: {
        extraArgument: { serviceLayer }
      },
      // Customize the built-in serializability dev check
      serializableCheck: {
        ignoredActions: [FLUSH, REHYDRATE, PAUSE, PERSIST, PURGE, REGISTER]
      }
    }).concat(customMiddleware, api.middleware)

    // Conditionally add another middleware in dev
    if (process.env.NODE_ENV !== 'production') {
      middleware.push(logger)
    }

    return middleware
  },
  // Turn off devtools in prod, or pass options in dev
  devTools:
    process.env.NODE_ENV === 'production'
      ? false
      : {
          stateSanitizer: stateSanitizerForDevtools
        }
})

Редьюсеры и экшены с createSlice

В типичном legacy-коде Redux логика редьюсеров, создатели экшенов и типы экшенов разбросаны по отдельным файлам, часто в разных папках по типу кода. Логика редьюсеров написана с использованием switch-операторов и ручных иммутабельных обновлений через spread-операторы и map для массивов:

src/constants/todos.js

export const ADD_TODO = 'ADD_TODO'
export const TOGGLE_TODO = 'TOGGLE_TODO'

src/actions/todos.js

import { ADD_TODO, TOGGLE_TODO } from '../constants/todos'

export const addTodo = (id, text) => ({
  type: ADD_TODO,
  text,
  id
})

export const toggleTodo = id => ({
  type: TOGGLE_TODO,
  id
})

src/reducers/todos.js

import { ADD_TODO, TOGGLE_TODO } from '../constants/todos'

const initialState = []

export default function todosReducer(state = initialState, action) {
  switch (action.type) {
    case ADD_TODO: {
      return state.concat({
        id: action.id,
        text: action.text,
        completed: false
      })
    }
    case TOGGLE_TODO: {
      return state.map(todo => {
        if (todo.id !== action.id) {
          return todo
        }

        return {
          ...todo,
          completed: !todo.completed
        }
      })
    }
    default:
      return state
  }
}

API createSlice из Redux Toolkit было создано, чтобы устранить весь "шаблонный код" при написании редьюсеров, экшенов и иммутабельных обновлений!

С Redux Toolkit в legacy-коде происходят следующие изменения:

• createSlice полностью устраняет необходимость ручного написания создателей экшенов и их типов

• Все уникальные поля вроде action.text и action.id заменяются на action.payload, который может быть как отдельным значением, так и объектом с этими полями

• Ручные иммутабельные обновления заменяются "мутирующей" логикой в редьюсерах благодаря Immer

• Отпадает необходимость в отдельных файлах для каждого типа кода

• Мы рекомендуем хранить всю логику для одного редьюсера в едином файле "среза" (slice)

• Вместо разделения по папкам по "типу кода" мы советуем организовывать файлы по "фичам", размещая связанный код в одной папке

• Идеально называть редьюсеры и экшены в прошедшем времени, описывая "произошедшее событие", а не императивную команду: например, todoAdded вместо ADD_TODO

Отдельные файлы для констант, экшенов и редьюсеров заменяются единым файлом "среза". Модернизированный файл среза будет выглядеть так:

src/features/todos/todosSlice.js

import { createSlice } from '@reduxjs/toolkit'

const initialState = []

const todosSlice = createSlice({
  name: 'todos',
  initialState,
  reducers: {
    // Give case reducers meaningful past-tense "event"-style names
    todoAdded(state, action) {
      const { id, text } = action.payload
      // "Mutating" update syntax thanks to Immer, and no `return` needed
      state.todos.push({
        id,
        text,
        completed: false
      })
    },
    todoToggled(state, action) {
      // Look for the specific nested object to update.
      // In this case, `action.payload` is the default field in the action,
      // and can hold the `id` value - no need for `action.id` separately
      const matchingTodo = state.todos.find(todo => todo.id === action.payload)

      if (matchingTodo) {
        // Can directly "mutate" the nested object
        matchingTodo.completed = !matchingTodo.completed
      }
    }
  }
})

// `createSlice` automatically generated action creators with these names.
// export them as named exports from this "slice" file
export const { todoAdded, todoToggled } = todosSlice.actions

// Export the slice reducer as the default export
export default todosSlice.reducer

При вызове dispatch(todoAdded('Buy milk')) любое переданное значение в создатель экшена todoAdded автоматически становится полем action.payload. Для передачи нескольких значений используйте объект: dispatch(todoAdded({id, text})). Альтернативно можно использовать нотацию "prepare" внутри редьюсера createSlice для приёма нескольких аргументов и формирования поля payload. Нотация prepare также полезна, когда создатели экшенов выполняли дополнительную работу, например генерировали уникальные ID.

Хотя Redux Toolkit не навязывает структуру папок/файлов или именование экшенов, это лучшие практики, которые мы рекомендуем, так как они делают код более поддерживаемым и понятным.

Запросы данных с RTK Query

Типичный legacy-подход к запросам данных в React+Redux приложении требует множества компонентов и типов кода:

• Создатели экшенов и их типы для представления состояний "запрос начат", "запрос успешен" и "запрос провален"

• Thunk'и для диспатча этих экшенов и выполнения асинхронного запроса

• Редьюсеры для отслеживания статуса загрузки и хранения кэшированных данных

• Селекторы для чтения этих значений из хранилища

• Диспатч санка в компоненте после монтирования, через componentDidMount в классовых компонентах или useEffect в функциональных

Обычно это распределено по разным файлам:

src/constants/todos.js

export const FETCH_TODOS_STARTED = 'FETCH_TODOS_STARTED'
export const FETCH_TODOS_SUCCEEDED = 'FETCH_TODOS_SUCCEEDED'
export const FETCH_TODOS_FAILED = 'FETCH_TODOS_FAILED'

src/actions/todos.js

import axios from 'axios'
import {
  FETCH_TODOS_STARTED,
  FETCH_TODOS_SUCCEEDED,
  FETCH_TODOS_FAILED
} from '../constants/todos'

export const fetchTodosStarted = () => ({
  type: FETCH_TODOS_STARTED
})

export const fetchTodosSucceeded = todos => ({
  type: FETCH_TODOS_SUCCEEDED,
  todos
})

export const fetchTodosFailed = error => ({
  type: FETCH_TODOS_FAILED,
  error
})

export const fetchTodos = () => {
  return async dispatch => {
    dispatch(fetchTodosStarted())

    try {
      // Axios is common, but also `fetch`, or your own "API service" layer
      const res = await axios.get('/todos')
      dispatch(fetchTodosSucceeded(res.data))
    } catch (err) {
      dispatch(fetchTodosFailed(err))
    }
  }
}

src/reducers/todos.js

import {
  FETCH_TODOS_STARTED,
  FETCH_TODOS_SUCCEEDED,
  FETCH_TODOS_FAILED
} from '../constants/todos'

const initialState = {
  status: 'uninitialized',
  todos: [],
  error: null
}

export default function todosReducer(state = initialState, action) {
  switch (action.type) {
    case FETCH_TODOS_STARTED: {
      return {
        ...state,
        status: 'loading'
      }
    }
    case FETCH_TODOS_SUCCEEDED: {
      return {
        ...state,
        status: 'succeeded',
        todos: action.todos
      }
    }
    case FETCH_TODOS_FAILED: {
      return {
        ...state,
        status: 'failed',
        todos: [],
        error: action.error
      }
    }
    default:
      return state
  }
}

src/selectors/todos.js

export const selectTodosStatus = state => state.todos.status
export const selectTodos = state => state.todos.todos

src/components/TodosList.js

import { useEffect } from 'react'
import { useSelector, useDispatch } from 'react-redux'
import { fetchTodos } from '../actions/todos'
import { selectTodosStatus, selectTodos } from '../selectors/todos'

export function TodosList() {
  const dispatch = useDispatch()
  const status = useSelector(selectTodosStatus)
  const todos = useSelector(selectTodos)

  useEffect(() => {
    dispatch(fetchTodos())
  }, [dispatch])

  // omit rendering logic here
}

Многие используют библиотеку redux-saga для управления запросами данных, что добавляет дополнительные "сигнальные" типы действий для запуска саг и заменяет санки:

src/sagas/todos.js

import { put, takeEvery, call } from 'redux-saga/effects'
import {
  FETCH_TODOS_BEGIN,
  fetchTodosStarted,
  fetchTodosSucceeded,
  fetchTodosFailed
} from '../actions/todos'

// Saga to actually fetch data
export function* fetchTodos() {
  yield put(fetchTodosStarted())

  try {
    const res = yield call(axios.get, '/todos')
    yield put(fetchTodosSucceeded(res.data))
  } catch (err) {
    yield put(fetchTodosFailed(err))
  }
}

// "Watcher" saga that waits for a "signal" action, which is
// dispatched only to kick off logic, not to update state
export function* fetchTodosSaga() {
  yield takeEvery(FETCH_TODOS_BEGIN, fetchTodos)
}

Весь этот код можно заменить слоем RTK Query для запросов данных и кэширования!

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

Для миграции настройте единый "API слой" RTK Query и добавьте сгенерированные редюсер + мидлвару в стор:

src/features/api/apiSlice.js

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'

export const api = createApi({
  baseQuery: fetchBaseQuery({
    // Fill in your own server starting URL here
    baseUrl: '/'
  }),
  endpoints: build => ({})
})

src/app/store.js

import { configureStore } from '@reduxjs/toolkit'

// Import the API object
import { api } from '../features/api/apiSlice'
// Import any other slice reducers as usual here
import usersReducer from '../features/users/usersSlice'

export const store = configureStore({
  reducer: {
    // Add the generated RTK Query "API slice" caching reducer
    [api.reducerPath]: api.reducer,
    // Add any other reducers
    users: usersReducer
  },
  // Add the RTK Query API middleware
  middleware: getDefaultMiddleware =>
    getDefaultMiddleware().concat(api.middleware)
})

Добавьте "эндпоинты" для конкретных данных и экспортируйте автоматически сгенерированные хуки React:

src/features/api/apiSlice.js

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'

export const api = createApi({
  baseQuery: fetchBaseQuery({
    // Fill in your own server starting URL here
    baseUrl: '/'
  }),
  endpoints: build => ({
    // A query endpoint with no arguments
    getTodos: build.query({
      query: () => '/todos'
    }),
    // A query endpoint with an argument
    userById: build.query({
      query: userId => `/users/${userId}`
    }),
    // A mutation endpoint
    updateTodo: build.mutation({
      query: updatedTodo => ({
        url: `/todos/${updatedTodo.id}`,
        method: 'POST',
        body: updatedTodo
      })
    })
  })
})

export const { useGetTodosQuery, useUserByIdQuery, useUpdateTodoMutation } = api

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

src/features/todos/TodoList.js

import { useGetTodosQuery } from '../api/apiSlice'

export function TodoList() {
  const { data: todos, isFetching, isSuccess } = useGetTodosQuery()

  // omit rendering logic here
}

Запросы данных через createAsyncThunk

Мы конкретно рекомендуем использовать RTK Query для запросов данных. Однако некоторые пользователи сообщали, что ещё не готовы к этому шагу. В таком случае вы можете хотя бы сократить шаблонный код рукописных санков и редьюсеров с помощью createAsyncThunk из RTK. Он автоматически создаёт экшен-креаторы и типы действий, вызывает вашу асинхронную функцию для выполнения запроса и диспатчит экшены по жизненному циклу промиса. Тот же пример с createAsyncThunk может выглядеть так:

src/features/todos/todosSlice

import { createAsyncThunk, createSlice } from '@reduxjs/toolkit'
import axios from 'axios'

const initialState = {
  status: 'uninitialized',
  todos: [],
  error: null
}

const fetchTodos = createAsyncThunk('todos/fetchTodos', async () => {
  // Just make the async request here, and return the response.
  // This will automatically dispatch a `pending` action first,
  // and then `fulfilled` or `rejected` actions based on the promise.
  // as needed based on the
  const res = await axios.get('/todos')
  return res.data
})

export const todosSlice = createSlice({
  name: 'todos',
  initialState,
  reducers: {
    // any additional "normal" case reducers here.
    // these will generate new action creators
  },
  extraReducers: builder => {
    // Use `extraReducers` to handle actions that were generated
    // _outside_ of the slice, such as thunks or in other slices
    builder
      .addCase(fetchTodos.pending, (state, action) => {
        state.status = 'loading'
      })
      // Pass the generated action creators to `.addCase()`
      .addCase(fetchTodos.fulfilled, (state, action) => {
        // Same "mutating" update syntax thanks to Immer
        state.status = 'succeeded'
        state.todos = action.payload
      })
      .addCase(fetchTodos.rejected, (state, action) => {
        state.status = 'failed'
        state.todos = []
        state.error = action.error
      })
  }
})

export default todosSlice.reducer

Вам всё равно потребуется писать селекторы и диспатчить санк fetchTodos через хук useEffect.

Реактивная логика с помощью createListenerMiddleware

Многие Redux-приложения используют "реактивную" логику, отслеживающую определённые действия или изменения состояния для запуска дополнительной логики. Часто это реализуется через redux-saga или redux-observable.

Эти библиотеки решают разнообразные задачи. Базовый пример: сага/эпик, слушающий действие, ждущий секунду и диспатчащий новое действие:

src/sagas/ping.js

import { delay, put, takeEvery } from 'redux-saga/effects'

export function* ping() {
  yield delay(1000)
  yield put({ type: 'PONG' })
}

// "Watcher" saga that waits for a "signal" action, which is
// dispatched only to kick off logic, not to update state
export function* pingSaga() {
  yield takeEvery('PING', ping)
}

src/epics/ping.js

import { filter, mapTo } from 'rxjs/operators'
import { ofType } from 'redux-observable'

const pingEpic = action$ =>
  action$.pipe(ofType('PING'), delay(1000), mapTo({ type: 'PONG' }))

src/app/store.js

import { createStore, applyMiddleware } from 'redux'
import createSagaMiddleware from 'redux-saga'
import { combineEpics, createEpicMiddleware  } from 'redux-observable';

// skip reducers

import { pingEpic } from '../sagas/ping'
import { pingSaga } from '../epics/ping

function* rootSaga() {
  yield pingSaga()
}

const rootEpic = combineEpics(
  pingEpic
);

const sagaMiddleware = createSagaMiddleware()
const epicMiddleware = createEpicMiddleware()

const middlewareEnhancer = applyMiddleware(sagaMiddleware, epicMiddleware)

const store = createStore(rootReducer, middlewareEnhancer)

sagaMiddleware.run(rootSaga)
epicMiddleware.run(rootEpic)

Мидлвара-слушатель RTK заменяет саги/эпики с более простым API, меньшим размером бандла и лучшей поддержкой TypeScript.

Примеры саги/эпика заменяются мидлварой-слушателем:

src/app/listenerMiddleware.js

import { createListenerMiddleware } from '@reduxjs/toolkit'

// Best to define this in a separate file, to avoid importing
// from the store file into the rest of the codebase
export const listenerMiddleware = createListenerMiddleware()

export const { startListening, stopListening } = listenerMiddleware

src/features/ping/pingSlice.js

import { createSlice } from '@reduxjs/toolkit'
import { startListening } from '../../app/listenerMiddleware'

const pingSlice = createSlice({
  name: 'ping',
  initialState,
  reducers: {
    pong(state, action) {
      // state update here
    }
  }
})

export const { pong } = pingSlice.actions
export default pingSlice.reducer

// The `startListening()` call could go in different files,
// depending on your preferred app setup. Here, we just add
// it directly in a slice file.
startListening({
  // Match this exact action type based on the action creator
  actionCreator: pong,
  // Run this effect callback whenever that action is dispatched
  effect: async (action, listenerApi) => {
    // Listener effect functions get a `listenerApi` object
    // with many useful methods built in, including `delay`:
    await listenerApi.delay(1000)
    listenerApi.dispatch(pong())
  }
})

src/app/store.js

import { configureStore } from '@reduxjs/toolkit'

import { listenerMiddleware } from './listenerMiddleware'

// omit reducers

export const store = configureStore({
  reducer: rootReducer,
  // Add the listener middleware _before_ the thunk or dev checks
  middleware: getDefaultMiddleware =>
    getDefaultMiddleware().prepend(listenerMiddleware.middleware)
})

Миграция TypeScript для Redux-логики

Устаревший TypeScript-код Redux часто использует многословные шаблоны: ручное определение типов для каждого действия и объединение типов действий ("action type unions") для ограничения допустимых dispatch.

Мы категорически не рекомендуем такой подход!

src/actions/todos.ts

import { ADD_TODO, TOGGLE_TODO } from '../constants/todos'

// ❌ Common pattern: manually defining types for each action object
interface AddTodoAction {
  type: typeof ADD_TODO
  text: string
  id: string
}

interface ToggleTodoAction {
  type: typeof TOGGLE_TODO
  id: string
}

// ❌ Common pattern: an "action type union" of all possible actions
export type TodoActions = AddTodoAction | ToggleTodoAction

export const addTodo = (id: string, text: string): AddTodoAction => ({
  type: ADD_TODO,
  text,
  id
})

export const toggleTodo = (id: string): ToggleTodoAction => ({
  type: TOGGLE_TODO,
  id
})

src/reducers/todos.ts

import { ADD_TODO, TOGGLE_TODO, TodoActions } from '../constants/todos'

interface Todo {
  id: string
  text: string
  completed: boolean
}

export type TodosState = Todo[]

const initialState: TodosState = []

export default function todosReducer(
  state = initialState,
  action: TodoActions
) {
  switch (action.type) {
    // omit reducer logic
    default:
      return state
  }
}

src/app/store.ts

import { createStore, Dispatch } from 'redux'

import { TodoActions } from '../actions/todos'
import { CounterActions } from '../actions/counter'
import { TodosState } from '../reducers/todos'
import { CounterState } from '../reducers/counter'

// omit reducer setup

export const store = createStore(rootReducer)

// ❌ Common pattern: an "action type union" of all possible actions
export type RootAction = TodoActions | CounterActions
// ❌ Common pattern: manually defining the root state type with each field
export interface RootState {
  todos: TodosState
  counter: CounterState
}

// ❌ Common pattern: limiting what can be dispatched at the types level
export type AppDispatch = Dispatch<RootAction>

Redux Toolkit радикально упрощает использование TypeScript через максимальное использование вывода типов!

Следуя руководству по TypeScript, настройте стор для вывода типов AppDispatch и RootState непосредственно из стора. Это автоматически включает модификации dispatch (например, поддержку санков) и обновляет RootState при изменении слайсов.

app/store.ts

import { configureStore } from '@reduxjs/toolkit'
// omit any other imports

const store = configureStore({
  reducer: {
    todos: todosReducer,
    counter: counterReducer
  }
})

// Infer the `RootState` and `AppDispatch` types from the store itself

// Inferred state type: {todos: TodosState, counter: CounterState}
export type RootState = ReturnType<typeof store.getState>

// Inferred dispatch type: Dispatch & ThunkDispatch<RootState, undefined, UnknownAction>
export type AppDispatch = typeof store.dispatch

Каждый файл слайса должен объявлять и экспортировать тип для собственного состояния. Затем используйте тип PayloadAction для указания типа аргумента action внутри createSlice.reducers. Сгенерированные создатели действий (action creators) будут автоматически иметь корректный тип для принимаемого аргумента и возвращаемого значения action.payload.

src/features/todos/todosSlice.ts

import { createSlice, PayloadAction } from '@reduxjs/toolkit'

interface Todo {
  id: string
  text: string
  completed: boolean
}

// Declare and export a type for the slice's state
export type TodosState = Todo[]

const initialState: TodosState = []

const todosSlice = createSlice({
  name: 'todos',
  // The `state` argument type will be inferred for all case reducers
  // from the type of `initialState`
  initialState,
  reducers: {
    // Use `PayloadAction<YourPayloadTypeHere>` for each `action` argument
    todoAdded(state, action: PayloadAction<{ id: string; text: string }>) {
      // omit logic
    },
    todoToggled(state, action: PayloadAction<string>) {
      // omit logic
    }
  }
})

Модернизация React-компонентов с React-Redux

Общий подход для модернизации использования React-Redux в компонентах:

• Преобразовать классовый компонент React в функциональный компонент

• Заменить обёртку connect на использование хуков useSelector и useDispatch внутри компонента

Это можно делать для каждого компонента индивидуально. Компоненты с connect и хуками могут сосуществовать одновременно.

Этот материал не охватывает процесс преобразования классовых компонентов в функциональные, но фокусируется на изменениях, специфичных для React-Redux.

Замена connect на хуки

Типичный устаревший компонент с использованием API connect из React-Redux может выглядеть так:

src/features/todos/TodoListItem.js

import { connect } from 'react-redux'
import { bindActionCreators } from 'redux'
import {
  todoToggled,
  todoDeleted,
  selectTodoById,
  selectActiveTodoId
} from './todosSlice'

// A `mapState` function, possibly using values from `ownProps`,
// and returning an object with multiple separate fields inside
const mapStateToProps = (state, ownProps) => {
  return {
    todo: selectTodoById(state, ownProps.todoId),
    activeTodoId: selectActiveTodoId(state)
  }
}

// Several possible variations on how you might see `mapDispatch` written:

// 1) a separate function, manual wrapping of `dispatch`
const mapDispatchToProps = dispatch => {
  return {
    todoDeleted: id => dispatch(todoDeleted(id)),
    todoToggled: id => dispatch(todoToggled(id))
  }
}

// 2) A separate function, wrapping with `bindActionCreators`
const mapDispatchToProps2 = dispatch => {
  return bindActionCreators(
    {
      todoDeleted,
      todoToggled
    },
    dispatch
  )
}

// 3) An object full of action creators
const mapDispatchToProps3 = {
  todoDeleted,
  todoToggled
}

// The component, which gets all these fields as props
function TodoListItem({ todo, activeTodoId, todoDeleted, todoToggled }) {
  // rendering logic here
}

// Finished with the call to `connect`
export default connect(mapStateToProps, mapDispatchToProps)(TodoListItem)

С хуками React-Redux вызов connect и аргументы mapState/mapDispatch заменяются хуками!

• Каждое поле, возвращаемое в mapState, становится отдельным вызовом useSelector

• Каждая функция, передаваемая через mapDispatch, становится отдельной callback-функцией внутри компонента

src/features/todos/TodoListItem.js

import { useState } from 'react'
import { useSelector, useDispatch } from 'react-redux'
import {
  todoAdded,
  todoToggled,
  selectTodoById,
  selectActiveTodoId
} from './todosSlice'

export function TodoListItem({ todoId }) {
  // Get the actual `dispatch` function with `useDispatch`
  const dispatch = useDispatch()

  // Select values from the state with `useSelector`
  const activeTodoId = useSelector(selectActiveTodoId)
  // Use prop in scope to select a specific value
  const todo = useSelector(state => selectTodoById(state, todoId))

  // Create callback functions that dispatch as needed, with arguments
  const handleToggleClick = () => {
    dispatch(todoToggled(todoId))
  }

  const handleDeleteClick = () => {
    dispatch(todoDeleted(todoId))
  }

  // omit rendering logic
}

Важное отличие: connect оптимизировал производительность рендеринга, предотвращая обновление обёрнутого компонента, пока не изменялись входные stateProps+dispatchProps+ownProps. Хуки так не могут, поскольку находятся внутри компонента. Если нужно предотвратить стандартное поведение рекурсивного рендеринга React, оберните компонент в React.memo(MyComponent) самостоятельно.

Миграция TypeScript для компонентов

Один из главных недостатков connect — чрезвычайная сложность корректной типизации, что приводит к многословным объявлениям типов. Это связано с его природой как Higher-Order Component и гибкостью API (четыре необязательных аргумента с множеством перегрузок).

Сообщество разработало несколько подходов к решению этой проблемы разной сложности. Простейшие требовали указания типа state в mapState() и ручного вычисления типов всех пропсов компонента:

Simple connect TS example

import { connect } from 'react-redux'
import { RootState } from '../../app/store'
import {
  todoToggled,
  todoDeleted,
  selectTodoById,
  selectActiveTodoId
} from './todosSlice'

interface TodoListItemOwnProps {
  todoId: string
}

const mapStateToProps = (state: RootState, ownProps) => {
  return {
    todo: selectTodoById(state, ownProps.todoId),
    activeTodoId: selectActiveTodoId(state)
  }
}

const mapDispatchToProps = {
  todoDeleted,
  todoToggled
}

type TodoListItemProps = TodoListItemOwnProps &
  ReturnType<typeof mapStateToProps> &
  typeof mapDispatchToProps

function TodoListItem({
  todo,
  activeTodoId,
  todoDeleted,
  todoToggled
}: TodoListItemProps) {}

export default connect(mapStateToProps, mapDispatchToProps)(TodoListItem)

Использование typeof mapDispatch как объекта особенно опасно, так как ломается при включении thunk-действий.

Другие подходы требовали значительных усилий: объявление mapDispatch как функции с вызовом bindActionCreators для передачи типа dispatch: Dispatch<RootActions>, или ручной расчёт типов всех пропсов обёрнутого компонента с передачей их как дженериков в connect.

Более удачной альтернативой стал тип ConnectedProps<T>, добавленный в @types/react-redux (v7.x), который выводил типы всех пропсов, передаваемых компоненту через connect. Но требовал разделения вызова connect для корректной работы вывода типов:

ConnectedProps<T> TS example

import { connect, ConnectedProps } from 'react-redux'
import { RootState } from '../../app/store'
import {
  todoToggled,
  todoDeleted,
  selectTodoById,
  selectActiveTodoId
} from './todosSlice'

interface TodoListItemOwnProps {
  todoId: string
}

const mapStateToProps = (state: RootState, ownProps) => {
  return {
    todo: selectTodoById(state, ownProps.todoId),
    activeTodoId: selectActiveTodoId(state)
  }
}

const mapDispatchToProps = {
  todoDeleted,
  todoToggled
}

// Call the first part of `connect` to get the function that accepts the component.
// This knows the types of the props returned by `mapState/mapDispatch`
const connector = connect(mapStateToProps, mapDispatchToProps)
// The `ConnectedProps<T> util type can extract "the type of all props from Redux"
type PropsFromRedux = ConnectedProps<typeof connector>

// The final component props are "the props from Redux" + "props from the parent"
type TodoListItemProps = PropsFromRedux & TodoListItemOwnProps

// That type can then be used in the component
function TodoListItem({
  todo,
  activeTodoId,
  todoDeleted,
  todoToggled
}: TodoListItemProps) {}

// And the final wrapped component is generated and exported
export default connector(TodoListItem)

API хуков React-Redux значительно проще использовать с TypeScript! Вместо работы со слоями обёрток, выводом типов и дженериками, хуки — простые функции, принимающие аргументы и возвращающие результат. Все необходимые типы — RootState и AppDispatch.

Согласно нашим рекомендациям по TypeScript, мы рекомендуем создавать "предварительно типизированные" алиасы для хуков (с уже встроенными корректными типами) и использовать только их в приложении.

Сначала настройте хуки:

src/app/hooks.ts

import { useDispatch, useSelector } from 'react-redux'
import type { AppDispatch, RootState } from './store'

// Use throughout your app instead of plain `useDispatch` and `useSelector`
export const useAppDispatch = useDispatch.withTypes<AppDispatch>()
export const useAppSelector = useSelector.withTypes<RootState>()

Затем используйте их в своих компонентах:

src/features/todos/TodoListItem.tsx

import { useAppSelector, useAppDispatch } from '../../app/hooks'
import {
  todoToggled,
  todoDeleted,
  selectTodoById,
  selectActiveTodoId
} from './todosSlice'

interface TodoListItemProps {
  todoId: string
}

function TodoListItem({ todoId }: TodoListItemProps) {
  // Use the pre-typed hooks in the component
  const dispatch = useAppDispatch()
  const activeTodoId = useAppSelector(selectActiveTodoId)
  const todo = useAppSelector(state => selectTodoById(state, todoId))

  // omit event handlers and rendering logic
}

Дополнительные материалы

Подробнее см. на следующих страницах документации и в блогах:

• Учебные материалы

  • Redux Essentials: структура приложения с Redux Toolkit
  • Redux Fundamentals: современный Redux с Redux Toolkit
  • Redux TypeScript: быстрый старт

• Дополнительная документация

  • Почему Redux Toolkit — современный способ использования Redux
  • Руководство по стилю Redux: лучшие практики и рекомендации
  • Redux core: использование с TypeScript
  • Redux Toolkit: использование с TypeScript

• Статьи

  • Презентация: современный Redux с Redux Toolkit
  • Mark Erikson: анонс Redux Toolkit 1.0 и история разработки
  • Lenz Weber: не создавайте объединения типов экшенов