useStore

API 参考

语法

const state = useStore(store, options?)

参数

store: ZenBox store 实例
options (可选):
- pick: 用于选择性订阅的属性名称数组
- deep: 启用深度比较以处理嵌套对象（默认：false）

返回值

当前 store 状态，或使用 pick 选项时返回选定的属性。

示例

完整 Store 订阅

订阅所有 store 状态变化以实现完整响应式更新：

import { createStore, useStore } from "zenbox";

const userStore = createStore({
  name: "张三",
  age: 30,
  email: "zhangsan@example.com",
});

function UserProfile() {
  // useStore 的任意属性发生变化，都会触发重新渲染
  const user = useStore(userStore);

  return (
    <div>
      <h1>{user.name}</h1>
      <p>年龄: {user.age}</p>
      <p>邮箱: {user.email}</p>
    </div>
  );
}

选择性订阅

仅订阅所需属性以优化性能：

function UserName() {
  // 仅在 'name' 变化时重新渲染
  const name = useStore(
    userStore,
    (state) => state.name // 使用 selector 订阅指定属性
  );
  return <h1>{name}</h1>;
}

function UserContact() {
  // 仅在 'name' 或 'email' 变化时重新渲染
  const { name, email } = useStore(userStore, {
    pick: ["name", "email"], // 使用 pick 订阅指定属性
  });

  return (
    <div>
      <p>姓名: {name}</p>
      <p>邮箱: {email}</p>
    </div>
  );
}

深度比较

对于需要深度比较的复杂嵌套对象：

const settingsStore = createStore({
  theme: {
    colors: { primary: "#blue", secondary: "#gray" },
    typography: { fontSize: 16, fontFamily: "Arial" },
  },
  preferences: {
    notifications: true,
    autoSave: false,
  },
});

function ThemeDisplay() {
  const { theme } = useStore(settingsStore, {
    pick: ["theme"],
    deep: true, // 启用深度比较，避免不必要的重新渲染
  });

  return (
    <div style={{ color: theme.colors.primary }}>
      主题: {theme.colors.primary}
    </div>
  );
}

最佳实践

✅ 大型 store 使用选择性订阅

// Good：仅订阅所需属性
const { name, status } = useStore(largeStore, {
  pick: ["name", "status"],
});

❌ 仅需要特定属性时避免完整订阅

// 低效：订阅所有状态变化
const store = useStore(largeStore);
return <div>{store.name}</div>; // 仅使用 name，但订阅了所有状态

✅ 性能优先使用浅层监听

// 默认的浅层比较能够满足大多数情况
const user = useStore(userStore);

❌ 非必要时不要使用深度监听

// 昂贵：仅在需要深度对象比较时使用
const data = useStore(store, { deep: true });

Hook 比较

Hook	用途	重新渲染	最适用于
`useStore`	完整 store 订阅	✅ 是	所有 store 状态
`usePick`	选择性属性订阅	✅ 是	特定属性
`useComputed`	响应式更新的计算值	✅ 是	计算数据
`useWatch`	监听状态变化并执行副作用	❌ 否	日志、API

API 参考

语法

参数

返回值

示例

完整 Store 订阅

选择性订阅

深度比较

最佳实践

Hook 比较

相关 Hook

目录