首页
/ NgRx Signals 重大变更:从 computed 到 props 的迁移指南

NgRx Signals 重大变更:从 computed 到 props 的迁移指南

2025-05-28 19:57:30作者:卓炯娓

NgRx Signals 作为 Angular 状态管理的新范式,在最新版本中引入了一项重要变更:将原先的 computed 概念全面重构为 props。这一变更影响了多个核心 API 和类型定义,本文将详细解析这一变更的背景、具体内容以及如何进行平滑迁移。

变更背景

在早期版本的 NgRx Signals 中,computed 被用于描述派生状态(derived state)的概念。但随着 API 设计的演进,开发团队发现 props 更能准确表达其作为组件输入属性的语义。这一命名变更不仅提升了代码的可读性,也为未来功能扩展打下了更坚实的基础。

主要变更点

1. 类型定义重命名

原先的 EntityComputedNamedEntityComputed 类型已更名为更简洁的 EntityPropsNamedEntityProps

// 旧版本
import { EntityComputed, NamedEntityComputed } from '@ngrx/signals/entities';

// 新版本
import { EntityProps, NamedEntityProps } from '@ngrx/signals/entities';

2. signalStoreFeature 配置变更

signalStoreFeature 的配置对象中,computed 属性已统一改为 props

// 旧版本配置方式
export function withMyFeature() {
  return signalStoreFeature(
    { computed: type<{ num: Signal<number> }>() },
    // ...
  );
}

// 新版本配置方式
export function withMyFeature() {
  return signalStoreFeature(
    { props: type<{ num: Signal<number> }>() },
    // ...
  );
}

3. 泛型参数变更

SignalStoreFeature 泛型参数中的 computed 也相应变更为 props

// 旧版本泛型定义
export function withMyFeature(): SignalStoreFeature<
  { state: {}, computed: { num1: Signal<number> }, methods: {} },
  { state: {}, computed: { num2: Signal<number> }, methods: {} },
> {
  // ...
}

// 新版本泛型定义
export function withMyFeature(): SignalStoreFeature<
  { state: {}, props: { num1: Signal<number> }, methods: {} },
  { state: {}, props: { num2: Signal<number> }, methods: {} },
> {
  // ...
}

迁移建议

对于大型项目,手动修改这些变更可能比较耗时。NgRx 团队已经提供了自动迁移工具(schematic)来简化这一过程。开发者可以通过以下步骤完成迁移:

  1. 确保项目已更新到最新版本的 @ngrx/signals
  2. 运行 NgRx 提供的迁移 schematic
  3. 检查并验证自动迁移的结果
  4. 手动处理任何未被自动迁移的特殊情况

变更带来的优势

这一命名变更带来了几个显著优势:

  1. 语义更清晰propscomputed 更能准确表达这些属性的用途
  2. 一致性增强:与前端生态中其他流行框架(如 React、Vue)的术语保持一致
  3. 扩展性更好:为未来可能添加的更多属性类型预留了设计空间

总结

NgRx Signals 从 computedprops 的变更是框架演进过程中的重要一步,虽然带来了短暂的迁移成本,但从长远来看将显著提升代码的可维护性和可读性。开发者应尽快完成迁移以享受新版本带来的各种改进和未来可能的新特性。

登录后查看全文
热门项目推荐
相关项目推荐