https://react-ko.dev/reference/react/useSyncExternalStore#usesyncexternalstore ์ธ๋ถ ์คํ ์ด๋ฅผ ๊ตฌ๋ ํ ์ ์๋ React ํ
const snapshot = useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot?) Parameters
subscribe- ํ๋์ callback ์ธ์๋ฅผ ๋ฐ์ ์คํ ์ด๋ฅผ ๊ตฌ๋
ํ๋ ํจ์. ์คํ ์ด๊ฐ ๋ณ๊ฒฝ๋๋ฉด ์ธ์๋ก ๋์ด์จ callback์ ํธ์ถํด์ผํจ. ์ด๋ก์จ
getSnapshot์ ์คํ์ํค๋๋ก ํ๋ค. subscribe๋ ๊ตฌ๋ ์ ํด์ ํ๋ ํจ์๋ฅผ ๋ฐํํด์ผํ๋ค.
- ํ๋์ callback ์ธ์๋ฅผ ๋ฐ์ ์คํ ์ด๋ฅผ ๊ตฌ๋
ํ๋ ํจ์. ์คํ ์ด๊ฐ ๋ณ๊ฒฝ๋๋ฉด ์ธ์๋ก ๋์ด์จ callback์ ํธ์ถํด์ผํจ. ์ด๋ก์จ
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();
}
}subscribeํจ์์์listener๋ฅผ ๋ฐ์ ์ ์ฅํ๋ค.button์ ๋๋ฌ ์ธ๋ถ ์ ์ฅ์์ ๊ฐ์ ์ ๋ฐ์ดํธํ๋ค.- ์ธ๋ถ์ ์ฅ์ ์
๋ฐ์ดํธ ํจ์(
addTodo)๋ ๊ตฌ๋ ์ค์ธ ๋ชจ๋ listener๋ฅผ ํธ์ถํ์ฌgetSnapshot์ ํธ์ถํ๋๋ก ํ๋ค. 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) {
// ...
}