跳到主要内容

用户存储

UserStore 是会话管理器。它处理登录与注册,维护当前用户,并在身份验证完成后编排数据加载。

功能说明​

初始化后,存储为空。用户登录后,它会:

  1. 为该适配器创建一个 ESPCDFUser 实体
  2. 暴露 auth 服务,用于登录、注册、OAuth 和密码找回
  3. 提供 user.getGroups(),用群组和设备引导加载应用
  4. 退出登录时清空全部数据

多适配器配置下,每个适配器维护一个用户。

API 参考​

属性​

属性类型用途
userESPCDFUser | undefined当前适配器下已登录的用户
adaptorAuthorizationEntityMapRecord<string, ESPCDFUser> | null适配器 ID 到用户实体的映射(多适配器)
authAuth认证服务:登录、注册、OAuth、重置密码

获取存储实例​

import { initCDF } from "@espressif/rainmaker-base-cdf";

const espCDF = await initCDF({ sdkAdaptorRegistry });
const { userStore } = espCDF;

使用方法​

使用密码登录​

await espCDF.userStore.auth.login({
username: "user@example.com",
password: "••••",
});

使用 OAuth 登录​

await espCDF.userStore.auth.loginWithOauth({
identityProvider: "google",
// 已设置当前适配器时,adaptorIdentifier 可选
});

注册​

// 步骤 1:请求注册验证码
await espCDF.userStore.auth.getSignUpCode({
username: "user@example.com",
password: "••••",
});

// 步骤 2:确认
await espCDF.userStore.auth.confirmSignUp({
username: "user@example.com",
verificationCode: "789012",
});

忘记密码​

await espCDF.userStore.auth.forgotPassword({ username: "user@example.com" });
await espCDF.userStore.auth.setNewPassword({
username: "user@example.com",
newPassword: "••••",
verificationCode: "345678",
});

恢复已有会话​

在应用启动时调用 restoreSession,检查用户是否仍处于登录状态:

const user = await espCDF.userStore.restoreSession();
if (user) {
// 已找到会话,继续拉取数据
} else {
// 无会话,显示登录界面
}

访问当前用户实体​

const user = espCDF.userStore.user; // ESPCDFUser | undefined

获取群组与节点​

用户实体是分层数据拉取的入口:

const user = espCDF.userStore.user!;

// 获取群组:UserStoreSynchronizer 会自动填充 GroupStore
await user.getGroups();

// getGroups 之后,群组可在 GroupStore 中观察
const groups = espCDF.groupStore.groupsList;

退出登录​

await user.logout();
// UserStoreSynchronizer 会清空所有存储

响应式会话显示​

import { observer } from "mobx-react-lite";
import type { ESPCDF } from "@espressif/rainmaker-base-cdf";

const UserProfileBadge = observer(function UserProfileBadge({
espCDF,
}: {
espCDF: ESPCDF;
}) {
const user = espCDF.userStore.user;

if (!user) return <LoginButton />;
return <Text>{user.userInfo.name ?? user.userInfo.email}</Text>;
});

资料操作​

资料编辑、自定义数据和账号删除请直接使用用户实体。完整操作见 ESPCDFUser。

多适配器配置​

在支持多个 SDK 的应用中,按适配器管理用户:

// 获取指定适配器的用户
const rainmakerUser = espCDF.userStore.getAuthorizationEntityForAdaptor("rainmaker-base-sdk");

// 为指定适配器设置用户(auth.login 会自动完成)
espCDF.userStore.setAuthorizationEntityForAdaptor("rainmaker-base-sdk", userEntity);

// 移除指定适配器的会话
espCDF.userStore.removeAuthorizationEntityForAdaptor("rainmaker-base-sdk");

// 清除所有会话
espCDF.userStore.removeAuthorizationEntityForAdaptor();

响应式用户显示​

import { observer } from "mobx-react-lite";
import type { ESPCDF } from "@espressif/rainmaker-base-cdf";

const UserProfileBadge = observer(function UserProfileBadge({
espCDF,
}: {
espCDF: ESPCDF;
}) {
const user = espCDF.userStore.user;

if (!user) return <LoginButton />;
return <Text>{user.userInfo.name ?? user.userInfo.email}</Text>;
});

另请参阅​

核心实体

实现

API 参考

On this page