鴻蒙HarmonyOS系統中的JS開發框架
https://harmonyos.51cto.com/#zz
HarmonyOS開源至今已經一個多月,源碼托管在國內知名開源平臺碼云上,https://gitee.com/openharmony 。
我最感興趣的就是JS 框架 ace_lite_jsfwk,從名字中可以看出來這是一個非常輕量級的框架,官方介紹說是“輕量級 JS 核心開發框架”。
當我看完源碼后發現它確實輕。src 目錄中一共有 4 個目錄,總計 8 個文件。其中 1 個是單元測試,還有 1 個性能分析。再除去 2 個 index.js 文件,關鍵的文件一共 4 個,大概300-400 行代碼。
src
├── __test__
│ └── index.test.js
├── core
│ └── index.js
├── index.js
├── observer
│ ├── index.js
│ ├── observer.js
│ ├── subject.js
│ └── utils.js
└── profiler
└── index.js
從名字可以看出來,這些代碼實現了一個觀察者模式。也就是說,它實現了一個非常輕量級的 MVVM 模式。通過使用和 vue2 相似的屬性劫持技術實現了響應式系統。

utils 里面定義了一個 Observer 棧,存放了觀察者。subject 定義了被觀察者。當我們觀察某個對象時,也就是劫持這個對象屬性的操作,還包括一些數組函數,比如 push、pop 等。這個文件應該是代碼最多的,160 行。observer 的代碼就更簡單了,五六十行。
而當我們開發的時候,通過 Toolkit 將開發者編寫的 HML、CSS 和 JS 文件編譯打包成 JS Bundle,然后再將 JS Bundle 解析運行成C++ native UI 的 View 組件進行渲染。
“通過支持三方開發者使用聲明式的 API 進行應用開發,以數據驅動視圖變化,避免了大量的視圖操作,大大降低了應用開發難度,提升開發者開發體驗”。基本上就是一個小程序式的開發體驗。
在 src\core\base\framework_min_js.h文件中,這段編譯好的 js 被編譯到了 runtime 里面。編譯完的 js 文件不到 3K,確實夠輕量。
js runtime 沒有使用 V8,也沒有使用 jscore。而是選擇了 JerryScript。JerryScript 是用于物聯網的超輕量 JavaScript 引擎。它能夠在內存少于 64 KB 的設備上執行 ECMAScript 5.1 源代碼。
從整體看這個 js 框架大概使用了 96% 的 C/C++ 代碼,1.8% 的 JS 代碼。在 htm 文件中寫的組件會被編譯為原生組件。而 app_style_manager.cpp 和同級的七八個文件則用來解析 css,最終生成原生布局。
雖然在 SDK 中有幾個 weex 包,也發現了 react 的影子。但是在 C/C++ 代碼中并沒有看到 yoga 相關的內容(全局搜索沒發現)。而 SDK 中的那些包僅僅是做 loader 用的,大概是為了在 webpack 打包時解析 htm 組件用的。將 htm 的 template 編譯為 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 有任何變化時需要主動通知被觀察者。這就是響應式。
第一部分
- 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 代碼太長了,定義一個函數來避免代碼重復。
第一部分
- 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 做屬性劫持。

第一部分
- 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===key) {
- 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,那么需要將新的元素放入觀察者隊列中。
另外兩個文件分別是單元測試和性能分析,這里就不再分析了。
整體而言,比我預想的要好一些。
https://harmonyos.51cto.com/#zz