TypeScript/doc/handbook/Classes.md

538 lines
17 KiB
Markdown
Raw Normal View History

2015-06-13 13:20:04 +08:00
# 介绍
2016-09-26 15:48:46 +08:00
传统的JavaScript程序使用函数和基于原型的继承来创建可重用的组件但对于熟悉使用面向对象方式的程序员来讲就有些棘手因为他们用的是基于类的继承并且对象是由类构建出来的。
从ECMAScript 2015也就是ECMAScript 6开始JavaScript程序员将能够使用基于类的面向对象的方式。
使用TypeScript我们允许开发者现在就使用这些特性并且编译后的JavaScript可以在所有主流浏览器和平台上运行而不需要等到下个JavaScript版本。
2015-06-13 13:20:04 +08:00
# 类
下面看一个使用类的例子:
```ts
2015-06-13 13:20:04 +08:00
class Greeter {
greeting: string;
constructor(message: string) {
this.greeting = message;
}
greet() {
return "Hello, " + this.greeting;
}
}
2015-12-03 19:26:43 +08:00
let greeter = new Greeter("world");
2015-06-13 13:20:04 +08:00
```
如果你使用过C#或Java你会对这种语法非常熟悉。
我们声明一个`Greeter`类。这个类有3个成员一个叫做`greeting`的属性,一个构造函数和一个`greet`方法。
你会注意到,我们在引用任何一个类成员的时候都用了`this`。
它表示我们访问的是类的成员。
2016-09-26 15:48:46 +08:00
最后一行,我们使用`new`构造了`Greeter`类的一个实例。
2015-06-13 13:20:04 +08:00
它会调用之前定义的构造函数,创建一个`Greeter`类型的新对象,并执行构造函数初始化它。
# 继承
在TypeScript里我们可以使用常用的面向对象模式。
基于类的程序设计中一种最基本的模式是允许使用继承来扩展现有的类。
2015-06-13 13:20:04 +08:00
看下面的例子:
```ts
2015-06-13 13:20:04 +08:00
class Animal {
move(distanceInMeters: number = 0) {
console.log(`Animal moved ${distanceInMeters}m.`);
}
}
class Dog extends Animal {
bark() {
console.log('Woof! Woof!');
}
}
const dog = new Dog();
dog.bark();
dog.move(10);
dog.bark();
```
这个例子展示了最基本的继承:类从基类中继承了属性和方法。
这里,`Dog`是一个*派生类*,它派生自`Animal`*基类*,通过`extends`关键字。
派生类通常被称作*子类*,基类通常被称作*超类*。
因为`Dog`继承了`Animal`的功能,因此我们可以创建一个`Dog`的实例,它能够`bark()`和`move()`。
下面我们来看个更加复杂的例子。
```ts
class Animal {
name: string;
2015-06-13 13:20:04 +08:00
constructor(theName: string) { this.name = theName; }
move(distanceInMeters: number = 0) {
2015-11-02 21:04:47 +08:00
console.log(`${this.name} moved ${distanceInMeters}m.`);
2015-06-13 13:20:04 +08:00
}
}
class Snake extends Animal {
constructor(name: string) { super(name); }
move(distanceInMeters = 5) {
2015-11-02 21:04:47 +08:00
console.log("Slithering...");
2015-06-13 13:20:04 +08:00
super.move(distanceInMeters);
}
}
class Horse extends Animal {
constructor(name: string) { super(name); }
move(distanceInMeters = 45) {
2015-11-02 21:04:47 +08:00
console.log("Galloping...");
2015-06-13 13:20:04 +08:00
super.move(distanceInMeters);
}
}
2015-12-03 19:26:43 +08:00
let sam = new Snake("Sammy the Python");
let tom: Animal = new Horse("Tommy the Palomino");
2015-06-13 13:20:04 +08:00
sam.move();
tom.move(34);
```
这个例子展示了一些上面没有提到的特性。
这一次,我们使用`extends`关键字创建了`Animal`的两个子类:`Horse`和`Snake`。
2015-06-13 13:20:04 +08:00
与前一个例子的不同点是,派生类包含了一个构造函数,它*必须*调用`super()`,它会执行基类的构造函数。
而且,在构造函数里访问`this`的属性之前,我们*一定*要调用`super()`。
这个是TypeScript强制执行的一条重要规则。
2016-04-27 12:40:57 +08:00
2015-11-02 21:04:47 +08:00
这个例子演示了如何在子类里可以重写父类的方法。
2016-09-26 15:48:46 +08:00
`Snake`类和`Horse`类都创建了`move`方法,它们重写了从`Animal`继承来的`move`方法,使得`move`方法根据不同的类而具有不同的功能。
注意,即使`tom`被声明为`Animal`类型,但因为它的值是`Horse`,调用`tom.move(34)`时,它会调用`Horse`里重写的方法:
2015-11-02 21:04:47 +08:00
2016-06-02 16:56:37 +08:00
```text
2015-11-02 21:04:47 +08:00
Slithering...
Sammy the Python moved 5m.
Galloping...
Tommy the Palomino moved 34m.
```
2015-06-13 13:20:04 +08:00
# 公共,私有与受保护的修饰符
2016-09-26 15:48:46 +08:00
## 默认为`public`
2015-06-13 13:20:04 +08:00
在上面的例子里,我们可以自由的访问程序里定义的成员。
如果你对其它语言中的类比较了解,就会注意到我们在之前的代码里并没有使用`public`来做修饰例如C#要求必须明确地使用`public`指定成员是可见的。
2016-09-26 15:48:46 +08:00
在TypeScript里成员都默认为`public`。
2015-06-13 13:20:04 +08:00
2015-11-02 21:04:47 +08:00
你也可以明确的将一个成员标记成`public`。
2015-06-13 13:20:04 +08:00
我们可以用下面的方式来重写上面的`Animal`类:
```ts
2015-06-13 13:20:04 +08:00
class Animal {
public name: string;
2015-11-02 21:04:47 +08:00
public constructor(theName: string) { this.name = theName; }
public move(distanceInMeters: number) {
2015-11-02 21:04:47 +08:00
console.log(`${this.name} moved ${distanceInMeters}m.`);
2015-06-13 13:20:04 +08:00
}
}
```
## 理解`private`
当成员被标记成`private`时,它就不能在声明它的类的外部访问。比如:
```ts
2015-06-13 13:20:04 +08:00
class Animal {
private name: string;
constructor(theName: string) { this.name = theName; }
}
2017-10-09 08:13:16 +08:00
new Animal("Cat").name; // 错误: 'name' 是私有的.
2015-06-13 13:20:04 +08:00
```
TypeScript使用的是结构性类型系统。
2016-09-26 15:48:46 +08:00
当我们比较两种不同的类型时,并不在乎它们从何处而来,如果所有成员的类型都是兼容的,我们就认为它们的类型是兼容的。
2015-06-13 13:20:04 +08:00
然而,当我们比较带有`private`或`protected`成员的类型的时候,情况就不同了。
2016-09-26 15:48:46 +08:00
如果其中一个类型里包含一个`private`成员,那么只有当另外一个类型中也存在这样一个`private`成员, 并且它们都是来自同一处声明时,我们才认为这两个类型是兼容的。
2015-06-13 13:20:04 +08:00
对于`protected`成员也使用这个规则。
2016-09-26 15:48:46 +08:00
下面来看一个例子,更好地说明了这一点:
2015-06-13 13:20:04 +08:00
```ts
2015-06-13 13:20:04 +08:00
class Animal {
private name: string;
constructor(theName: string) { this.name = theName; }
}
class Rhino extends Animal {
constructor() { super("Rhino"); }
}
class Employee {
private name: string;
constructor(theName: string) { this.name = theName; }
2015-06-13 13:20:04 +08:00
}
2015-12-03 19:26:43 +08:00
let animal = new Animal("Goat");
let rhino = new Rhino();
let employee = new Employee("Bob");
2015-06-13 13:20:04 +08:00
animal = rhino;
2017-10-09 08:13:16 +08:00
animal = employee; // 错误: Animal 与 Employee 不兼容.
2015-06-13 13:20:04 +08:00
```
这个例子中有`Animal`和`Rhino`两个类,`Rhino`是`Animal`类的子类。
还有一个`Employee`类,其类型看上去与`Animal`是相同的。
我们创建了几个这些类的实例,并相互赋值来看看会发生什么。
因为`Animal`和`Rhino`共享了来自`Animal`里的私有成员定义`private name: string`,因此它们是兼容的。
然而`Employee`却不是这样。当把`Employee`赋值给`Animal`的时候,得到一个错误,说它们的类型不兼容。
尽管`Employee`里也有一个私有成员`name`,但它明显不是`Animal`里面定义的那个。
## 理解`protected`
`protected`修饰符与`private`修饰符的行为很相似,但有一点不同,`protected`成员在派生类中仍然可以访问。例如:
```ts
2015-06-13 13:20:04 +08:00
class Person {
protected name: string;
constructor(name: string) { this.name = name; }
}
class Employee extends Person {
private department: string;
constructor(name: string, department: string) {
super(name)
this.department = department;
}
public getElevatorPitch() {
return `Hello, my name is ${this.name} and I work in ${this.department}.`;
}
}
2015-12-03 19:26:43 +08:00
let howard = new Employee("Howard", "Sales");
2015-06-13 13:20:04 +08:00
console.log(howard.getElevatorPitch());
2017-10-09 08:13:16 +08:00
console.log(howard.name); // 错误
2015-06-13 13:20:04 +08:00
```
2016-09-26 15:48:46 +08:00
注意,我们不能在`Person`类外使用`name`,但是我们仍然可以通过`Employee`类的实例方法访问,因为`Employee`是由`Person`派生而来的。
2015-06-13 13:20:04 +08:00
2016-07-20 15:26:51 +08:00
构造函数也可以被标记成`protected`。
这意味着这个类不能在包含它的类外被实例化,但是能被继承。比如,
```ts
class Person {
protected name: string;
protected constructor(theName: string) { this.name = theName; }
}
2017-10-09 08:13:16 +08:00
// Employee 能够继承 Person
2016-07-20 15:26:51 +08:00
class Employee extends Person {
private department: string;
constructor(name: string, department: string) {
super(name);
this.department = department;
}
public getElevatorPitch() {
return `Hello, my name is ${this.name} and I work in ${this.department}.`;
}
}
let howard = new Employee("Howard", "Sales");
2017-10-09 08:13:16 +08:00
let john = new Person("John"); // 错误: 'Person' 的构造函数是被保护的.
2016-07-20 15:26:51 +08:00
```
2016-09-26 15:48:46 +08:00
# readonly修饰符
2016-07-20 15:26:51 +08:00
你可以使用`readonly`关键字将属性设置为只读的。
只读属性必须在声明时或构造函数里被初始化。
```ts
class Octopus {
readonly name: string;
readonly numberOfLegs: number = 8;
constructor (theName: string) {
this.name = theName;
}
}
let dad = new Octopus("Man with the 8 strong legs");
2017-10-09 08:13:16 +08:00
dad.name = "Man with the 3-piece suit"; // 错误! name 是只读的.
2016-07-20 15:26:51 +08:00
```
2015-06-13 13:20:04 +08:00
## 参数属性
2018-04-19 12:23:54 +08:00
在上面的例子中,我们不得不定义一个受保护的成员`name`和一个构造函数参数`theName`在`Person`类里,并且立刻将`theName`的值赋给`name`。
2015-06-13 13:20:04 +08:00
这种情况经常会遇到。*参数属性*可以方便地让我们在一个地方定义并初始化一个成员。
下面的例子是对之前`Animal`类的修改版,使用了参数属性:
```ts
2015-06-13 13:20:04 +08:00
class Animal {
constructor(private name: string) { }
move(distanceInMeters: number) {
2015-11-02 21:04:47 +08:00
console.log(`${this.name} moved ${distanceInMeters}m.`);
2015-06-13 13:20:04 +08:00
}
}
```
注意看我们是如何舍弃了`theName`,仅在构造函数里使用`private name: string`参数来创建和初始化`name`成员。
我们把声明和赋值合并至一处。
参数属性通过给构造函数参数添加一个访问限定符来声明。
使用`private`限定一个参数属性会声明并初始化一个私有成员;对于`public`和`protected`来说也是一样。
# 存取器
2016-09-26 15:48:46 +08:00
TypeScript支持通过getters/setters来截取对对象成员的访问。
2015-06-13 13:20:04 +08:00
它能帮助你有效的控制对对象成员的访问。
2016-09-26 15:48:46 +08:00
下面来看如何把一个简单的类改写成使用`get`和`set`。
首先,我们从一个没有使用存取器的例子开始。
2015-06-13 13:20:04 +08:00
```ts
2015-06-13 13:20:04 +08:00
class Employee {
fullName: string;
}
2015-12-03 19:26:43 +08:00
let employee = new Employee();
2015-06-13 13:20:04 +08:00
employee.fullName = "Bob Smith";
if (employee.fullName) {
2015-11-02 21:04:47 +08:00
console.log(employee.fullName);
2015-06-13 13:20:04 +08:00
}
```
2015-12-19 15:12:21 +08:00
我们可以随意的设置`fullName`,这是非常方便的,但是这也可能会带来麻烦。
2015-06-13 13:20:04 +08:00
2016-09-26 15:48:46 +08:00
下面这个版本里,我们先检查用户密码是否正确,然后再允许其修改员工信息。
2015-12-19 15:12:21 +08:00
我们把对`fullName`的直接访问改成了可以检查密码的`set`方法。
2015-06-13 13:20:04 +08:00
我们也加了一个`get`方法,让上面的例子仍然可以工作。
```ts
2015-12-03 19:26:43 +08:00
let passcode = "secret passcode";
2015-06-13 13:20:04 +08:00
class Employee {
private _fullName: string;
get fullName(): string {
return this._fullName;
}
2015-06-13 13:20:04 +08:00
set fullName(newName: string) {
if (passcode && passcode == "secret passcode") {
this._fullName = newName;
}
else {
2015-11-02 21:04:47 +08:00
console.log("Error: Unauthorized update of employee!");
2015-06-13 13:20:04 +08:00
}
}
}
2015-12-03 19:26:43 +08:00
let employee = new Employee();
2015-06-13 13:20:04 +08:00
employee.fullName = "Bob Smith";
if (employee.fullName) {
alert(employee.fullName);
}
```
2016-09-26 15:48:46 +08:00
我们可以修改一下密码,来验证一下存取器是否是工作的。当密码不对时,会提示我们没有权限去修改员工。
2015-06-13 13:20:04 +08:00
2016-09-26 15:48:46 +08:00
对于存取器有下面几点需要注意的:
首先存取器要求你将编译器设置为输出ECMAScript 5或更高。
不支持降级到ECMAScript 3。
其次,只带有`get`不带有`set`的存取器自动被推断为`readonly`。
这在从代码生成`.d.ts`文件时是有帮助的,因为利用这个属性的用户会看到不允许够改变它的值。
2015-06-13 13:20:04 +08:00
# 静态属性
到目前为止,我们只讨论了类的实例成员,那些仅当类被实例化的时候才会被初始化的属性。
我们也可以创建类的静态成员,这些属性存在于类本身上面而不是类的实例上。
在这个例子里,我们使用`static`定义`origin`,因为它是所有网格都会用到的属性。
2016-09-26 15:48:46 +08:00
每个实例想要访问这个属性的时候,都要在`origin`前面加上类名。
2015-06-13 13:20:04 +08:00
如同在实例属性上使用`this.`前缀来访问属性一样,这里我们使用`Grid.`来访问静态属性。
```ts
2015-06-13 13:20:04 +08:00
class Grid {
static origin = {x: 0, y: 0};
calculateDistanceFromOrigin(point: {x: number; y: number;}) {
2015-12-03 19:26:43 +08:00
let xDist = (point.x - Grid.origin.x);
let yDist = (point.y - Grid.origin.y);
2015-06-13 13:20:04 +08:00
return Math.sqrt(xDist * xDist + yDist * yDist) / this.scale;
}
constructor (public scale: number) { }
}
2015-12-03 19:26:43 +08:00
let grid1 = new Grid(1.0); // 1x scale
let grid2 = new Grid(5.0); // 5x scale
2015-06-13 13:20:04 +08:00
2015-11-02 21:04:47 +08:00
console.log(grid1.calculateDistanceFromOrigin({x: 10, y: 10}));
console.log(grid2.calculateDistanceFromOrigin({x: 10, y: 10}));
2015-06-13 13:20:04 +08:00
```
2015-11-18 19:42:44 +08:00
# 抽象类
2016-09-26 15:48:46 +08:00
抽象类做为其它派生类的基类使用。
它们一般不会直接被实例化。
2015-11-18 19:42:44 +08:00
不同于接口,抽象类可以包含成员的实现细节。
`abstract`关键字是用于定义抽象类和在抽象类内部定义抽象方法。
```ts
abstract class Animal {
abstract makeSound(): void;
move(): void {
2019-02-15 18:05:50 +08:00
console.log("roaming the earth...");
2015-11-18 19:42:44 +08:00
}
}
```
抽象类中的抽象方法不包含具体实现并且必须在派生类中实现。
抽象方法的语法与接口方法相似。
2016-09-26 15:48:46 +08:00
两者都是定义方法签名但不包含方法体。
然而,抽象方法必须包含`abstract`关键字并且可以包含访问修饰符。
2015-11-18 19:42:44 +08:00
```ts
abstract class Department {
constructor(public name: string) {
}
printName(): void {
console.log('Department name: ' + this.name);
}
abstract printMeeting(): void; // 必须在派生类中实现
}
class AccountingDepartment extends Department {
constructor() {
2017-10-09 08:13:16 +08:00
super('Accounting and Auditing'); // 在派生类的构造函数中必须调用 super()
2015-11-18 19:42:44 +08:00
}
printMeeting(): void {
console.log('The Accounting Department meets each Monday at 10am.');
}
generateReports(): void {
console.log('Generating accounting reports...');
}
}
2017-10-09 08:13:16 +08:00
let department: Department; // 允许创建一个对抽象类型的引用
department = new Department(); // 错误: 不能创建一个抽象类的实例
department = new AccountingDepartment(); // 允许对一个抽象子类进行实例化和赋值
2015-11-18 19:42:44 +08:00
department.printName();
department.printMeeting();
2017-10-09 08:13:16 +08:00
department.generateReports(); // 错误: 方法在声明的抽象类中不存在
2015-11-18 19:42:44 +08:00
```
2015-06-13 13:20:04 +08:00
# 高级技巧
## 构造函数
2016-09-26 15:48:46 +08:00
当你在TypeScript里声明了一个类的时候实际上同时声明了很多东西。
首先就是类的*实例*的类型。
2015-06-13 13:20:04 +08:00
```ts
2015-06-13 13:20:04 +08:00
class Greeter {
greeting: string;
constructor(message: string) {
this.greeting = message;
}
greet() {
return "Hello, " + this.greeting;
}
}
2015-12-03 19:26:43 +08:00
let greeter: Greeter;
2015-06-13 13:20:04 +08:00
greeter = new Greeter("world");
2015-11-02 21:04:47 +08:00
console.log(greeter.greet());
2015-06-13 13:20:04 +08:00
```
2016-09-26 15:48:46 +08:00
这里,我们写了`let greeter: Greeter`,意思是`Greeter`类的实例的类型是`Greeter`。
2015-06-13 13:20:04 +08:00
这对于用过其它面向对象语言的程序员来讲已经是老习惯了。
我们也创建了一个叫做*构造函数*的值。
这个函数会在我们使用`new`创建类实例的时候被调用。
下面我们来看看上面的代码被编译成JavaScript后是什么样子的
```ts
2015-12-03 19:26:43 +08:00
let Greeter = (function () {
2015-06-13 13:20:04 +08:00
function Greeter(message) {
this.greeting = message;
}
Greeter.prototype.greet = function () {
return "Hello, " + this.greeting;
};
return Greeter;
})();
2015-12-03 19:26:43 +08:00
let greeter;
2015-06-13 13:20:04 +08:00
greeter = new Greeter("world");
2015-11-02 21:04:47 +08:00
console.log(greeter.greet());
2015-06-13 13:20:04 +08:00
```
2015-12-03 19:26:43 +08:00
上面的代码里,`let Greeter`将被赋值为构造函数。
2016-09-26 15:48:46 +08:00
当我们调用`new`并执行了这个函数后,便会得到一个类的实例。
2015-06-13 13:20:04 +08:00
这个构造函数也包含了类的所有静态属性。
2016-09-26 15:48:46 +08:00
换个角度说,我们可以认为类具有*实例部分*与*静态部分*这两个部分。
2015-06-13 13:20:04 +08:00
2017-12-06 08:31:36 +08:00
让我们稍微改写一下这个例子,看看它们之间的区别:
2015-06-13 13:20:04 +08:00
```ts
2015-06-13 13:20:04 +08:00
class Greeter {
static standardGreeting = "Hello, there";
greeting: string;
greet() {
if (this.greeting) {
return "Hello, " + this.greeting;
}
else {
return Greeter.standardGreeting;
}
}
}
2015-12-03 19:26:43 +08:00
let greeter1: Greeter;
2015-06-13 13:20:04 +08:00
greeter1 = new Greeter();
2015-11-02 21:04:47 +08:00
console.log(greeter1.greet());
2015-06-13 13:20:04 +08:00
2015-12-03 19:26:43 +08:00
let greeterMaker: typeof Greeter = Greeter;
2015-06-13 13:20:04 +08:00
greeterMaker.standardGreeting = "Hey there!";
2016-09-26 15:48:46 +08:00
let greeter2: Greeter = new greeterMaker();
2015-11-02 21:04:47 +08:00
console.log(greeter2.greet());
2015-06-13 13:20:04 +08:00
```
这个例子里,`greeter1`与之前看到的一样。
我们实例化`Greeter`类,并使用这个对象。
与我们之前看到的一样。
再之后,我们直接使用类。
我们创建了一个叫做`greeterMaker`的变量。
这个变量保存了这个类或者说保存了类构造函数。
然后我们使用`typeof Greeter`意思是取Greeter类的类型而不是实例的类型。
2015-12-12 13:42:12 +08:00
或者更确切的说,"告诉我`Greeter`标识符的类型",也就是构造函数的类型。
2015-06-13 13:20:04 +08:00
这个类型包含了类的所有静态成员和构造函数。
之后,就和前面一样,我们在`greeterMaker`上使用`new`,创建`Greeter`的实例。
## 把类当做接口使用
2016-09-26 15:48:46 +08:00
如上一节里所讲的,类定义会创建两个东西:类的实例类型和一个构造函数。
因为类可以创建出类型,所以你能够在允许使用接口的地方使用类。
2015-06-13 13:20:04 +08:00
```ts
2015-06-13 13:20:04 +08:00
class Point {
x: number;
y: number;
}
interface Point3d extends Point {
z: number;
}
2015-12-03 19:26:43 +08:00
let point3d: Point3d = {x: 1, y: 2, z: 3};
2015-06-13 13:20:04 +08:00
```