Decorator 提供了一種獨特的抽象邏輯,可在原有代碼基礎上,零侵入添加新功能特性。商業代碼總是多種交織并存的,在日常開發中,除了實現業務功能之外,我們還需要考慮諸如:異常處理、性能分析、日志等額外的需求。未經設計的的開發方法會傾向于將各種需求耦合組成一個功能模塊,比如:
class Math{ static add(num1,num2){ try{ console.time('some label'); log('log for something'); const result= num1+num2; console.timeEnd('some label'); return result; }catch(e){ error('something had broken'); } } }
上述簡單的兩數相加功能,在添加各類需求之后,已經變的面目全非。Decorator 語法通過描述,可將功能特性疊加到原有功能中:
class Math{ @log @error @time static add(num1,num2){ return num1+num2; } }
Decorator 是什么
Decorator 就是一個的包裹函數,運行時在編譯階段調用該函數,修改目標對象的行為、屬性。我們先來看一個簡單實例:
const log = (target,prop)=>console.log(`Wrap function: '${prop}'`); const tec={ @log say(){ console.log('hello world') } } // => Wrap function 'say'
Decorator 函數簽名如下:
// @param target 作用對象 // @param prop 作用的屬性名 // @param descriptor 屬性描述符 // @return descriptor 屬性描述符 function decorator(target,prop,descriptor){}
參數詳解:
Decorator 的ES5實現
理解 Decorator 機制,最佳方式是使用ES5實現該過程。
class裝飾器機制比較簡單,僅做一層包裝,偽代碼:
// 調用實例 @log class Person{} // 實現代碼 const Person = log(Person);
屬性裝飾器機制則比較復雜,babel 就此提供了一個參考范例:
// decorator 處理 function _applyDecoratedDescriptor(target, property, decorators, descriptor, context) { var desc = {}; Object['ke' + 'ys'](descriptor).forEach(function (key) { desc[key] = descriptor[key]; }); desc.enumerable = !!desc.enumerable; desc.configurable = !!desc.configurable; if ('value' in desc || desc.initializer) { desc.writable = true; } desc = decorators.slice().reverse().reduce(function (desc, decorator) { return decorator(target, property, desc) || desc; }, desc); if (context && desc.initializer !== void 0) { desc.value = desc.initializer ? desc.initializer.call(context) : void 0; desc.initializer = undefined; } if (desc.initializer === void 0) { Object['define' + 'Property'](target, property, desc); desc = null; } return desc; } // 調用實例 class Person{ @log say(){} } // 實現代碼 _applyDecoratedDescriptor( Person.prototype, 'say', [log], Object.getOwnPropertyDescriptor(Person.prototype, 'say'), Person.prototype) )
用例
Decorator 主要應用于如下幾類對象:
// 類 @log class Person{ // 函數 @log say(){} // 屬性 @log name = 'tec'; } // 同樣適用于對象字面量的方法、屬性 const tec = { @log name:'tec', @log walk(){} };
Decorator 實踐
在JS中,Decorator 是一個新概念,對于多數沒有接觸過諸如python、C#的開發者而言,很難理解實際應用場景。幸運的是github已經有人封裝了常用Decorator。筆者分析該庫,總結如下幾種定義模式:
通過 descriptor 的 value 值修改:
function decorate(target, key, descriptor) { const fn = descriptor.value; return { ...descriptor, value() { return fn.apply(this, arguments); } } }
通過 descriptor 的 get、set 函數修改:
function decorate(target, key, descriptor) { let value = descriptor.value; return { ...descriptor, get() { return value; } set(v) { value=v; } } }
通過 descriptor 的 writable、enumerable 等屬性修改:
function readonly(target, key, descriptor) { return { ...descriptor, writable:false } }
針對 class ,返回包裹函數
function log(target){ let initTimes=0; return (...arg)=>{ console.log(++initTimes); target.call(this,...arg); }; }
在實際開發中,還需要注意以下事項:
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com