Какую структуру состояния React выбрать

год назад·12 мин. на чтение

Компонент с хорошо структурированным состоянием приятно модифицировать и легко отлаживать. В этой статье вы найдете советы, которые следует учитывать при структурировании состояния в React компонентах.

Содержание туториала по React Компонент с хорошо структурированным состоянием приятно модифицировать и легко отлаживать. В этой статье вы найдете советы, которые следует учитывать при структурировании состояния.

Принципы структурирования состояния

Когда вы пишете компонент, который содержит какое-то состояние, вам придется выбирать, сколько переменных состояния использовать и какой должна быть форма их данных. Хотя можно писать правильные программы даже с неоптимальной структурой состояний, есть несколько принципов, которые помогут вам сделать правильный выбор:
  1. Состояние, связанное с группой. Если вы всегда одновременно обновляете две или более переменных состояния, рассмотрите возможность их объединения в одну переменную состояния.
  2. Избегайте противоречий в состоянии. Когда состояние структурировано таким образом, что несколько частей состояния могут противоречить и «не согласовываться» друг с другом, вы оставляете место для ошибок. Постарайтесь избежать этого.
  3. Избегайте избыточного состояния. Если вы можете вычислить некоторую информацию из пропсов компонента или его существующих переменных состояния во время рендеринга, вы не должны помещать эту информацию в состояние этого компонента.
  4. Избегайте дублирования состояния. Когда одни и те же данные дублируются между несколькими переменными состояния или внутри вложенных объектов, их сложно синхронизировать. Уменьшайте дублирование, если возможно.
  5. Избегайте глубоко вложенных состояний. Глубоко иерархическое состояние не очень удобно обновлять. По возможности предпочтительнее структурировать состояние в плоском виде.
Цель этих принципов — упростить обновление состояния без внесения ошибок. Удаление избыточных и повторяющихся данных из состояния помогает обеспечить синхронизацию всех его частей. Это похоже на то, как инженер базы данных может захотеть «нормализовать» структуру базы данных, чтобы уменьшить вероятность ошибок. Теперь давайте посмотрим, как эти принципы применяются в действии.

Состояние, связанное с группой

Иногда вы можете быть не уверены, использовать одну или несколько переменных состояния. Должны ли вы это сделать так?
const [x, setX] = useState(0);
const [y, setY] = useState(0);
Или так?
const [position, setPosition] = useState({ x: 0, y: 0 });
Технически вы можете использовать любой из этих подходов. Но если какие-то две переменные состояния всегда изменяются вместе, было бы неплохо объединить их в одну переменную состояния. Тогда вы не забудете всегда синхронизировать их, как в этом примере, где перемещение курсора обновляет обе координаты красной точки:
import { useState } from 'react';

export default function MovingDot() {
  const [position, setPosition] = useState({
    x: 0,
    y: 0,
  });
  return (
    <div
      onPointerMove={(e) => {
        setPosition({
          x: e.clientX,
          y: e.clientY,
        });
      }}
      style={{
        position: 'relative',
        width: '100vw',
        height: '100vh',
      }}
    >
      <div
        style={{
          position: 'absolute',
          backgroundColor: 'red',
          borderRadius: '50%',
          transform: `translate(${position.x}px, ${position.y}px)`,
          left: -10,
          top: -10,
          width: 20,
          height: 20,
        }}
      />
    </div>
  );
}
Другой случай, когда вы будете группировать данные в объект или массив, — это когда вы не знаете, сколько различных частей состояния вам понадобится. Например, когда у вас есть форма, в которой пользователь может добавлять настраиваемые поля. Если ваша переменная состояния является объектом, помните, что вы не можете обновить в ней только одно поле без явного копирования других полей. Например, вы не можете использовать setPosition({ x: 100 }) в приведенном выше примере, потому что у него вообще не будет свойства y. Вместо этого, если вы хотите установить только x, вы должны либо выполнить setPosition({ ...position, x: 100}), либо разделить их на две переменные состояния и выполнить setX(100).

Избегайте противоречий в состоянии

Вот форма обратной связи отеля с переменными состояния isSending и isSent:
import { useState } from 'react';

export default function FeedbackForm() {
  const [text, setText] = useState('');
  const [isSending, setIsSending] = useState(false);
  const [isSent, setIsSent] = useState(false);

  async function handleSubmit(e) {
    e.preventDefault();
    setIsSending(true);
    await sendMessage(text);
    setIsSending(false);
    setIsSent(true);
  }

  if (isSent) {
    return <h1>Thanks for feedback!</h1>;
  }

  return (
    <form onSubmit={handleSubmit}>
      <p>How was your stay at The Prancing Pony?</p>
      <textarea
        disabled={isSending}
        value={text}
        onChange={(e) => setText(e.target.value)}
      />
      <br />
      <button disabled={isSending} type="submit">
        Send
      </button>
      {isSending && <p>Sending...</p>}
    </form>
  );
}

// Имитация отправки сообщения.
function sendMessage(text) {
  return new Promise((resolve) => {
    setTimeout(resolve, 2000);
  });
}
Хотя этот код работает, в нем могут возникнуть «невозможные» состояний. Например, если вы забудете вызвать setIsSent и setIsSending вместе, вы можете оказаться в ситуации, когда и isSending, и isSent одновременно имеют значение true. Чем сложнее ваш компонент, тем сложнее будет понять, что произошло. Поскольку isSending и isSent никогда не должны принимать значение true одновременно, лучше заменить их одной переменной состояния, которая может принимать одно из трех допустимых состояний: «ввод» (typing), «отправка» (sending) и «отправлено» (sent):
import { useState } from 'react';

export default function FeedbackForm() {
  const [text, setText] = useState('');
  const [status, setStatus] = useState('typing');

  async function handleSubmit(e) {
    e.preventDefault();
    setStatus('sending');
    await sendMessage(text);
    setStatus('sent');
  }

  const isSending = status === 'sending';
  const isSent = status === 'sent';

  if (isSent) {
    return <h1>Thanks for feedback!</h1>;
  }

  return (
    <form onSubmit={handleSubmit}>
      <p>How was your stay at The Prancing Pony?</p>
      <textarea
        disabled={isSending}
        value={text}
        onChange={(e) => setText(e.target.value)}
      />
      <br />
      <button disabled={isSending} type="submit">
        Send
      </button>
      {isSending && <p>Sending...</p>}
    </form>
  );
}

// Имитация отправки сообщения.
function sendMessage(text) {
  return new Promise((resolve) => {
    setTimeout(resolve, 2000);
  });
}
Вы также можете объявить некоторые константы для удобства чтения:
const isSending = status === 'sending';
const isSent = status === 'sent';
Но они не являются переменными состояния, поэтому вам не нужно беспокоиться об их рассинхронизации друг с другом.

Избегайте избыточного состояния

Если вы можете вычислить некоторую информацию из пропсов компонента или его существующих переменных состояния во время рендеринга, вы не должны помещать эту информацию в состояние этого компонента. Например, рассмотрим такую форму. Он работает, но можете ли вы найти в нем какое-либо избыточное состояние?
import { useState } from 'react';

export default function Form() {
  const [firstName, setFirstName] = useState('');
  const [lastName, setLastName] = useState('');
  const [fullName, setFullName] = useState('');

  function handleFirstNameChange(e) {
    setFirstName(e.target.value);
    setFullName(e.target.value + ' ' + lastName);
  }

  function handleLastNameChange(e) {
    setLastName(e.target.value);
    setFullName(firstName + ' ' + e.target.value);
  }

  return (
    <>
      <h2>Let’s check you in</h2>
      <label>
        First name: <input value={firstName} onChange={handleFirstNameChange} />
      </label>
      <label>
        Last name: <input value={lastName} onChange={handleLastNameChange} />
      </label>
      <p>
        Your ticket will be issued to: <b>{fullName}</b>
      </p>
    </>
  );
}
Эта форма имеет три переменные состояния: firstName, lastName и fullName. Однако fullName является избыточным. Вы всегда можете вычислить fullName из firstName и lastName во время рендеринга, поэтому удалите его из состояния. Вот как вы можете это сделать:
import { useState } from 'react';

export default function Form() {
  const [firstName, setFirstName] = useState('');
  const [lastName, setLastName] = useState('');

  const fullName = firstName + ' ' + lastName;

  function handleFirstNameChange(e) {
    setFirstName(e.target.value);
  }

  function handleLastNameChange(e) {
    setLastName(e.target.value);
  }

  return (
    <>
      <h2>Let’s check you in</h2>
      <label>
        First name: <input value={firstName} onChange={handleFirstNameChange} />
      </label>
      <label>
        Last name: <input value={lastName} onChange={handleLastNameChange} />
      </label>
      <p>
        Your ticket will be issued to: <b>{fullName}</b>
      </p>
    </>
  );
}
Здесь fullName не является переменной состояния. Вместо этого он вычисляется во время рендеринга:
const fullName = firstName + ' ' + lastName;
В результате обработчикам изменений не нужно делать ничего особенного для его обновления. Когда вы вызываете setFirstName или setLastName, вы запускаете повторный рендеринг, а затем следующее значение fullName будет вычислено из свежих данных.

Не отзеркаливайте пропсы в состоянии

Типичным примером избыточного состояния является такой код:
function Message({ messageColor }) {
  const [color, setColor] = useState(messageColor);
Здесь переменная состояния color инициализируется пропсом messageColor. Проблема в том, что если родительский компонент позже передаст другое значение messageColor (например, «красный» вместо «синий»), переменная состояния цвета не будет обновлена. Состояние инициализируется только во время первого рендеринга. Вот почему «отзеркаливание» некоторых пропсов в переменной состояния может привести к путанице. Вместо этого используйте проп messageColor непосредственно в коде. Если вы хотите дать ему более короткое имя, используйте константу:
function Message({ messageColor }) {
  const color = messageColor;
Таким образом, он не будет рассинхронизирован с пропсом, переданным от родительского компонента. «Зеркалирование» пропсов в состояние имеет смысл только в том случае, если вы хотите игнорировать все обновления для определенного пропса. По соглашению начинайте имя пропса с initial или default, чтобы уточнить, что его новые значения игнорируются:
function Message({ initialColor }) {
  // Переменная состояния `color` содержит начальное значение `initialColor`.
  // Последующие изменения пропса `initialColor` игнорируются.
  const [color, setColor] = useState(initialColor);

Избегайте дублирования состояния

Этот компонент меню позволяет выбрать один перекус из нескольких:
import { useState } from 'react';

const initialItems = [
  { title: 'pretzels', id: 0 },
  { title: 'crispy seaweed', id: 1 },
  { title: 'granola bar', id: 2 },
];

export default function Menu() {
  const [items, setItems] = useState(initialItems);
  const [selectedItem, setSelectedItem] = useState(items[0]);

  return (
    <>
      <h2>What's your travel snack?</h2>
      <ul>
        {items.map((item) => (
          <li key={item.id}>
            {item.title}{' '}
            <button
              onClick={() => {
                setSelectedItem(item);
              }}
            >
              Choose
            </button>
          </li>
        ))}
      </ul>
      <p>You picked {selectedItem.title}.</p>
    </>
  );
}
В настоящее время он сохраняет выбранный элемент как объект в переменной состояния selectedItem. Однако это не очень хорошо: содержимое selectedItem — это тот же объект, что и один из элементов в списке элементов. Это означает, что информация о самом предмете дублируется в двух местах. Почему это проблема? Давайте сделаем каждый элемент редактируемым:
import { useState } from 'react';

const initialItems = [
  { title: 'pretzels', id: 0 },
  { title: 'crispy seaweed', id: 1 },
  { title: 'granola bar', id: 2 },
];

export default function Menu() {
  const [items, setItems] = useState(initialItems);
  const [selectedItem, setSelectedItem] = useState(items[0]);

  function handleItemChange(id, e) {
    setItems(
      items.map((item) => {
        if (item.id === id) {
          return {
            ...item,
            title: e.target.value,
          };
        } else {
          return item;
        }
      })
    );
  }

  return (
    <>
      <h2>What's your travel snack?</h2>
      <ul>
        {items.map((item, index) => (
          <li key={item.id}>
            <input
              value={item.title}
              onChange={(e) => {
                handleItemChange(item.id, e);
              }}
            />{' '}
            <button
              onClick={() => {
                setSelectedItem(item);
              }}
            >
              Choose
            </button>
          </li>
        ))}
      </ul>
      <p>You picked {selectedItem.title}.</p>
    </>
  );
}
Обратите внимание, что если вы сначала нажмете «Выбрать» на элементе, а затем отредактируете его, ввод обновится, но метка внизу не отразит изменения. Это потому, что вы дублировали состояние и забыли обновить selectedItem. Хотя вы также можете обновить selectedItem, более простое решение — удалить дублирование. В этом примере вместо объекта selectedItem (который создает дублирование объектов внутри элементов) вы сохраняете selectedId в состоянии, а затем получаете selectedItem путем поиска в массиве элементов элемента с этим идентификатором:
import { useState } from 'react';

const initialItems = [
  { title: 'pretzels', id: 0 },
  { title: 'crispy seaweed', id: 1 },
  { title: 'granola bar', id: 2 },
];

export default function Menu() {
  const [items, setItems] = useState(initialItems);
  const [selectedId, setSelectedId] = useState(0);

  const selectedItem = items.find((item) => item.id === selectedId);

  function handleItemChange(id, e) {
    setItems(
      items.map((item) => {
        if (item.id === id) {
          return {
            ...item,
            title: e.target.value,
          };
        } else {
          return item;
        }
      })
    );
  }

  return (
    <>
      <h2>What's your travel snack?</h2>
      <ul>
        {items.map((item, index) => (
          <li key={item.id}>
            <input
              value={item.title}
              onChange={(e) => {
                handleItemChange(item.id, e);
              }}
            />{' '}
            <button
              onClick={() => {
                setSelectedId(item.id);
              }}
            >
              Choose
            </button>
          </li>
        ))}
      </ul>
      <p>You picked {selectedItem.title}.</p>
    </>
  );
}
В качестве альтернативы вы можете хранить выбранный индекс в состоянии. Раньше состояние дублировалось так:
  • items = [{ id: 0, title: 'pretzels'}, ...]
  • selectedItem = {id: 0, title: 'pretzels'}
А вот после замены состояние выглядит так:
  • items = [{ id: 0, title: 'pretzels'}, ...]
  • selectedId = 0
Дублирование исчезло, и вы сохранили только основное состояние. Теперь, если вы отредактируете выбранный элемент, сообщение ниже будет немедленно обновлено. Это связано с тем, что setItems вызывает повторный рендеринг, а items.find(...) найдет элемент с обновленным заголовком. Вам не нужно было удерживать выбранный элемент в состоянии, потому что важен только выбранный идентификатор. Остальное можно рассчитать во время рендера.

Избегайте глубоко вложенных состояний

Представьте план путешествия, состоящий из планет, континентов и стран. У вас может возникнуть соблазн структурировать его состояние с помощью вложенных объектов и массивов, как в этом примере:
// App.jsx

import { useState } from 'react';
import { initialTravelPlan } from './places.js';

function PlaceTree({ place }) {
  const childPlaces = place.childPlaces;
  return (
    <li>
      {place.title}
      {childPlaces.length > 0 && (
        <ol>
          {childPlaces.map((place) => (
            <PlaceTree key={place.id} place={place} />
          ))}
        </ol>
      )}
    </li>
  );
}

export default function TravelPlan() {
  const [plan, setPlan] = useState(initialTravelPlan);
  const planets = plan.childPlaces;
  return (
    <>
      <h2>Places to visit</h2>
      <ol>
        {planets.map((place) => (
          <PlaceTree key={place.id} place={place} />
        ))}
      </ol>
    </>
  );
}
// places.js

export const initialTravelPlan = {
  id: 0,
  title: '(Root)',
  childPlaces: [
    {
      id: 1,
      title: 'Earth',
      childPlaces: [
        {
          id: 2,
          title: 'Africa',
          childPlaces: [
            {
              id: 3,
              title: 'Botswana',
              childPlaces: [],
            },
            {
              id: 4,
              title: 'Egypt',
              childPlaces: [],
            },
          ],
        },
        {
          id: 5,
          title: 'Asia',
          childPlaces: [
            {
              id: 6,
              title: 'China',
              childPlaces: [],
            },
            {
              id: 7,
              title: 'Hong Kong',
              childPlaces: [],
            },
          ],
        },
      ],
    },
    {
      id: 8,
      title: 'Mars',
      childPlaces: [
        {
          id: 9,
          title: 'Corn Town',
          childPlaces: [],
        },
        {
          id: 10,
          title: 'Green Hill',
          childPlaces: [],
        },
      ],
    },
  ],
};
Теперь предположим, что вы хотите добавить кнопку для удаления места, которое вы уже посетили. Как бы вы это сделали? Обновление вложенного состояния включает в себя создание копий объектов от той части, которая была изменена. Удаление глубоко вложенного места потребует копирования всей его родительской цепочки мест. Такой код может быть очень многословным. Если состояние слишком вложенное, чтобы его можно было легко обновить, подумайте о том, чтобы сделать его «плоским». Вот один из способов реструктуризации этих данных. Вместо древовидной структуры, в которой каждое место имеет массив своих дочерних мест, вы можете сделать так, чтобы каждое место содержало массив идентификаторов своих дочерних мест. Затем вы можете сохранить сопоставление каждого идентификатора места с соответствующим местом. Эта реструктуризация данных может напомнить вам таблицу базы данных:
// App.jsx

import { useState } from 'react';
import { initialTravelPlan } from './places.js';

function PlaceTree({ id, placesById }) {
  const place = placesById[id];
  const childIds = place.childIds;
  return (
    <li>
      {place.title}
      {childIds.length > 0 && (
        <ol>
          {childIds.map((childId) => (
            <PlaceTree key={childId} id={childId} placesById={placesById} />
          ))}
        </ol>
      )}
    </li>
  );
}

export default function TravelPlan() {
  const [plan, setPlan] = useState(initialTravelPlan);
  const root = plan[0];
  const planetIds = root.childIds;
  return (
    <>
      <h2>Places to visit</h2>
      <ol>
        {planetIds.map((id) => (
          <PlaceTree key={id} id={id} placesById={plan} />
        ))}
      </ol>
    </>
  );
}
// places.js

export const initialTravelPlan = {
  0: {
    id: 0,
    title: '(Root)',
    childIds: [1, 8],
  },
  1: {
    id: 1,
    title: 'Earth',
    childIds: [2, 5],
  },
  2: {
    id: 2,
    title: 'Africa',
    childIds: [3, 4],
  },
  3: {
    id: 3,
    title: 'Botswana',
    childIds: [],
  },
  4: {
    id: 4,
    title: 'Egypt',
    childIds: [],
  },
  5: {
    id: 5,
    title: 'Asia',
    childIds: [6, 7],
  },
  6: {
    id: 6,
    title: 'China',
    childIds: [],
  },
  7: {
    id: 7,
    title: 'Hong Kong',
    childIds: [],
  },
  8: {
    id: 8,
    title: 'Mars',
    childIds: [9, 10],
  },
  9: {
    id: 9,
    title: 'Corn Town',
    childIds: [],
  },
  10: {
    id: 10,
    title: 'Green Hill',
    childIds: [],
  },
};
Теперь, когда состояние «плоское» (также известное как «нормализованное»), обновление вложенных элементов становится проще. Чтобы удалить место сейчас, вам нужно всего лишь обновить два уровня состояния:
  • Обновленная версия родительского места должна исключить удаленный идентификатор из массива childIds.
  • Обновленная версия корневого объекта должна включать обновленную версию родительского места.
Вот пример того, как вы можете это сделать:
// App.jsx

import { useState } from 'react';
import { initialTravelPlan } from './places.js';

export default function TravelPlan() {
  const [plan, setPlan] = useState(initialTravelPlan);

  function handleComplete(parentId, childId) {
    const parent = plan[parentId];
    // Создаем новую версию родительского места,
    // которая не включает этот дочерний ID.
    const nextParent = {
      ...parent,
      childIds: parent.childIds.filter((id) => id !== childId),
    };
    // Обновляем состояние корневого объекта...
    setPlan({
      ...plan,
      // ...чтобы он содержал обновленный объект родителя.
      [parentId]: nextParent,
    });
  }

  const root = plan[0];
  const planetIds = root.childIds;
  return (
    <>
      <h2>Places to visit</h2>
      <ol>
        {planetIds.map((id) => (
          <PlaceTree
            key={id}
            id={id}
            parentId={0}
            placesById={plan}
            onComplete={handleComplete}
          />
        ))}
      </ol>
    </>
  );
}

function PlaceTree({ id, parentId, placesById, onComplete }) {
  const place = placesById[id];
  const childIds = place.childIds;
  return (
    <li>
      {place.title}
      <button
        onClick={() => {
          onComplete(parentId, id);
        }}
      >
        Complete
      </button>
      {childIds.length > 0 && (
        <ol>
          {childIds.map((childId) => (
            <PlaceTree
              key={childId}
              id={childId}
              parentId={id}
              placesById={placesById}
              onComplete={onComplete}
            />
          ))}
        </ol>
      )}
    </li>
  );
}
Вы можете сколько угодно вкладывать состояния, но если сделать их «плоскими», это может решить множество проблем. Это упрощает обновление состояния и помогает избежать дублирования в разных частях вложенного объекта.

Улучшение использования памяти

В идеале вы также должны удалить удаленные элементы (и их дочерние элементы) из объекта-таблицы, чтобы оптимизировать использование памяти. Реализация ниже содержит эту логику. Он также использует Immer, чтобы сделать логику обновления более лаконичной.
import { useImmer } from 'use-immer';
import { initialTravelPlan } from './places.js';

export default function TravelPlan() {
  const [plan, updatePlan] = useImmer(initialTravelPlan);

  function handleComplete(parentId, childId) {
    updatePlan((draft) => {
      // Удлаим дочерние ID из родительского `place`.
      const parent = draft[parentId];
      parent.childIds = parent.childIds.filter((id) => id !== childId);

      // Удалим это место и все его поддерево.
      deleteAllChildren(childId);
      function deleteAllChildren(id) {
        const place = draft[id];
        place.childIds.forEach(deleteAllChildren);
        delete draft[id];
      }
    });
  }

  const root = plan[0];
  const planetIds = root.childIds;
  return (
    <>
      <h2>Places to visit</h2>
      <ol>
        {planetIds.map((id) => (
          <PlaceTree
            key={id}
            id={id}
            parentId={0}
            placesById={plan}
            onComplete={handleComplete}
          />
        ))}
      </ol>
    </>
  );
}

function PlaceTree({ id, parentId, placesById, onComplete }) {
  const place = placesById[id];
  const childIds = place.childIds;
  return (
    <li>
      {place.title}
      <button
        onClick={() => {
          onComplete(parentId, id);
        }}
      >
        Complete
      </button>
      {childIds.length > 0 && (
        <ol>
          {childIds.map((childId) => (
            <PlaceTree
              key={childId}
              id={childId}
              parentId={id}
              placesById={placesById}
              onComplete={onComplete}
            />
          ))}
        </ol>
      )}
    </li>
  );
}
Иногда вы также можете уменьшить вложенность состояний, переместив часть вложенных состояний в дочерние компоненты. Это хорошо работает для временного состояния пользовательского интерфейса, которое не нужно сохранять, например, наведен ли элемент.

Резюме

  • Если две переменные состояния всегда обновляются вместе, рассмотрите возможность их объединения в одну.
  • Тщательно выбирайте переменные состояния, чтобы избежать создания «невозможных» состояний.
  • Структурируйте свое состояние таким образом, чтобы уменьшить вероятность того, что вы совершите ошибку при его обновлении.
  • Избегайте избыточного и дублирующего состояния, чтобы вам не нужно было синхронизировать его.
  • Не помещайте пропсы в состояние, если вы специально не хотите предотвратить обновления.
  • Для шаблонов пользовательского интерфейса, таких как выбор, сохраняйте в состоянии не сам объект, а его идентификатор или индекс.
  • Если обновление глубоко вложенного состояния затруднено, попробуйте сделать его плоским.

Мышление в стиле React

год назад·10 мин. на чтение

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

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

Начните с макета

Представьте, что у вас уже есть JSON API и мокап от дизайнера. JSON API возвращает некоторые данные, которые выглядят следующим образом:
[
  { category: 'Fruits', price: '$1', stocked: true, name: 'Apple' },
  { category: 'Fruits', price: '$1', stocked: true, name: 'Dragonfruit' },
  { category: 'Fruits', price: '$2', stocked: false, name: 'Passionfruit' },
  { category: 'Vegetables', price: '$2', stocked: true, name: 'Spinach' },
  { category: 'Vegetables', price: '$4', stocked: false, name: 'Pumpkin' },
  { category: 'Vegetables', price: '$1', stocked: true, name: 'Peas' },
];
Чтобы реализовать пользовательский интерфейс в React, обычно выполняется одни и те же пять шагов.

Шаг 1. Разбейте пользовательский интерфейс на иерархию компонентов

Начните с рисования рамок вокруг каждого компонента и подкомпонента в макете и присваивайте им имена. Если вы работаете с дизайнером, возможно, они уже назвали эти компоненты в своем инструменте дизайна. В зависимости от вашего опыта вы можете думать о разделении дизайна на компоненты по-разному:
  • Программирование — используйте те же методы для принятия решения о создании новой функции или объекта. Одним из таких методов является принцип единой ответственности, то есть в идеале компонент должен делать только одну вещь. Если он в конечном итоге растет, его следует разбить на более мелкие подкомпоненты.
  • CSS — подумайте, для чего бы вы сделали селекторы классов.
  • Дизайн — подумайте, как бы вы организовали слои дизайна.
Если ваш JSON хорошо структурирован, вы часто обнаружите, что он естественным образом сопоставляется со структурой компонентов вашего пользовательского интерфейса. Это связано с тем, что модели пользовательского интерфейса и данных часто имеют одинаковую информационную архитектуру, то есть одинаковую форму. Разделите свой пользовательский интерфейс на компоненты, где каждый компонент соответствует одной части вашей модели данных.
На этом экране пять компонентов: На этом экране пять компонентов
  1. FilterableProductTable (серый) содержит все приложение.
  2. SearchBar (синий) получает пользовательский ввод.
  3. ProductTable (фиолетовый) отображает и фильтрует список в соответствии с пользовательским вводом.
  4. ProductCategoryRow (зеленый) отображает заголовок для каждой категории.
  5. ProductRow (желтый) отображает строку для каждого продукта.
Если вы посмотрите на ProductTable (фиолетовый), вы увидите, что заголовок таблицы (содержащий метки "Name" и "Price") не является отдельным компонентом. Это вопрос предпочтений, и вы можете пойти любым путем. В этом примере это часть ProductTable, поскольку она появляется внутри списка ProductTable. Однако, если этот заголовок станет сложным (например, если вы добавите сортировку), имеет смысл сделать его отдельным компонентом ProductTableHeader. Теперь, когда вы идентифицировали компоненты макета, расположите их в иерархическом порядке. Компоненты, которые появляются внутри другого компонента в макете, должны отображаться как дочерние элементы в иерархии:
  • FilterableProductTable
    • SearchBar
    • ProductTable
      • ProductCategoryRow
      • ProductRow

Шаг 2: Создайте статичную версию в React

Теперь, когда у вас есть иерархия компонентов, пришло время реализовать ваше приложение. Самый простой подход — создать версию, которая отображает пользовательский интерфейс из вашей модели данных без добавления какой-либо интерактивности… пока! Часто проще сначала создать статичную версию, а затем добавить интерактивность отдельно. Чтобы создать статичную версию приложения, которое отображает вашу модель данных, вам нужно создать компоненты, которые повторно используют другие компоненты и передают данные с помощью пропсов. Пропсы — это способ передачи данных от родителя к дочернему элементу. (Если вы знакомы с концепцией состояния, вообще не используйте состояние для создания этой статичной версии. Состояние зарезервировано только для интерактивности, то есть данных, которые меняются со временем. Поскольку это статичная версия приложения, вам это не нужно.)
Вы можете строить «сверху вниз», начиная с компонентов, расположенных выше в иерархии (например, FilterableProductTable), или «снизу вверх», работая с компонентами, расположенными ниже (например, ProductRow). В более простых примерах обычно проще идти сверху вниз, а в более крупных проектах легче идти снизу вверх.
function ProductCategoryRow({ category }) {
  return (
    <tr>
      <th colSpan="2">{category}</th>
    </tr>
  );
}

function ProductRow({ product }) {
  const name = product.stocked ? (
    product.name
  ) : (
    <span style={{ color: 'red' }}>{product.name}</span>
  );

  return (
    <tr>
      <td>{name}</td>
      <td>{product.price}</td>
    </tr>
  );
}

function ProductTable({ products }) {
  const rows = [];
  let lastCategory = null;

  products.forEach((product) => {
    if (product.category !== lastCategory) {
      rows.push(
        <ProductCategoryRow
          category={product.category}
          key={product.category}
        />
      );
    }
    rows.push(<ProductRow product={product} key={product.name} />);
    lastCategory = product.category;
  });

  return (
    <table>
      <thead>
        <tr>
          <th>Name</th>
          <th>Price</th>
        </tr>
      </thead>
      <tbody>{rows}</tbody>
    </table>
  );
}

function SearchBar() {
  return (
    <form>
      <input type="text" placeholder="Search..." />
      <label>
        <input type="checkbox" /> Only show products in stock
      </label>
    </form>
  );
}

function FilterableProductTable({ products }) {
  return (
    <div>
      <SearchBar />
      <ProductTable products={products} />
    </div>
  );
}

const PRODUCTS = [
  { category: 'Fruits', price: '$1', stocked: true, name: 'Apple' },
  { category: 'Fruits', price: '$1', stocked: true, name: 'Dragonfruit' },
  { category: 'Fruits', price: '$2', stocked: false, name: 'Passionfruit' },
  { category: 'Vegetables', price: '$2', stocked: true, name: 'Spinach' },
  { category: 'Vegetables', price: '$4', stocked: false, name: 'Pumpkin' },
  { category: 'Vegetables', price: '$1', stocked: true, name: 'Peas' },
];

export default function App() {
  return <FilterableProductTable products={PRODUCTS} />;
}
(Если этот код выглядит пугающе, сначала пройдите Быстрый старт.) После создания компонентов у вас будет библиотека повторно используемых компонентов, которые отображают вашу модель данных. Поскольку это статичное приложение, компоненты будут возвращать только JSX. Компонент наверху иерархии (FilterableProductTable) будет использовать вашу модель данных в качестве опоры. Это называется односторонним потоком данных, потому что данные передаются от компонента верхнего уровня к компонентам в нижней части дерева.

Шаг 3. Найдите минимальное, но полное представление состояния пользовательского интерфейса.

Чтобы сделать пользовательский интерфейс интерактивным, вам нужно разрешить пользователям изменять базовую модель данных. Для этого вы будете использовать состояние. Думайте о состоянии как о минимальном наборе изменяющихся данных, которые должно запомнить ваше приложение. Самый важный принцип структурирования состояния — следовать принципу DRY (Don’t Repeat Yourself, не повторяться). Выясните абсолютно минимальное представление состояния, в котором нуждается ваше приложение, и вычислите все остальное по требованию. Например, если вы создаете список покупок, вы можете хранить элементы в виде массива в состоянии. Если вы хотите также отобразить количество элементов в списке, не сохраняйте количество элементов в качестве другого значения состояния — вместо этого считывайте длину вашего массива. Теперь подумайте обо всех фрагментах данных в этом примере приложения:
  1. Первоначальный список продуктов
  2. Текст для поиска, который ввел пользователь
  3. Значение флажка
  4. Отфильтрованный список товаров
Что из этого является состоянием? Определите те, которые не являются:
  1. Остается ли он неизменным с течением времени? Если да, то это не состояние.
  2. Он передается от родителя через проп? Если да, то это не состояние.
  3. Можете ли вы вычислить его на основе существующего состояния или пропса в вашем компоненте? Если да, то это точно не состояние!
То что осталось, наверное, является состояние. Давайте еще раз пройдемся по ним один за другим:
  1. Исходный список продуктов передается в качестве пропса, поэтому он не является состоянием.
  2. Текст поиска кажется состоянием, поскольку он меняется со временем и не может быть вычислен из чего-либо.
  3. Значение флажка кажется состоянием, поскольку оно меняется со временем и не может быть вычислено из чего-либо.
  4. Отфильтрованный список продуктов не является состоянием, поскольку его можно вычислить, взяв исходный список продуктов и отфильтровав его в соответствии с текстом поиска и значением флажка.
Это означает, что только текст поиска и значение флажка являются состоянием.

Пропсы и Состояние

В React есть два типа данных: пропсы и состояние. Они очень разные:
  • Пропсы похожи на аргументы, которые вы передаете в функции. Они позволяют родительскому компоненту передавать данные дочернему компоненту и настраивать его внешний вид. Например, Form может передать проп color в кнопку Button.
  • Состояние похоже на память компонента. Это позволяет компоненту отслеживать некоторую информацию и изменять ее в ответ на взаимодействие. Например, Button может отслеживать состояние isHovered.
Пропсы и состояния разные, но они работают вместе. Родительский компонент часто сохраняет некоторую информацию в состоянии (чтобы он мог ее изменить) и передает ее дочерним компонентам в качестве их пропсов. Ничего страшного, если разница все еще кажется нечеткой при первом чтении. Требуется немного практики.

Шаг 4: Определите, где должно находится ваше состояние

После определения минимальных данных о состоянии вашего приложения вам необходимо определить, какой компонент отвечает за изменение этого состояния или владеет этим состоянием. Помните: React использует односторонний поток данных, передавая данные вниз по иерархии компонентов от родительского к дочернему компоненту. Сразу может быть неясно, какой компонент каким состоянием должен владеть. Это может быть сложно, если вы новичок в этой концепции, но вы можете понять это, выполнив следующие шаги. Для каждой части состояния в вашем приложении:
  1. Определите каждый компонент, который отображает что-то на основе этого состояния.
  2. Найдите их ближайший общий родительский компонент — компонент выше всех в иерархии.
  3. Решите, где должно находится состояние:
    1. Часто вы можете поместить состояние непосредственно в их общего родителя.
    2. Вы также можете поместить состояние в какой-либо компонент над их общим родителем.
    3. Если вы не можете найти компонент, где имеет смысл владеть состоянием, создайте новый компонент исключительно для хранения состояния и добавьте его где-нибудь в иерархии над общим родительским компонентом.
На предыдущем шаге вы нашли в этом приложении две части состояния: вводимый текст поиска и значение флажка. В этом примере они всегда появляются вместе, поэтому их легче представить как единый элемент состояния.
Теперь давайте рассмотрим нашу стратегию для этого состояния:
  1. Определите компоненты, которые используют состояние: ProductTable необходимо отфильтровать список продуктов на основе этого состояния (текст поиска и значение флажка). SearchBar должен отображать это состояние (текст поиска и значение флажка).
  2. Найдите их общего родителя: первый родительский компонент, который используется обоими компонентами, — это FilterableProductTable.
  3. Решите, где находится состояние: мы сохраним текст фильтра и проверенные значения состояния в FilterableProductTable.
Таким образом, значения состояния будут жить в FilterableProductTable. Добавьте состояние к компоненту с помощью хука useState(). Хуки позволяют «подключиться» к циклу рендеринга компонента. Добавьте две переменные состояния вверху FilterableProductTable и укажите начальное состояние вашего приложения:
function FilterableProductTable({ products }) {
  const [filterText, setFilterText] = useState('');
  const [inStockOnly, setInStockOnly] = useState(false);
Затем передайте filterText и inStockOnly в ProductTable и SearchBar в качестве проса:
<div>
  <SearchBar filterText="{filterText}" inStockOnly="{inStockOnly}" />
  <ProductTable
    products="{products}"
    filterText="{filterText}"
    inStockOnly="{inStockOnly}"
  />
</div>
Вы можете начать видеть, как будет вести себя ваше приложение. Измените начальное значение filterText с useState('') на useState('fruit') в приведенном ниже коде песочницы. Вы увидите как текст ввода поиска, так и обновление таблицы:
import { useState } from 'react';

function FilterableProductTable({ products }) {
  const [filterText, setFilterText] = useState('');
  const [inStockOnly, setInStockOnly] = useState(false);

  return (
    <div>
      <SearchBar filterText={filterText} inStockOnly={inStockOnly} />
      <ProductTable
        products={products}
        filterText={filterText}
        inStockOnly={inStockOnly}
      />
    </div>
  );
}

function ProductCategoryRow({ category }) {
  return (
    <tr>
      <th colSpan="2">{category}</th>
    </tr>
  );
}

function ProductRow({ product }) {
  const name = product.stocked ? (
    product.name
  ) : (
    <span style={{ color: 'red' }}>{product.name}</span>
  );

  return (
    <tr>
      <td>{name}</td>
      <td>{product.price}</td>
    </tr>
  );
}

function ProductTable({ products, filterText, inStockOnly }) {
  const rows = [];
  let lastCategory = null;

  products.forEach((product) => {
    if (product.name.toLowerCase().indexOf(filterText.toLowerCase()) === -1) {
      return;
    }
    if (inStockOnly && !product.stocked) {
      return;
    }
    if (product.category !== lastCategory) {
      rows.push(
        <ProductCategoryRow
          category={product.category}
          key={product.category}
        />
      );
    }
    rows.push(<ProductRow product={product} key={product.name} />);
    lastCategory = product.category;
  });

  return (
    <table>
      <thead>
        <tr>
          <th>Name</th>
          <th>Price</th>
        </tr>
      </thead>
      <tbody>{rows}</tbody>
    </table>
  );
}

function SearchBar({ filterText, inStockOnly }) {
  return (
    <form>
      <input type="text" value={filterText} placeholder="Search..." />
      <label>
        <input type="checkbox" checked={inStockOnly} /> Only show products in
        stock
      </label>
    </form>
  );
}

const PRODUCTS = [
  { category: 'Fruits', price: '$1', stocked: true, name: 'Apple' },
  { category: 'Fruits', price: '$1', stocked: true, name: 'Dragonfruit' },
  { category: 'Fruits', price: '$2', stocked: false, name: 'Passionfruit' },
  { category: 'Vegetables', price: '$2', stocked: true, name: 'Spinach' },
  { category: 'Vegetables', price: '$4', stocked: false, name: 'Pumpkin' },
  { category: 'Vegetables', price: '$1', stocked: true, name: 'Peas' },
];

export default function App() {
  return <FilterableProductTable products={PRODUCTS} />;
}
Обратите внимание, что редактирование формы пока не работает. В приведенном выше коде есть ошибка консоли, объясняющая, почему:
You provided a `value` prop to a form field without an `onChange` handler. This will render a read-only field.


Вы предоставили проп `value` для поля формы без обработчика `onChange`. Это отобразит поле только для чтения.
В приведенном выше коде ProductTable и SearchBar считывают пропсы filterText и inStockOnly для отображения таблицы, ввода и флажка. Например, вот как SearchBar заполняет входное значение:
function SearchBar({ filterText, inStockOnly }) {
  return (
    <form>
      <input
        type="text"
        value={filterText}
        placeholder="Search..."/>
Однако вы еще не добавили никакого кода для реагирования на действия пользователя, такие как ввод текста. Сделаем это в следующем шаге.

Шаг 5. Добавьте обратный поток данных

В настоящее время ваше приложение корректно отображается с пропсами и состоянием, спускающимися по иерархии. Но чтобы изменить состояние в соответствии с пользовательским вводом, вам нужно будет поддерживать поток данных в обратном направлении: компоненты формы глубоко в иерархии должны обновить состояние в FilterableProductTable. React делает этот поток данных явным, но требует немного большего набора текста, чем двусторонняя привязка данных. Если вы попытаетесь ввести или установить флажок в приведенном выше примере, вы увидите, что React игнорирует ваш ввод. Это сделано намеренно. Написав <input value={filterText} />, вы установили проп value для input, чтобы оно всегда было равно состоянию filterText, переданному из FilterableProductTable. Поскольку состояние filterText никогда не устанавливается, ввод никогда не изменяется. Вы хотите сделать так, чтобы всякий раз, когда пользователь меняет ввод формы, состояние обновлялось, чтобы отражать эти изменения. Состояние принадлежит FilterableProductTable, поэтому только он может вызывать setFilterText и setInStockOnly. Чтобы позволить SearchBar обновлять состояние FilterableProductTable, вам нужно передать эти функции в SearchBar:
function FilterableProductTable({ products }) {
  const [filterText, setFilterText] = useState('');
  const [inStockOnly, setInStockOnly] = useState(false);

  return (
    <div>
      <SearchBar
        filterText={filterText}
        inStockOnly={inStockOnly}
        onFilterTextChange={setFilterText}
        onInStockOnlyChange={setInStockOnly} />
Внутри SearchBar вы добавите обработчики событий onChange, который установит родительское состояние:
<input
  type="text"
  value={filterText}
  placeholder="Search..."
  onChange={(e) => onFilterTextChange(e.target.value)}
/>
Теперь приложение работает!
import { useState } from 'react';

function FilterableProductTable({ products }) {
  const [filterText, setFilterText] = useState('');
  const [inStockOnly, setInStockOnly] = useState(false);

  return (
    <div>
      <SearchBar
        filterText={filterText}
        inStockOnly={inStockOnly}
        onFilterTextChange={setFilterText}
        onInStockOnlyChange={setInStockOnly}
      />
      <ProductTable
        products={products}
        filterText={filterText}
        inStockOnly={inStockOnly}
      />
    </div>
  );
}

function ProductCategoryRow({ category }) {
  return (
    <tr>
      <th colSpan="2">{category}</th>
    </tr>
  );
}

function ProductRow({ product }) {
  const name = product.stocked ? (
    product.name
  ) : (
    <span style={{ color: 'red' }}>{product.name}</span>
  );

  return (
    <tr>
      <td>{name}</td>
      <td>{product.price}</td>
    </tr>
  );
}

function ProductTable({ products, filterText, inStockOnly }) {
  const rows = [];
  let lastCategory = null;

  products.forEach((product) => {
    if (product.name.toLowerCase().indexOf(filterText.toLowerCase()) === -1) {
      return;
    }
    if (inStockOnly && !product.stocked) {
      return;
    }
    if (product.category !== lastCategory) {
      rows.push(
        <ProductCategoryRow
          category={product.category}
          key={product.category}
        />
      );
    }
    rows.push(<ProductRow product={product} key={product.name} />);
    lastCategory = product.category;
  });

  return (
    <table>
      <thead>
        <tr>
          <th>Name</th>
          <th>Price</th>
        </tr>
      </thead>
      <tbody>{rows}</tbody>
    </table>
  );
}

function SearchBar({
  filterText,
  inStockOnly,
  onFilterTextChange,
  onInStockOnlyChange,
}) {
  return (
    <form>
      <input
        type="text"
        value={filterText}
        placeholder="Search..."
        onChange={(e) => onFilterTextChange(e.target.value)}
      />
      <label>
        <input
          type="checkbox"
          checked={inStockOnly}
          onChange={(e) => onInStockOnlyChange(e.target.checked)}
        />{' '}
        Only show products in stock
      </label>
    </form>
  );
}

const PRODUCTS = [
  { category: 'Fruits', price: '$1', stocked: true, name: 'Apple' },
  { category: 'Fruits', price: '$1', stocked: true, name: 'Dragonfruit' },
  { category: 'Fruits', price: '$2', stocked: false, name: 'Passionfruit' },
  { category: 'Vegetables', price: '$2', stocked: true, name: 'Spinach' },
  { category: 'Vegetables', price: '$4', stocked: false, name: 'Pumpkin' },
  { category: 'Vegetables', price: '$1', stocked: true, name: 'Peas' },
];

export default function App() {
  return <FilterableProductTable products={PRODUCTS} />;
}
Вы можете узнать все об обработке событий и обновлении состояния в разделе "Добавление интерактивности".