逐行分析鴻蒙系統的 JavaScript 框架

時間 2020-09-19

標籤逐行分析鴻蒙系統 javascript 框架欄目 JavaScript 简体版

原文原文鏈接

我在前文中曾經介紹過鴻蒙的 Javascript 框架，這幾天終於把 JS 倉庫編譯經過了，期間踩了很多坑，也給鴻蒙貢獻了幾個 PR。今天咱們就來逐行分析鴻蒙系統中的 JS 框架。vue

文中的全部代碼都基於鴻蒙的當前最新版（版本爲 677ed06，提交日期爲 2020-09-10）。git

鴻蒙系統使用 JavaScript 開發 GUI 是一種相似於微信小程序、輕應用的模式。而這個 MVVM 模式中，V 實際上是由 C++ 來承擔的。JavaScript 代碼只是其中的 ViewModel 層。npm

鴻蒙 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 個。也是本文分析的重點。app

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，那麼須要將新的元素放入觀察者隊列中。

另外兩個文件分別是單元測試和性能分析，這裏就再也不分析了。