Atualizando Objetos no State

O state pode conter qualquer tipo de valor JavaScript, inclusive objetos. Mas você não deve alterar diretamente os objetos que mantém no state do React. Em vez disso, quando quiser atualizar um objeto, você precisa criar um novo (ou fazer uma cópia de um existente) e, em seguida, definir o state para usar essa cópia.

Você aprenderá

Como atualizar corretamente um objeto no state do React
Como atualizar um objeto aninhado sem mutá-lo
O que é imutabilidade e como não quebrá-la
Como tornar a cópia de objetos menos repetitiva com o Immer

O que é uma mutação?

Você pode armazenar qualquer tipo de valor JavaScript no state.

const [x, setX] = useState(0);

Até agora, você trabalhou com números, strings e booleanos. Esses tipos de valores JavaScript são “imutáveis”, ou seja, inalteráveis ou “somente leitura”. Você pode acionar uma nova renderização para substituir um valor:

setX(5);

O state x foi alterado de 0 para 5, mas o número 0 em si não foi alterado. Não é possível fazer nenhuma alteração nos valores primitivos internos, como números, strings e booleanos, no JavaScript.

Agora, considere um objeto no state:

const [position, setPosition] = useState({ x: 0, y: 0 });

Tecnicamente, é possível alterar o conteúdo do próprio objeto. Isso é chamado de mutação:

position.x = 5;

No entanto, embora os objetos no state do React sejam tecnicamente mutáveis, você deve tratá-los como se fossem imutáveis — como números, booleanos e strings. Em vez de mutá-los, você deve sempre substituí-los.

Trate o state como somente leitura

Em outras palavras, você deve tratar qualquer objeto JavaScript que você colocar no state como somente leitura.

Este exemplo mantém um objeto no state para representar a posição atual do ponteiro. O ponto vermelho deve se mover quando você tocar ou mover o cursor sobre a área de visualização. Mas o ponto permanece na posição inicial:

Fork

import { useState } from 'react';
export default function MovingDot() {
  const [position, setPosition] = useState({
    x: 0,
    y: 0
  });
  return (
    <div
      onPointerMove={e => {
        position.x = e.clientX;
        position.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>
  );
}

O problema é com este trecho de código.

onPointerMove={e => {
  position.x = e.clientX;
  position.y = e.clientY;
}}

Esse código modifica o objeto atribuído à position da renderização anterior. Mas sem usar a função de configuração de state, o React não tem ideia de que o objeto foi alterado. Portanto, o React não faz nada em resposta. É como tentar alterar o pedido depois que você já comeu a refeição. Embora a mutação de state possa funcionar em alguns casos, não a recomendamos. Você deve tratar o valor de state ao qual tem acesso em uma renderização como somente leitura.

Para realmente acionar uma nova renderização nesse caso, crie um objeto novo e passe-o para a função de configuração de state:

onPointerMove={e => {
  setPosition({
    x: e.clientX,
    y: e.clientY
  });
}}

Com setPosition, você está dizendo ao React:

Substitua position por este novo objeto
E renderize esse componente novamente

Observe como o ponto vermelho agora segue seu ponteiro quando você toca ou passa o mouse sobre a área de visualização:

Fork

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>
  );
}

Deep Dive

Mutação local não tem problema

Um código como esse é um problema porque modifica um objeto existente no state:

position.x = e.clientX;
position.y = e.clientY;

Mas um código como esse é absolutamente aceitável porque você está alterando um objeto novo que acabou de criar:

const nextPosition = {};
nextPosition.x = e.clientX;
nextPosition.y = e.clientY;
setPosition(nextPosition);

Na verdade, é completamente equivalente a escrever isto:

setPosition({
  x: e.clientX,
  y: e.clientY
});

A mutação só é um problema quando você altera objetos existentes que já estão no state. A mutação de um objeto que você acabou de criar não tem problema porque nenhum outro código faz referência a ele ainda. Alterá-lo não afetará acidentalmente algo que depende dele. Isso é chamado de “mutação local”. Você pode até mesmo fazer a mutação local durante a renderização. Muito conveniente e completamente aceitável!

Copiando objetos com a sintaxe de espalhamento

No exemplo anterior, o objeto position é sempre criado a partir da posição atual do cursor. Mas, muitas vezes, você desejará incluir dados existentes como parte do novo objeto que está criando. Por exemplo, talvez você queira atualizar apenas um campo em um formulário, mas manter os valores anteriores de todos os outros campos.

Esses campos de entrada não funcionam porque os manipuladores onChange alteram o state:

Fork

import { useState } from 'react';

export default function Form() {
  const [person, setPerson] = useState({
    firstName: 'Barbara',
    lastName: 'Hepworth',
    email: 'bhepworth@sculpture.com'
  });

  function handleFirstNameChange(e) {
    person.firstName = e.target.value;
  }

  function handleLastNameChange(e) {
    person.lastName = e.target.value;
  }

  function handleEmailChange(e) {
    person.email = e.target.value;
  }

  return (
    <>
      <label>
        Nome:
        <input
          value={person.firstName}
          onChange={handleFirstNameChange}
        />
      </label>
      <label>
        Sobrenome:
        <input
          value={person.lastName}
          onChange={handleLastNameChange}
        />
      </label>
      <label>
        E-mail:
        <input
          value={person.email}
          onChange={handleEmailChange}
        />
      </label>
      <p>
        {person.firstName}{' '}
        {person.lastName}{' '}
        ({person.email})
      </p>
    </>
  );
}

Por exemplo, esta linha altera o state de uma renderização anterior:

person.firstName = e.target.value;

A maneira confiável de obter o comportamento que você está procurando é criar um novo objeto e passá-lo para setPerson. Mas aqui, você também deseja copiar os dados existentes para ele porque apenas um dos campos foi alterado:

setPerson({
  firstName: e.target.value, // Novo nome a partir da entrada
  lastName: person.lastName,
  email: person.email
});

Você pode usar a sintaxe de espalhamento ... para não precisar copiar cada propriedade separadamente.

setPerson({
  ...person, // Copie os campos antigos
  firstName: e.target.value // Mas substitua esse
});

Agora o formulário funciona!

Observe como você não declarou uma variável de state separada para cada campo de entrada. Para formulários grandes, manter todos os dados agrupados em um objeto é muito conveniente — desde que você os atualize corretamente!

Fork

import { useState } from 'react';

export default function Form() {
  const [person, setPerson] = useState({
    firstName: 'Barbara',
    lastName: 'Hepworth',
    email: 'bhepworth@sculpture.com'
  });

  function handleFirstNameChange(e) {
    setPerson({
      ...person,
      firstName: e.target.value
    });
  }

  function handleLastNameChange(e) {
    setPerson({
      ...person,
      lastName: e.target.value
    });
  }

  function handleEmailChange(e) {
    setPerson({
      ...person,
      email: e.target.value
    });
  }

  return (
    <>
      <label>
        Nome:
        <input
          value={person.firstName}
          onChange={handleFirstNameChange}
        />
      </label>
      <label>
        Sobrenome:
        <input
          value={person.lastName}
          onChange={handleLastNameChange}
        />
      </label>
      <label>
        E-mail:
        <input
          value={person.email}
          onChange={handleEmailChange}
        />
      </label>
      <p>
        {person.firstName}{' '}
        {person.lastName}{' '}
        ({person.email})
      </p>
    </>
  );
}

Observe que a sintaxe de espalhamento ... é “rasa” — ela copia apenas um nível de profundidade. Isso a torna rápida, mas também significa que, se você quiser atualizar uma propriedade aninhada, terá de usá-la mais de uma vez.

Deep Dive

Usando um único manipulador de eventos para vários campos

Você também pode usar as chaves [ e ] dentro da definição do objeto para especificar uma propriedade com nome dinâmico. Aqui está o mesmo exemplo, mas com um único manipulador de eventos em vez de três diferentes:

Fork

import { useState } from 'react';

export default function Form() {
  const [person, setPerson] = useState({
    firstName: 'Barbara',
    lastName: 'Hepworth',
    email: 'bhepworth@sculpture.com'
  });

  function handleChange(e) {
    setPerson({
      ...person,
      [e.target.name]: e.target.value
    });
  }

  return (
    <>
      <label>
        Nome:
        <input
          name="firstName"
          value={person.firstName}
          onChange={handleChange}
        />
      </label>
      <label>
        Sobrenome:
        <input
          name="lastName"
          value={person.lastName}
          onChange={handleChange}
        />
      </label>
      <label>
        E-mail:
        <input
          name="email"
          value={person.email}
          onChange={handleChange}
        />
      </label>
      <p>
        {person.firstName}{' '}
        {person.lastName}{' '}
        ({person.email})
      </p>
    </>
  );
}

Aqui, e.target.name refere-se à propriedade name fornecida ao elemento do DOM <input>.

Atualizando um objeto aninhado

Considere uma estrutura de objetos aninhados como esta:

const [person, setPerson] = useState({
  name: 'Niki de Saint Phalle',
  artwork: {
    title: 'Blue Nana',
    city: 'Hamburgo',
    image: 'https://i.imgur.com/Sd1AgUOm.jpg',
  }
});

Se você quisesse atualizar person.artwork.city, está claro como fazer isso com a mutação:

person.artwork.city = 'Nova Deli';

Mas no React, você trata o state como imutável! Para alterar city, você precisaria primeiro produzir o novo objeto artwork (pré-preenchido com os dados do anterior) e, em seguida, produzir o novo objeto person que aponta para o novo artwork:

const nextArtwork = { ...person.artwork, city: 'Nova Deli' };
const nextPerson = { ...person, artwork: nextArtwork };
setPerson(nextPerson);

Ou, escrito como uma única chamada de função:

setPerson({
  ...person, // Copie os outros campos
  artwork: { // mas substitua artwork
    ...person.artwork, // pelo mesmo
    city: 'Nova Deli' // mas em Nova Deli!
  }
});

Isto fica um pouco verboso, mas funciona bem em muitos casos:

Fork

import { useState } from 'react';

export default function Form() {
  const [person, setPerson] = useState({
    name: 'Niki de Saint Phalle',
    artwork: {
      title: 'Blue Nana',
      city: 'Hamburgo',
      image: 'https://i.imgur.com/Sd1AgUOm.jpg',
    }
  });

  function handleNameChange(e) {
    setPerson({
      ...person,
      name: e.target.value
    });
  }

  function handleTitleChange(e) {
    setPerson({
      ...person,
      artwork: {
        ...person.artwork,
        title: e.target.value
      }
    });
  }

  function handleCityChange(e) {
    setPerson({
      ...person,
      artwork: {
        ...person.artwork,
        city: e.target.value
      }
    });
  }

  function handleImageChange(e) {
    setPerson({
      ...person,
      artwork: {
        ...person.artwork,
        image: e.target.value
      }
    });
  }

  return (
    <>
      <label>
        Nome:
        <input
          value={person.name}
          onChange={handleNameChange}
        />
      </label>
      <label>
        Título:
        <input
          value={person.artwork.title}
          onChange={handleTitleChange}
        />
      </label>
      <label>
        Cidade:
        <input
          value={person.artwork.city}
          onChange={handleCityChange}
        />
      </label>
      <label>
        Imagem:
        <input
          value={person.artwork.image}
          onChange={handleImageChange}
        />
      </label>
      <p>
        <i>{person.artwork.title}</i>
        {' por '}
        {person.name}
        <br />
        (localizada em {person.artwork.city})
      </p>
      <img 
        src={person.artwork.image} 
        alt={person.artwork.title}
      />
    </>
  );
}

Deep Dive

Objetos não são realmente aninhados

Um objeto como este parece “aninhado” no código:

let obj = {
  name: 'Niki de Saint Phalle',
  artwork: {
    title: 'Blue Nana',
    city: 'Hamburgo',
    image: 'https://i.imgur.com/Sd1AgUOm.jpg',
  }
};

No entanto, o “aninhamento” é uma maneira imprecisa de pensar sobre como os objetos se comportam. Quando o código é executado, não existe um objeto “aninhado”. Na verdade, você está olhando para dois objetos diferentes:

let obj1 = {
  title: 'Blue Nana',
  city: 'Hamburgo',
  image: 'https://i.imgur.com/Sd1AgUOm.jpg',
};

let obj2 = {
  name: 'Niki de Saint Phalle',
  artwork: obj1
};

O objeto obj1 não está “dentro” do obj2. Por exemplo, o obj3 também poderia “apontar” para o obj1:

let obj1 = {
  title: 'Blue Nana',
  city: 'Hamburgo',
  image: 'https://i.imgur.com/Sd1AgUOm.jpg',
};

let obj2 = {
  name: 'Niki de Saint Phalle',
  artwork: obj1
};

let obj3 = {
  name: 'Copycat',
  artwork: obj1
};

Se você fizesse uma mutação em obj3.artwork.city, isso afetaria tanto obj2.artwork.city quanto obj1.city. Isso ocorre porque obj3.artwork, obj2.artwork e obj1 são o mesmo objeto. Isso é difícil de perceber quando você pensa em objetos como “aninhados”. Em vez disso, eles são objetos separados “apontando” uns para os outros com propriedades.

Escreva uma lógica de atualização concisa com Immer

Se o seu state estiver muito aninhado, talvez você deva considerar achatá-lo. Mas, se você não quiser alterar sua estrutura de estado, talvez prefira um atalho para espalhamentos aninhados. Immer é uma biblioteca popular que permite que você escreva usando a sintaxe conveniente, mas mutante, e se encarrega de produzir as cópias para você. Com a Immer, o código que você escreve parece que está “quebrando as regras” e mutando um objeto:

updatePerson(draft => {
  draft.artwork.city = 'Lagos';
});

Mas, diferentemente de uma mutação normal, ela não sobrescreve o estado anterior!

Deep Dive

Como a Immer funciona?

O draft fornecido pela Immer é um tipo especial de objeto, chamado de Proxy, que “registra” o que você faz com ele. É por isso que você pode mutá-lo livremente o quanto quiser! Por baixo dos panos, a Immer descobre quais partes do draft foram alteradas e produz um objeto completamente novo que contém suas modificações.

Para experimentar a Immer:

Execute npm install use-immer para adicionar a Immer como uma dependência
Em seguida, substitua import { useState } from 'react' por import { useImmer } from 'use-immer'

Aqui está o exemplo acima convertido para Immer:

Fork

{
  "dependencies": {
    "immer": "1.7.3",
    "react": "latest",
    "react-dom": "latest",
    "react-scripts": "latest",
    "use-immer": "0.5.1"
  },
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test --env=jsdom",
    "eject": "react-scripts eject"
  },
  "devDependencies": {}
}

Observe como os manipuladores de eventos se tornaram muito mais concisos. Você pode misturar e combinar useState e useImmer em um único componente o quanto quiser. A Immer é uma ótima maneira de manter os manipuladores de atualização concisos, especialmente se houver aninhamento em seu state e a cópia de objetos resultar em código repetitivo.

Deep Dive

Por que a mutação de state não é recomendada no React?

Existem alguns motivos:

Depuração: Se você usar console.log e não mutar o state, os logs anteriores não serão afetados pelas alterações de estado mais recentes. Assim, você poderá ver claramente como o estado foi alterado entre as renderizações.
Otimizações: As estratégias de otimização comuns do React dependem de pular o trabalho se as props ou o state anteriores forem os mesmos que os próximos. Se você nunca altera o estado, é muito rápido verificar se houve alguma alteração. Se prevObj === obj, você pode ter certeza de que nada pode ter sido alterado dentro dele.
Novas Funcionalidades: As novas funcionalidades do React que estamos criando dependem de o estado ser tratado como um snapshot. Se você estiver mutando versões anteriores do estado, isso poderá impedi-lo de usar as novas funcionalidades.
Mudanças de Requisitos: Algumas funcionalidades de aplicações, como a implementação de Desfazer/Refazer, a exibição de um histórico de alterações ou a possibilidade de o usuário retornar um formulário para valores anteriores, são mais fáceis de fazer quando nada é mutado. Isso ocorre porque você pode manter cópias anteriores do estado na memória e reutilizá-las quando for apropriado. Se você começar com uma abordagem de mutação, pode ser difícil adicionar funcionalidades como essas no futuro.
Implementação Mais Simples: Como o React não depende de mutação, ele não precisa fazer nada de especial com seus objetos. Ele não precisa sequestrar suas propriedades, sempre envolvê-las em Proxies ou fazer outro trabalho na inicialização, como fazem muitas soluções “reativas”. É também por isso que o React permite que você coloque qualquer objeto no state — independentemente do tamanho — sem problemas adicionais de desempenho ou correção.

Na prática, muitas vezes é possível “sair ileso” ao fazer mutação de state no React, mas recomendamos enfaticamente que você não faça isso para que possa usar as novas funcionalidades do React desenvolvidas com essa abordagem em mente. Os futuros colaboradores e talvez até mesmo seu futuro eu lhe agradecerão!

Recap

Trate todo o estado no React como imutável.
Quando você armazena objetos no estado, a mutação deles não acionará renderizações e alterará o estado em “snapshots” de renderização anteriores.
Em vez de mutar um objeto, crie uma versão nova dele e acione uma nova renderização definindo o state para ele.
Você pode usar a sintaxe de espalhamento de objetos {...obj, something: 'newValue'} para criar cópias de objetos.
A sintaxe de espalhamento é superficial: ela copia apenas um nível de profundidade.
Para atualizar um objeto aninhado, é necessário criar cópias em todos os níveis a partir do local que está sendo atualizado.
Para reduzir a cópia de código repetitiva, use Immer.

Try out some challenges

Challenge 1 of 3:
Correção de atualizações de state incorretas

Este formulário tem alguns erros. Clique no botão que aumenta a pontuação algumas vezes. Observe que ela não aumenta. Em seguida, edite o nome e observe que a pontuação subitamente “alcançou” suas alterações. Por fim, edite o sobrenome e observe que a pontuação desapareceu completamente.

Sua tarefa é corrigir todos esses erros. Ao corrigi-los, explique por que cada um deles acontece.

Fork

import { useState } from 'react';

export default function Scoreboard() {
  const [player, setPlayer] = useState({
    firstName: 'Ranjani',
    lastName: 'Shettar',
    score: 10,
  });

  function handlePlusClick() {
    player.score++;
  }

  function handleFirstNameChange(e) {
    setPlayer({
      ...player,
      firstName: e.target.value,
    });
  }

  function handleLastNameChange(e) {
    setPlayer({
      lastName: e.target.value
    });
  }

  return (
    <>
      <label>
        Pontuação: <b>{player.score}</b>
        {' '}
        <button onClick={handlePlusClick}>
          +1
        </button>
      </label>
      <label>
        Nome:
        <input
          value={player.firstName}
          onChange={handleFirstNameChange}
        />
      </label>
      <label>
        Sobrenome:
        <input
          value={player.lastName}
          onChange={handleLastNameChange}
        />
      </label>
    </>
  );
}

PreviousEnfileirando uma Série de Atualizações de Estado

NextAtualizando Vetores no Estado

Atualizando Objetos no State

Você aprenderá

O que é uma mutação?

Trate o state como somente leitura

Deep Dive

Mutação local não tem problema

Copiando objetos com a sintaxe de espalhamento

Deep Dive

Usando um único manipulador de eventos para vários campos

Atualizando um objeto aninhado

Deep Dive

Objetos não são realmente aninhados

Escreva uma lógica de atualização concisa com Immer

Deep Dive

Como a Immer funciona?

Deep Dive

Por que a mutação de state não é recomendada no React?

Recap

Try out some challenges

Challenge 1 of 3: Correção de atualizações de state incorretas

Challenge 1 of 3:
Correção de atualizações de state incorretas