Разделение кода с помощью React.lazy и Suspense

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

Метод React.lazy позволяет легко разделить код приложения React на уровне компонентов с помощью динамического импорта.

import React, { lazy } from 'react';

const AvatarComponent = lazy(() => import('./AvatarComponent'));

const DetailsComponent = () => (
  <div>
    <AvatarComponent />
  </div>
)

Почему это полезно?

Большое приложение React обычно состоит из множества компонентов, служебных методов и сторонних библиотек. Если не пытаться загружать разные части приложения только тогда, когда они нужны, то при загрузке первой страницы пользователям будет отправлен один большой пакет JavaScript. Это может значительно повлиять на эффективность страницы.

Функция React.lazy позволяет без лишних усилий разделить компоненты приложения на отдельные фрагменты кода JavaScript. Затем вы можете позаботиться о состояниях загрузки, когда свяжете его с компонентом Suspense.

Саспенс

Проблема с отправкой пользователям большой полезной нагрузки JavaScript заключается в том, сколько времени потребуется для завершения загрузки страницы, особенно на более слабых устройствах и сетевых подключениях. Вот почему разделение кода и отложенная загрузка чрезвычайно полезны.

Однако при получении компонента с разделением кода по сети всегда будет небольшая задержка, поэтому важно отображать полезное состояние загрузки. Использование React.lazy с компонентом Suspense помогает решить эту проблему.

import React, { lazy, Suspense } from 'react';

const AvatarComponent = lazy(() => import('./AvatarComponent'));

const renderLoader = () => <p>Loading</p>;

const DetailsComponent = () => (
  <Suspense fallback={renderLoader()}>
    <AvatarComponent />
  </Suspense>
)

Suspense принимает компонент fallback, который позволяет показывать любой компонент React в качестве состояния загрузки. Ниже показано, как это работает. Аватар отображается только при нажатии кнопки, после чего выполняется запрос на получение кода, необходимого для приостановленного компонента AvatarComponent. Пока этого не произошло, показывается резервный компонент загрузки.

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

Вот как это работает:

  • Чтобы посмотреть сайт, нажмите View App (Посмотреть приложение), а затем – Fullscreen (Полноэкранный режим) полноэкранный режим.
  • Нажмите Ctrl + Shift + J (или Command + Option + J на Mac), чтобы открыть Инструменты разработчика.
  • Откройте вкладку Сеть.
  • Нажмите на раскрывающийся список Ограничение. По умолчанию в нем выбрано значение Без ограничения. Выберите Быстрый 3G.
  • Нажмите кнопку Click Me (Нажми меня) в приложении.

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

Панель &quot;Сеть&quot; в Инструментах разработчика, на которой показано скачивание одного файла chunk.js

Приостановка нескольких компонентов

Ещё одна особенность Suspense заключается в том, что он позволяет приостановить загрузку нескольких компонентов, даже если все они загружаются отложено.

Пример:

import React, { lazy, Suspense } from 'react';

const AvatarComponent = lazy(() => import('./AvatarComponent'));
const InfoComponent = lazy(() => import('./InfoComponent'));
const MoreInfoComponent = lazy(() => import('./MoreInfoComponent'));

const renderLoader = () => <p>Loading</p>;

const DetailsComponent = () => (
  <Suspense fallback={renderLoader()}>
    <AvatarComponent />
    <InfoComponent />
    <MoreInfoComponent />
  </Suspense>
)

Это очень полезный способ отложить рендеринг нескольких компонентов, показывая только одно состояние загрузки. Когда все компоненты будут получены, пользователь увидит их одновременно.

Это можно увидеть на следующем примере:

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

Как обрабатывать ошибки загрузки

Suspense позволяет показывать временное состояние загрузки, пока в фоновом режиме выполняются сетевые запросы. Но что, если эти сетевые запросы по какой-то причине не выполняются? Возможно, у вас нет подключения к интернету или веб-приложение пытается выполнить отложенную загрузку URL с версией, который устарел и больше не доступен после повторного развертывания сервера.

В React есть стандартный шаблон для корректной обработки таких сбоев загрузки – использование предохранителя. Как описано в документации, любой компонент React может служить в качестве предохранителя, если он реализует один или оба метода жизненного цикла: static getDerivedStateFromError() или componentDidCatch().

Чтобы обнаруживать и обрабатывать ошибки отложенной загрузки, вы можете обернуть компонент Suspense родительским компонентом, который служит границей ошибки. Внутри метода render() границы ошибки можно настроить отображение дочерних элементов в обычном режиме, если ошибки нет, или показ специального сообщения об ошибке, если что-то пошло не так:

import React, { lazy, Suspense } from 'react';

const AvatarComponent = lazy(() => import('./AvatarComponent'));
const InfoComponent = lazy(() => import('./InfoComponent'));
const MoreInfoComponent = lazy(() => import('./MoreInfoComponent'));

const renderLoader = () => <p>Loading</p>;

class ErrorBoundary extends React.Component {
  constructor(props) {
    super(props);
    this.state = {hasError: false};
  }

  static getDerivedStateFromError(error) {
    return {hasError: true};
  }

  render() {
    if (this.state.hasError) {
      return <p>Loading failed! Please reload.</p>;
    }

    return this.props.children;
  }
}

const DetailsComponent = () => (
  <ErrorBoundary>
    <Suspense fallback={renderLoader()}>
      <AvatarComponent />
      <InfoComponent />
      <MoreInfoComponent />
    </Suspense>
  </ErrorBoundary>
)

Заключение

Если вы не знаете, с чего начать разделение кода в приложении React, выполните следующие действия:

  1. Начните с уровня маршрута. Маршруты – это самый простой способ определить точки приложения, которые можно разделить. В документации по React показано, как использовать Suspense вместе с react-router.
  2. Найдите на странице крупные компоненты, которые отрисовываются только при определенных действиях пользователя, например нажатии кнопки. Разделение этих компонентов позволит минимизировать полезную нагрузку JavaScript.
  3. Рекомендуем разделить все остальные элементы, которые не видны на экране и не являются критически важными для пользователя.