1. 程式人生 > 實用技巧 >Class 的基本語法 - 阮一峰

Class 的基本語法 - 阮一峰

Class 的基本語法

簡介

類的由來

JavaScript 語言中,生成例項物件的傳統方法是通過建構函式。下面是一個例子。

function Point(x, y) {
  this.x = x;
  this.y = y;
}

Point.prototype.toString = function () {
  return '(' + this.x + ', ' + this.y + ')';
};

var p = new Point(1, 2);

上面這種寫法跟傳統的面嚮物件語言(比如 C++ 和 Java)差異很大,很容易讓新學習這門語言的程式設計師感到困惑。

ES6 提供了更接近傳統語言的寫法,引入了 Class(類)這個概念,作為物件的模板。通過class

關鍵字,可以定義類。

基本上,ES6 的class可以看作只是一個語法糖,它的絕大部分功能,ES5 都可以做到,新的class寫法只是讓物件原型的寫法更加清晰、更像面向物件程式設計的語法而已。上面的程式碼用 ES6 的class改寫,就是下面這樣。

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"
Point === Point.prototype.constructor // true

上面程式碼表明,類的資料型別就是函式,類本身就指向建構函式。

使用的時候,也是直接對類使用new命令,跟建構函式的用法完全一致。

class Bar {
  doStuff() {
    console.log('stuff');
  }
}

var b = new Bar();
b.doStuff() // "stuff"

建構函式的prototype屬性,在 ES6 的“類”上面繼續存在。事實上,類的所有方法都定義在類的prototype屬性上面。

class Point {
  constructor() {
    // ...
  }

  toString() {
    // ...
  }

  toValue() {
    // ...
  }
}

// 等同於

Point.prototype = {
  constructor() {},
  toString() {},
  toValue() {},
};

在類的例項上面呼叫方法,其實就是呼叫原型上的方法。

class B {}
let b = new B();

b.constructor === B.prototype.constructor // true

上面程式碼中,bB類的例項,它的constructor方法就是B類原型的constructor方法。

由於類的方法都定義在prototype物件上面,所以類的新方法可以新增在prototype物件上面。Object.assign方法可以很方便地一次向類新增多個方法。

class Point {
  constructor(){
    // ...
  }
}

Object.assign(Point.prototype, {
  toString(){},
  toValue(){}
});

prototype物件的constructor屬性,直接指向“類”的本身,這與 ES5 的行為是一致的。

Point.prototype.constructor === Point // true

另外,類的內部所有定義的方法,都是不可列舉的(non-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方法就是可列舉的。

constructor 方法

constructor方法是類的預設方法,通過new命令生成物件例項時,自動呼叫該方法。一個類必須有constructor方法,如果沒有顯式定義,一個空的constructor方法會被預設新增。

class Point {
}

// 等同於
class Point {
  constructor() {}
}

上面程式碼中,定義了一個空的類Point,JavaScript 引擎會自動為它新增一個空的constructor方法。

constructor方法預設返回例項物件(即this),完全可以指定返回另外一個物件。

class Foo {
  constructor() {
    return Object.create(null);
  }
}

new Foo() instanceof Foo
// false

上面程式碼中,constructor函式返回一個全新的物件,結果導致例項物件不是Foo類的例項。

類必須使用new呼叫,否則會報錯。這是它跟普通建構函式的一個主要區別,後者不用new也可以執行。

class Foo {
  constructor() {
    return Object.create(null);
  }
}

Foo()
// TypeError: Class constructor Foo cannot be invoked without 'new'

類的例項

生成類的例項的寫法,與 ES5 完全一樣,也是使用new命令。前面說過,如果忘記加上new,像函式那樣呼叫Class,將會報錯。

class Point {
  // ...
}

// 報錯
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

上面程式碼中,xy都是例項物件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

上面程式碼中,p1p2都是Point的例項,它們的原型都是Point.prototype,所以__proto__屬性是相等的。

這也意味著,可以通過例項的__proto__屬性為“類”新增方法。

__proto__ 並不是語言本身的特性,這是各大廠商具體實現時新增的私有屬性,雖然目前很多現代瀏覽器的 JS 引擎中都提供了這個私有屬性,但依舊不建議在生產中使用該屬性,避免對環境產生依賴。生產環境中,我們可以使用 Object.getPrototypeOf 方法來獲取例項物件的原型,然後再來為原型新增方法/屬性。

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__屬性改寫原型,必須相當謹慎,不推薦使用,因為這會改變“類”的原始定義,影響到所有例項。

取值函式(getter)和存值函式(setter)

與 ES5 一樣,在“類”的內部可以使用getset關鍵字,對某個屬性設定存值函式和取值函式,攔截該屬性的存取行為。

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 完全一致。

屬性表示式

類的屬性名,可以採用表示式。

let methodName = 'getArea';

class Square {
  constructor(length) {
    // ...
  }

  [methodName]() {
    // ...
  }
}

上面程式碼中,Square類的方法名getArea,是從表示式得到的。

Class 表示式

與函式一樣,類也可以使用表示式的形式定義。

const MyClass = class Me {
  getClassName() {
    return Me.name;
  }
};

上面程式碼使用表示式定義了一個類。需要注意的是,這個類的名字是Me,但是Me只在 Class 的內部可用,指代當前類。在 Class 外部,這個類只能用MyClass引用。

let inst = new MyClass();
inst.getClassName() // Me
Me.name // ReferenceError: Me is not defined

上面程式碼表示,Me只在 Class 內部有定義。

如果類的內部沒用到的話,可以省略Me,也就是可以寫成下面的形式。

const MyClass = class { /* ... */ };

採用 Class 表示式,可以寫出立即執行的 Class。

let person = new class {
  constructor(name) {
    this.name = name;
  }

  sayName() {
    console.log(this.name);
  }
}('張三');

person.sayName(); // "張三"

上面程式碼中,person是一個立即執行的類的例項。

注意點

(1)嚴格模式

類和模組的內部,預設就是嚴格模式,所以不需要使用use strict指定執行模式。只要你的程式碼寫在類或模組之中,就只有嚴格模式可用。考慮到未來所有的程式碼,其實都是執行在模組之中,所以 ES6 實際上把整個語言升級到了嚴格模式。

(2)不存在提升

類不存在變數提升(hoist),這一點與 ES5 完全不同。

new Foo(); // ReferenceError
class Foo {}

上面程式碼中,Foo類使用在前,定義在後,這樣會報錯,因為 ES6 不會把類的宣告提升到程式碼頭部。這種規定的原因與下文要提到的繼承有關,必須保證子類在父類之後定義。

{
  let Foo = class {};
  class Bar extends Foo {
  }
}

上面的程式碼不會報錯,因為Bar繼承Foo的時候,Foo已經有定義了。但是,如果存在class的提升,上面程式碼就會報錯,因為class會被提升到程式碼頭部,而let命令是不提升的,所以導致Bar繼承Foo的時候,Foo還沒有定義。

(3)name 屬性

由於本質上,ES6 的類只是 ES5 的建構函式的一層包裝,所以函式的許多特性都被Class繼承,包括name屬性。

class Point {}
Point.name // "Point"

name屬性總是返回緊跟在class關鍵字後面的類名。

(4)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迴圈會自動呼叫這個遍歷器。

(5)this 的指向

類的方法內部如果含有this,它預設指向類的例項。但是,必須非常小心,一旦單獨使用該方法,很可能報錯。

class Logger {
  printName(name = 'there') {
    this.print(`Hello ${name}`);
  }

  print(text) {
    console.log(text);
  }
}

const logger = new Logger();
const { printName } = logger;
printName(); // TypeError: Cannot read property 'print' of undefined

上面程式碼中,printName方法中的this,預設指向Logger類的例項。但是,如果將這個方法提取出來單獨使用,this會指向該方法執行時所在的環境(由於 class 內部是嚴格模式,所以 this 實際指向的是undefined),從而導致找不到print方法而報錯。

一個比較簡單的解決方法是,在構造方法中繫結this,這樣就不會找不到print方法了。

class Logger {
  constructor() {
    this.printName = this.printName.bind(this);
  }

  // ...
}

另一種解決方法是使用箭頭函式。

class Obj {
  constructor() {
    this.getThis = () => this;
  }
}

const myObj = new Obj();
myObj.getThis() === myObj // true

箭頭函式內部的this總是指向定義時所在的物件。上面程式碼中,箭頭函式位於建構函式內部,它的定義生效的時候,是在建構函式執行的時候。這時,箭頭函式所在的執行環境,肯定是例項物件,所以this會總是指向例項物件。

還有一種解決方法是使用Proxy,獲取方法的時候,自動繫結this

function selfish (target) {
  const cache = new WeakMap();
  const handler = {
    get (target, key) {
      const value = Reflect.get(target, key);
      if (typeof value !== 'function') {
        return value;
      }
      if (!cache.has(value)) {
        cache.set(value, value.bind(target));
      }
      return cache.get(value);
    }
  };
  const proxy = new Proxy(target, handler);
  return proxy;
}

const logger = selfish(new Logger());

靜態方法

類相當於例項的原型,所有在類中定義的方法,都會被例項繼承。如果在一個方法前,加上static關鍵字,就表示該方法不會被例項繼承,而是直接通過類來呼叫,這就稱為“靜態方法”。

class Foo {
  static classMethod() {
    return 'hello';
  }
}

Foo.classMethod() // 'hello'

var foo = new Foo();
foo.classMethod()
// TypeError: foo.classMethod is not a function

上面程式碼中,Foo類的classMethod方法前有static關鍵字,表明該方法是一個靜態方法,可以直接在Foo類上呼叫(Foo.classMethod()),而不是在Foo類的例項上呼叫。如果在例項上呼叫靜態方法,會丟擲一個錯誤,表示不存在該方法。

注意,如果靜態方法包含this關鍵字,這個this指的是類,而不是例項。

class Foo {
  static bar() {
    this.baz();
  }
  static baz() {
    console.log('hello');
  }
  baz() {
    console.log('world');
  }
}

Foo.bar() // hello

上面程式碼中,靜態方法bar呼叫了this.baz,這裡的this指的是Foo類,而不是Foo的例項,等同於呼叫Foo.baz。另外,從這個例子還可以看出,靜態方法可以與非靜態方法重名。

父類的靜態方法,可以被子類繼承。

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() // "hello, too"

例項屬性的新寫法

例項屬性除了定義在constructor()方法裡面的this上面,也可以定義在類的最頂層。

class IncreasingCounter {
  constructor() {
    this._count = 0;
  }
  get value() {
    console.log('Getting the current value!');
    return this._count;
  }
  increment() {
    this._count++;
  }
}

上面程式碼中,例項屬性this._count定義在constructor()方法裡面。另一種寫法是,這個屬性也可以定義在類的最頂層,其他都不變。

class IncreasingCounter {
  _count = 0;
  get value() {
    console.log('Getting the current value!');
    return this._count;
  }
  increment() {
    this._count++;
  }
}

上面程式碼中,例項屬性_count與取值函式value()increment()方法,處於同一個層級。這時,不需要在例項屬性前面加上this

這種新寫法的好處是,所有例項物件自身的屬性都定義在類的頭部,看上去比較整齊,一眼就能看出這個類有哪些例項屬性。

class foo {
  bar = 'hello';
  baz = 'world';

  constructor() {
    // ...
  }
}

上面的程式碼,一眼就能看出,foo類有兩個例項屬性,一目瞭然。另外,寫起來也比較簡潔。

靜態屬性

靜態屬性指的是 Class 本身的屬性,即Class.propName,而不是定義在例項物件(this)上的屬性。

class Foo {
}

Foo.prop = 1;
Foo.prop // 1

上面的寫法為Foo類定義了一個靜態屬性prop

目前,只有這種寫法可行,因為 ES6 明確規定,Class 內部只有靜態方法,沒有靜態屬性。現在有一個提案提供了類的靜態屬性,寫法是在例項屬性的前面,加上static關鍵字。

class MyClass {
  static myStaticProp = 42;

  constructor() {
    console.log(MyClass.myStaticProp); // 42
  }
}

這個新寫法大大方便了靜態屬性的表達。

// 老寫法
class Foo {
  // ...
}
Foo.prop = 1;

// 新寫法
class Foo {
  static prop = 1;
}

上面程式碼中,老寫法的靜態屬性定義在類的外部。整個類生成以後,再生成靜態屬性。這樣讓人很容易忽略這個靜態屬性,也不符合相關程式碼應該放在一起的程式碼組織原則。另外,新寫法是顯式宣告(declarative),而不是賦值處理,語義更好。

私有方法和私有屬性

現有的解決方案

私有方法和私有屬性,是隻能在類的內部訪問的方法和屬性,外部不能訪問。這是常見需求,有利於程式碼的封裝,但 ES6 不提供,只能通過變通方法模擬實現。

一種做法是在命名上加以區別。

class Widget {

  // 公有方法
  foo (baz) {
    this._bar(baz);
  }

  // 私有方法
  _bar(baz) {
    return this.snaf = baz;
  }

  // ...
}

上面程式碼中,_bar方法前面的下劃線,表示這是一個只限於內部使用的私有方法。但是,這種命名是不保險的,在類的外部,還是可以呼叫到這個方法。

另一種方法就是索性將私有方法移出模組,因為模組內部的所有方法都是對外可見的。

class Widget {
  foo (baz) {
    bar.call(this, baz);
  }

  // ...
}

function bar(baz) {
  return this.snaf = baz;
}

上面程式碼中,foo是公開方法,內部呼叫了bar.call(this, baz)。這使得bar實際上成為了當前模組的私有方法。

還有一種方法是利用Symbol值的唯一性,將私有方法的名字命名為一個Symbol值。

const bar = Symbol('bar');
const snaf = Symbol('snaf');

export default class myClass{

  // 公有方法
  foo(baz) {
    this[bar](baz);
  }

  // 私有方法
  [bar](baz) {
    return this[snaf] = baz;
  }

  // ...
};

上面程式碼中,barsnaf都是Symbol值,一般情況下無法獲取到它們,因此達到了私有方法和私有屬性的效果。但是也不是絕對不行,Reflect.ownKeys()依然可以拿到它們。

const inst = new myClass();

Reflect.ownKeys(myClass.prototype)
// [ 'constructor', 'foo', Symbol(bar) ]

上面程式碼中,Symbol 值的屬性名依然可以從類的外部拿到。

私有屬性的提案

目前,有一個提案,為class加了私有屬性。方法是在屬性名之前,使用#表示。

class IncreasingCounter {
  #count = 0;
  get value() {
    console.log('Getting the current value!');
    return this.#count;
  }
  increment() {
    this.#count++;
  }
}

上面程式碼中,#count就是私有屬性,只能在類的內部使用(this.#count)。如果在類的外部使用,就會報錯。

const counter = new IncreasingCounter();
counter.#count // 報錯
counter.#count = 42 // 報錯

上面程式碼在類的外部,讀取私有屬性,就會報錯。

下面是另一個例子。

class Point {
  #x;

  constructor(x = 0) {
    this.#x = +x;
  }

  get x() {
    return this.#x;
  }

  set x(value) {
    this.#x = +value;
  }
}

上面程式碼中,#x就是私有屬性,在Point類之外是讀取不到這個屬性的。由於井號#是屬性名的一部分,使用時必須帶有#一起使用,所以#xx是兩個不同的屬性。

之所以要引入一個新的字首#表示私有屬性,而沒有采用private關鍵字,是因為 JavaScript 是一門動態語言,沒有型別宣告,使用獨立的符號似乎是唯一的比較方便可靠的方法,能夠準確地區分一種屬性是否為私有屬性。另外,Ruby 語言使用@表示私有屬性,ES6 沒有用這個符號而使用#,是因為@已經被留給了 Decorator。

這種寫法不僅可以寫私有屬性,還可以用來寫私有方法。

class Foo {
  #a;
  #b;
  constructor(a, b) {
    this.#a = a;
    this.#b = b;
  }
  #sum() {
    return this.#a + this.#b;
  }
  printSum() {
    console.log(this.#sum());
  }
}

上面程式碼中,#sum()就是一個私有方法。

另外,私有屬性也可以設定 getter 和 setter 方法。

class Counter {
  #xValue = 0;

  constructor() {
    super();
    // ...
  }

  get #x() { return #xValue; }
  set #x(value) {
    this.#xValue = value;
  }
}

上面程式碼中,#x是一個私有屬性,它的讀寫都通過get #x()set #x()來完成。

私有屬性不限於從this引用,只要是在類的內部,例項也可以引用私有屬性。

class Foo {
  #privateValue = 42;
  static getPrivateValue(foo) {
    return foo.#privateValue;
  }
}

Foo.getPrivateValue(new Foo()); // 42

上面程式碼允許從例項foo上面引用私有屬性。

私有屬性和私有方法前面,也可以加上static關鍵字,表示這是一個靜態的私有屬性或私有方法。

class FakeMath {
  static PI = 22 / 7;
  static #totallyRandomNumber = 4;

  static #computeRandomNumber() {
    return FakeMath.#totallyRandomNumber;
  }

  static random() {
    console.log('I heard you like random numbers…')
    return FakeMath.#computeRandomNumber();
  }
}

FakeMath.PI // 3.142857142857143
FakeMath.random()
// I heard you like random numbers…
// 4
FakeMath.#totallyRandomNumber // 報錯
FakeMath.#computeRandomNumber() // 報錯

上面程式碼中,#totallyRandomNumber是私有屬性,#computeRandomNumber()是私有方法,只能在FakeMath這個類的內部呼叫,外部呼叫就會報錯。

new.target 屬性

new是從建構函式生成例項物件的命令。ES6 為new命令引入了一個new.target屬性,該屬性一般用在建構函式之中,返回new命令作用於的那個建構函式。如果建構函式不是通過new命令或Reflect.construct()呼叫的,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, width) {
    super(length, width);
  }
}

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會報錯。