私有方法和私有属性

现有的解决方案

私有方法和私有属性,是只能在类的内部访问的方法和属性,外部不能访问。这是常见需求,有利于代码的封装,但 ES6 不提供,只能通过变通方法模拟实现。

一种做法是在命名上加以区别。

  1. class Widget {
  2. // 公有方法
  3. foo (baz) {
  4. this._bar(baz);
  5. }
  6. // 私有方法
  7. _bar(baz) {
  8. return this.snaf = baz;
  9. }
  10. // ...
  11. }

上面代码中,_bar方法前面的下划线,表示这是一个只限于内部使用的私有方法。但是,这种命名是不保险的,在类的外部,还是可以调用到这个方法。

另一种方法就是索性将私有方法移出模块,因为模块内部的所有方法都是对外可见的。

  1. class Widget {
  2. foo (baz) {
  3. bar.call(this, baz);
  4. }
  5. // ...
  6. }
  7. function bar(baz) {
  8. return this.snaf = baz;
  9. }

上面代码中,foo是公开方法,内部调用了bar.call(this, baz)。这使得bar实际上成为了当前模块的私有方法。

还有一种方法是利用Symbol值的唯一性,将私有方法的名字命名为一个Symbol值。

  1. const bar = Symbol('bar');
  2. const snaf = Symbol('snaf');
  3. export default class myClass{
  4. // 公有方法
  5. foo(baz) {
  6. this[bar](baz);
  7. }
  8. // 私有方法
  9. [bar](baz) {
  10. return this[snaf] = baz;
  11. }
  12. // ...
  13. };

上面代码中,barsnaf都是Symbol值,一般情况下无法获取到它们,因此达到了私有方法和私有属性的效果。但是也不是绝对不行,Reflect.ownKeys()依然可以拿到它们。

  1. const inst = new myClass();
  2. Reflect.ownKeys(myClass.prototype)
  3. // [ 'constructor', 'foo', Symbol(bar) ]

上面代码中,Symbol 值的属性名依然可以从类的外部拿到。

私有属性的提案

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

  1. class IncreasingCounter {
  2. #count = 0;
  3. get value() {
  4. console.log('Getting the current value!');
  5. return this.#count;
  6. }
  7. increment() {
  8. this.#count++;
  9. }
  10. }

上面代码中,#count就是私有属性,只能在类的内部使用(this.#count)。如果在类的外部使用,就会报错。

  1. const counter = new IncreasingCounter();
  2. counter.#count // 报错
  3. counter.#count = 42 // 报错

上面代码在类的外部,读取私有属性,就会报错。

下面是另一个例子。

  1. class Point {
  2. #x;
  3. constructor(x = 0) {
  4. this.#x = +x;
  5. }
  6. get x() {
  7. return this.#x;
  8. }
  9. set x(value) {
  10. this.#x = +value;
  11. }
  12. }

上面代码中,#x就是私有属性,在Point类之外是读取不到这个属性的。由于井号#是属性名的一部分,使用时必须带有#一起使用,所以#xx是两个不同的属性。

之所以要引入一个新的前缀#表示私有属性,而没有采用private关键字,是因为 JavaScript 是一门动态语言,没有类型声明,使用独立的符号似乎是唯一的比较方便可靠的方法,能够准确地区分一种属性是否为私有属性。另外,Ruby 语言使用@表示私有属性,ES6 没有用这个符号而使用#,是因为@已经被留给了 Decorator。

这种写法不仅可以写私有属性,还可以用来写私有方法。

  1. class Foo {
  2. #a;
  3. #b;
  4. constructor(a, b) {
  5. this.#a = a;
  6. this.#b = b;
  7. }
  8. #sum() {
  9. return #a + #b;
  10. }
  11. printSum() {
  12. console.log(this.#sum());
  13. }
  14. }

上面代码中,#sum()就是一个私有方法。

另外,私有属性也可以设置 getter 和 setter 方法。

  1. class Counter {
  2. #xValue = 0;
  3. constructor() {
  4. super();
  5. // ...
  6. }
  7. get #x() { return #xValue; }
  8. set #x(value) {
  9. this.#xValue = value;
  10. }
  11. }

上面代码中,#x是一个私有属性,它的读写都通过get #x()set #x()来完成。

私有属性不限于从this引用,只要是在类的内部,实例也可以引用私有属性。

  1. class Foo {
  2. #privateValue = 42;
  3. static getPrivateValue(foo) {
  4. return foo.#privateValue;
  5. }
  6. }
  7. Foo.getPrivateValue(new Foo()); // 42

上面代码允许从实例foo上面引用私有属性。

私有属性和私有方法前面,也可以加上static关键字,表示这是一个静态的私有属性或私有方法。

  1. class FakeMath {
  2. static PI = 22 / 7;
  3. static #totallyRandomNumber = 4;
  4. static #computeRandomNumber() {
  5. return FakeMath.#totallyRandomNumber;
  6. }
  7. static random() {
  8. console.log('I heard you like random numbers…')
  9. return FakeMath.#computeRandomNumber();
  10. }
  11. }
  12. FakeMath.PI // 3.142857142857143
  13. FakeMath.random()
  14. // I heard you like random numbers…
  15. // 4
  16. FakeMath.#totallyRandomNumber // 报错
  17. FakeMath.#computeRandomNumber() // 报错

上面代码中,#totallyRandomNumber是私有属性,#computeRandomNumber()是私有方法,只能在FakeMath这个类的内部调用,外部调用就会报错。