biye-note

Appearance

TypeScript 的对象类型 ​

简介 ​

除了原始类型，对象是 JavaScript 最基本的数据结构。TypeScript 对于对象类型有很多规则。

对象类型的最简单声明方法，就是使用大括号表示对象，在大括号内部声明每个属性和方法的类型。

ts
const obj: {
	x: number
	y: number
} = { x: 1, y: 1 }

上面示例中，对象obj的类型就写在变量名后面，使用大括号描述，内部声明每个属性的属性名和类型。

属性的类型可以用分号结尾，也可以用逗号结尾。

ts
// 属性类型以分号结尾
type MyObj = {
  x: number;
  y: number;
};

// 属性类型以逗号结尾
type MyObj2 = {
  x: number,
  y: number,
};

最后一个属性后面，可以写分号或逗号，也可以不写。

一旦声明了类型，对象赋值时，就不能缺少指定的属性，也不能有多余的属性。

ts
type MyObj = {
	x: number
	y: number
}

const o1: MyObj = { x: 1 } // 报错 Property 'y' is missing in type '{ x: number; }' but required in type 'MyObj'.
const o2: MyObj = { x: 1, y: 1, z: 1 } // 报错 Object literal may only specify known properties, and 'z' does not exist in type 'MyObj'.

上面示例中，变量o1缺少了属性y，变量o2多出了属性z，都会报错。

读写不存在的属性也会报错。

ts
const obj: {
	x: number
	y: number
} = { x: 1, y: 1 }

console.log(obj.z) // 报错 Property 'z' does not exist on type '{ x: number; y: number; }'.
obj.z = 1 // 报错 Property 'z' does not exist on type '{ x: number; y: number; }'.

上面示例中，读写不存在的属性z都会报错。

同样地，也不能删除类型声明中存在的属性，修改属性值是可以的。

ts
const myUser = {
	name: 'Sabrina',
}

delete myUser.name // 报错
myUser.name = 'Cynthia' // 正确

上面声明中，删除类型声明中存在的属性name会报错，但是可以修改它的值。

对象的方法使用函数类型描述。

ts
const obj: {
	x: number
	y: number
	add(x: number, y: number): number
	// 或者写成
	// add: (x:number, y:number) => number;
} = {
	x: 1,
	y: 1,
	add(x, y) {
		return x + y
	},
}

上面示例中，对象obj有一个方法add()，需要定义它的参数类型和返回值类型。

对象类型可以使用方括号读取属性的类型。

ts
type User = {
	name: string
	age: number
}
type Name = User['name'] // string

上面示例中，对象类型User使用方括号，读取了属性name的类型（string）。

除了type命令可以为对象类型声明一个别名，TypeScript 还提供了interface命令，可以把对象类型提炼为一个接口。

ts
// 写法一
type MyObj = {
	x: number
	y: number
}

const obj1: MyObj = { x: 1, y: 1 }

// 写法二
interface MyObj2 {
	x: number
	y: number
}

const obj: MyObj2 = { x: 1, y: 1 }

上面示例中，写法一是type命令的用法，写法二是interface命令的用法。interface命令的详细解释，以及与type命令的区别，详见《Interface》一章。

注意，TypeScript 不区分对象自身的属性和继承的属性，一律视为对象的属性。

ts
interface MyInterface {
	toString(): string // 继承的属性
	prop: number // 自身的属性
}

const obj: MyInterface = {
	// 正确
	prop: 123,
}

上面示例中，obj只写了prop属性，但是不报错。因为它可以继承原型上面的toString()方法。

可选属性 ​

如果某个属性是可选的（即可以忽略），需要在属性名后面加一个问号。

ts
const obj: {
	x: number
	y?: number
} = { x: 1 }

上面示例中，属性y是可选的。

可选属性等同于允许赋值为undefined，下面两种写法是等效的。

ts
type User = {
	firstName: string
	lastName?: string
}

// 等同于
type User2 = {
	firstName: string
	lastName?: string | undefined
}

上面示例中，类型User的可选属性lastName可以是字符串，也可以是undefined，即可选属性可以赋值为undefined。

ts
const obj: {
	x: number
	y?: number
} = { x: 1, y: undefined }

上面示例中，可选属性y赋值为undefined，不会报错。

同样地，读取一个没有赋值的可选属性时，返回undefined。

ts
type MyObj = {
	x: string
	y?: string
}

const obj: MyObj = { x: 'hello' }
obj.y.toLowerCase() // 报错

上面示例中，最后一行会报错，因为obj.y返回undefined，无法对其调用toLowerCase()。

所以，读取可选属性之前，必须检查一下是否为undefined。

ts
const user: {
	firstName: string
	lastName?: string
} = { firstName: 'Foo' }

if (user.lastName !== undefined) {
	console.log(`hello ${user.firstName} ${user.lastName}`)
}

上面示例中，lastName是可选属性，需要判断是否为undefined以后，才能使用。建议使用下面的写法。

ts
const user: {
	firstName?: string
	lastName?: string
} = { firstName: 'Foo' }

// 写法一
let firstName = user.firstName === undefined ? 'Foo' : user.firstName
let lastName = user.lastName === undefined ? 'Bar' : user.lastName

// 写法二
let firstName2 = user.firstName ?? 'Foo'
let lastName2 = user.lastName ?? 'Bar'

上面示例中，写法一使用三元运算符?:，判断是否为undefined，并设置默认值。写法二使用 Null 判断运算符??，与写法一的作用完全相同。

只读属性 ​

属性名前面加上readonly关键字，表示这个属性是只读属性，不能修改。

ts
interface MyInterface {
	readonly prop: number
}

上面示例中，prop属性是只读属性，不能修改它的值。

ts
const person: {
	readonly age: number
} = { age: 20 }

person.age = 21 // 报错 Cannot assign to 'age' because it is a read-only property.

上面示例中，最后一行修改了只读属性age，就报错了。

只读属性只能在对象初始化期间赋值，此后就不能修改该属性。

ts
type Point = {
	readonly x: number
	readonly y: number
}

const p: Point = { x: 0, y: 0 }

p.x = 100 // 报错 Cannot assign to 'x' because it is a read-only property.

上面示例中，类型Point的属性x和y都带有修饰符readonly，表示这两个属性只能在初始化期间赋值，后面再修改就会报错。

注意，如果属性值是一个对象，readonly修饰符并不禁止修改该对象的属性，只是禁止完全替换掉该对象。

ts
interface Home {
	readonly resident: {
		name: string
		age: number
	}
}

const h: Home = {
	resident: {
		name: 'Vicky',
		age: 42,
	},
}

h.resident.age = 32 // 正确
h.resident = {
	name: 'Kate',
	age: 23,
} // 报错 Cannot assign to 'resident' because it is a read-only property.

上面示例中，h.resident是只读属性，它的值是一个对象。修改这个对象的age属性是可以的，但是整个替换掉h.resident属性会报错。

另一个需要注意的地方是，如果一个对象有两个引用，即两个变量对应同一个对象，其中一个变量是可写的，另一个变量是只读的，那么从可写变量修改属性，会影响到只读变量。

ts
interface Person {
	name: string
	age: number
}

interface ReadonlyPerson {
	readonly name: string
	readonly age: number
}

let w: Person = {
	name: 'Vicky',
	age: 42,
}

let r: ReadonlyPerson = w

w.age += 1
r.age // 43

上面示例中，变量w和r指向同一个对象，其中w是可写的，r是只读的。那么，对w的属性修改，会影响到r。

如果希望属性值是只读的，除了声明时加上readonly关键字，还有一种方法，就是在赋值时，在对象后面加上只读断言as const。

ts
const myUser = {
	name: 'Sabrina',
} as const

myUser.name = 'Cynthia' // 报错 Cannot assign to 'name' because it is a read-only property.

上面示例中，对象后面加了只读断言as const，就变成只读对象了，不能修改属性了。

注意，上面的as const属于 TypeScript 的类型推断，如果变量明确地声明了类型，那么 TypeScript 会以声明的类型为准。

ts
const myUser: { name: string } = {
	name: 'Sabrina',
} as const

myUser.name = 'Cynthia' // 正确

上面示例中，根据变量myUser的类型声明，name不是只读属性，但是赋值时又使用只读断言as const。这时会以声明的类型为准，因为name属性可以修改。

属性名的索引类型 ​

如果对象的属性非常多，一个个声明类型就很麻烦，而且有些时候，无法事前知道对象会有多少属性，比如外部 API 返回的对象。这时 TypeScript 允许采用属性名表达式的写法来描述类型，称为“属性名的索引类型”。

索引类型里面，最常见的就是属性名的字符串索引。

ts
type MyObj = {
	[property: string]: string
}

const obj: MyObj = {
	foo: 'a',
	bar: 'b',
	baz: 'c',
}

上面示例中，类型MyObj的属性名类型就采用了表达式形式，写在方括号里面。[property: string]的property表示属性名，这个是可以随便起的，它的类型是string，即属性名类型为string。也就是说，不管这个对象有多少属性，只要属性名为字符串，且属性值也是字符串，就符合这个类型声明。

JavaScript 对象的属性名（即上例的property）的类型有三种可能，除了上例的string，还有number和symbol。

ts
type T1 = {
	[property: number]: string
}

type T2 = {
	[property: symbol]: string
}

上面示例中，对象属性名的类型分别为number和symbol。

ts
type MyArr = {
	[n: number]: number
}

const arr: MyArr = [1, 2, 3]
// 或者
const arr2: MyArr = {
	0: 1,
	1: 2,
	2: 3,
}

上面示例中，对象类型MyArr的属性名是[n:number]，就表示它的属性名都是数值，比如0、1、2。

对象可以同时有多种类型的属性名索引，比如同时有数值索引和字符串索引。但是，数值索引不能与字符串索引发生冲突，必须服从后者，这是因为在 JavaScript 语言内部，所有的数值属性名都会自动转为字符串属性名。

ts
type MyType = {
	[x: number]: boolean // 报错 'number' index type 'boolean' is not assignable to 'string' index type 'string'.
	[x: string]: string
}

上面示例中，类型MyType同时有两种属性名索引，但是数值索引与字符串索引冲突了，所以报错了。由于字符属性名的值类型是string，数值属性名的值类型只有同样为string，才不会报错。

同样地，可以既声明属性名索引，也声明具体的单个属性名。如果单个属性名不符合属性名索引的范围，两者发生冲突，就会报错。

ts
type MyType = {
	foo: boolean // 报错 Property 'foo' of type 'boolean' is not assignable to 'string' index type 'string'.
	[x: string]: string
}

上面示例中，属性名foo符合属性名的字符串索引，但是两者的属性值类型不一样，所以报错了。

属性的索引类型写法，建议谨慎使用，因为属性名的声明太宽泛，约束太少。另外，属性名的数值索引不宜用来声明数组，因为采用这种方式声明数组，就不能使用各种数组方法以及length属性，因为类型里面没有定义这些东西。

ts
type MyArr = {
	[n: number]: number
}

const arr: MyArr = [1, 2, 3]
arr.length // 报错 Property 'length' does not exist on type 'MyArr'.

上面示例中，读取arr.length属性会报错，因为类型MyArr没有这个属性。

解构赋值 ​

解构赋值用于直接从对象中提取属性。

ts
const { id, name, price } = product

上面语句从对象product提取了三个属性，并声明属性名的同名变量。

解构赋值的类型写法，跟为对象声明类型是一样的。

ts
const {
	id,
	name,
	price,
}: {
	id: string
	name: string
	price: number
} = product

注意，目前没法为解构变量指定类型，因为对象解构里面的冒号，JavaScript 指定了其他用途。

ts
let { x: foo, y: bar } = obj

// 等同于
let foo = obj.x
let bar = obj.y

上面示例中，冒号不是表示属性x和y的类型，而是为这两个属性指定新的变量名。如果要为x和y指定类型，不得不写成下面这样。

ts
let { x: foo, y: bar }: { x: string; y: number } = obj

这一点要特别小心，TypeScript 里面很容易搞糊涂。

ts
function draw({ shape: Shape, xPos: number = 100, yPos: number = 100 }) {
	let myShape = shape // 报错 Cannot find name 'shape'. Did you mean 'Shape'?
	let x = xPos // 报错 Cannot find name 'xPos'.
}

上面示例中，函数draw()的参数是一个对象解构，里面的冒号很像是为变量指定类型，其实是为对应的属性指定新的变量名。所以，TypeScript 就会解读成，函数体内不存在变量shape，而是属性shape的值被赋值给了变量Shape。

结构类型原则 ​

只要对象 B 满足 对象 A 的结构特征，TypeScript 就认为对象 B 兼容对象 A 的类型，这称为“结构类型”原则（structural typing）。

ts
type A = {
	x: number
}

type B = {
	x: number
	y: number
}

上面示例中，对象A只有一个属性x，类型为number。对象B满足这个特征，因此兼容对象A，只要可以使用A的地方，就可以使用B。

ts
const B = {
	x: 1,
	y: 1,
}

const A: { x: number } = B // 正确

上面示例中，A和B并不是同一个类型，但是B可以赋值给A，因为B满足A的结构特征。

根据“结构类型”原则，TypeScript 检查某个值是否符合指定类型时，并不是检查这个值的类型名（即“名义类型”），而是检查这个值的结构是否符合要求（即“结构类型”）。

TypeScript 之所以这样设计，是为了符合 JavaScript 的行为。JavaScript 并不关心对象是否严格相似，只要某个对象具有所要求的属性，就可以正确运行。

如果类型 B 可以赋值给类型 A，TypeScript 就认为 B 是 A 的子类型（subtyping），A 是 B 的父类型。子类型满足父类型的所有结构特征，同时还具有自己的特征。凡是可以使用父类型的地方，都可以使用子类型，即子类型兼容父类型。

这种设计有时会导致令人惊讶的结果。

ts
type myObj = {
	x: number
	y: number
}

function getSum(obj: myObj) {
	let sum = 0

	for (const n of Object.keys(obj)) {
		const v = obj[n] // 报错
		sum += Math.abs(v)
	}

	return sum
}

上面示例中，函数getSum()要求传入参数的类型是myObj，但是实际上所有与myObj兼容的对象都可以传入。这会导致const v = obj[n]这一行报错，原因是obj[n]取出的属性值不一定是数值（number），使得变量v的类型被推断为any。如果项目设置为不允许变量类型推断为any，代码就会报错。写成下面这样，就不会报错。

ts
// "noImplicitAny": true,
type myObj = {
	x: number
	y: number
}

function getSum(obj: myObj) {
	let sum = 0

	for (const n of Object.keys(obj)) {
		const v = obj[n] // 报错 Element implicitly has an 'any' type because expression of type 'string' can't be used to index type 'myObj'.
		sum += Math.abs(v)
	}

	return sum
}

上面示例中，函数getSum()要求传入参数的类型是myObj，但是实际上所有与myObj兼容的对象都可以传入。这会导致const v = obj[n]这一行报错，原因是obj[n]取出的属性值不一定是数值（number），使得变量v的类型被推断为any。如果项目设置为不允许变量类型推断为any，代码就会报错。写成下面这样，就不会报错。

ts
// "noImplicitAny": true,
type MyObj = {
	x: number
	y: number
}

function getSum(obj: MyObj) {
	return Math.abs(obj.x) + Math.abs(obj.y)
}

上面示例就不会报错，因为函数体内部只使用了属性x和y，这两个属性有明确的类型声明，保证obj.x和obj.y肯定是数值。虽然与MyObj兼容的任何对象都可以传入函数getSum()，但是只要不使用其他属性，就不会有类型报错。

严格字面量检查 ​

如果对象使用字面量表示，会触发 TypeScript 的严格字面量检查（strict object literal checking）。如果字面量的结构跟类型定义的不一样（比如多出了未定义的属性），就会报错。

ts
const point: {
	x: number
	y: number
} = {
	x: 1,
	y: 1,
	z: 1, // 报错 Object literal may only specify known properties, and 'z' does not exist in type '{ x: number; y: number; }'.
}

上面示例中，等号右边是一个对象的字面量，这时会触发严格字面量检查。只要有类型声明中不存在的属性（本例是z），就会导致报错。

如果等号右边不是字面量，而是一个变量，根据结构类型原则，是不会报错的。

ts
const myPoint = {
	x: 1,
	y: 1,
	z: 1,
}

const point: {
	x: number
	y: number
} = myPoint // 正确

上面示例中，等号右边是一个变量，就不会触发严格字面量检查，从而不报错。

TypeScript 对字面量进行严格检查的目的，主要是防止拼写错误。一般来说，字面量大多数来自手写，容易出现拼写错误，或者误用 API。

ts
type Options = {
	title: string
	darkMode?: boolean
}

const obj: Options = {
	title: '我的网页',
	darkmode: true, // 报错 Object literal may only specify known properties, but 'darkmode' does not exist in type 'Options'. Did you mean to write 'darkMode'?
}

上面示例中，属性darkMode拼写错了，成了darkmode。如果没有严格字面量规则，就不会报错，因为darkMode是可选属性，根据结构类型原则，任何对象只要有title属性，都认为符合Options类型。

规避严格字面量检查，可以使用中间变量。

ts
let myOptions = {
	title: '我的网页',
	darkmode: true,
}

type Options = {
	title: string
	darkMode?: boolean
}

const obj: Options = myOptions

上面示例中，创建了一个中间变量myOptions，就不会触发严格字面量规则，因为这时变量obj的赋值，不属于直接字面量赋值。

如果你确认字面量没有错误，也可以使用类型断言规避严格字面量检查。

ts
type Options = {
	title: string
	darkMode?: boolean
}

const obj: Options = {
	title: '我的网页',
	darkmode: true,
} as Options

上面示例使用类型断言as Options，告诉编译器，字面量符合 Options 类型，就能规避这条规则。

如果允许字面量有多余属性，可以像下面这样在类型里面定义一个通用属性。

ts
let x: {
	foo: number
	[x: string]: any
}

x = { foo: 1, baz: 2 } // Ok

上面示例中，变量x的类型声明里面，有一个属性的字符串索引（[x: string]），导致任何字符串属性名都是合法的。

由于严格字面量检查，字面量对象传入函数必须很小心，不能有多余的属性。

ts
interface Point {
	x: number
	y: number
}

function computeDistance(point: Point) {
	/*...*/
}

computeDistance({ x: 1, y: 2, z: 3 }) // 报错 Object literal may only specify known properties, and 'z' does not exist in type 'Point'.
computeDistance({ x: 1, y: 2 }) // 正确

最小可选属性规则 ​

根据“结构类型”原则，如果一个对象的所有属性都是可选的，那么其他对象跟它都是结构类似的。

ts
type Options = {
	a?: number
	b?: number
	c?: number
}

上面示例中，类型Options的所有属性都是可选的，所以它可以是一个空对象，也就意味着任意对象都满足Options的结构。

为了避免这种情况，TypeScript 2.4 引入了一个“最小可选属性规则”，也称为“弱类型检测”（weak type detection）。

ts
type Options = {
	a?: number
	b?: number
	c?: number
}

const opts = { d: 123 }

const obj: Options = opts // 报错 Type '{ d: number; }' has no properties in common with type 'Options'.

上面示例中，对象opts与类型Options没有共同属性，赋值给该类型的变量就会报错。

报错原因是，如果某个类型的所有属性都是可选的，那么该类型的对象必须至少存在一个可选属性，不能所有可选属性都不存在。这就叫做“最小可选属性规则”。

如果想规避这条规则，要么在类型里面增加一条索引属性（[propName: string]: someType），要么使用类型断言（opts as Options）。

空对象 ​

空对象是 TypeScript 的一种特殊值，也是一种特殊类型。

ts
const obj = {}
obj.prop = 123 // 报错 Property 'prop' does not exist on type '{}'

上面示例中，变量obj的值是一个空对象，然后对obj.prop赋值就会报错。

原因是这时 TypeScript 会推断变量obj的类型为空对象，实际执行的是下面的代码。

ts
const obj: {} = {}

空对象没有自定义属性，所以对自定义属性赋值就会报错。空对象只能使用继承的属性，即继承自原型对象Object.prototype的属性。

ts
obj.toString() // 正确

上面示例中，toString()方法是一个继承自原型对象的方法，TypeScript 允许在空对象上使用。

回到本节开始的例子，这种写法其实在 JavaScript 很常见：先声明一个空对象，然后向空对象添加属性。但是，TypeScript 不允许动态添加属性，所以对象不能分步生成，必须生成时一次性声明所有属性。

ts
// 错误 Property 'x' does not exist on type '{}'  Property 'y' does not exist on type '{}'
const pt = {}
pt.x = 3
pt.y = 4

// 正确
const pt2 = {
	x: 3,
	y: 4,
}

如果确实需要分步声明，一个比较好的方法是，使用扩展运算符（...）合成一个新对象。

ts
const pt0 = {}
const pt1 = { x: 3 }
const pt2 = { y: 4 }

const pt = {
	...pt0,
	...pt1,
	...pt2,
}

上面示例中，对象pt是三个部分合成的，这样既可以分步声明，也符合 TypeScript 静态声明的要求。

空对象作为类型，其实是Object类型的简写形式。

ts
let d: {}
// 等同于
// let d:Object;

d = {}
d = { x: 1 }
d = 'hello'
d = 2

上面示例中，各种类型的值（除了null和undefined）都可以赋值给空对象类型，跟Object类型的行为是一样的。

因为Object可以接受各种类型的值，而空对象是Object类型的简写，所以它不会有严格字面量检查，赋值时总是允许多余的属性，只是不能读取这些属性。

ts
interface Empty {}
const b: Empty = { myProp: 1, anotherProp: 2 } // 正确
b.myProp // 报错 Property 'myProp' does not exist on type 'Empty'

上面示例中，变量b的类型是空对象，视同Object类型，不会有严格字面量检查，但是读取多余的属性会报错。

如果想强制使用没有任何属性的对象，可以采用下面的写法。

ts
interface WithoutProperties {
	[key: string]: never
}

// 报错 Type 'number' is not assignable to type 'never'
const a: WithoutProperties = { prop: 1 }

参考 ​

https://wangdoc.com/typescript/object