NgRx Signals 信号存储中的私有成员实现方案

背景与需求

在现代前端状态管理中，封装性是一个重要的设计考量。NgRx Signals 作为 Angular 状态管理的新方案，开发者希望能够像类一样定义私有成员，以隐藏内部实现细节，只暴露必要的公共接口。

解决方案设计

NgRx Signals 团队提出了一种基于命名约定的私有成员实现方案，通过在成员名前添加下划线 _ 前缀来标记私有性：

export const CounterStore = signalStore(
  withState({
    count1: 0,        // 公共状态
    _count2: 0,       // 私有状态
  }),
  withComputed(({ count1, _count2 }) => ({
    _doubleCount1: computed(() => count1() * 2),  // 私有计算信号
    doubleCount2: computed(() => _count2() * 2),  // 公共计算信号
  })),
  withMethods((store) => ({
    increment1(): void { ... },    // 公共方法
    _increment2(): void { ... },   // 私有方法
  })),
);

类型安全实现

这种私有性是通过 TypeScript 的类型系统实现的，类似于类的私有字段：

const store = inject(CounterStore);

store.count1();      // 允许访问
store._count2();     // 类型错误

虽然可以通过类型断言绕过这一限制，但这为开发者提供了明确的接口边界。

状态保护机制

即使在未受保护的状态配置下，私有状态切片仍然受到保护：

const store = signalStore(
  { protectedState: false },
  withState({ count1: 0, _count2: 0 }),
);

patchState(store, { _count2: 10 });  // 编译时错误

自定义特性中的私有成员

在自定义 SignalStore 特性中，私有成员对使用该特性的 Store 可见。如需限制可见性，开发者可以：

1. 显式指定返回类型
2. 使用 Symbol 作为键名

// 方法1：显式类型
export function withCount(): SignalStoreFeature<
  EmptyFeatureResult,
  { state: { count2: number }; computed: {}; methods: {} }
> {
  return signalStoreFeature(withState({ count1: 0, count2: 0 }));
}

// 方法2：使用Symbol
const FOO = Symbol('FOO');
export function withFoo() {
  return signalStoreFeature(withMethods({ [FOO]: () => {} }));
}

实体集合的私有化处理

对于实体集合，可以通过在集合名前添加 _ 前缀实现整体私有化，然后选择性公开：

const todoConfig = entityConfig({
  entity: type<Todo>(),
  collection: '_todo',  // 私有集合
});

const TodosStore = signalStore(
  withEntities(todoConfig),
  withComputed(({ _todoEntities }) => ({
    todos: _todoEntities,  // 公开实体数组
  }))
);

技术价值与最佳实践

这种设计为 NgRx Signals 带来了以下优势：

1. 更好的封装性：隐藏内部实现细节，减少意外修改
2. 清晰的接口边界：通过类型系统明确区分公共和私有API
3. 渐进式采用：开发者可以根据需要逐步引入私有成员

建议开发者在设计 Store 时：

• 将可能变化的实现细节标记为私有
• 仅暴露必要的状态和方法
• 在自定义特性中谨慎处理可见性

这种模式为复杂应用的状态管理提供了更好的组织结构，同时保持了 NgRx Signals 的简洁性和可组合性。