关于前端:逐行分析鸿蒙系统的-JavaScript-框架

我在前文中已经介绍过鸿蒙的 Javascript 框架，这几天终于把 JS 仓库编译通过了，期间踩了不少坑，也给鸿蒙奉献了几个 PR。明天咱们就来逐行剖析鸿蒙零碎中的 JS 框架。

文中的所有代码都基于鸿蒙的以后最新版（版本为 677ed06，提交日期为 2020-09-10）。

鸿蒙零碎应用 JavaScript 开发 GUI 是一种相似于微信小程序、轻利用的模式。而这个 MVVM 模式中，V 其实是由 C++ 来承当的。JavaScript 代码只是其中的 ViewModel 层。

鸿蒙 JS 框架是零依赖的，只在开发打包过程中应用到了一些 npm 包。打包完之的代码是没有依赖任何 npm 包的。咱们先看一下应用鸿蒙 JS 框架写进去的 JS 代码到底长什么样。

export default {data() {return { count: 1};
  },
  increase() {++this.count;},
  decrease() {--this.count;},
}

如果我不通知你这是鸿蒙，你甚至会认为它是 vue 或小程序。如果独自把 JS 拿进去应用（脱离鸿蒙零碎），代码是这样：

const vm = new ViewModel({data() {return { count: 1};
  },
  increase() {++this.count;},
  decrease() {--this.count;},
});

console.log(vm.count); // 1

vm.increase();
console.log(vm.count); // 2

vm.decrease();
console.log(vm.count); // 1

仓库中的所有 JS 代码实现了一个 响应式零碎，充当了 MVVM 中的 ViewModel。

上面咱们逐行剖析。

src 目录中一共有 4 个目录，总计 8 个文件。其中 1 个是单元测试。还有 1 个性能剖析。再除去 2 个 index.js 文件，有用的文件一共是 4 个。也是本文剖析的重点。

src
├── __test__
│   └── index.test.js
├── core
│   └── index.js
├── index.js
├── observer
│   ├── index.js
│   ├── observer.js
│   ├── subject.js
│   └── utils.js
└── profiler
    └── index.js

首先是入口文件，src/index.js，只有 2 行代码：

import {ViewModel} from './core';
export default ViewModel;

其实就是从新导出。

另一个相似的文件是 src/observer/index.js，也是 2 行代码：

export {Observer} from './observer';
export {Subject} from './subject';

observer 和 subject 实现了一个观察者模式。subject 是主题，也就是被观察者。observer 是观察者。当 subject 有任何变动时须要被动告诉被观察者。这就是响应式。

这 2 个文件都应用到了 src/observer/utils.js，所以咱们先剖析一下 utils 文件。分 3 局部。

第一局部

export const ObserverStack = {stack: [],
  push(observer) {this.stack.push(observer);
  },
  pop() {return this.stack.pop();
  },
  top() {return this.stack[this.stack.length - 1];
  }
};

首先是定义了一个用来寄存观察者的栈，遵循后进先出的准则，外部应用 stack 数组来存储。

入栈操作 push，和数组的 push 函数一样，在栈顶放入一个观察者 observer。
出栈操作 pop，和数组的 pop 函数一样，在将栈顶的观察者删除，并返回这个被删除的观察者。
取栈顶元素 top，和 pop 操作不同，top 是把栈顶元素取出来，然而并不删除。

第二局部

export const SYMBOL_OBSERVABLE = '__ob__';
export const canObserve = target => typeof target === 'object';

定义了一个字符串常量 SYMBOL_OBSERVABLE。为了前面用着不便。

定义了一个函数 canObserve，指标是否能够被察看。只有对象能力被察看，所以应用 typeof 来判断指标的类型。等等，如同有什么不对。如果 target 为 null 的话，函数也会返回 true。如果 null 不可察看，那么这就是一个 bug。（写这篇文章的时候我曾经提了一个 PR，并询问了这种行为是否是冀望的行为）。

第三局部

export const defineProp = (target, key, value) => {Object.defineProperty(target, key, { enumerable: false, value});
};

这个没有什么好解释的，就是 Object.defineProperty 代码太长了，定义一个函数来防止代码反复。

上面再来剖析观察者 src/observer/observer.js，分 4 局部。

第一局部

export function Observer(context, getter, callback, meta) {
  this._ctx = context;
  this._getter = getter;
  this._fn = callback;
  this._meta = meta;
  this._lastValue = this._get();}

构造函数。承受 4 个参数。

context 以后观察者所处的上下午，类型是 ViewModel。当第三个参数 callback 调用时，函数的 this 就是这个 context。

getter 类型是一个函数，用来获取某个属性的值。

callback 类型是一个函数，当某个值变动后执行的回调函数。

meta 元数据。观察者 (Observer) 并不关注 meta 元数据。

在构造函数的最初一行，this._lastValue = this._get()。上面来剖析 _get 函数。

第二局部

Observer.prototype._get = function() {
  try {ObserverStack.push(this);
    return this._getter.call(this._ctx);
  } finally {ObserverStack.pop();
  }
};

ObserverStack 就是下面剖析过的用来存储所有观察者的栈。将以后观察者入栈，并通过 _getter 获得以后值。联合第一局部的构造函数，这个值存储在了 _lastValue 属性中。

执行完这个过程后，这个观察者就曾经初始化实现了。

第三局部

Observer.prototype.update = function() {
  const lastValue = this._lastValue;
  const nextValue = this._get();
  const context = this._ctx;
  const meta = this._meta;

  if (nextValue !== lastValue || canObserve(nextValue)) {this._fn.call(context, nextValue, lastValue, meta);
    this._lastValue = nextValue;
  }
};

这部分实现了数据更新时的脏查看 (Dirty checking) 机制。比拟更新后的值和以后值，如果不同，那么就执行回调函数。如果这个回调函数是渲染 UI，那么则能够实现按需渲染。如果值雷同，那么再查看设置的新值是否能够被察看，再决定到底要不要执行回调函数。

第四局部

Observer.prototype.subscribe = function(subject, key) {const detach = subject.attach(key, this);
  if (typeof detach !== 'function') {return;}
  if (!this._detaches) {this._detaches = [];
  }
  this._detaches.push(detach);
};

Observer.prototype.unsubscribe = function() {
  const detaches = this._detaches;
  if (!detaches) {return;}
  while (detaches.length) {detaches.pop()();}
};

订阅与勾销订阅。

咱们后面常常说观察者和被观察者。对于观察者模式其实还有另一种说法，叫订阅 / 公布模式。而这部分代码则实现了对主题 (subject) 的订阅。

先调用主题的 attach 办法进行订阅。如果订阅胜利，subject.attach 办法会返回一个函数，当调用这个函数就会勾销订阅。为了未来可能勾销订阅，这个返回值必须保存起来。

subject 的实现很多人应该曾经猜到了。观察者订阅了 subject，那么 subject 须要做的就是，当数据变动时即便告诉观察者。subject 如何晓得数据产生了变动呢，机制和 vue2 一样，应用 Object.defineProperty 做属性劫持。

上面再来剖析观察者 src/observer/subject.js，分 7 局部。

第一局部

export function Subject(target) {
  const subject = this;
  subject._hijacking = true;
  defineProp(target, SYMBOL_OBSERVABLE, subject);

  if (Array.isArray(target)) {hijackArray(target);
  }

  Object.keys(target).forEach(key => hijack(target, key, target[key]));
}

构造函数。根本没什么难点。设置 _hijacking 属性为 true，用来标示这个对象曾经被劫持了。Object.keys 通过遍从来劫持每个属性。如果是数组，则调用 hijackArray。

第二局部

两个静态方法。

Subject.of = function(target) {if (!target || !canObserve(target)) {return target;}
  if (target[SYMBOL_OBSERVABLE]) {return target[SYMBOL_OBSERVABLE];
  }
  return new Subject(target);
};

Subject.is = function(target) {return target && target._hijacking;};

Subject 的构造函数并不间接被内部调用，而是封装到了 Subject.of 静态方法中。

如果指标不能被察看，那么间接返回指标。

如果 target[SYMBOL_OBSERVABLE] 不是 undefined，阐明指标曾经被初始化过了。

否则，调用构造函数初始化 Subject。

Subject.is 则用来判断指标是否被劫持过了。

第三局部

Subject.prototype.attach = function(key, observer) {if (typeof key === 'undefined' || !observer) {return;}
  if (!this._obsMap) {this._obsMap = {};
  }
  if (!this._obsMap[key]) {this._obsMap[key] = [];}
  const observers = this._obsMap[key];
  if (observers.indexOf(observer) < 0) {observers.push(observer);
    return function() {observers.splice(observers.indexOf(observer), 1);
    };
  }
};

这个办法很眼生，对，就是上文的 Observer.prototype.subscribe 中调用的。作用是某个观察者用来订阅主题。而这个办法则是“主题是怎么订阅的”。

观察者保护这一个主题的哈希表 _obsMap。哈希表的 key 是须要订阅的 key。比方某个观察者订阅了 name 属性的变动，而另一个观察者订阅了 age 属性的变动。而且属性的变动还能够被多个观察者同时订阅，因而哈希表存储的值是一个数组，数据的每个元素都是一个观察者。

第四局部

Subject.prototype.notify = function(key) {
  if (
    typeof key === 'undefined' ||
    !this._obsMap ||
    !this._obsMap[key]
  ) {return;}
  this._obsMap[key].forEach(observer => observer.update());
};

当属性发生变化是，告诉订阅了此属性的观察者们。遍历每个观察者，并调用观察者的 update 办法。咱们上文中也提到了，脏查看就是在这个办法内实现的。

第五局部

Subject.prototype.setParent = function(parent, key) {
  this._parent = parent;
  this._key = key;
};

Subject.prototype.notifyParent = function() {this._parent && this._parent.notify(this._key);
};

这部分是用来解决属性嵌套 (nested object) 的问题的。就是相似这种对象：{user: { name: 'JJC'} }。

第六局部

function hijack(target, key, cache) {const subject = target[SYMBOL_OBSERVABLE];

  Object.defineProperty(target, key, {
    enumerable: true,
    get() {const observer = ObserverStack.top();
      if (observer) {observer.subscribe(subject, key);
      }

      const subSubject = Subject.of(cache);
      if (Subject.is(subSubject)) {subSubject.setParent(subject, key);
      }

      return cache;
    },
    set(value) {
      cache = value;
      subject.notify(key);
    }
  });
}

这一部分展现了如何应用 Object.defineProperty 进行属性劫持。当设置属性时，会调用 set(value)，设置新的值，而后调用 subject 的 notify 办法。这里并不进行任何查看，只有设置了属性就会调用，即便属性的新值和旧值一样。notify 会告诉所有的观察者。

第七局部

劫持数组办法。

const ObservedMethods = {
  PUSH: 'push',
  POP: 'pop',
  UNSHIFT: 'unshift',
  SHIFT: 'shift',
  SPLICE: 'splice',
  REVERSE: 'reverse'
};

const OBSERVED_METHODS = Object.keys(ObservedMethods).map(key => ObservedMethods[key]
);

ObservedMethods 定义了须要劫持的数组函数。后面大写的用来做 key，前面小写的是须要劫持的办法。

function hijackArray(target) {
  OBSERVED_METHODS.forEach(key => {const originalMethod = target[key];

    defineProp(target, key, function() {const args = Array.prototype.slice.call(arguments);
      originalMethod.apply(this, args);

      let inserted;
      if (ObservedMethods.PUSH === key || ObservedMethods.UNSHIFT === key) {inserted = args;} else if (ObservedMethods.SPLICE) {inserted = args.slice(2);
      }

      if (inserted && inserted.length) {inserted.forEach(Subject.of);
      }

      const subject = target[SYMBOL_OBSERVABLE];
      if (subject) {subject.notifyParent();
      }
    });
  });
}

数组的劫持和对象不同，不能应用 Object.defineProperty。

咱们须要劫持 6 个数组办法。别离是头部增加、头部删除、尾部增加、尾部删除、替换 / 删除某几项、数组反转。

通过重写数组办法实现了数组的劫持。然而这里有一个须要留神的中央，数据的每一个元素都是被察看过的，然而当在数组中增加了新元素时，这些元素还没有被察看。因而代码中还须要判断以后的办法如果是 push、unshift、splice，那么须要将新的元素放入观察者队列中。

另外两个文件别离是单元测试和性能剖析，这里就不再剖析了。

关于前端:逐行分析鸿蒙系统的-JavaScript-框架

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）