re:re:actable
Урок 044 минуты чтения

Задача: useLocalStorage

На этой странице
Кратко

useLocalStorage(key, initialValue) работает как useState, но сохраняет значение в localStorage и восстанавливает его после перезагрузки. Важные детали: ленивая инициализация (читать хранилище один раз), try/catch вокруг JSON.parse и доступа к хранилищу (поврежденные данные, приватный режим, переполнение квоты), поддержка функционального обновления, синхронизация между вкладками через событие storage и работа при SSR, где window нет.

Вопрос

Реализуйте хук useLocalStorage<T>(key, initialValue) с API как у useState, обработкой ошибок, синхронизацией между вкладками и безопасной работой при SSR.

Решение

import { useCallback, useEffect, useState } from "react";
 
function readValue<T>(key: string, initialValue: T): T {
  if (typeof window === "undefined") return initialValue;     // SSR
  try {
    const raw = window.localStorage.getItem(key);
    return raw === null ? initialValue : (JSON.parse(raw) as T);
  } catch {
    return initialValue;                                      // поврежденный JSON или запрет доступа
  }
}
 
export function useLocalStorage<T>(key: string, initialValue: T) {
  const [value, setValue] = useState<T>(() => readValue(key, initialValue)); // читаем один раз
 
  const setStoredValue = useCallback(
    (next: T | ((prev: T) => T)) => {
      setValue((prev) => {
        const resolved = next instanceof Function ? next(prev) : next;
        try {
          window.localStorage.setItem(key, JSON.stringify(resolved));
        } catch (error) {
          console.warn(`Не удалось сохранить "${key}"`, error);   // QuotaExceededError, приватный режим
        }
        return resolved;
      });
    },
    [key],
  );
 
  const remove = useCallback(() => {
    try { window.localStorage.removeItem(key); } catch {}
    setValue(initialValue);
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [key]);
 
  useEffect(() => {
    function onStorage(event: StorageEvent) {
      if (event.storageArea === window.localStorage && event.key === key) {
        setValue(event.newValue === null ? initialValue : JSON.parse(event.newValue));
      }
    }
    window.addEventListener("storage", onStorage);           // изменения из других вкладок
    return () => window.removeEventListener("storage", onStorage);
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [key]);
 
  return [value, setStoredValue, remove] as const;
}

Использование

function ThemeSwitcher() {
  const [theme, setTheme] = useLocalStorage<"light" | "dark">("theme", "light");
 
  useEffect(() => {
    document.documentElement.dataset.theme = theme;
  }, [theme]);
 
  return (
    <button onClick={() => setTheme((t) => (t === "light" ? "dark" : "light"))}>
      Тема: {theme}
    </button>
  );
}

Нюансы

ПроблемаРешение
window нет на серверепроверка typeof window или чтение в useEffect после монтирования
hydration mismatch (сервер рендерит initialValue, клиент — сохраненное)читать после монтирования или useSyncExternalStore с getServerSnapshot
поврежденный JSONtry/catch при чтении
переполнение квоты, приватный режим Safaritry/catch при записи
несколько вкладоксобытие storage (срабатывает только в других вкладках)
несколько компонентов с одним ключом в одной вкладкеобщий store или useSyncExternalStore + собственное событие
чувствительные данныене хранить токены и персональные данные — доступны любому скрипту

Вариант на useSyncExternalStore

const subscribe = (callback: () => void) => {
  window.addEventListener("storage", callback);
  return () => window.removeEventListener("storage", callback);
};
 
export function useStoredString(key: string, fallback: string) {
  return useSyncExternalStore(
    subscribe,
    () => localStorage.getItem(key) ?? fallback,   // строка сравнивается по значению — без лишних ререндеров
    () => fallback,                                 // сервер
  );
}

Доп. вопросы интервьюера

  • Почему ленивая инициализация useState(() => ...)? чтобы не читать хранилище и не парсить JSON при каждом рендере.
  • Почему next instanceof Function? поддержать setValue(prev => ...), как у useState.
  • Почему событие storage не срабатывает в текущей вкладке? так устроен стандарт: оно для синхронизации других контекстов.
  • Что хранить в localStorage? настройки интерфейса, черновики, кеш некритичных данных — до ~5 МБ, только строки.

Что важно помнить

  • localStorage синхронный — не храните большие данные, для них IndexedDB.
  • Значения — строки: сериализуйте через JSON.stringify, Date превратится в строку.
  • Не храните секреты: XSS прочитает всё.
  • Теория: модель данных и хранилища, useSyncExternalStore.

Мини-шпаргалка

useState(() => read()) с try/catch и проверкой window. Сеттер: функциональное обновление + setItem в try/catch. storage-событие для других вкладок. SSR — читать после монтирования или useSyncExternalStore. Не хранить секреты.

Документация

MDN: Window.localStorage, MDN: StorageEvent, React: useSyncExternalStore, React: Avoiding recreating the initial state.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам