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

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

2025-05-05 01:36:27作者:房伟宁

概述

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管理不可变状态。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
27
11
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
466
3.47 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
flutter_flutterflutter_flutter
暂无简介
Dart
715
172
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
203
82
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
695
rainbondrainbond
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
15
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1