https://react-ko.dev/reference/react/useSyncExternalStore#usesyncexternalstore ์™ธ๋ถ€ ์Šคํ† ์–ด๋ฅผ ๊ตฌ๋…ํ•  ์ˆ˜ ์žˆ๋Š” React ํ›…

const snapshot = useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot?) 

Parameters

  • subscribe
    • ํ•˜๋‚˜์˜ callback ์ธ์ˆ˜๋ฅผ ๋ฐ›์•„ ์Šคํ† ์–ด๋ฅผ ๊ตฌ๋…ํ•˜๋Š” ํ•จ์ˆ˜. ์Šคํ† ์–ด๊ฐ€ ๋ณ€๊ฒฝ๋˜๋ฉด ์ธ์ˆ˜๋กœ ๋„˜์–ด์˜จ callback์„ ํ˜ธ์ถœํ•ด์•ผํ•จ. ์ด๋กœ์จ getSnapshot์„ ์‹คํ–‰์‹œํ‚ค๋„๋ก ํ•œ๋‹ค.
    • subscribe๋Š” ๊ตฌ๋…์„ ํ•ด์ œํ•˜๋Š” ํ•จ์ˆ˜๋ฅผ ๋ฐ˜ํ™˜ํ•ด์•ผํ•œ๋‹ค.
  • getSnapshot
    • ์ปดํฌ๋„ŒํŠธ์— ํ•„์š”ํ•œ ์Šคํ† ์–ด ๋ฐ์ดํ„ฐ์˜ ์Šค๋ƒ…์ƒท์„ ๋ฐ˜ํ™˜ํ•˜๋Š” ํ•จ์ˆ˜
    • ์Šคํ† ์–ด๊ฐ€ ๋ณ€๊ฒฝ๋˜์ง€ ์•Š์•˜์œผ๋ฉด ๊ฐ™์€ ๊ฐ’์„ ๋ฐ˜ํ™˜ํ•˜๊ณ , ๋ณ€๊ฒฝ๋˜์–ด ๋‹ค๋ฅธ ๊ฐ’์„ ๋ฐ˜ํ™˜ํ•˜๋ฉด(Object.is) React๋Š” ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋ฆฌ๋ Œ๋”๋งํ•œ๋‹ค.
  • getServerSnapshot
    • ์Šคํ† ์–ด์— ์žˆ๋Š” ๋ฐ์ดํ„ฐ์˜ ์ดˆ๊ธฐ ์Šค๋ƒ…์ƒท์„ ๋ฐ˜ํ™˜ํ•˜๋Š” ํ•จ์ˆ˜
    • ์„œ๋ฒ„์—์„œ ๋ Œ๋”๋งํ•  ๋•Œ์™€ ํด๋ผ์ด์–ธํŠธ์—์„œ hydrateํ•  ๋–„๋งŒ ํ˜ธ์ถœ๋œ๋‹ค.
    • ์„œ๋ฒ„ ์Šค๋ƒ…์ƒท์€ ํด๋ผ์ด์–ธํŠธ์™€ ์„œ๋ฒ„๊ฐ„์— ๋™์ผํ•ด์•ผํ•˜๋ฉฐ ์ผ๋ฐ˜์ ์œผ๋กœ ์„œ๋ฒ„์—์„œ serializeํ•˜์—ฌ ํด๋ผ์ด์–ธํŠธ๋กœ ์ „๋‹ฌํ•œ๋‹ค.
    • ์ด ํ•จ์ˆ˜๊ฐ€ ์—†์œผ๋ฉด ์„œ๋ฒ„์—์„œ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋ Œ๋”๋งํ•  ๋•Œ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•œ๋‹ค.

Returns

  • ์Šคํ† ์–ด์˜ ํ˜„์žฌ ์Šค๋ƒ…์ƒท

Caveats

  • getSnapshot์ด ๋ฐ˜ํ™˜ํ•˜๋Š” ์Šคํ† ์–ด ์Šค๋ƒ…์ƒท์€ ๋ถˆ๋ณ€ํ•ด์•ผํ•œ๋‹ค. ๋ฐ์ดํ„ฐ์— ๋ณ€์ด ๋ฐœ์ƒ ์‹œ, ์ƒˆ๋กœ์šด ๋ถˆ๋ณ€ ์Šค๋ƒ…์ƒท์„ ๋ฐ˜ํ™˜ํ•˜๋„๋ก ํ•ด์•ผํ•œ๋‹ค.
  • ๋ฆฌ๋ Œ๋”๋ง ์‹œ์— ๋‹ค๋ฅธ subscribe ํ•จ์ˆ˜๊ฐ€ ์ „๋‹ฌ๋˜๋ฉด React๋Š” ์ƒˆ๋กœ ์ „๋‹ฌ๋œ subscribe ํ•จ์ˆ˜๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์Šคํ† ์–ด๋ฅผ ๊ตฌ๋…ํ•œ๋‹ค. ์ปดํฌ๋„ŒํŠธ ์™ธ๋ถ€์—์„œ subscribe๋ฅผ ์„ ์–ธํ•˜๊ฑฐ๋‚˜ useCallback์„ ์‚ฌ์šฉํ•˜์—ฌ ์ด๋ฅผ ๋ฐฉ์ง€ํ•  ์ˆ˜ ์žˆ๋‹ค

Usage

Subscribing to an external store

๋ณดํ†ต ์ปดํฌ๋„ŒํŠธ๋Š” props, state, context๋ฅผ ์ฝ์ง€๋งŒ ์™ธ๋ถ€ ์ €์žฅ์†Œ์—์„œ ๋ฐ์ดํ„ฐ๋ฅผ ์ฝ์–ด์•ผํ•˜๋Š” ๊ฒฝ์šฐ๋„ ์žˆ๋‹ค

  • React ์™ธ๋ถ€์— state๋ฅผ ๋ณด๊ด€์ค‘์ธ ์„œ๋“œํŒŒํ‹ฐ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ
  • ๋ณ€์ด ๊ฐ€๋Šฅํ•œ ๊ฐ’์„ ๋…ธ์ถœํ•˜๋Š” ๋ธŒ๋ผ์šฐ์ € API์™€ ๊ทธ ๋ณ€์ด์‚ฌํ•ญ์„ ๊ตฌ๋…ํ•˜๋Š” ์ด๋ฒคํŠธ
// App.js
export default function TodosApp() {
  const todos = useSyncExternalStore(todosStore.subscribe, todosStore.getSnapshot);
  return (
    <>
      <button onClick={() => todosStore.addTodo()}>Add todo</button>
      <hr />
      <ul>
        {todos.map(todo => (
          <li key={todo.id}>{todo.text}</li>
        ))}
      </ul>
    </>
  );
}
// todoStore.js
 
let nextId = 0;
let todos = [{ id: nextId++, text: 'Todo #1' }];
let listeners = [];
 
export const todosStore = {
  addTodo() {
    todos = [...todos, { id: nextId++, text: 'Todo #' + nextId }]
    emitChange();
  },
  subscribe(listener) {
    listeners = [...listeners, listener];
    return () => {
      listeners = listeners.filter(l => l !== listener);
    };
  },
  getSnapshot() {
    return todos;
  }
};
 
function emitChange() {
  for (let listener of listeners) {
    listener();
  }
}
  1. subscribe ํ•จ์ˆ˜์—์„œ listener๋ฅผ ๋ฐ›์•„ ์ €์žฅํ•œ๋‹ค.
  2. button์„ ๋ˆŒ๋Ÿฌ ์™ธ๋ถ€ ์ €์žฅ์†Œ์˜ ๊ฐ’์„ ์—…๋ฐ์ดํŠธํ•œ๋‹ค.
  3. ์™ธ๋ถ€์ €์žฅ์†Œ ์—…๋ฐ์ดํŠธ ํ•จ์ˆ˜(addTodo)๋Š” ๊ตฌ๋…์ค‘์ธ ๋ชจ๋“  listener๋ฅผ ํ˜ธ์ถœํ•˜์—ฌ getSnapshot์„ ํ˜ธ์ถœํ•˜๋„๋ก ํ•œ๋‹ค.
  4. getSnapshot์„ ํ†ตํ•ด ์ƒˆ๋กœ์šด ๊ฐ’์„ ๋ฐ›์•„, Object.is๋กœ ๋น„๊ตํ•˜์—ฌ ๊ฐ’์ด ๋‹ฌ๋ผ์กŒ์œผ๋ฉด ์—…๋ฐ์ดํŠธํ•œ๋‹ค.

Subscribing to a browser API

import { useSyncExternalStore } from 'react';
 
export function useOnlineStatus() {
  const isOnline = useSyncExternalStore(subscribe, getSnapshot);
  return isOnline;
}
 
function getSnapshot() {
  return navigator.onLine;
}
 
function subscribe(callback) {
  window.addEventListener('online', callback);
  window.addEventListener('offline', callback);
  return () => {
    window.removeEventListener('online', callback);
    window.removeEventListener('offline', callback);
  };
}

Adding support for server rendering

์„ธ๋ฒˆ์จฐ ์ธ์ž๋กœ ์„œ๋ฒ„์‚ฌ์ด๋“œ์—์„œ ์ตœ์ดˆ๋ Œ๋”๋ง ์‹œ ํด๋ผ์ด์–ธํŠธ์™€ ์‹ฑํฌ๋ฅผ ๋งž์ถ”๊ธฐ ์œ„ํ•œ ํ•จ์ˆ˜๋ฅผ ์ „๋‹ฌํ•  ์ˆ˜ ์žˆ๋‹ค.

export function useOnlineStatus() {  
	const isOnline = useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);  
	return isOnline;  
}  
 
function getSnapshot() {  
	return navigator.onLine;  
}  
 
function getServerSnapshot() {  
	return true; // Always show "Online" for server-generated HTML  
}  
 
function subscribe(callback) {  
	// ...  
}