Decorator:從原理到實踐

時間  2020-11-24
標籤 html 前端 git github segmentfault babel app 函數 學習 this 欄目 HTML 简体版
原文   原文鏈接

前言

原文連接:Nealyang/personalBloghtml

img

ES6 已經沒必要在過多介紹，在 ES6 以前，裝飾器可能並無那麼重要，由於你只須要加一層 wrapper 就行了，可是如今，因爲語法糖 class 的出現，當咱們想要去在多個類之間共享或者擴展一些方法的時候，代碼會變得錯綜複雜，難以維護，而這，也正式咱們 Decorator 的用武之地。前端

Object.defineProperty

關於 Object.defineProperty 簡單的說，就是該方法能夠精準的添加和修改對象的屬性git

語法

Object.defineProperty(obj,prop,descriptor)github

  • ojb:要在其上定義屬性的對象
  • prop:要定義或修改的屬性的名稱
  • descriptor:將被定義或修改的屬性描述符

該方法返回被傳遞給函數的對象segmentfault

在ES6中，因爲 Symbol類型的特殊性，用Symbol類型的值來作對象的key與常規的定義或修改不一樣，而Object.defineProperty 是定義key爲Symbol的屬性的方法之一。babel

經過賦值操做添加的普通屬性是可枚舉的，可以在屬性枚舉期間呈現出來（for...in 或 Object.keys 方法）， 這些屬性的值能夠被改變，也能夠被刪除。這個方法容許修改默認的額外選項（或配置）。默認狀況下，使用 Object.defineProperty() 添加的屬性值是不可修改的app

屬相描述符

對象裏目前存在的屬性描述符有兩種主要形式：數據描述符和存取描述符。數據描述符是一個具備值的屬性，該值多是可寫的，也可能不是可寫的。存取描述符是由getter-setter函數對描述的屬性。描述符必須是這兩種形式之一；不能同時是二者。函數

數據描述符和存取描述符均具備如下可選鍵值：學習

configurablethis

當且僅當該屬性的 configurable 爲 true 時，該屬性描述符纔可以被改變，同時該屬性也能從對應的對象上被刪除。默認爲 false

enumerable

當且僅當該屬性的enumerable爲true時，該屬性纔可以出如今對象的枚舉屬性中。默認爲 false。

數據描述符同時具備如下可選鍵值：

value

該屬性對應的值。能夠是任何有效的 JavaScript 值（數值，對象，函數等）。默認爲 undefined。

writable

當且僅當該屬性的writable爲true時，value才能被賦值運算符改變。默認爲 false

存取描述符同時具備如下可選鍵值：

get

一個給屬性提供 getter 的方法，若是沒有 getter 則爲 undefined。當訪問該屬性時，該方法會被執行，方法執行時沒有參數傳入，可是會傳入this對象（因爲繼承關係，這裏的this並不必定是定義該屬性的對象）。默認爲 undefined。

set

一個給屬性提供 setter 的方法，若是沒有 setter 則爲 undefined。當屬性值修改時，觸發執行該方法。該方法將接受惟一參數，即該屬性新的參數值。默認爲 undefined。

若是一個描述符不具備value,writable,get 和 set 任意一個關鍵字，那麼它將被認爲是一個數據描述符。若是一個描述符同時有(value或writable)和(get或set)關鍵字，將會產生一個異常

更多使用實例和介紹，參看：MDN

裝飾者模式

在看Decorator以前，咱們先看下裝飾者模式的使用，咱們都知道，裝飾者模式可以在不改變對象自身基礎上，在程序運行期間給對象添加指責。特色就是不影響以前對象的特性，而新增額外的職責功能。

like...this:

IMAGE

這段比較簡單，直接看代碼吧：

let Monkey = function () {}
Monkey.prototype.say = function () {
  console.log('目前我只是個野猴子');
}
let TensionMonkey = function (monkey) {
  this.monkey = monkey;
}
TensionMonkey.prototype.say = function () {
  this.monkey.say();
  console.log('帶上緊箍咒，我就要忘記世間煩惱!');
}
let monkey = new TensionMonkey(new Monkey());
monkey.say();

執行結果： IMAGE

Decorator

Decorator其實就是一個語法糖，背後其實就是利用es5的Object.defineProperty(target,name,descriptor),瞭解Object.defineProperty請移步這個連接:MDN文檔

其背後原理大體以下：

class Monkey{
  say(){
    console.log('目前，我只是個野猴子');
  }
}

執行上面的代碼，大體代碼以下：

Object.defineProperty(Monkey.prototype,'say',{
  value:function(){console.log('目前，我只是個野猴子')},
  enumerable:false,
  configurable:true,
  writable:true
})

若是咱們利用裝飾器來修飾他

class Monkey{
@readonly
say(){console.log('如今我是隻讀的了')}
}

在這種裝飾器的屬性，會在Object.defineProperty爲Monkey.prototype註冊say屬性以前，執行如下代碼：

let descriptor = {
  value:specifiedFunction,
  enumerable:false,
  configurable:true,
  writeable:true
};

descriptor = readonly(Monkey.prototype,'say',descriptor)||descriptor;
Object.defineProperty(Monkey.prototype,'say',descriptor);

從上面的僞代碼咱們能夠看出，Decorator只是在Object.defineProperty爲Monkey.prototype註冊屬性以前，執行了一個裝飾函數，其屬於一個類對Object.defineProperty的攔截。因此它和Object.defineProperty具備一致的形參：

  • obj：做用的目標對象
  • prop:做用的屬性名
  • descriptor:針對該屬性的描述符

下面看下簡單的使用

在class中的使用

  • 建立一個新的class繼承自原有的class，並添加屬性
@name
class Person{
  sayHello(){
    console.log(`hello ,my name is ${this.name}`)
  }
}

function name(constructor) {  
  return class extends constructor{
    name="Nealyang"
  }
}

new Person().sayHello()
//hello ,my name is Nealyang
  • 針對當前class修改(相似mixin)
@name
@seal
class Person {
  sayHello() {
    console.log(`hello ,my name is ${this.name}`)
  }
}

function name(constructor) {
  Object.defineProperty(constructor.prototype,'name',{
    value:'一凨'
  })
}
new Person().sayHello()

//若修改一個屬性

function seal(constructor) {
  let descriptor = Object.getOwnPropertyDescriptor(constructor.prototype, 'sayHello')
  Object.defineProperty(constructor.prototype, 'sayHello', {
    ...descriptor,
    writable: false
  })
}

new Person().sayHello = 1;// Cannot assign to read only property 'sayHello' of object '#<Person>'

上面說到mixin，那麼我就來模擬一個mixin吧

class A {
  run() {
    console.log('我會跑步!')
  }
}

class B {
  jump() {
    console.log('我會跳!')
  }
}

@mixin(A, B)
class C {}

function mixin(...args) {
  return function (constructor) {
    for (const arg of args) {
      for (let key of Object.getOwnPropertyNames(arg.prototype)) {
        if (key === 'constructor') continue;
        Object.defineProperty(constructor.prototype, key, Object.getOwnPropertyDescriptor(arg.prototype, key));
      }
    }
  }
}

let c = new C();
c.jump();
c.run();
// 我會跳!
// 我會跑步!

截止目前我們貌似寫了很是多的代碼了，對。。。這篇，爲了完全搞投Decorator，這。。。只是開始。。。

img

在class成員中的使用

這類的裝飾器的寫法應該就是咱們最爲熟知了，會接受三個參數:

  • 若是裝飾器掛載在靜態成員上，則會返回構造函數，若是掛載在實例成員上，則返回類的原型
  • 裝飾器掛載的成員名稱
  • Object.getOwnPropertyDescriptor的返回值

首先，咱們明確下靜態成員和實例成員的區別

class Model{
  //實例成員
  method1(){}
  method2 = ()=>{}
  
  // 靜態成員
  static method3(){}
  static method4 = ()=>{}
}

method1 和method2 是實例成員，可是method1存在於prototype上，method2只有實例化對象之後纔有。

method3和method4是靜態成員，二者的區別在因而否可枚舉描述符的設置，咱們經過babel轉碼能夠看到：

IMAGE

上述代碼比較亂，簡單的能夠理解爲：

function Model () {
  // 成員僅在實例化時賦值
  this.method2 = function () {}
}

// 成員被定義在原型鏈上
Object.defineProperty(Model.prototype, 'method1', {
  value: function () {}, 
  writable: true, 
  enumerable: false,  // 設置不可被枚舉
  configurable: true
})

// 成員被定義在構造函數上，且是默認的可被枚舉
Model.method4 = function () {}

// 成員被定義在構造函數上
Object.defineProperty(Model, 'method3', {
  value: function () {}, 
  writable: true, 
  enumerable: false,  // 設置不可被枚舉
  configurable: true
})

能夠看出，只有method2是在實例化時才賦值的，一個不存在的屬性是不會有descriptor的，因此這就是爲何在針對Property Decorator不傳遞第三個參數的緣由，至於爲何靜態成員也沒有傳遞descriptor，目前沒有找到合理的解釋，可是若是明確的要使用，是能夠手動獲取的。

就像上述的示例，咱們針對四個成員都添加了裝飾器之後，method1和method2第一個參數就是Model.prototype，而method3和method4的第一個參數就是Model。

class Model {
  // 實例成員
  @instance
  method1 () {}
  @instance
  method2 = () => {}

  // 靜態成員
  @static
  static method3 () {}
  @static
  static method4 = () => {}
}

function instance(target) {
  console.log(target.constructor === Model)
}

function static(target) {
  console.log(target === Model)
}

函數、訪問器、屬性 三者裝飾器的使用

  • 函數裝飾器的返回值會默認做爲屬性的value描述符的存在，若是返回爲undefined則忽略
class Model {
  @log1
  getData1() {}
  @log2
  getData2() {}
}

// 方案一，返回新的value描述符
function log1(tag, name, descriptor) {
  return {
    ...descriptor,
    value(...args) {
      let start = new Date().valueOf()
      try {
        return descriptor.value.apply(this, args)
      } finally {
        let end = new Date().valueOf()
        console.log(`start: ${start} end: ${end} consume: ${end - start}`)
      }
    }
  }
}

// 方案2、修改現有描述符
function log2(tag, name, descriptor) {
  let func = descriptor.value // 先獲取以前的函數

  // 修改對應的value
  descriptor.value = function (...args) {
    let start = new Date().valueOf()
    try {
      return func.apply(this, args)
    } finally {
      let end = new Date().valueOf()
      console.log(`start: ${start} end: ${end} consume: ${end - start}`)
    }
  }
}
  • 訪問器的Decorator就是get set前綴函數了，用於控制屬性的賦值、取值操做，在使用上和函數裝飾器沒有任何區別
class Modal {
  _name = 'Niko'

  @prefix
  get name() { return this._name }
}

function prefix(target, name, descriptor) {
  return {
    ...descriptor,
    get () {
      return `wrap_${this._name}`
    }
  }
}

console.log(new Modal().name) // wrap_Niko
  • 對於屬性裝飾器是沒有descriptor返回的，而且裝飾器函數的返回值也會被忽略，若是咱們須要修改某一個靜態屬性，則須要本身獲取descriptor
class Modal {
    @prefix
    static name1 = 'Niko'
  }
  
  function prefix(target, name) {
    let descriptor = Object.getOwnPropertyDescriptor(target, name)
  
    Object.defineProperty(target, name, {
      ...descriptor,
      value: `wrap_${descriptor.value}`
    })
  }
  
  console.log(Modal.name1) // wrap_Niko

對於一個實例的屬性，則沒有直接修改的方案，不過咱們能夠結合着一些其餘裝飾器來曲線救國。

好比，咱們有一個類，會傳入姓名和年齡做爲初始化的參數，而後咱們要針對這兩個參數設置對應的格式校驗

const validateConf = {} // 存儲校驗信息
  
  @validator
  class Person {
    @validate('string')
    name
    @validate('number')
    age
  
    constructor(name, age) {
      this.name = name
      this.age = age
    }
  }
  
  function validator(constructor) {
    return class extends constructor {
      constructor(...args) {
        super(...args)
  
        // 遍歷全部的校驗信息進行驗證
        for (let [key, type] of Object.entries(validateConf)) {
          if (typeof this[key] !== type) throw new Error(`${key} must be ${type}`)
        }
      }
    }
  }
  
  function validate(type) {
    return function (target, name, descriptor) {
      // 向全局對象中傳入要校驗的屬性名及類型
      validateConf[name] = type
    }
  }
  
  new Person('Niko', '18')  // throw new error: [age must be number]

函數參數裝飾器

const parseConf = {}
  class Modal {
    @parseFunc
    addOne(@parse('number') num) {
      return num + 1
    }
  }
  
  // 在函數調用前執行格式化操做
  function parseFunc (target, name, descriptor) {
    return {
      ...descriptor,
      value (...arg) {
        // 獲取格式化配置
        for (let [index, type] of parseConf) {
          switch (type) {
            case 'number':  arg[index] = Number(arg[index])             break
            case 'string':  arg[index] = String(arg[index])             break
            case 'boolean': arg[index] = String(arg[index]) === 'true'  break
          }
  
          return descriptor.value.apply(this, arg)
        }
      }
    }
  }
  
  // 向全局對象中添加對應的格式化信息
  function parse(type) {
    return function (target, name, index) {
      parseConf[index] = type
    }
  }
  
  console.log(new Modal().addOne('10')) // 11

Decorator 用例

img

log

爲一個方法添加 log 函數，檢查輸入的參數

let log = type => {
      return (target,name,decorator) => {
        const method = decorator.value;
        console.log(method);

        decorator.value = (...args) => {
          console.info(`${type} 正在進行：${name}(${args}) = ?`);
          let result;
          try{
            result = method.apply(target,args);
            console.info(`(${type}) 成功 : ${name}(${args}) => ${result}`);
          }catch(err){
            console.error(`(${type}) 失敗: ${name}(${args}) => ${err}`);
          }
          return result;
        }
      }
    }

    class Math {
      @log('add')
      add(a, b) {
        return a + b;
      }
    }

    const math = new Math();

    // (add) 成功 : add(2,4) => 6
    math.add(2, 4);

img

time

用於統計方法執行的時間:

function time(prefix) {
  let count = 0;
  return function handleDescriptor(target, key, descriptor) {

    const fn = descriptor.value;

    if (prefix == null) {
      prefix = `${target.constructor.name}.${key}`;
    }

    if (typeof fn !== 'function') {
      throw new SyntaxError(`@time can only be used on functions, not: ${fn}`);
    }

    return {
      ...descriptor,
      value() {
        const label = `${prefix}-${count}`;
        count++;
        console.time(label);

        try {
          return fn.apply(this, arguments);
        } finally {
          console.timeEnd(label);
        }
      }
    }
  }
}

debounce

對執行的方法進行防抖處理

class Toggle extends React.Component {
  
    @debounce(500, true)
    handleClick() {
      console.log('toggle')
    }
  
    render() {
      return (
        <button onClick={this.handleClick}>
          button
        </button>
      );
    }
  }
  
  function _debounce(func, wait, immediate) {
  
      var timeout;
  
      return function () {
          var context = this;
          var args = arguments;
  
          if (timeout) clearTimeout(timeout);
          if (immediate) {
              var callNow = !timeout;
              timeout = setTimeout(function(){
                  timeout = null;
              }, wait)
              if (callNow) func.apply(context, args)
          }
          else {
              timeout = setTimeout(function(){
                  func.apply(context, args)
              }, wait);
          }
      }
  }
  
  function debounce(wait, immediate) {
    return function handleDescriptor(target, key, descriptor) {
      const callback = descriptor.value;
  
      if (typeof callback !== 'function') {
        throw new SyntaxError('Only functions can be debounced');
      }
  
      var fn = _debounce(callback, wait, immediate)
  
      return {
        ...descriptor,
        value() {
          fn()
        }
      };
    }
  }

更多關於 core-decorators 的例子後面再 Nealyang/PersonalBlog中補充，再加註釋說明。

參考

學習交流

關注公衆號： 【全棧前端精選】 每日獲取好文推薦。還能夠入羣，一塊兒學習交流呀~~

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程