20 советов для улучшения качества кода в React проекте

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

React очень гибок и не строг к структуре компонентов. Именно поэтому мы несем ответственность за поддержание чистоты и поддерживаемости наших проектов.

В этой статье рассмотрим некоторые рекомендации по улучшению качества приложения на React. Эти правила широко приняты. Таким образом, обладание этими знаниями является обязательным.

1. Используйте короткую запись JSX

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

Плохо

return (
  <Navbar showTitle={true} />
);

Хорошо

return(
  <Navbar showTitle />  
)

2. Используйте тернарные операторы

Допустим, вы хотите отобразить сведения о пользователе в зависимости от роли.

Плохо

const { role } = user;

if(role === ADMIN) {
  return <AdminUser />
}else{
  return <NormalUser />
} 

Хорошо

const { role } = user;

return role === ADMIN ? <AdminUser /> : <NormalUser />

3. Воспользуйтесь преимуществами объектных литералов

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

Плохо

const {role} = user

switch(role){
  case ADMIN:
    return <AdminUser />
  case EMPLOYEE:
    return <EmployeeUser />
  case USER:
    return <NormalUser />
}

Хорошо

const {role} = user

const components = {
  ADMIN: AdminUser,
  EMPLOYEE: EmployeeUser,
  USER: NormalUser
};

const Component = components[role];

return <Componenent />;
Теперь код выглядит намного лучше.

4. Используйте фрагменты

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

Плохо

return (
  <div>
     <Component1 />
     <Component2 />
     <Component3 />
  </div>  
)

Хорошо

return (
  <>
     <Component1 />
     <Component2 />
     <Component3 />
  </>  
)

5. Не определяйте функцию внутри рендеринга

Не определяйте функцию внутри функции рендеринга. Постарайтесь свести логику рендеринга к абсолютному минимуму.

Плохо

return (
    <button onClick={() => dispatch(ACTION_TO_SEND_DATA)}>    // здесь определена функция
      This is a bad example 
    </button>  
)

Хорошо

const submitData = () => dispatch(ACTION_TO_SEND_DATA)

return (
  <button onClick={submitData}>  
    This is a good example 
  </button>  
)

6. Используйте React memo

React.PureComponent и Memo могут значительно повысить производительность вашего приложения. Они помогают нам избежать ненужного рендеринга.

Плохо

import React, { useState } from "react";

export const TestMemo = () => {
  const [userName, setUserName] = useState("faisal");
  const [count, setCount] = useState(0);

  const increment = () => setCount((count) => count + 1);

  return (
    <>
      <ChildrenComponent userName={userName} />
      <button onClick={increment}> Increment </button>
    </>
  );
};

const ChildrenComponent =({ userName }) => {
  console.log("rendered", userName);
  return <div> {userName} </div>;
};
Хотя дочерний компонент должен отображаться только один раз, так как значение count не имеет ничего общего с ChildComponent. Но он отображается рендерится каждый раз, когда вы нажимаете на кнопку.

Хорошо

Давайте отредактируем ChildrenComponent следующим образом:
import React, {useState} from "react";

const ChildrenComponent = React.memo(({userName}) => {
    console.log('rendered')
    return <div> {userName}</div>
})
Теперь, независимо от того, сколько раз вы нажмете на кнопку, она будет отображаться только тогда, когда это необходимо.

7. Поместите CSS в JavaScript

Избегайте сырого JavaScript при написании приложений React, потому что организовать CSS намного сложнее, чем организовать JS.

Плохо

// CSS FILE

.body {
  height: 10px;
}

//JSX

return <div className='body'>

</div>

Хорошо

const bodyStyle = {
  height: "10px"
}

return <div style={bodyStyle}>

</div>

8. Используйте деструктурирование объектов

Используйте деструктурирование объектов в своих интересах. Допустим, вам нужно показать данные пользователя.

Плохо

return (
  <>
    <div> {user.name} </div>
    <div> {user.age} </div>
    <div> {user.profession} </div>
  </>  
)

Хорошо

const { name, age, profession } = user;

return (
  <>
    <div> {name} </div>
    <div> {age} </div>
    <div> {profession} </div>
  </>  
)

9. Строковые пропсы можно передавать без фигурных скобок

При передаче строковых пропсов дочернему компоненту.

Плохо

return(
  <Navbar title={"My Special App"} />
)

Хорошо

return(
  <Navbar title="My Special App" />  
)

10. Удалить JS-код из JSX

Вынесите JS-код из JSX, если это не служит какой-либо цели рендеринга или функциональности пользовательского интерфейса.

Плохо

return (
  <ul>
    {posts.map((post) => (
      <li onClick={event => {
        console.log(event.target, 'clicked!'); // <- плохо
        }} key={post.id}>{post.title}
      </li>
    ))}
  </ul>
);

Хорошо

const onClickHandler = (event) => {
   console.log(event.target, 'clicked!'); 
}

return (
  <ul>
    {posts.map((post) => (
      <li onClick={onClickHandler} key={post.id}>{post.title}</li>
    ))}
  </ul>
);

11. Используйте шаблонные литералы

Используйте шаблонные литералы для создания длинных строк. Избегайте использования конкатенации строк. Это будет выглядеть красиво и чисто.

Плохо

const userDetails = user.name + "'s profession is" + user.proffession

return (
  <div> {userDetails} </div>  
)

Хорошо

const userDetails = `${user.name}'s profession is ${user.proffession}`

return (
  <div> {userDetails} </div>  
)

12. Порядок импортов

Всегда старайтесь импортировать сущности в определенном порядке. Это улучшает читаемость кода.

Плохо

import React from 'react';
import ErrorImg from '../../assets/images/error.png';
import styled from 'styled-components/native';
import colors from '../../styles/colors';
import { PropTypes } from 'prop-types';

Хорошо

Эмпирическое правило состоит в том, чтобы сохранить порядок импорта следующим образом:
  • Встроенные зависимости
  • Внешние зависимости
  • Внутренние зависимости
Итак, приведенный выше пример становится:
import React from 'react';

import { PropTypes } from 'prop-types';
import styled from 'styled-components/native';

import ErrorImg from '../../assets/images/error.png';
import colors from '../../styles/colors';

13. Используйте неявный возврат

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

Плохо

const add = (a, b) => {
  return a + b;
}

Хорошо

const add = (a, b) => a + b;

14. Именование компонентов

Всегда используйте PascalCase для компонентов и camelCase для экземпляров.

Плохо

import reservationCard from './ReservationCard';

const ReservationItem = <ReservationCard />;

Хорошо

import ReservationCard from './ReservationCard';

const reservationItem = <ReservationCard />;

15. Кавычки

Используйте двойные кавычки для атрибутов JSX и одинарные кавычки для всех остальных JS.

Плохо

<Foo bar='bar' />

<Foo style={{ left: "20px" }} />

Хорошо

<Foo bar="bar" />

<Foo style={{ left: '20px' }} />

16. Именование пропсов

Всегда используйте camelCase для имен объектов или PascalCase, если значение объекта является компонентом React.

Плохо

<Component
  UserName="hello"
  phone_number={12345678}
/>

Хорошо

<MyComponent
  userName="hello"
  phoneNumber={12345678}
  Component={SomeComponent}
/>

17. JSX в круглых скобках

Если компонент занимает более одной строки, всегда заключайте его в круглые скобки.

Плохо

return <MyComponent variant="long">
           <MyChild />
         </MyComponent>;

Хорошо

return (
    <MyComponent variant="long">
      <MyChild />
    </MyComponent>
);

18. Самозакрывающиеся теги

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

Плохо

<SomeComponent variant="stuff"></SomeComponent>

Хорошо

<SomeComponent variant="stuff" />

19. Нижнее подчеркивание в названии метода

Не используйте символы подчеркивания ни в одном внутреннем методе React.

Плохо

const _onClickHandler = () => {
  // код
}

Хорошо

const onClickHandler = () => {
  // код
}

20. Проп alt

Всегда включайте проп alt в теги <img >. И не используйте picture или image в проп alt, потому что программы чтения с экрана уже объявляют элементы img изображениями.

Плохо

<img src="hello.jpg" />

<img src="hello.jpg" alt="Picture of me rowing a boat" />

Хорошо

<img src="hello.jpg" alt="Me waving hello" />

Состояние - память React компонента

10 месяцев назад·1 мин. на чтение

Компонентам часто необходимо изменить то, что отображается на экране в результате взаимодействия. Ввод в форму должен обновить поле ввода, нажатие «Далее» на карусели изображений должно изменить отображаемое изображение, нажатие «купить» должно поместить продукт в корзину. Компоненты должны «запоминать» вещи: текущее входное значение, текущее изображение, корзину. В React такой тип памяти для конкретного компонента называется состоянием.

Содержание туториала по React Компонентам часто необходимо изменить то, что отображается на экране в результате взаимодействия. Ввод в форму должен обновить поле ввода, нажатие «Далее» на карусели изображений должно изменить отображаемое изображение, нажатие «купить» должно поместить продукт в корзину. Компоненты должны «запоминать» вещи: текущее входное значение, текущее изображение, корзину. В React такой тип памяти для конкретного компонента называется состоянием.

Когда обычной переменной недостаточно

Вот компонент, который рендерит изображение скульптуры. Нажатие кнопки «Далее» должно отобразить следующую скульптуру, изменив индекс на 1, затем на 2 и так далее. Однако это не сработает:
// App.jsx

import { sculptureList } from './data.js';

export default function Gallery() {
  let index = 0;

  function handleClick() {
    index = index + 1;
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <img src={sculpture.url} alt={sculpture.alt} />
      <p>{sculpture.description}</p>
    </>
  );
}
// data.js

export const sculptureList = [
  {
    name: 'Sculpture 1 Name',
    artist: 'Sculpture 1 Artist',
    description: 'Sculpture 1 Description',
    url: 'https://example.com/sculpture1.jpg',
    alt: 'Sculpture 1 Description',
  },
  {
    name: 'Sculpture 2 Name',
    artist: 'Sculpture 2 Artist',
    description: 'Sculpture 2 Description',
    url: 'https://example.com/sculpture2.jpg',
    alt: 'Sculpture 2 Description',
  },
];
Обработчик события handleClick обновляет локальную переменную index. Но две вещи препятствуют тому, чтобы это изменение было видимым:
  1. Локальные переменные не сохраняются между рендерами. Когда React рендерит этот компонент во второй раз, он рендерит его с нуля — он не учитывает никаких изменений в локальных переменных.
  2. Изменения локальных переменных не вызовут рендеринга. React не понимает, что ему нужно снова визуализировать компонент с новыми данными.
Чтобы обновить компонент новыми данными, должны произойти две вещи:
  1. Данные между рендерами должны сохраняться.
  2. Нужно заставить React отрендерить компонент с новыми данными (повторный рендеринг).
Хук useState предоставляет две вещи:
  1. Переменную состояния для сохранения данных между рендерами.
  2. Функцию установки состояния для обновления переменной и запуска React для повторного рендеринга компонента.

Добавление переменной состояния

Чтобы добавить переменную состояния, импортируйте useState из React в начало файла:
import { useState } from 'react';
Затем замените эту строку:
let index = 0;
на эту:
const [index, setIndex] = useState(0);
index — это переменная состояния, а setIndex — функция установки состояния. Синтаксис [ и ] называется деструктурированием массива и позволяет считывать значения из массива. Массив, возвращаемый useState, всегда содержит ровно два элемента. Вот как они работают вместе в handleClick:
function handleClick() {
  setIndex(index + 1);
}
Теперь нажатие кнопки «Далее» переключает текущее изображение:
// App.jsx

import { useState } from 'react';
import { sculptureList } from './data.js';

export default function Gallery() {
  const [index, setIndex] = useState(0);

  function handleClick() {
    setIndex(index + 1);
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <img src={sculpture.url} alt={sculpture.alt} />
      <p>{sculpture.description}</p>
    </>
  );
}

Встречайте свой первый хук

В React useState, как и любая другая функция, начинающаяся с «use», называется хуком. Хуки — это специальные функции, которые доступны только во время рендеринга React (о чем мы поговорим подробнее на следующей странице). Они позволяют вам «подключаться» к различным функциям React. Состояние — это только одна из этих функций, но позже вы познакомитесь с другими хуками. Хуки — функции, начинающиеся с use — могут вызываться только на верхнем уровне ваших компонентов или ваших собственных кастомных хуков. Вы не можете вызывать хуки внутри условий, циклов или других вложенных функций. Хуки — это функции, но полезно думать о них как о безусловных декларациях о потребностях вашего компонента. Вы используете (use) функции React в верхней части вашего компонента, подобно тому, как вы «импортируете» модули в верхней части вашего файла.

Как устроен useState?

Когда вы вызываете useState, вы сообщаете React, что хотите, чтобы этот компонент что-то запомнил:
const [index, setIndex] = useState(0);
В этом случае вы хотите, чтобы React запомнил index. По соглашению эта пара именуется как const [something, setSomething]. Вы можете назвать их как угодно, но соглашения облегчают понимание разных проектов. Единственный аргумент useState — это начальное значение вашей переменной состояния. В этом примере начальное значение индекса устанавливается равным 0 с помощью useState(0). Каждый раз, когда ваш компонент рендерится, useState предоставляет вам массив, содержащий два значения:
  1. Переменная состояния (index) со значением, которое вы сохранили.
  2. Функция установки состояния (setIndex), которая может обновлять переменную состояния и запускать React для повторного рендеринга компонента.
Вот как это происходит в действии:
const [index, setIndex] = useState(0);
  1. Ваш компонент отображается в первый раз. Поскольку вы передали 0 в useState в качестве начального значения для index, он вернет [0, setIndex]. React помнит, что 0 — это последнее значение состояния.
  2. Вы обновляете состояние. Когда пользователь нажимает кнопку, он вызывается setIndex(index + 1). index равен 0, поэтому это setIndex(1). Это говорит React запомнить, что index теперь равен 1, и запускается другой рендеринг.
  3. Второй рендер вашего компонента. React по-прежнему видит useState(0), но поскольку React запомнил, что вы установили index равным 1, вместо этого он возвращает [1, setIndex].
И т.д.

Несколько переменных состояния в компоненте

В одном компоненте вы можете иметь столько переменных состояния любого типа, сколько захотите. Этот компонент имеет две переменные состояния, числовой index и логическое значение showMore, которое переключается, когда вы нажимаете "Show details":
import { useState } from 'react';
import { sculptureList } from './data.js';

export default function Gallery() {
  const [index, setIndex] = useState(0);
  const [showMore, setShowMore] = useState(false);

  function handleNextClick() {
    setIndex(index + 1);
  }

  function handleMoreClick() {
    setShowMore(!showMore);
  }

  let sculpture = sculptureList[index];
  return (
    <>
      <button onClick={handleNextClick}>Next</button>
      <h2>
        <i>{sculpture.name} </i>
        by {sculpture.artist}
      </h2>
      <h3>
        ({index + 1} of {sculptureList.length})
      </h3>
      <button onClick={handleMoreClick}>
        {showMore ? 'Hide' : 'Show'} details
      </button>
      {showMore && <p>{sculpture.description}</p>}
      <img src={sculpture.url} alt={sculpture.alt} />
    </>
  );
}
Рекомендуется иметь несколько переменных состояния, если их состояние не связано, например index и showMore в этом примере. Но если вы обнаружите, что часто меняете две переменные состояния вместе, может быть лучше объединить их в одну. Например, если у вас есть форма с множеством полей, удобнее иметь одну переменную состояния, которая содержит объект, чем переменную состояния для каждого поля. В руководстве "Какую структуру состояния выбрать" содержится больше советов по этому вопросу.

Как React узнает, какое состояние вернуть?

Вы могли заметить, что вызов useState не получает никакой информации о том, на какую переменную состояния он ссылается. В useState не передается «идентификатор», так как же он узнает, какую из переменных состояния следует вернуть? Чтобы обеспечить лаконичный синтаксис, хуки полагаются на стабильный порядок вызовов при каждом рендеринге одного и того же компонента. Это хорошо работает на практике, потому что если вы будете следовать правилу выше («вызывать хуки только на верхнем уровне»), хуки всегда будут вызываться в одном и том же порядке. Кроме того, linter плагин отлавливает большинство ошибок. Внутри React хранит массив пар состояний для каждого компонента. Он также поддерживает индекс для текущуй пары, который перед рендерингом устанавливается в 0. Каждый раз, когда вы вызываете useState, React предоставляет вам следующую пару состояний и увеличивает индекс.
В следующем примере не используется React, но он дает представление о внутренней работе useState:
let componentHooks = [];
let currentHookIndex = 0;

// Как useState работает внутри React (упрощенно).
function useState(initialState) {
  let pair = componentHooks[currentHookIndex];
  if (pair) {
    // Это не первый рендер,
    // поэтому пара состояний уже существует.
    // Верните его и приготовьтесь к следующему хуку.
    currentHookIndex++;
    return pair;
  }

  // Это первый рендеринг,
  // поэтому создаем пару состояния и сохраняем ее.
  pair = [initialState, setState];

  function setState(nextState) {
    // Когда пользователь запрашивает изменение состояния,
    // помещаем новое значение в пару.
    pair[0] = nextState;
    updateDOM();
  }

  // Сохраняем пару для будущих рендеров
  // и подготовимся к следующему вызову хука.
  componentHooks[currentHookIndex] = pair;
  currentHookIndex++;
  return pair;
}

function Gallery() {
  // Каждый вызов useState() будет получать следующую пару.
  const [index, setIndex] = useState(0);
  const [showMore, setShowMore] = useState(false);

  function handleNextClick() {
    setIndex(index + 1);
  }

  function handleMoreClick() {
    setShowMore(!showMore);
  }

  let sculpture = sculptureList[index];
  // В этом примере не используется React,
  //поэтому вернем объект вместо JSX.
  return {
    onNextClick: handleNextClick,
    onMoreClick: handleMoreClick,
    header: `${sculpture.name} by ${sculpture.artist}`,
    counter: `${index + 1} of ${sculptureList.length}`,
    more: `${showMore ? 'Hide' : 'Show'} details`,
    description: showMore ? sculpture.description : null,
    imageSrc: sculpture.url,
    imageAlt: sculpture.alt,
  };
}

function updateDOM() {
  // Сбросить текущий индекс хука
  // перед рендерингом компонента.
  currentHookIndex = 0;
  let output = Gallery();

  // Обновить DOM, чтобы он соответствовал выходным данным.
  // Это та часть, которую React делает за вас.
  nextButton.onclick = output.onNextClick;
  header.textContent = output.header;
  moreButton.onclick = output.onMoreClick;
  moreButton.textContent = output.more;
  image.src = output.imageSrc;
  image.alt = output.imageAlt;
  if (output.description !== null) {
    description.textContent = output.description;
    description.style.display = '';
  } else {
    description.style.display = 'none';
  }
}

let nextButton = document.getElementById('nextButton');
let header = document.getElementById('header');
let moreButton = document.getElementById('moreButton');
let description = document.getElementById('description');
let image = document.getElementById('image');
let sculptureList = [
  {
    name: 'Sculpture 1 Name',
    artist: 'Sculpture 1 Artist',
    description: 'Sculpture 1 Description',
    url: 'https://example.com/sculpture1.jpg',
    alt: 'Sculpture 1 Description',
  },
  {
    name: 'Sculpture 2 Name',
    artist: 'Sculpture 2 Artist',
    description: 'Sculpture 2 Description',
    url: 'https://example.com/sculpture2.jpg',
    alt: 'Sculpture 2 Description',
  },
];

// Сделать интерфейс соответствующим начальному состоянию.
updateDOM();
Вам не нужно понимать это, чтобы использовать React, но вы можете найти полезную ментальную модель.

Состояние изолировано и приватно

Состояние является локальным для экземпляра компонента на экране. Другими словами, если вы рендерите один и тот же компонент дважды, каждая копия будет иметь полностью изолированное состояние. Изменение одного из них не повлияет на другой. В этом примере ранее компонент Gallery визуализируется дважды без каких-либо изменений в его логике.
import Gallery from './Gallery.js';

export default function Page() {
  return (
    <div className="Page">
      <Gallery />
      <Gallery />
    </div>
  );
}
Это то, что отличает состояние от обычных переменных, которые вы можете объявить в верхней части вашего модуля. Состояние не привязано к конкретному вызову функции или месту в коде, но оно «локально» для определенного места на экране. Мы отрендерили два компонента <Gallery />, поэтому их состояние сохраняется отдельно.
Также обратите внимание на то, что компонент Page ничего не «знает» о состоянии Gallery и даже о том, есть ли оно у него. В отличие от пропсов, состояние полностью приватно для компонента, объявляющего его. Родительский компонент не может его изменить. Это позволяет добавлять состояние к любому компоненту или удалять его, не затрагивая остальные компоненты. Что, если вы хотите, чтобы обе галереи синхронизировали свои состояния? Правильный способ сделать это в React — удалить состояние из дочерних компонентов и добавить его к их ближайшему общему родителю. Следующие несколько частей будут посвящены организации состояния одного компонента, но мы вернемся к этой теме в разделе "Обмен данными между компонентами".

Резюме

  • Используйте переменную состояния, когда компоненту необходимо «запомнить» некоторую информацию между рендерами.
  • Переменные состояния объявляются путем вызова хука useState.
  • Хуки — это специальные функции, которые начинаются с use. Они позволяют вам «подключаться» к возможностям React, таким как состояние.
  • Вызов хуков, включая useState, действителен только на верхнем уровне компонента или другого хука.
  • Хук useState возвращает пару значений: текущее состояние и функцию для его обновления.
  • Вы можете иметь более одной переменной состояния. Внутри React сопоставляет их по порядку.
  • Состояние является приватным для компонента. Если вы рендерите его в двух местах, каждая копия получает свое состояние.