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

utils 里面定義了一個(gè) Observer 棧,存放了觀察者。subject 定義了被觀察者。當(dāng)我們觀察某個(gè)對(duì)象時(shí),也就是劫持這個(gè)對(duì)象屬性的操作,還包括一些數(shù)組函數(shù),比如 push、pop 等。這個(gè)文件應(yīng)該是代碼最多的,160 行。observer 的代碼就更簡(jiǎn)單了,五六十行。
而當(dāng)我們開發(fā)的時(shí)候,通過 Toolkit 將開發(fā)者編寫的 HML、CSS 和 JS 文件編譯打包成 JS Bundle,然后再將 JS Bundle 解析運(yùn)行成C++ native UI 的 View 組件進(jìn)行渲染。
“通過支持三方開發(fā)者使用聲明式的 API 進(jìn)行應(yīng)用開發(fā),以數(shù)據(jù)驅(qū)動(dòng)視圖變化,避免了大量的視圖操作,大大降低了應(yīng)用開發(fā)難度,提升開發(fā)者開發(fā)體驗(yàn)”?;旧暇褪且粋€(gè)小程序式的開發(fā)體驗(yàn)。
在 src\core\base\framework_min_js.h文件中,這段編譯好的 js 被編譯到了 runtime 里面。編譯完的 js 文件不到 3K,確實(shí)夠輕量。
js runtime 沒有使用 V8,也沒有使用 jscore。而是選擇了 JerryScript。JerryScript 是用于物聯(lián)網(wǎng)的超輕量 JavaScript 引擎。它能夠在內(nèi)存少于 64 KB 的設(shè)備上執(zhí)行 ECMAScript 5.1 源代碼。
從整體看這個(gè) js 框架大概使用了 96% 的 C/C++ 代碼,1.8% 的 JS 代碼。在 htm 文件中寫的組件會(huì)被編譯為原生組件。而 app_style_manager.cpp 和同級(jí)的七八個(gè)文件則用來解析 css,最終生成原生布局。
雖然在 SDK 中有幾個(gè) weex 包,也發(fā)現(xiàn)了 react 的影子。但是在 C/C++ 代碼中并沒有看到 yoga 相關(guān)的內(nèi)容(全局搜索沒發(fā)現(xiàn))。而 SDK 中的那些包僅僅是做 loader 用的,大概是為了在 webpack 打包時(shí)解析 htm 組件用的。將 htm 的 template 編譯為 js 代碼。
下面我們逐行分析。
首先是入口文件,src/index.js,只有 2 行代碼:
- import { ViewModel } from './core';
- export default ViewModel;
其實(shí)就是重新導(dǎo)出。
另一個(gè)類似的文件是 src/observer/index.js,也是 2 行代碼:
- export { Observer } from './observer';
- export { Subject } from './subject';
observer 和 subject 實(shí)現(xiàn)了一個(gè)觀察者模式。subject 是主題,也就是被觀察者。observer 是觀察者。當(dāng) subject 有任何變化時(shí)需要主動(dòng)通知被觀察者。這就是響應(yīng)式。
第一部分
- export const ObserverStack = {
- stack: [],
- push(observer) {
- this.stack.push(observer);
- },
- pop() {
- return this.stack.pop();
- },
- top() {
- return this.stack[this.stack.length - 1];
- }
- };
首先是定義了一個(gè)用來存放觀察者的棧,遵循后進(jìn)先出的原則,內(nèi)部使用 stack 數(shù)組來存儲(chǔ)。
- 入棧操作 push,和數(shù)組的 push 函數(shù)一樣,在棧頂放入一個(gè)觀察者 observer。
- 出棧操作 pop,和數(shù)組的 pop 函數(shù)一樣,在將棧頂?shù)挠^察者刪除,并返回這個(gè)被刪除的觀察者。
- 取棧頂元素 top,和 pop 操作不同,top 是把棧頂元素取出來,但是并不刪除。
第二部分
- export const SYMBOL_OBSERVABLE = '__ob__';
- export const canObserve = target => typeof target === 'object';
定義了一個(gè)字符串常量 SYMBOL_OBSERVABLE。為了后面用著方便。
定義了一個(gè)函數(shù) canObserve,目標(biāo)是否可以被觀察。只有對(duì)象才能被觀察,所以使用 typeof 來判斷目標(biāo)的類型。等等,好像有什么不對(duì)。如果 target 為 null 的話,函數(shù)也會(huì)返回 true。如果 null 不可觀察,那么這就是一個(gè) bug。(寫這篇文章的時(shí)候我已經(jīng)提了一個(gè) PR,并詢問了這種行為是否是期望的行為)。
第三部分
- export const defineProp = (target, key, value) => {
- Object.defineProperty(target, key, { enumerable: false, value });
- };
這個(gè)沒有什么好解釋的,就是Object.defineProperty 代碼太長(zhǎng)了,定義一個(gè)函數(shù)來避免代碼重復(fù)。
第一部分
- export function Observer(context, getter, callback, meta) {
- this._ctx = context;
- this._getter = getter;
- this._fn = callback;
- this._meta = meta;
- this._lastValue = this._get();
- }
構(gòu)造函數(shù)。接受 4 個(gè)參數(shù)。
context 當(dāng)前觀察者所處的上下文,類型是 ViewModel。當(dāng)?shù)谌齻€(gè)參數(shù) callback 調(diào)用時(shí),函數(shù)的 this 就是這個(gè) context。getter 類型是一個(gè)函數(shù),用來獲取某個(gè)屬性的值。callback 類型是一個(gè)函數(shù),當(dāng)某個(gè)值變化后執(zhí)行的回調(diào)函數(shù)。meta 元數(shù)據(jù)。觀察者(Observer)并不關(guān)注 meta 元數(shù)據(jù)。
在構(gòu)造函數(shù)的最后一行,this._lastValue = this._get()。下面來分析 _get 函數(shù)。
第二部分
- Observer.prototype._get = function() {
- try {
- ObserverStack.push(this);
- return this._getter.call(this._ctx);
- } finally {
- ObserverStack.pop();
- }
- };
ObserverStack 就是上面分析過的用來存儲(chǔ)所有觀察者的棧。將當(dāng)前觀察者入棧,并通過 _getter 取得當(dāng)前值。結(jié)合第一部分的構(gòu)造函數(shù),這個(gè)值存儲(chǔ)在了 _lastValue 屬性中。
執(zhí)行完這個(gè)過程后,這個(gè)觀察者就已經(jīng)初始化完成了。
第三部分
- 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;
- }
- };
這部分實(shí)現(xiàn)了數(shù)據(jù)更新時(shí)的臟檢查(Dirty checking)機(jī)制。比較更新后的值和當(dāng)前值,如果不同,那么就執(zhí)行回調(diào)函數(shù)。如果這個(gè)回調(diào)函數(shù)是渲染 UI,那么則可以實(shí)現(xiàn)按需渲染。如果值相同,那么再檢查設(shè)置的新值是否可以被觀察,再?zèng)Q定到底要不要執(zhí)行回調(diào)函數(shù)。
第四部分
- 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()();
- }
- };
訂閱與取消訂閱。
我們前面經(jīng)常說觀察者和被觀察者。對(duì)于觀察者模式其實(shí)還有另一種說法,叫訂閱/發(fā)布模式。而這部分代碼則實(shí)現(xiàn)了對(duì)主題(subject)的訂閱。
先調(diào)用主題的 attach 方法進(jìn)行訂閱。如果訂閱成功,subject.attach 方法會(huì)返回一個(gè)函數(shù),當(dāng)調(diào)用這個(gè)函數(shù)就會(huì)取消訂閱。為了將來能夠取消訂閱,這個(gè)返回值必需保存起來。
subject 的實(shí)現(xiàn)很多人應(yīng)該已經(jīng)猜到了。觀察者訂閱了 subject,那么 subject 需要做的就是,當(dāng)數(shù)據(jù)變化時(shí)即使通知觀察者。subject 如何知道數(shù)據(jù)發(fā)生了變化呢,機(jī)制和 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]));
- }
構(gòu)造函數(shù)?;緵]什么難點(diǎn)。設(shè)置 _hijacking 屬性為 true,用來標(biāo)示這個(gè)對(duì)象已經(jīng)被劫持了。Object.keys 通過遍歷來劫持每個(gè)屬性。如果是數(shù)組,則調(diào)用 hijackArray。
第二部分
兩個(gè)靜態(tài)方法。
- 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 的構(gòu)造函數(shù)并不直接被外部調(diào)用,而是封裝到了 Subject.of 靜態(tài)方法中。
如果目標(biāo)不能被觀察,那么直接返回目標(biāo)。如果target[SYMBOL_OBSERVABLE] 不是 undefined,說明目標(biāo)已經(jīng)被初始化過了。
否則,調(diào)用構(gòu)造函數(shù)初始化 Subject。
Subject.is 則用來判斷目標(biāo)是否被劫持過了。
第三部分
- 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);
- };
- }
- };
這個(gè)方法很眼熟,對(duì),就是上文的Observer.prototype.subscribe 中調(diào)用的。作用是某個(gè)觀察者用來訂閱主題。而這個(gè)方法則是“主題是怎么訂閱的”。
觀察者維護(hù)這一個(gè)主題的哈希表 _obsMap。哈希表的 key 是需要訂閱的 key。比如某個(gè)觀察者訂閱了 name 屬性的變化,而另一個(gè)觀察者訂閱了 age 屬性的變化。而且屬性的變化還可以被多個(gè)觀察者同時(shí)訂閱,因此哈希表存儲(chǔ)的值是一個(gè)數(shù)組,數(shù)據(jù)的每個(gè)元素都是一個(gè)觀察者。
第四部分
- Subject.prototype.notify = function(key) {
- if (
- typeof key === 'undefined' ||
- !this._obsMap ||
- !this._obsMap[key]
- ) {
- return;
- }
- this._obsMap[key].forEach(observer => observer.update());
- };
當(dāng)屬性發(fā)生變化是,通知訂閱了此屬性的觀察者們。遍歷每個(gè)觀察者,并調(diào)用觀察者的 update 方法。我們上文中也提到了,臟檢查就是在這個(gè)方法內(nèi)完成的。
第五部分
- 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)的問題的。就是類似這種對(duì)象:
{ 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 進(jìn)行屬性劫持。當(dāng)設(shè)置屬性時(shí),會(huì)調(diào)用 set(value),設(shè)置新的值,然后調(diào)用 subject 的 notify 方法。這里并不進(jìn)行任何檢查,只要設(shè)置了屬性就會(huì)調(diào)用,即使屬性的新值和舊值一樣。notify 會(huì)通知所有的觀察者。
第七部分
劫持?jǐn)?shù)組方法。
- 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 定義了需要劫持的數(shù)組函數(shù)。前面大寫的用來做 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();
- }
- });
- });
- }
數(shù)組的劫持和對(duì)象不同,不能使用Object.defineProperty。我們需要劫持 6 個(gè)數(shù)組方法。分別是頭部添加、頭部刪除、尾部添加、尾部刪除、替換/刪除某幾項(xiàng)、數(shù)組反轉(zhuǎn)。
通過重寫數(shù)組方法實(shí)現(xiàn)了數(shù)組的劫持。但是這里有一個(gè)需要注意的地方,數(shù)據(jù)的每一個(gè)元素都是被觀察過的,但是當(dāng)在數(shù)組中添加了新元素時(shí),這些元素還沒有被觀察。因此代碼中還需要判斷當(dāng)前的方法如果是 push、unshift、splice,那么需要將新的元素放入觀察者隊(duì)列中。
另外兩個(gè)文件分別是單元測(cè)試和性能分析,這里就不再分析了。
整體而言,比我預(yù)想的要好一些。
51CTO和華為官方合作共建的鴻蒙技術(shù)社區(qū)
https://harmonyos.51cto.com/#zz