## Class基本語法
### (1)概述
JavaScript語言的傳統方法是通過構造函數,定義并生成新對象。下面是一個例子。
~~~
function Point(x,y){
this.x = x;
this.y = y;
}
Point.prototype.toString = function () {
return '(' + this.x + ', ' + this.y + ')';
}
~~~
上面這種寫法跟傳統的面向對象語言(比如C++和Java)差異很大,很容易讓新學習這門語言的程序員感到困惑。
ES6提供了更接近傳統語言的寫法,引入了Class(類)這個概念,作為對象的模板。通過class關鍵字,可以定義類。基本上,ES6的class可以看作只是一個語法糖,它的絕大部分功能,ES5都可以做到,新的class寫法只是讓對象原型的寫法更加清晰、更像面向對象編程的語法而已。上面的代碼用ES6的“類”改寫,就是下面這樣。
~~~
//定義類
class Point {
constructor(x, y) {
this.x = x;
this.y = y;
}
toString() {
return '('+this.x+', '+this.y+')';
}
}
~~~
上面代碼定義了一個“類”,可以看到里面有一個constructor方法,這就是構造方法,而this關鍵字則代表實例對象。也就是說,ES5的構造函數Point,對應ES6的Point類的構造方法。
Point類除了構造方法,還定義了一個toString方法。注意,定義“類”的方法的時候,前面不需要加上function這個保留字,直接把函數定義放進去了就可以了。
ES6的類,完全可以看作構造函數的另一種寫法。
~~~
class Point{
// ...
}
typeof Point // "function"
~~~
上面代碼表明,類的數據類型就是函數。
構造函數的prototype屬性,在ES6的“類”上面繼續存在。事實上,除了constructor方法以外,類的方法都定義在類的prototype屬性上面。
~~~
class Point {
constructor(){
// ...
}
toString(){
// ...
}
toValue(){
// ...
}
}
// 等同于
Point.prototype = {
toString(){},
toValue(){}
}
~~~
由于類的方法(除constructor以外)都定義在prototype對象上面,所以類的新方法可以添加在prototype對象上面。`Object.assign`方法可以很方便地一次向類添加多個方法。
~~~
class Point {
constructor(){
// ...
}
}
Object.assign(Point.prototype, {
toString(){},
toValue(){}
})
~~~
prototype對象的constructor屬性,直接指向“類”的本身,這與ES5的行為是一致的。
~~~
Point.prototype.constructor === Point // true
~~~
另外,類的內部所有定義的方法,都是不可枚舉的(enumerable)。
~~~
class Point {
constructor(x, y) {
// ...
}
toString() {
// ...
}
}
Object.keys(Point.prototype)
// []
Object.getOwnPropertyNames(Point.prototype)
// ["constructor","toString"]
~~~
上面代碼中,toString方法是Point類內部定義的方法,它是不可枚舉的。這一點與ES5的行為不一致。
~~~
var Point = function (x, y){
// ...
}
Point.prototype.toString = function() {
// ...
}
Object.keys(Point.prototype)
// ["toString"]
Object.getOwnPropertyNames(Point.prototype)
// ["constructor","toString"]
~~~
上面代碼采用ES5的寫法,toString方法就是可枚舉的。
類的屬性名,可以采用表達式。
~~~
let methodName = "getArea";
class Square{
constructor(length) {
// ...
}
[methodName]() {
// ...
}
}
~~~
上面代碼中,Square類的方法名getArea,是從表達式得到的。
### (2)constructor方法
constructor方法是類的默認方法,通過new命令生成對象實例時,自動調用該方法。一個類必須有constructor方法,如果沒有顯式定義,一個空的constructor方法會被默認添加。
~~~
constructor() {}
~~~
constructor方法默認返回實例對象(即this),完全可以指定返回另外一個對象。
~~~
class Foo {
constructor() {
return Object.create(null);
}
}
new Foo() instanceof Foo
// false
~~~
上面代碼中,constructor函數返回一個全新的對象,結果導致實例對象不是Foo類的實例。
### (3)實例對象
生成實例對象的寫法,與ES5完全一樣,也是使用new命令。如果忘記加上new,像函數那樣調用Class,將會報錯。
~~~
// 報錯
var point = Point(2, 3);
// 正確
var point = new Point(2, 3);
~~~
與ES5一樣,實例的屬性除非顯式定義在其本身(即定義在this對象上),否則都是定義在原型上(即定義在class上)。
~~~
//定義類
class Point {
constructor(x, y) {
this.x = x;
this.y = y;
}
toString() {
return '('+this.x+', '+this.y+')';
}
}
var point = new Point(2, 3);
point.toString() // (2, 3)
point.hasOwnProperty('x') // true
point.hasOwnProperty('y') // true
point.hasOwnProperty('toString') // false
point.__proto__.hasOwnProperty('toString') // true
~~~
上面代碼中,x和y都是實例對象point自身的屬性(因為定義在this變量上),所以hasOwnProperty方法返回true,而toString是原型對象的屬性(因為定義在Point類上),所以hasOwnProperty方法返回false。這些都與ES5的行為保持一致。
與ES5一樣,類的所有實例共享一個原型對象。
~~~
var p1 = new Point(2,3);
var p2 = new Point(3,2);
p1.__proto__ === p2.__proto__
//true
~~~
上面代碼中,p1和p2都是Point的實例,它們的原型都是Point,所以__proto__屬性是相等的。
這也意味著,可以通過實例的__proto__屬性為Class添加方法。
~~~
var p1 = new Point(2,3);
var p2 = new Point(3,2);
p1.__proto__.printName = function () { return 'Oops' };
p1.printName() // "Oops"
p2.printName() // "Oops"
var p3 = new Point(4,2);
p3.printName() // "Oops"
~~~
上面代碼在p1的原型上添加了一個printName方法,由于p1的原型就是p2的原型,因此p2也可以調用這個方法。而且,此后新建的實例p3也可以調用這個方法。這意味著,使用實例的__proto__屬性改寫原型,必須相當謹慎,不推薦使用,因為這會改變Class的原始定義,影響到所有實例。
### (4)name屬性
由于本質上,ES6的Class只是ES5的構造函數的一層包裝,所以函數的許多特性都被Class繼承,包括name屬性。
~~~
class Point {}
Point.name // "Point"
~~~
name屬性總是返回緊跟在class關鍵字后面的類名。
### (5)Class表達式
與函數一樣,Class也可以使用表達式的形式定義。
~~~
const MyClass = class Me {
getClassName() {
return Me.name;
}
};
~~~
上面代碼使用表達式定義了一個類。需要注意的是,這個類的名字是MyClass而不是Me,Me只在Class的內部代碼可用,指代當前類。
~~~
let inst = new MyClass();
inst.getClassName() // Me
Me.name // ReferenceError: Me is not defined
~~~
上面代碼表示,Me只在Class內部有定義。
如果Class內部沒用到的話,可以省略Me,也就是可以寫成下面的形式。
~~~
const MyClass = class { /* ... */ };
~~~
采用Class表達式,可以寫出立即執行的Class。
~~~
let person = new class {
constructor(name) {
this.name = name;
}
sayName() {
console.log(this.name);
}
}("張三");
person.sayName(); // "張三"
~~~
上面代碼中,person是一個立即執行的Class的實例。
### (6)不存在變量提升
Class不存在變量提升(hoist),這一點與ES5完全不同。
~~~
new Foo(); // ReferenceError
class Foo {}
~~~
上面代碼中,Foo類使用在前,定義在后,這樣會報錯,因為ES6不會把變量聲明提升到代碼頭部。這種規定的原因與下文要提到的繼承有關,必須保證子類在父類之后定義。
~~~
{
let Foo = class {};
class Bar extends Foo {
}
}
~~~
如果存在Class的提升,上面代碼將報錯,因為let命令也是不提升的。
### (7)嚴格模式
類和模塊的內部,默認就是嚴格模式,所以不需要使用`use strict`指定運行模式。只要你的代碼寫在類或模塊之中,就只有嚴格模式可用。
考慮到未來所有的代碼,其實都是運行在模塊之中,所以ES6實際上把整個語言升級到了嚴格模式。
## Class的繼承
### 基本用法
Class之間可以通過extends關鍵字,實現繼承,這比ES5的通過修改原型鏈實現繼承,要清晰和方便很多。
~~~
class ColorPoint extends Point {}
~~~
上面代碼定義了一個ColorPoint類,該類通過extends關鍵字,繼承了Point類的所有屬性和方法。但是由于沒有部署任何代碼,所以這兩個類完全一樣,等于復制了一個Point類。下面,我們在ColorPoint內部加上代碼。
~~~
class ColorPoint extends Point {
constructor(x, y, color) {
super(x, y); // 調用父類的constructor(x, y)
this.color = color;
}
toString() {
return this.color + ' ' + super.toString(); // 調用父類的toString()
}
}
~~~
上面代碼中,constructor方法和toString方法之中,都出現了super關鍵字,它指代父類的實例(即父類的this對象)。
子類必須在constructor方法中調用super方法,否則新建實例時會報錯。這是因為子類沒有自己的this對象,而是繼承父類的this對象,然后對其進行加工。如果不調用super方法,子類就得不到this對象。
~~~
class Point { /* ... */ }
class ColorPoint extends Point {
constructor() {
}
}
let cp = new ColorPoint(); // ReferenceError
~~~
上面代碼中,ColorPoint繼承了父類Point,但是它的構造函數沒有調用super方法,導致新建實例時報錯。
ES5的繼承,實質是先創造子類的實例對象this,然后再將父類的方法添加到this上面(`Parent.apply(this)`)。ES6的繼承機制完全不同,實質是先創造父類的實例對象this(所以必須先調用super方法),然后再用子類的構造函數修改this。
如果子類沒有定義constructor方法,這個方法會被默認添加,代碼如下。也就是說,不管有沒有顯式定義,任何一個子類都有constructor方法。
~~~
constructor(...args) {
super(...args);
}
~~~
另一個需要注意的地方是,在子類的構造函數中,只有調用super之后,才可以使用this關鍵字,否則會報錯。這是因為子類實例的構建,是基于對父類實例加工,只有super方法才能返回父類實例。
~~~
class Point {
constructor(x, y) {
this.x = x;
this.y = y;
}
}
class ColorPoint extends Point {
constructor(x, y, color) {
this.color = color; // ReferenceError
super(x, y);
this.color = color; // 正確
}
}
~~~
上面代碼中,子類的constructor方法沒有調用super之前,就使用this關鍵字,結果報錯,而放在super方法之后就是正確的。
下面是生成子類實例的代碼。
~~~
let cp = new ColorPoint(25, 8, 'green');
cp instanceof ColorPoint // true
cp instanceof Point // true
~~~
上面代碼中,實例對象cp同時是ColorPoint和Point兩個類的實例,這與ES5的行為完全一致。
### 類的prototype屬性和__proto__屬性
在ES5中,每一個對象都有`__proto__`屬性,指向對應的構造函數的prototype屬性。Class作為構造函數的語法糖,同時有prototype屬性和`__proto__`屬性,因此同時存在兩條繼承鏈。
(1)子類的`__proto__`屬性,表示構造函數的繼承,總是指向父類。
(2)子類prototype屬性的`__proto__`屬性,表示方法的繼承,總是指向父類的prototype屬性。
~~~
class A {
}
class B extends A {
}
B.__proto__ === A // true
B.prototype.__proto__ === A.prototype // true
~~~
上面代碼中,子類A的`__proto__`屬性指向父類B,子類A的prototype屬性的**proto**屬性指向父類B的prototype屬性。
這兩條繼承鏈,可以這樣理解:作為一個對象,子類(B)的原型(`__proto__屬性`)是父類(A);作為一個構造函數,子類(B)的原型(prototype屬性)是父類的實例。
~~~
B.prototype = new A();
// 等同于
B.prototype.__proto__ = A.prototype;
~~~
此外,考慮三種特殊情況。第一種特殊情況,子類繼承Object類。
~~~
class A extends Object {
}
A.__proto__ === Object // true
A.prototype.__proto__ === Object.prototype // true
~~~
這種情況下,A其實就是構造函數Object的復制,A的實例就是Object的實例。
第二種特性情況,不存在任何繼承。
~~~
class A {
}
A.__proto__ === Function.prototype // true
A.prototype.__proto__ === Object.prototype // true
~~~
這種情況下,A作為一個基類(即不存在任何繼承),就是一個普通函數,所以直接繼承`Funciton.prototype`。但是,A調用后返回一個空對象(即Object實例),所以`A.prototype.__proto__`指向構造函數(Object)的prototype屬性。
第三種特殊情況,子類繼承null。
~~~
class A extends null {
}
A.__proto__ === Function.prototype // true
A.prototype.__proto__ === null // true
~~~
這種情況與第二種情況非常像。A也是一個普通函數,所以直接繼承`Funciton.prototype`。但是,A調用后返回的對象不繼承任何方法,所以它的`__proto__`指向`Function.prototype`,即實質上執行了下面的代碼。
~~~
class C extends null {
constructor() { return Object.create(null); }
}
~~~
### Object.getPrototypeOf()
Object.getPrototypeOf方法可以用來從子類上獲取父類。
~~~
Object.getPrototypeOf(ColorPoint) === Point
// true
~~~
### 實例的__proto__屬性
父類實例和子類實例的__proto__屬性,指向是不一樣的。
~~~
var p1 = new Point(2, 3);
var p2 = new ColorPoint(2, 3, 'red');
p2.__proto__ === p1.__proto // false
p2.__proto__.__proto__ === p1.__proto__ // true
~~~
通過子類實例的__proto__屬性,可以修改父類實例的行為。
~~~
p2.__proto__.__proto__.printName = function () {
console.log('Ha');
};
p1.printName() // "Ha"
~~~
上面代碼在ColorPoint的實例p2上向Point類添加方法,結果影響到了Point的實例p1。
### 原生構造函數的繼承
原生構造函數是指語言內置的構造函數,通常用來生成數據結構,比如`Array()`。以前,這些原生構造函數是無法繼承的,即不能自己定義一個Array的子類。
~~~
function MyArray() {
Array.apply(this, arguments);
}
MyArray.prototype = Object.create(Array.prototype, {
constructor: {
value: MyArray,
writable: true,
configurable: true,
enumerable: true
}
});
~~~
上面代碼定義了一個繼承Array的MyArray類。但是,這個類的行為與Array完全不一致。
~~~
var colors = new MyArray();
colors[0] = "red";
colors.length // 0
colors.length = 0;
colors[0] // "red"
~~~
之所以會發生這種情況,是因為原生構造函數無法外部獲取,通過`Array.apply()`或者分配給原型對象都不行。ES5是先新建子類的實例對象this,再將父類的屬性添加到子類上,由于父類的屬性無法獲取,導致無法繼承原生的構造函數。
ES6允許繼承原生構造函數定義子類,因為ES6是先新建父類的實例對象this,然后再用子類的構造函數修飾this,使得父類的所有行為都可以繼承。下面是一個繼承Array的例子。
~~~
class MyArray extends Array {
constructor(...args) {
super(...args);
}
}
var arr = new MyArray();
arr[0] = 12;
arr.length // 1
arr.length = 0;
arr[0] // undefined
~~~
上面代碼定義了一個MyArray類,繼承了Array構造函數,因此就可以從MyArray生成數組的實例。這意味著,ES6可以自定義原生數據結構(比如Array、String等)的子類,這是ES5無法做到的。
上面這個例子也說明,extends關鍵字不僅可以用來繼承類,還可以用來繼承原生的構造函數。下面是一個自定義Error子類的例子。
~~~
class MyError extends Error {
}
throw new MyError('Something happened!');
~~~
## class的取值函數(getter)和存值函數(setter)
與ES5一樣,在Class內部可以使用get和set關鍵字,對某個屬性設置存值函數和取值函數,攔截該屬性的存取行為。
~~~
class MyClass {
constructor() {
// ...
}
get prop() {
return 'getter';
}
set prop(value) {
console.log('setter: '+value);
}
}
let inst = new MyClass();
inst.prop = 123;
// setter: 123
inst.prop
// 'getter'
~~~
上面代碼中,prop屬性有對應的存值函數和取值函數,因此賦值和讀取行為都被自定義了。
存值函數和取值函數是設置在屬性的descriptor對象上的。
~~~
class CustomHTMLElement {
constructor(element) {
this.element = element;
}
get html() {
return this.element.innerHTML;
}
set html(value) {
this.element.innerHTML = value;
}
}
var descriptor = Object.getOwnPropertyDescriptor(
CustomHTMLElement.prototype, "html");
"get" in descriptor // true
"set" in descriptor // true
~~~
上面代碼中,存值函數和取值函數是定義在html屬性的描述對象上面,這與ES5完全一致。
下面的例子針對所有屬性,設置存值函數和取值函數。
~~~
class Jedi {
constructor(options = {}) {
// ...
}
set(key, val) {
this[key] = val;
}
get(key) {
return this[key];
}
}
~~~
上面代碼中,Jedi實例所有屬性的存取,都會通過存值函數和取值函數。
## Class的Generator方法
如果某個方法之前加上星號(*),就表示該方法是一個Generator函數。
~~~
class Foo {
constructor(...args) {
this.args = args;
}
* [Symbol.iterator]() {
for (let arg of this.args) {
yield arg;
}
}
}
for (let x of new Foo('hello', 'world')) {
console.log(x);
}
// hello
// world
~~~
上面代碼中,Foo類的Symbol.iterator方法前有一個星號,表示該方法是一個Generator函數。Symbol.iterator方法返回一個Foo類的默認遍歷器,for...of循環會自動調用這個遍歷器。
## Class的靜態方法
類相當于實例的原型,所有在類中定義的方法,都會被實例繼承。如果在一個方法前,加上static關鍵字,就表示該方法不會被實例繼承,而是直接通過類來調用,這就稱為“靜態方法”。
~~~
class Foo {
static classMethod() {
return 'hello';
}
}
Foo.classMethod() // 'hello'
var foo = new Foo();
foo.classMethod()
// TypeError: undefined is not a function
~~~
上面代碼中,Foo類的classMethod方法前有static關鍵字,表明該方法是一個靜態方法,可以直接在Foo類上調用(`Foo.classMethod()`),而不是在Foo類的實例上調用。如果在實例上調用靜態方法,會拋出一個錯誤,表示不存在該方法。
父類的靜態方法,可以被子類繼承。
~~~
class Foo {
static classMethod() {
return 'hello';
}
}
class Bar extends Foo {
}
Bar.classMethod(); // 'hello'
~~~
上面代碼中,父類Foo有一個靜態方法,子類Bar可以調用這個方法。
靜態方法也是可以從super對象上調用的。
~~~
class Foo {
static classMethod() {
return 'hello';
}
}
class Bar extends Foo {
static classMethod() {
return super.classMethod() + ', too';
}
}
Bar.classMethod();
~~~
## new.target屬性
new是從構造函數生成實例的命令。ES6為new命令引入了一個`new.target`屬性,(在構造函數中)返回new命令作用于的那個構造函數。如果構造函數不是通過new命令調用的,`new.target`會返回undefined,因此這個屬性可以用來確定構造函數是怎么調用的。
~~~
function Person(name) {
if (new.target !== undefined) {
this.name = name;
} else {
throw new Error('必須使用new生成實例');
}
}
// 另一種寫法
function Person(name) {
if (new.target === Person) {
this.name = name;
} else {
throw new Error('必須使用new生成實例');
}
}
var person = new Person('張三'); // 正確
var notAPerson = Person.call(person, '張三'); // 報錯
~~~
上面代碼確保構造函數只能通過new命令調用。
Class內部調用`new.target`,返回當前Class。
~~~
class Rectangle {
constructor(length, width) {
console.log(new.target === Rectangle);
this.length = length;
this.width = width;
}
}
var obj = new Rectangle(3, 4); // 輸出 true
~~~
需要注意的是,子類繼承父類時,`new.target`會返回子類。
~~~
class Rectangle {
constructor(length, width) {
console.log(new.target === Rectangle);
// ...
}
}
class Square extends Rectangle {
constructor(length) {
super(length, length);
}
}
var obj = new Square(3); // 輸出 false
~~~
上面代碼中,`new.target`會返回子類。
利用這個特點,可以寫出不能獨立使用、必須繼承后才能使用的類。
~~~
class Shape {
constructor() {
if (new.target === Shape) {
throw new Error('本類不能實例化');
}
}
}
class Rectangle extends Shape {
constructor(length, width) {
super();
// ...
}
}
var x = new Shape(); // 報錯
var y = new Rectangle(3, 4); // 正確
~~~
上面代碼中,Shape類不能被實例化,只能用于繼承。
注意,在函數外部,使用`new.target`會報錯。
## 修飾器
### 類的修飾
修飾器(Decorator)是一個表達式,用來修改類的行為。這是ES7的一個[提案](https://github.com/wycats/javascript-decorators),目前Babel轉碼器已經支持。
修飾器對類的行為的改變,是代碼編譯時發生的,而不是在運行時。這意味著,修飾器能在編譯階段運行代碼。
~~~
function testable(target) {
target.isTestable = true;
}
@testable
class MyTestableClass () {}
console.log(MyTestableClass.isTestable) // true
~~~
上面代碼中,`@testable`就是一個修飾器。它修改了MyTestableClass這個類的行為,為它加上了靜態屬性isTestable。
修飾器函數可以接受三個參數,依次是目標函數、屬性名和該屬性的描述對象。后兩個參數可省略。上面代碼中,testable函數的參數target,就是所要修飾的對象。如果希望修飾器的行為,能夠根據目標對象的不同而不同,就要在外面再封裝一層函數。
~~~
function testable(isTestable) {
return function(target) {
target.isTestable = isTestable;
}
}
@testable(true) class MyTestableClass () {}
console.log(MyTestableClass.isTestable) // true
@testable(false) class MyClass () {}
console.log(MyClass.isTestable) // false
~~~
上面代碼中,修飾器testable可以接受參數,這就等于可以修改修飾器的行為。
如果想要為類的實例添加方法,可以在修飾器函數中,為目標類的prototype屬性添加方法。
~~~
function testable(target) {
target.prototype.isTestable = true;
}
@testable
class MyTestableClass () {}
let obj = new MyClass();
console.log(obj.isTestable) // true
~~~
上面代碼中,修飾器函數testable是在目標類的prototype屬性添加屬性,因此就可以在類的實例上調用添加的屬性。
下面是另外一個例子。
~~~
// mixins.js
export function mixins(...list) {
return function (target) {
Object.assign(target.prototype, ...list)
}
}
// main.js
import { mixins } from './mixins'
const Foo = {
foo() { console.log('foo') }
}
@mixins(Foo)
class MyClass {}
let obj = new MyClass()
obj.foo() // 'foo'
~~~
上面代碼通過修飾器mixins,可以為類添加指定的方法。
修飾器可以用`Object.assign()`模擬。
~~~
const Foo = {
foo() { console.log('foo') }
}
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
~~~
### 方法的修飾
修飾器不僅可以修飾類,還可以修飾類的屬性。
~~~
class Person {
@readonly
name() { return `${this.first} ${this.last}` }
}
~~~
上面代碼中,修飾器readonly用來修飾”類“的name方法。
此時,修飾器函數一共可以接受三個參數,第一個參數是所要修飾的目標對象,第二個參數是所要修飾的屬性名,第三個參數是該屬性的描述對象。
~~~
readonly(Person.prototype, 'name', descriptor);
function readonly(target, name, descriptor){
// descriptor對象原來的值如下
// {
// value: specifiedFunction,
// enumerable: false,
// configurable: true,
// writable: true
// };
descriptor.writable = false;
return descriptor;
}
Object.defineProperty(Person.prototype, 'name', descriptor);
~~~
上面代碼說明,修飾器(readonly)會修改屬性的描述對象(descriptor),然后被修改的描述對象再用來定義屬性。下面是另一個例子。
~~~
class Person {
@nonenumerable
get kidCount() { return this.children.length; }
}
function nonenumerable(target, name, descriptor) {
descriptor.enumerable = false;
return descriptor;
}
~~~
修飾器有注釋的作用。
~~~
@testable
class Person {
@readonly
@nonenumerable
name() { return `${this.first} ${this.last}` }
}
~~~
從上面代碼中,我們一眼就能看出,MyTestableClass類是可測試的,而name方法是只讀和不可枚舉的。
除了注釋,修飾器還能用來類型檢查。所以,對于Class來說,這項功能相當有用。從長期來看,它將是JavaScript代碼靜態分析的重要工具。
### core-decorators.js
[core-decorators.js](https://github.com/jayphelps/core-decorators.js)是一個第三方模塊,提供了幾個常見的修飾器,通過它可以更好地理解修飾器。
**(1)@autobind**
autobind修飾器使得方法中的this對象,綁定原始對象。
~~~
import { autobind } from 'core-decorators';
class Person {
@autobind
getPerson() {
return this;
}
}
let person = new Person();
let getPerson = person.getPerson;
getPerson() === person;
// true
~~~
**(2)@readonly**
readonly修飾器是的屬性或方法不可寫。
~~~
import { readonly } from 'core-decorators';
class Meal {
@readonly
entree = 'steak';
}
var dinner = new Meal();
dinner.entree = 'salmon';
// Cannot assign to read only property 'entree' of [object Object]
~~~
**(3)@override**
override修飾器檢查子類的方法,是否正確覆蓋了父類的同名方法,如果不正確會報錯。
~~~
import { override } from 'core-decorators';
class Parent {
speak(first, second) {}
}
class Child extends Parent {
@override
speak() {}
// SyntaxError: Child#speak() does not properly override Parent#speak(first, second)
}
// or
class Child extends Parent {
@override
speaks() {}
// SyntaxError: No descriptor matching Child#speaks() was found on the prototype chain.
//
// Did you mean "speak"?
}
~~~
**(4)@deprecate (別名@deprecated)**
deprecate或deprecated修飾器在控制臺顯示一條警告,表示該方法將廢除。
~~~
import { deprecate } from 'core-decorators';
class Person {
@deprecate
facepalm() {}
@deprecate('We stopped facepalming')
facepalmHard() {}
@deprecate('We stopped facepalming', { url: 'http://knowyourmeme.com/memes/facepalm' })
facepalmHarder() {}
}
let person = new Person();
person.facepalm();
// DEPRECATION Person#facepalm: This function will be removed in future versions.
person.facepalmHard();
// DEPRECATION Person#facepalmHard: We stopped facepalming
person.facepalmHarder();
// DEPRECATION Person#facepalmHarder: We stopped facepalming
//
// See http://knowyourmeme.com/memes/facepalm for more details.
//
~~~
**(5)@suppressWarnings**
suppressWarnings修飾器抑制decorated修飾器導致的`console.warn()`調用。但是,異步代碼出發的調用除外。
~~~
import { suppressWarnings } from 'core-decorators';
class Person {
@deprecated
facepalm() {}
@suppressWarnings
facepalmWithoutWarning() {
this.facepalm();
}
}
let person = new Person();
person.facepalmWithoutWarning();
// no warning is logged
~~~
### Mixin
在修飾器的基礎上,可以實現Mixin模式。所謂Mixin模式,就是對象繼承的一種替代方案,中文譯為“混入”(mix in),意為在一個對象之中混入另外一個對象的方法。
請看下面的例子。
~~~
const Foo = {
foo() { console.log('foo') }
};
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
~~~
上面代碼之中,對象Foo有一個foo方法,通過`Object.assign`方法,可以將foo方法“混入”MyClass類,導致MyClass的實例obj對象都具有foo方法。這就是“混入”模式的一個簡單實現。
下面,我們部署一個通用腳本`mixins.js`,將mixin寫成一個修飾器。
~~~
export function mixins(...list) {
return function (target) {
Object.assign(target.prototype, ...list);
};
}
~~~
然后,就可以使用上面這個修飾器,為類“混入”各種方法。
~~~
import { mixins } from './mixins'
const Foo = {
foo() { console.log('foo') }
};
@mixins(Foo)
class MyClass {}
let obj = new MyClass();
obj.foo() // "foo"
~~~
通過mixins這個修飾器,實現了在MyClass類上面“混入”Foo對象的foo方法。
### Trait
Trait也是一種修飾器,功能與Mixin類型,但是提供更多功能,比如防止同名方法的沖突、排除混入某些方法、為混入的方法起別名等等。
下面采用[traits-decorator](https://github.com/CocktailJS/traits-decorator)這個第三方模塊作為例子。這個模塊提供的traits修飾器,不僅可以接受對象,還可以接受ES6類作為參數。
~~~
import {traits } from 'traits-decorator'
class TFoo {
foo() { console.log('foo') }
}
const TBar = {
bar() { console.log('bar') }
}
@traits(TFoo, TBar)
class MyClass { }
let obj = new MyClass()
obj.foo() // foo
obj.bar() // bar
~~~
上面代碼中,通過traits修飾器,在MyClass類上面“混入”了TFoo類的foo方法和TBar對象的bar方法。
Trait不允許“混入”同名方法。
~~~
import {traits } from 'traits-decorator'
class TFoo {
foo() { console.log('foo') }
}
const TBar = {
bar() { console.log('bar') },
foo() { console.log('foo') }
}
@traits(TFoo, TBar)
class MyClass { }
// 報錯
// throw new Error('Method named: ' + methodName + ' is defined twice.');
// ^
// Error: Method named: foo is defined twice.
~~~
上面代碼中,TFoo和TBar都有foo方法,結果traits修飾器報錯。
一種解決方法是排除TBar的foo方法。
~~~
import { traits, excludes } from 'traits-decorator'
class TFoo {
foo() { console.log('foo') }
}
const TBar = {
bar() { console.log('bar') },
foo() { console.log('foo') }
}
@traits(TFoo, TBar::excludes('foo'))
class MyClass { }
let obj = new MyClass()
obj.foo() // foo
obj.bar() // bar
~~~
上面代碼使用綁定運算符(::)在TBar上排除foo方法,混入時就不會報錯了。
另一種方法是為TBar的foo方法起一個別名。
~~~
import { traits, alias } from 'traits-decorator'
class TFoo {
foo() { console.log('foo') }
}
const TBar = {
bar() { console.log('bar') },
foo() { console.log('foo') }
}
@traits(TFoo, TBar::alias({foo: 'aliasFoo'}))
class MyClass { }
let obj = new MyClass()
obj.foo() // foo
obj.aliasFoo() // foo
obj.bar() // bar
~~~
上面代碼為TBar的foo方法起了別名aliasFoo,于是MyClass也可以混入TBar的foo方法了。
alias和excludes方法,可以結合起來使用。
~~~
@traits(TExample::excludes('foo','bar')::alias({baz:'exampleBaz'}))
class MyClass {}
~~~
上面代碼排除了TExample的foo方法和bar方法,為baz方法起了別名exampleBaz。
as方法則為上面的代碼提供了另一種寫法。
~~~
@traits(TExample::as({excludes:['foo', 'bar'], alias: {baz: 'exampleBaz'}}))
class MyClass {}
~~~
### Babel轉碼器的支持
目前,Babel轉碼器已經支持Decorator,命令行的用法如下。
~~~
$ babel --optional es7.decorators
~~~
腳本中打開的命令如下。
~~~
babel.transfrom("code", {optional: ["es7.decorators"]})
~~~
Babel的官方網站提供一個[在線轉碼器](https://babeljs.io/repl/),只要勾選Experimental,就能支持Decorator的在線轉碼。