ES6 系列之私有變量的實現

前言

在閱讀 《ECMAScript 6 入門》的時候,零散的看到有私有變量的實現,所以在此總結一篇。

1. 約定

實現

class Example {
    constructor() {
        this._private = 'private';
    }
    getName() {
        return this._private
    }
}

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex._private); // private

優點

  1. 寫法簡單
  2. 調試方便
  3. 兼容性好

缺點

  1. 外部可以訪問和修改
  2. 語言沒有配合的機制,如 for in 語句會將所有屬性枚舉出來
  3. 命名衝突

2. 閉包

實現一

/**
 * 實現一
 */
class Example {
  constructor() {
    var _private = '';
    _private = 'private';
    this.getName = function() {return _private}
  }
}

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex._private); // undefined

優點

  1. 無命名衝突
  2. 外部無法訪問和修改

缺點

  1. constructor 的邏輯變得複雜。構造函數應該只做對象初始化的事情,現在爲了實現私有變量,必須包含部分方法的實現,代碼組織上略不清晰。
  2. 方法存在於實例,而非原型上,子類也無法使用 super 調用
  3. 構建增加一點點開銷

實現二

/**
 * 實現二
 */
const Example = (function() {
  var _private = '';

  class Example {
    constructor() {
      _private = 'private';
    }
    getName() {
      return _private;
    }
  }

  return Example;

})();

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex._private); // undefined

優點

  1. 無命名衝突
  2. 外部無法訪問和修改

缺點

  1. 寫法有一點複雜
  2. 構建增加一點點開銷

3. Symbol

實現

const Example = (function() {
    var _private = Symbol('private');

    class Example {
        constructor() {
          this[_private] = 'private';
        }
        getName() {
          return this[_private];
        }
    }

    return Example;
})();

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex.name); // undefined

優點

  1. 無命名衝突
  2. 外部無法訪問和修改
  3. 無性能損失

缺點

  1. 寫法稍微複雜
  2. 兼容性也還好

4. WeakMap

實現

/**
 * 實現一
 */
const _private = new WeakMap();

class Example {
  constructor() {
    _private.set(this, 'private');
  }
  getName() {
      return _private.get(this);
  }
}

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex.name); // undefined

如果這樣寫,你可能覺得封裝性不夠,你也可以這樣寫:

/**
 * 實現二
 */
const Example = (function() {
  var _private = new WeakMap(); // 私有成員存儲容器

  class Example {
    constructor() {
      _private.set(this, 'private');
    }
    getName() {
        return _private.get(this);
    }
  }

  return Example;
})();

var ex = new Example();

console.log(ex.getName()); // private
console.log(ex.name); // undefined

優點

  1. 無命名衝突
  2. 外部無法訪問和修改

缺點

  1. 寫法比較麻煩
  2. 兼容性有點問題
  3. 有一定性能代價

5. 最新提案

class Point {
  #x;
  #y;

  constructor(x, y) {
    this.#x = x;
    this.#y = y;
  }

  equals(point) {
    return this.#x === point.#x && this.#y === point.#y;
  }
}

那麼爲什麼不直接使用 private 字段呢?比如說這樣:

class Foo {
  private value;

  equals(foo) {
    return this.value === foo.value;
  }
}

簡單點來說,就是嫌麻煩,當然也有性能上的考慮……

舉個例子,如果我們不使用 #,而是使用 private 關鍵字:

class Foo {
  private value = '1';

  equals(foo) {
    return this.value === foo.value;
  }
}

var foo1 = new Foo();
var foo2 = new Foo();

console.log(foo1.equals(foo2));

在這裏我們新建了兩個實例,然後將 foo2 作爲參數傳入了 foo1 的實例方法中。

那麼我們可以獲取 foo2.value 的值嗎?如果我們直接 foo2.value 肯定是獲取不到值的,畢竟是私有變量,可是 equals 是 Foo 的一個類方法,那麼可以獲取到的嗎?

答案是可以的。

其實這點在其他語言,比如說 Java 和 C++ 中也是一樣的,類的成員函數中可以訪問同類型實例的私有變量,這是因爲私有是爲了實現“對外”的信息隱藏,在類自己內部,沒有必要禁止私有變量的訪問,你也可以理解爲私有變量的限制是以類爲單位,而不是以對象爲單位,此外這樣做也可以爲使用者帶來便利。

既然獲取值是可以的,那麼打印的結果應該爲 true,但是如果我們傳入的值不是 Foo 的實例,而是一個其他對象呢?

var foo1 = new Foo();

console.log(foo1.equals({
  value: 2
}));

當然這裏代碼也是可以正常運行的,但是對於編譯器來說,就有一點麻煩了,因爲編譯器不知道 value 到底是 foo 的正常屬性還是私有屬性,所以編譯器需要做判斷,先判斷 foo 是不是 Foo 的實例,然後再接着獲取值。

這也意味着每次屬性訪問都需要做這樣一個判斷,而引擎已經圍繞屬性訪問做了高度優化,懶得改,而且還降低速度。

不過除了這個工作之外,還會有一些其他的內容需要考慮,比如說:

  1. 你必須將私有的 key 編碼進每個詞法環境
  2. for in 可以遍歷這些屬性嗎?
  3. 私有屬性和正常屬性同名的時候,誰會屏蔽誰?
  4. 怎麼防止私有屬性的名稱不被探測出來。

關於使用 # 而不使用 private 更多的討論可以參考這個 Issue

當然這些問題都可以被解決啦,就是麻煩了點。

而如果你選擇 #,實現的方式將跟 JavaScript 對象屬性完全沒有關係,將會使用 private slots 的方式以及使用一個新的 slot 查找語法,總之就是會比 private 的實現方式簡單很多。

參考

  1. 《編程語言如何演化——以JS的private爲例》賀師俊
  2. Exploring ES6
  3. 譯 JS 新語法:私有屬性

ES6 系列

ES6 系列目錄地址:https://github.com/mqyqingfeng/Blog

ES6 系列預計寫二十篇左右,旨在加深 ES6 部分知識點的理解,重點講解塊級作用域、標籤模板、箭頭函數、Symbol、Set、Map 以及 Promise 的模擬實現、模塊加載方案、異步處理等內容。

如果有錯誤或者不嚴謹的地方,請務必給予指正,十分感謝。如果喜歡或者有所啓發,歡迎 star,對作者也是一種鼓勵。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章