typescript 中的 Readonly 工具类型

Readonly 工具类型背景

在 TypeScript 中，Readonly 是一个内置的工具类型，用于将对象类型的所有属性设为只读。这意味着这些属性不能被重新分配。

使用场景

Readonly 常用于确保对象的不可变性，防止意外修改数据，特别是在函数参数中传递对象时。

代码示例

1
2
3
4
5
6
7
8
9
10
11
12
interface User {
  name: string;
  age: number;
}

const user: Readonly<User> = {
  name: "Alice",
  age: 30
};

// 错误：无法为 'name' 赋值，因为它是只读属性。
// user.name = "Bob";

参数说明

  • User: 定义了一个用户接口。
  • user: 用 Readonly<User> 创建一个用户实例，使其属性不可修改。

注意点

  • Readonly 只能限制顶层属性，对于嵌套对象无效。需要深度不可变性时，可以考虑第三方库如 Immutable.js。

Readonly vs. Const

特性 Readonly const
应用范围 对象的属性 原始值和引用
修改限制 属性不可更改 引用不可更改
使用位置 类型注解 变量声明

原因

使用 Readonly 的原因在于提供一种类型安全机制，使得对象在某些上下文中保持不变，减少错误几率并提高代码的可读性和维护性。