Перейти к содержанию

applyMiddleware

applyMiddleware(...middlewares);

Mидлвар (middleware) - это предлагаемый способ расширения Redux с помощью настраиваемых функций. Mидлвар позволяет вам обернуть метод стора dispatch для пользы и дела. Ключевой особенностью мидлвара является то, что они компонуемы. Несколько мидлваров можно объединить вместе, где каждый мидлвар не должен знать, что происходит до или после него в цепочке.

Наиболее распространенным случаем использования мидлваров является поддержка асинхронных экшенов без большого количества шаблонного кода или зависимости от библиотек типа Rx. Это позволяет вам вызывать асинхронные экшены помимо обычных экшенов.

Например, redux-thunk позволяет генераторам экшенов инвертировать управление вызывая функции. Они будут получать dispatch как аргумент и могут вызывать его асинхронно. Такие функции называются преобразователями (thunks). Другим примером мидлвара является redux-promise. Он позволяет вам вызывать асинхронный экшен c Promise и вызывать обычные экшены, когда промис вернет resolve.

Mидлвары нельзя сравнивать с createStore и это не фундаментальная часть архитектуры Redux, но, мы считаем, что достаточно полезно поддерживать их прямо в ядре. Таким образом, существует единственный стандартный способ расширить dispatch в экосистеме и разные мидлвары могут конкурировать в выразительности и полезности.

Параметры

...middlewares (arguments)
Функции, которые соответствуют Redux middleware API. Каждый мидлвар получает dispatch и getState функции в качестве именованных аргументов и возвращает функцию. Эта функция будет передана next dispatch-методу мидлвара и, как ожидается, вернет функцию экшена, вызывающую next(action) с возможно другим аргументом или позже или, возможно, не вызывая его вообще. Последний мидлвар в цепочке получит реальный dispatch метод стора в качестве next параметра, таким образом завершая цепочку. Следовательно, сигнатурой мидлвара является ({ getState, dispatch }) => next => action.

Возвращает

(Function)
Расширитель стора, который применяет полученный мидлвар. Сигнатурой расширителя стора является createStore => createStore', но самый простой способ его применить - это передать его в createStore() как последний аргумент enhancer.

Примеры

Мидлвар для кастомного логирования

import { createStore, applyMiddleware } from 'redux';
import todos from './reducers';

function logger({ getState }) {
  return (next) => (action) => {
    console.log('will dispatch', action);

    // Вызовем следующий метод dispatch в цепочке мидлваров.
    const returnValue = next(action);

    console.log('state after dispatch', getState());

    // Это наверняка будет `экшен`, если только
    // какой-нибудь `мидлвар` дальше в цепочке не изменит его.
    return returnValue;
  };
}

const store = createStore(
  todos,
  ['Use Redux'],
  applyMiddleware(logger)
);

store.dispatch({
  type: 'ADD_TODO',
  text: 'Understand the middleware',
});
// (Эти строки будут залогированы милдвэром:)
// will dispatch: { type: 'ADD_TODO', text: 'Understand the middleware' }
// state after dispatch: [ 'Use Redux', 'Understand the middleware' ]

Использование Thunk мидлвара для асинхронных экшенов

import {
  createStore,
  combineReducers,
  applyMiddleware,
} from 'redux';
import thunk from 'redux-thunk';
import * as reducers from './reducers';

const reducer = combineReducers(reducers);
// applyMiddleware улучшает createStore переданным мидлваром:
const store = createStore(reducer, applyMiddleware(thunk));

function fetchSecretSauce() {
  return fetch(
    'https://www.google.com/search?q=secret+sauce'
  );
}

//Это такие же обычные генераторы экшенов, которые вы видели ранее.
//Экшены, которые они возвращают, могут быть переданы в `dispatch` без каких-либо мидлваров.
//Тем не менее, они отражают только "факты", но не "асинхронный flow"

function makeASandwich(forPerson, secretSauce) {
  return {
    type: 'MAKE_SANDWICH',
    forPerson,
    secretSauce,
  };
}

function apologize(fromPerson, toPerson, error) {
  return {
    type: 'APOLOGIZE',
    fromPerson,
    toPerson,
    error,
  };
}

function withdrawMoney(amount) {
  return {
    type: 'WITHDRAW',
    amount,
  };
}

// Мы можем диспатчить событие даже без мидлвера
store.dispatch(withdrawMoney(100));

// Но что, если вам нужно запустить асинхронную операцию,
// такую, как вызов API или переход в роутере?

// Встречайте `преобразователи` (thunks).
// Преобразователь - это всего лишь функция, возвращающая функцию.
// Вот пример преобразователя:

function makeASandwichWithSecretSauce(forPerson) {
  // Инвертируем управление!
  // Возвращаем функцию, которая принимает `dispatch` как аргумент, чтобы мы могли её вызвать позже.
  // мидлвар-преобразователь знает, как нужно конвертировать такие асинхронные экшены в стандартные.

  return function (dispatch) {
    return fetchSecretSauce().then(
      (sauce) => dispatch(makeASandwich(forPerson, sauce)),
      (error) =>
        dispatch(
          apologize('The Sandwich Shop', forPerson, error)
        )
    );
  };
}

// мидлвар-преобразователь позволяет диспатчить асинхронные функции так,
// как будто это обычные события!
store.dispatch(makeASandwichWithSecretSauce('Me'));

// мидлвар даже возвращает результат вашей функции из dispatch, поэтому можно создавать цепочки Promise, если вы их возвращаете.
store
  .dispatch(makeASandwichWithSecretSauce('My wife'))
  .then(() => {
    console.log('Done!');
  });

// Фактически, можно даже писать генераторы событий, которые диспатчат обычные и асинхронные события из других генераторов событий,
// и, таким образом, создавать полноценные потоки управления событиями с использованием Promise
function makeSandwichesForEverybody() {
  return function (dispatch, getState) {
    if (!getState().sandwiches.isShopOpen) {
      // Вы не обязаны возвращать Promise, но это хорошее соглашение, чтобы вызывающий мог всегда вызвать .then() на результате вашего `dispatch`

      return Promise.resolve();
    }

    // Мы можем диспатчить как обычные объекты событий, так и асинхронные функции-преобразователи одновременно,
    // что позволяем нам встраивать асинхронные события в единый поток событий.
    return dispatch(
      makeASandwichWithSecretSauce('My Grandma')
    )
      .then(() =>
        Promise.all([
          dispatch(makeASandwichWithSecretSauce('Me')),
          dispatch(makeASandwichWithSecretSauce('My wife')),
        ])
      )
      .then(() =>
        dispatch(makeASandwichWithSecretSauce('Our kids'))
      )
      .then(() =>
        dispatch(
          getState().myMoney > 42
            ? withdrawMoney(42)
            : apologize('Me', 'The Sandwich Shop')
        )
      );
  };
}

// Это очень полезно для server-side рендеринда, т.к. мы можем дождаться получения данных, а после синхронно отрендерить приложение.

import { renderToString } from 'react-dom/server';

store
  .dispatch(makeSandwichesForEverybody())
  .then(() =>
    response.send(renderToString(<MyApp store={store} />))
  );

// Можно также диспатчить асинхронный генератор экшенов прямо из компонента при изменении его `props`
// для получения недостающих данных.

import { connect } from 'react-redux';
import { Component } from 'react';

class SandwichShop extends Component {
  componentDidMount() {
    this.props.dispatch(
      makeASandwichWithSecretSauce(this.props.forPerson)
    );
  }

  componentWillReceiveProps(nextProps) {
    if (nextProps.forPerson !== this.props.forPerson) {
      this.props.dispatch(
        makeASandwichWithSecretSauce(nextProps.forPerson)
      );
    }
  }

  render() {
    return <p>{this.props.sandwiches.join('mustard')}</p>;
  }
}

export default connect((state) => ({
  sandwiches: state.sandwiches,
}))(SandwichShop);

Советы

  • Мидлвары всего лишь оборачивают метод стора dispatch. Технически, вы можете воспроизвести это поведение, оборачивая каждый вызов dispatch вручную, но гораздо проще управлять этим из единого места и устанавливать трансформации экшенов во всём приложении одновременно.
  • Если вы используете другие расширители стора, помимо applyMiddleware, убедитесь, что вы расположили applyMiddleware перед ними в цепочке преобразований, поскольку мидлвары потенциально могут быть асинхронными. Например, он должен быть установлен перед redux-devtools иначе DevTools не увидит сырые события, сгенерированные мидлваром Promise middleware и ему подобными.
  • Если вы ходите применять мидлвар по условию, убедитесь, что он импортируется только тогда, когда он необходим:
const middleware = [a, b];
if (process.env.NODE_ENV !== 'production') {
  const c = require('some-debug-middleware');
  const d = require('another-debug-middleware');
  middleware = [...middleware, c, d];
}

const store = createStore(
  reducer,
  preloadedState,
  applyMiddleware(...middleware)
);

Это позволяет инструментам сборки эффективно удалять неиспользуемый код из сборки и уменьшать их размер.

  • Никогда не задумывались, что из себя представляет applyMiddleware? Он должен быть более мощным механизмом расширения, чем сами мидлвары. И действительно, applyMiddleware является примером наиболее мощного механизма расширения Redux, который называется расширители стора (store enhancers). Достаточно маловероятно, что вам когда-либо придётся самостоятельно писать расширитель стора. Примером такого расширителя является redux-devtools. мидлвар менее мощный, чем расширитель стора, но его проще написать.
  • Мидлвары представляются гораздо сложнее, чем они есть на самом деле. Единственный способ действительно понять мидлвар - это увидеть, как работают уже существующие, и попробовать написать собственный. Множественная вложенность функций может выглядеть пугающей, но большинство написанных мидлваров, фактически, содержат не больше 10 строк кода, а вложенность и компонуемость - это как раз то, что делает систему мидлваров такой мощной.
  • Вы можете использовать compose() для применения нескольких расширителей стора одновременно.