在线演练

改变输入，看 restate 如何响应。

七个实验运行的都是真正的包。左边的控制器属于本网站；右边的示例只接收 props，所以它的代码就是你实际要写的代码。

控制器 — 仅属于网站props — 连接两者的桥示例 — 你复制的代码

两个界面，一个 store

多个组件需要同一个值。声明一次，到处都能读取。

观察要点

点击步进按钮：所有读取方同时显示新的数字。
改变读取方的数量：新的读取方从当前值开始。

控制器不属于示例代码。值以 props 的形式传给示例。

读取方readers
步长step

<Example
  readers={3}
  step={1}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { restate } from '@kkwaenggwari/restate';
import './styles.css';

const useCount = restate(0);

function Reader({ name }) {
  const count = useCount();

  return (
    <section className="card">
      <span>{name}</span>
      <output>{count}</output>
    </section>
  );
}

export default function Example({ readers = 3, step = 1 }) {
  return (
    <main>
      <div className="grid">
        {Array.from({ length: readers }, (_, index) => (
          <Reader key={index} name={`界面 ${index + 1}`} />
        ))}
      </div>
      <div className="actions">
        <button onClick={() => useCount.set((count) => count + step)}>+{step}</button>
        <button onClick={() => useCount.reset()}>重置</button>
      </div>
    </main>
  );
}

快速开始

只渲染变化的部分

大型 store 不应该在每次变化时都重新渲染所有组件。

观察要点

编辑留言：只有读取整个 store 的卡片会渲染。
添加商品：商品和摘要渲染，优惠券卡片保持不动。
关闭 shallow：摘要每次变化都会渲染，因为它的 selector 每次都返回新对象。

控制器不属于示例代码。值以 props 的形式传给示例。

用 shallow 比较摘要shallowSummary

<Example
  shallowSummary={true}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { memo, useRef } from 'react';
import { restate, shallow } from '@kkwaenggwari/restate';
import './styles.css';

const useCart = restate({ items: ['Book'], coupon: '', note: '' });

function Card({ title, value }) {
  const renders = useRef(0);
  renders.current += 1;

  return (
    <section className="card">
      <span>{title}</span>
      <output>{value}</output>
      <small>{`渲染 ${renders.current} 次`}</small>
    </section>
  );
}

const ItemCount = memo(function ItemCount() {
  const count = useCart((cart) => cart.items.length);
  return <Card title="商品" value={count} />;
});

const Coupon = memo(function Coupon() {
  const coupon = useCart((cart) => cart.coupon);
  return <Card title="优惠券" value={coupon || '无'} />;
});

const Summary = memo(function Summary({ compare }) {
  const summary = useCart((cart) => ({ count: cart.items.length, coupon: cart.coupon }), compare);
  return <Card title="摘要" value={`${summary.count} · ${summary.coupon || '-'}`} />;
});

const Whole = memo(function Whole() {
  const cart = useCart();
  return <Card title="整个 store" value={cart.note.length} />;
});

export default function Example({ shallowSummary = true }) {
  return (
    <main>
      <div className="grid">
        <ItemCount />
        <Coupon />
        <Summary compare={shallowSummary ? shallow : undefined} />
        <Whole />
      </div>
      <div className="actions">
        <button onClick={() => useCart.set((cart) => ({ ...cart, items: [...cart.items, 'Pen'] }))}>
          添加商品
        </button>
        <button
          onClick={() => useCart.set((cart) => ({ ...cart, coupon: cart.coupon ? '' : 'SPRING' }))}
        >
          切换优惠券
        </button>
        <button onClick={() => useCart.set((cart) => ({ ...cart, note: cart.note + '!' }))}>
          编辑留言
        </button>
      </div>
    </main>
  );
}

只订阅需要的部分

多次变化，一次通知

逐个更新两个 store，会让订阅者看到一个只改了一半的状态。

观察要点

分别清空：订阅者会同时看到 0 件商品和旧的优惠券。
用 batch 清空：两个 store 都变化后，订阅者只运行一次。

控制器不属于示例代码。值以 props 的形式传给示例。

商品quantity
优惠券coupon

<Example
  quantity={3}
  coupon="SPRING"
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { useEffect, useState } from 'react';
import { batch, restate } from '@kkwaenggwari/restate';
import './styles.css';

const useItems = restate([]);
const useCoupon = restate('');

export default function Example({ quantity = 3, coupon = 'SPRING' }) {
  const items = useItems();
  const code = useCoupon();
  const [notices, setNotices] = useState([]);

  useEffect(() => {
    useItems.set(Array.from({ length: quantity }, (_, index) => `#${index + 1}`));
    useCoupon.set(coupon);
    setNotices([]);
  }, [quantity, coupon]);

  useEffect(
    () =>
      useItems.subscribe((next) => {
        const notice = `收到通知：${next.length} 件商品 · 优惠券 ${useCoupon.get() || '-'}`;
        setNotices((list) => [...list, notice]);
      }),
    [],
  );

  const clear = () => {
    useItems.set([]);
    useCoupon.set('');
  };

  return (
    <main>
      <div className="grid">
        <section className="card">
          <span>商品</span>
          <output>{items.length}</output>
        </section>
        <section className="card">
          <span>优惠券</span>
          <output>{code || '-'}</output>
        </section>
      </div>
      <div className="actions">
        <button onClick={clear}>分别清空</button>
        <button onClick={() => batch(clear)}>用 batch 清空</button>
      </div>
      <h2>订阅者看到的内容</h2>
      <ol className="log">
        {notices.length ? (
          notices.map((notice, index) => <li key={index}>{notice}</li>)
        ) : (
          <li>还没有通知。</li>
        )}
      </ol>
    </main>
  );
}

只订阅需要的部分

何时保存由你决定

编辑只改变内存。保存是一个显式操作，状态会显示正在发生什么。

观察要点

输入：dirty 变为开启，此时还没有写入任何内容。
调高延迟后保存：写入进行时 operation 显示 save。
重新播放：已保存的草稿会从 IndexedDB 恢复。

控制器不属于示例代码。值以 props 的形式传给示例。

存储延迟latency

<Example
  latency={600}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { useEffect } from 'react';
import { persistedRestate } from '@kkwaenggwari/restate';
import { settings, slowStorage } from './storage.js';
import './styles.css';

const useDraft = persistedRestate('', { key: 'playground-draft', storage: slowStorage });

export default function Example({ latency = 600 }) {
  useEffect(() => {
    settings.latency = latency;
  }, [latency]);

  const text = useDraft();
  const { dirty, operation, pending, lastSavedAt } = useDraft.useStatus();
  // A failed save keeps dirty and records status.error.
  const save = () => useDraft.save().catch(() => {});
  const revert = () => useDraft.restore().catch(() => {});

  return (
    <main>
      <label>
        草稿
        <textarea value={text} onChange={(event) => useDraft.set(event.target.value)} />
      </label>
      <div className="actions">
        <button disabled={!dirty} onClick={save}>
          保存
        </button>
        <button disabled={!dirty} onClick={revert}>
          撤销修改
        </button>
      </div>
      <dl className="status">
        <dt>dirty</dt>
        <dd className={dirty ? 'warn' : 'ok'}>{dirty ? '有未保存的修改' : '已保存'}</dd>
        <dt>operation</dt>
        <dd>{operation ?? '无'}</dd>
        <dt>pending</dt>
        <dd>{pending}</dd>
        <dt>lastSavedAt</dt>
        <dd>{lastSavedAt ? new Date(lastSavedAt).toLocaleTimeString() : '尚未'}</dd>
      </dl>
    </main>
  );
}

storage.js

import { createIndexedDBStorage } from '@kkwaenggwari/restate';

// IndexedDB with an adjustable delay, to watch operations in progress.
const indexedDB = createIndexedDBStorage();
export const settings = { latency: 0 };
const wait = () => new Promise((resolve) => setTimeout(resolve, settings.latency));

export const slowStorage = {
  async getItem(key) {
    await wait();
    return indexedDB.getItem(key);
  },
  async setItem(key, value) {
    await wait();
    return indexedDB.setItem(key, value);
  },
  async removeItem(key) {
    await wait();
    return indexedDB.removeItem(key);
  },
};

何时保存由你决定

打字再快，也只写一次

每次按键都保存会让存储不堪重负。autoSave 会等待输入停顿。

观察要点

输入一句话：编辑次数迅速增加，而写入次数在每次停顿后只加一。
选择“每次变化”：每次编辑都会写入，但改回已保存的值时不会写入。

控制器不属于示例代码。值以 props 的形式传给示例。

autoSave 延迟delayMs

<Example
  delayMs={800}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { useState } from 'react';
import { persistedRestate, useRestateScope } from '@kkwaenggwari/restate';
import { countingStorage, useWrites } from './storage.js';
import './styles.css';

function Note({ delayMs }) {
  const useNote = useRestateScope((scope) =>
    persistedRestate('', {
      scope,
      key: 'note',
      storage: countingStorage,
      autoSave: delayMs ? { delayMs } : true,
    }),
  );
  const note = useNote();
  const dirty = useNote.useStatus((status) => status.dirty);
  const writes = useWrites();
  const [edits, setEdits] = useState(0);

  return (
    <>
      <label>
        备注
        <textarea
          value={note}
          placeholder="快速输入一句话…"
          onChange={(event) => {
            useNote.set(event.target.value);
            setEdits((count) => count + 1);
          }}
        />
      </label>
      <div className="grid">
        <section className="card">
          <span>编辑</span>
          <output>{edits}</output>
        </section>
        <section className="card accent">
          <span>存储写入</span>
          <output>{writes}</output>
        </section>
      </div>
      <p className={dirty ? 'badge warn' : 'badge ok'}>{dirty ? '等待输入停顿' : '已保存'}</p>
    </>
  );
}

export default function Example({ delayMs = 800 }) {
  // autoSave is part of the declaration: a new delay starts a new scope.
  return (
    <main>
      <Note key={delayMs} delayMs={delayMs} />
    </main>
  );
}

storage.js

import { restate } from '@kkwaenggwari/restate';

// An in-memory storage adapter that counts real writes.
const records = new Map();
export const useWrites = restate(0);

export const countingStorage = {
  getItem: (key) => records.get(key) ?? null,
  setItem: (key, value) => {
    records.set(key, value);
    useWrites.set((count) => count + 1);
  },
  removeItem: (key) => {
    records.delete(key);
  },
};

何时保存由你决定

故障实验室

让存储变慢、出错或不可用，看看 restate 如何保住你的数据并报告问题。

观察要点

调高延迟后保存三次：这些请求共享同一次写入，所以 pending 保持为 1，三个结果同时返回。
开启写入失败后保存：dirty 保持为 true，error 显示原因。
让存储不可用：保存会以 STORAGE_UNAVAILABLE 被拒绝，但编辑照常进行。

控制器不属于示例代码。值以 props 的形式传给示例。

延迟latency
写入失败failWrites
存储不可用unavailable

<Example
  latency={700}
  failWrites={false}
  unavailable={false}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { useEffect, useState } from 'react';
import { persistedRestate } from '@kkwaenggwari/restate';
import { flakyStorage, settings } from './storage.js';
import './styles.css';

const useNote = persistedRestate('', { key: 'lab-note', storage: flakyStorage });

export default function Example({ latency = 700, failWrites = false, unavailable = false }) {
  useEffect(() => {
    Object.assign(settings, { latency, failWrites, unavailable });
  }, [latency, failWrites, unavailable]);

  const note = useNote();
  const { dirty, operation, pending, error } = useNote.useStatus();
  const [results, setResults] = useState([]);

  const save = () =>
    useNote.save().then(
      (value) => setResults((list) => [`已保存 ${JSON.stringify(value)}`, ...list]),
      (reason) => setResults((list) => [`失败：${reason.code ?? reason.message}`, ...list]),
    );

  return (
    <main>
      <label>
        备注
        <input value={note} onChange={(event) => useNote.set(event.target.value)} />
      </label>
      <div className="actions">
        <button onClick={save}>保存</button>
        <button
          onClick={() => {
            save();
            save();
            save();
          }}
        >
          保存三次
        </button>
      </div>
      <dl className="status">
        <dt>dirty</dt>
        <dd className={dirty ? 'warn' : 'ok'}>{String(dirty)}</dd>
        <dt>operation</dt>
        <dd>{operation ?? '-'}</dd>
        <dt>pending</dt>
        <dd>{pending}</dd>
        <dt>error</dt>
        <dd className={error ? 'bad' : ''}>{error ? (error.code ?? error.message) : '-'}</dd>
      </dl>
      <h2>结果</h2>
      <ol className="log">
        {results.length ? (
          results.map((result, index) => <li key={results.length - index}>{result}</li>)
        ) : (
          <li>-</li>
        )}
      </ol>
    </main>
  );
}

storage.js

// A storage adapter whose speed and failures you can change.
const records = new Map();
export const settings = { latency: 0, failWrites: false, unavailable: false };
const wait = () => new Promise((resolve) => setTimeout(resolve, settings.latency));

export const flakyStorage = {
  isAvailable: () => !settings.unavailable,
  async getItem(key) {
    await wait();
    return records.get(key) ?? null;
  },
  async setItem(key, value) {
    await wait();
    if (settings.failWrites) throw new Error('磁盘已满');
    records.set(key, value);
  },
  async removeItem(key) {
    await wait();
    records.delete(key);
  },
};

可靠性设计

按文档区分的状态

每个打开的文档都需要自己的状态，并在文档关闭时释放。

观察要点

先在文档 A 中输入，再在 B 中输入：它们各自保留自己的文字。
关闭文档 A 再重新打开：它从空白开始，因为它的 scope 已被销毁。

控制器不属于示例代码。值以 props 的形式传给示例。

文档documents
打开文档 AfirstOpen

<Example
  documents={2}
  firstOpen={true}
/>

正在准备示例…

在线示例需要 JavaScript，下方代码可以直接阅读。

App.jsx

import { restate, useRestateScope } from '@kkwaenggwari/restate';
import './styles.css';

function Document({ name }) {
  const useText = useRestateScope((scope) => restate('', { scope }));
  const text = useText();

  return (
    <section className="card">
      <span>{name}</span>
      <input
        value={text}
        placeholder="只在这里输入"
        onChange={(event) => useText.set(event.target.value)}
      />
      <small>{`${text.length} 个字符`}</small>
    </section>
  );
}

export default function Example({ documents = 2, firstOpen = true }) {
  const names = ['A', 'B', 'C'].slice(0, documents);

  return (
    <main>
      <div className="grid">
        {names.map((name, index) =>
          index === 0 && !firstOpen ? null : <Document key={name} name={`文档 ${name}`} />,
        )}
      </div>
    </main>
  );
}

组件拥有的状态