首页
/ Immer项目中Immutable类型与WritableDraft的赋值问题解析

Immer项目中Immutable类型与WritableDraft的赋值问题解析

2025-05-05 14:10:53作者:房伟宁

概述

Immer是一个流行的JavaScript不可变状态管理库,它通过Proxy机制让我们能够以"可变"的方式处理不可变数据。在TypeScript环境下,Immer提供了ImmutableWritableDraft等类型工具来帮助开发者处理类型安全问题。然而,在实际使用中,开发者可能会遇到一个特定的类型问题:无法将Immutable类型的值直接赋值给WritableDraft类型的属性。

问题现象

当使用Immer的Immutable类型标记一个对象后,该对象及其所有属性都会被标记为readonly。例如:

type A = Immutable<{ a: number }>;
const a: A = { a: 4 };
a.a = 5; // 错误,a.a是readonly

在Immer的produce函数中,我们可以修改draft对象,因为draft实际上是WritableDraft类型:

const a2 = produce(a, (draft) => {
  draft.a = 5; // 允许修改
});

但当尝试将一个Immutable值赋给draft的属性时,TypeScript会报错:

type B = Immutable<{ arr: number[] }>;

const b1: B = { arr: [1, 2, 3] };
const b2: B = { arr: [4, 5, 6] };

produce(b1, draft => {
  draft.arr = b2.arr; // TypeScript错误
});

技术背景

这个问题源于TypeScript的类型系统设计:

  1. Immutable类型会递归地将所有属性标记为readonly
  2. WritableDraft类型会移除外层的readonly标记,允许修改
  3. 但TypeScript不允许将readonly数组赋值给可变数组,即使源和目标都是不可变的

解决方案

Immer提供了castDraft工具类型来解决这个问题:

produce(b1, draft => {
  draft.arr = castDraft(b2.arr); // 正确
});

castDraft的作用是告诉TypeScript编译器,这个值可以被安全地用作draft的一部分,即使它原本是Immutable类型。

深入理解

为什么需要这个转换?从技术角度看:

  1. Immer的不可变保证是通过结构共享实现的,而不是通过JavaScript的不可变特性
  2. 将一个Immutable值赋给draft不会破坏不可变性,因为Immer会确保最终结果仍然是不可变的
  3. TypeScript的静态类型检查无法理解Immer的运行机制,所以需要显式类型转换

最佳实践

在实际项目中,特别是Redux等状态管理场景中:

  1. 优先使用castDraft进行显式类型转换
  2. 考虑创建辅助函数封装常见模式
  3. 在团队中统一约定Immutable数据的使用规范
  4. 对于复杂场景,可以定义自定义类型工具

总结

Immer的类型系统设计在大多数情况下都能很好地工作,但在Immutable值与WritableDraft交互时会出现类型冲突。理解这一现象背后的原因,并合理使用castDraft工具,可以帮助开发者更高效地使用Immer管理不可变状态。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K