在 TypeScript 中,我們使用接口(Interfaces)來定義對象的類型。
什么是接口
TypeScript 中的接口是一個非常靈活的概念,除了可用于對類的一部分行為進行抽象以外,也常用于對「對象的形狀(Shape)」進行描述。
簡單的例子
interface Person {
name: string;
age: number;
}
let tom: Person = {
name: 'Tom',
age: 25
};
上面的例子中,我們定義了一個接口Person,接著定義了一個變量 tom,它的類型是 Person。這樣,我們就約束了 tom 的形狀必須和接口 Person 一致。
定義的變量比接口少/多了一些屬性是不允許的
interface Person {
name: string;
age: number;
}
let tom: Person = {
name: 'Tom'
};
// index.ts(6,5): error TS2322: Type '{ name: string; }' is not assignable to type 'Person'.
// Property 'age' is missing in type '{ name: string; }'.
可選屬性:
有時我們希望不要完全匹配一個形狀,那么可以用可選屬性。
interface Person {
name: string;
age?: number;
}
let tom: Person = {
name: 'Tom'
};
這時仍然不允許添加未定義的屬性:
interface Person {
name: string;
age?: number;
}
let tom: Person = {
name: 'Tom',
age: 25,
gender: 'male'
};
// examples/playground/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;
[propName: string]: any;
}
let tom: Person = {
name: 'Tom',
gender: 'male'
};
只讀屬性:
有時候我們希望對象中的一些字段只能在創(chuàng)建的時候被賦值,那么可以用readonly定義只讀屬性。
interface Person {
readonly id: number;
name: string;
age?: number;
[propName: string]: any;
}
注意,只讀的約束存在于第一次給對象賦值的時候,而不是第一次給只讀屬性賦值的時候:
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.
上例中,報錯信息有兩處,第一處是在對 tom 進行賦值的時候,沒有給 id 賦值。
第二處是在給 tom.id 賦值的時候,由于它是只讀屬性,所以報錯了。