Typescript 接口 (五)

Typescript

发布日期: 2021-03-26

更新日期: 2021-04-16

文章字数: 878

阅读时长: 3 分

阅读次数:

对象的类型 – 接口

在 Typescript 中,我们使用接口(interface) 来定义对象的类型

对象的接口

在面向对象语言中,接口(interface)是一个很重要的概念,它是对行为的抽象,而具体如何行动需要由类(class)去实现(implement)

简单的例子

interface Person {
  name: string;
  age: number;
}

let tom: Person = {
  name: 'Tom',
  age: 25,
}

上面的例子我们定义了一个接口 Person,接着定义了一个变量 tom,他的类型是 Person,这样我们就约束了 tom 的形状必须和接口 Person 一致

接口一般首字母大写。有的编程语言中会建议接口的名称加上 I 前缀

定义的变量比接口少了一些属性是不允许的:

interface Person {
  name: string;
  age: number;
}

let tom: Person = {
  name: 'Tom',
}

//报错,因为没有age属性

多一些属性也是不可以的

interface Person {
  name: string;
  age: number;
}

let tom: Person = {
  name: 'Tom',
  age: 25,
  gender: 'male',
}

// index.ts(9,5): error TS2322: Type '{ name: string; age: number; gender: string; }' is not assignable to type 'Person'.
//   Object literal may only specify known properties, and 'gender' does not exist in type 'Person'.

可见赋值的时候,变量的形状必须和接口保持一致.

可选属性

有时我们希望不要完全一个形状,那么可以用可选属性,利用?来定义

interface Person {
  name: string;
  age?: number;
}

let tom: Person = {
  name: 'Tom',
}

任意属性

有时候我们希望一个接口有任意的属性,可以如下

interface Person {
  name: string;
  age?: number;
  [propName: string]: any;
}

let tom: Person = {
  name: 'Tom',
  gender: 'male',
}

使用[propName:string] 可以定义了任意属性取 string 类型的值

需要注意的是,一旦定义了任意属性,那么确定属性和可选属性的类型都必须是它的类型的子集。

interface Person {
  name: string;
  age?: number;
  [propName: string]: string;
}

let tom: Person = {
  name: 'Tom',
  age: 25,
  gender: 'male',
}

// index.ts(3,5): error TS2411: Property 'age' of type 'number' is not assignable to string index type 'string'.
// index.ts(7,5): error TS2322: Type '{ [x: string]: string | number; name: string; age: number; gender: string; }' is not assignable to type 'Person'.
//   Index signatures are incompatible.
//     Type 'string | number' is not assignable to type 'string'.
//       Type 'number' is not assignable to type 'string'.

上例中任意属性的值允许是 string,但是可选属性的 age 的值却是 number,number 不是 string 的子属性,所以报错了

例子可以改成

interface Person {
  name: string;
  age?: number;
  [propName: string]: string | number;
}

let tom: Person = {
  name: 'Tome',
  age: 25,
  gender: 'male',
}

总结: 任意属性和可选属性最好不能共存,即便共存最好类型一致

只读属性

有的时候我们希望对象中的一些字段只能在创建的时候被赋值,那么可以用 readonly 定义只读属性


interface Person {
  readonly id:number;
  name:string;
  age?:number;
  [propName:string]:any;
}

let tom:Person = {
  id:89757,
  name:'TOM',
  gender:'male'
}

tom.id = 1111;

// index.ts(14,5): error TS2540: Cannot assign to 'id' because it is a constant or a read-only property.

上例中,使用 readonly 定义的属性 id 初始化,又被赋值了,所以报错了

注意:只读的约束在于第一次给对象赋值的时候,而不是第一次给只读属性赋值的时候


interface Person {
   readonly id: number;
    name: string;
    age?: number;
    [propName: string]: any;
}

let tom:Person = {
  name:'Tom',
  gender:'male'
}

tom.id = 89757

// index.ts(8,5): error TS2322: Type '{ name: string; gender: string; }' is not assignable to type 'Person'.
//   Property 'id' is missing in type '{ name: string; gender: string; }'.
// index.ts(13,5): error TS2540: Cannot assign to 'id' because it is a constant or a read-only property.