逐行分析鸿蒙系统的 JavaScript 框架

向右看齐 2022-12-08 05:07 274阅读 1赞

我在前文中曾经介绍过[鸿蒙的 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 拿出来使用（脱离鸿蒙系统），代码是这样：

仓库中的所有 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' } }`。

**第六部分**

这一部分展示了如何使用 `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，后面小写的是需要劫持的方法。

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

我们需要劫持 6 个数组方法。分别是头部添加、头部删除、尾部添加、尾部删除、替换/删除某几项、数组反转。

通过重写数组方法实现了数组的劫持。但是这里有一个需要注意的地方，数据的每一个元素都是被观察过的，但是当在数组中添加了新元素时，这些元素还没有被观察。因此代码中还需要判断当前的方法如果是 `push`、`unshift`、`splice`，那么需要将新的元素放入观察者队列中。

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

**相关阅读**

*  [鸿蒙系统中的 JS 开发框架][Javascript]

## ❤️看完三件事 ##

如果你觉得这篇内容对你挺有启发，我想邀请你帮我三个小忙：

1.  点赞，让更多的人也能看到介绍内容（收藏不点赞，都是耍流氓-\_-）
2.  关注公众号“前端劝退师”，不定期分享原创知识。
3.  也看看其他文章

![format_png][]

劝退师个人微信：**huab119**

也可以来我的`GitHub`博客里拿所有文章的源文件：

**前端劝退指南**：https：//github.com/roger-hiro/BlogFN一起玩耍呀

在看、点赞、转发支持作者❤️

[Javascript]: http://mp.weixin.qq.com/s?__biz=MzI0NTAyNjE0NQ%3D%3D&chksm=f3da699dc4ade08bc569225004c3212728eb784303c260e5c0cc6d83c42fffa3ecdeae71ed7a&idx=1&mid=2675578259&scene=21&sn=3b615746ba8d05a763433595269197a1#wechat_redirect
[format_png]: /images/20221123/69998f156832413eb60eec6eb7f26944.png